https://github.com/Clement87/Pepito-API

Events when PepitoTheCat is in or out
https://github.com/Clement87/Pepito-API

Last synced: 3 months ago
JSON representation

Events when PepitoTheCat is in or out

• Host: GitHub
• URL: https://github.com/Clement87/Pepito-API
• Owner: Clement87
• License: apache-2.0
• Created: 2024-09-07T13:14:09.000Z (3 months ago)
• Default Branch: main
• Last Pushed: 2024-09-11T12:35:00.000Z (3 months ago)
• Last Synced: 2024-09-12T09:26:59.181Z (3 months ago)
• Size: 19.5 KB
• Stars: 83
• Watchers: 2
• Forks: 5
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• starred - Clement87/Pepito-API - Events when PepitoTheCat is in or out (Others)

README

        
# Pépito-API

This is the documentation to use the Pépito *Server-sent events* (SSE) API.  

It will let you know when Pépito is *in* or *out* with the corresponding picture.

## Technical Information

**SSE API Endpoint**

````

https://api.thecatdoor.com/sse/v1/events

````

**Response Example**

```json

{"event":"heartbeat","time":1725714568}

{"event":"heartbeat","time":1725714578}

{"event":"pepito","type":"in","time":1725714575,"img":"https://storage.thecatdoor.com/assets/1725714575-in-799154526.jpg"}

{"event":"heartbeat","time":1725714588}

{"event":"heartbeat","time":1725714598}

{"event":"pepito","type":"out","time":1725715521,"img":"https://storage.thecatdoor.com/assets/1725715521-in-722148161.jpg"}

{"event":"heartbeat","time":1725715532}

```

Go to [examples](./examples) to see some basic client examples.

## Pépito's Accounts

### Official

* X - https://x.com/pepitothecat

* TikTok - https://www.tiktok.com/@pepitothecat2007

### Unofficial

*Add yours here using PR or issue*

* BlueSky - https://bsky.app/profile/pepitothe-cat.bsky.social

* BlueSky - https://bsky.app/profile/pepitocat.bsky.social

* Tumblr - https://www.tumblr.com/pepitothecat ([#6](https://github.com/Clement87/Pepito-API/issues/6))

* Discord - [Discord Bot Invite](https://discord.com/oauth2/authorize?client_id=1282732564657737788&permissions=2147601408&integration_type=0&scope=bot)

## Usage Policy

You are free to use this API for non-commercial usage.  

If you use it to publish on a public platform (like Bluesky, Mastodon, Threads, etc.), you must specify that it's an unofficial account.  

Additionally, please add the account link to the list above.

## Support

For any question, please submit an issue or send me a Private Message on [X](https://x.com/pepitothecat).