The plug API is separated into two systems, WebSocket and REST.
While the WebSocket part is used to communicate at real time (such as chat, booth advancement etc.), the REST API is used to do everything that does not require a real-time connection. While this certainly induces a bit of latency for each action, it is something that can be easily handled with.
The API endpoints are rate limited. If you send too many requests in a given period of time, you will be temporarily IP banned. This can happen when you spam the booth join, or any other endpoint.
Some methods however, are white listed such as chat deleting, this is in order to prevent spam and other attacks.
| Endpoint Name | Link |
|---|---|
| Auth Facebook | "auth/facebook" |
| Auth Login | "auth/login" |
| Auth Reset | "auth/reset/me" |
| Auth Session | "auth/session" |
| Auth Token | "auth/token" |
| Bans | "bans" |
| Bans Add | "bans/add" |
| Booth | "booth" |
| Booth Add | "booth/add" |
| Booth Cycle | "booth/cycle" |
| Booth Lock | "booth/lock" |
| Booth Move | "booth/move" |
| Booth Remove | "booth/remove/:id" |
| Booth Skip | "booth/skip" |
| Booth Skip Me | "booth/skip/me" |
| Booth Waitlist Ban | "booth/waitlistban" |
| Chat Delete | "chat/:cid" |
| Friends | "friends" |
| Friends Ignore | "friends/ignore" |
| Friends Invites | "friends/invites" |
| Grabs | "grabs" |
| Ignores | "ignores" |
| Mutes | "mutes" |
| News | "news" |
| Notifications | "notifications" |
| Playlists | "playlists" |
| Playlists Activate | "playlists/:id/activate" |
| Playlists Media Delete | "playlists/:id/media/delete" |
| Playlists Media Insert | "playlists/:id/media/insert" |
| Playlists Media Move | "playlists/:id/media/move" |
| Playlists Media Update | "playlists/:id/media/update" |
| Playlists Rename | "playlists/:id/rename" |
| Playlists Shuffle | "playlists/:id/shuffle" |
| Playlists Media | "playlists/:id/media" |
| Profile Blurb | "profile/blurb" |
| Rooms | "rooms" |
| Rooms Favorites | "rooms/favorites" |
| Rooms History | "rooms/history" |
| Rooms Join | "rooms/join" |
| Rooms Me | "rooms/me" |
| Rooms SOS | "rooms/sos" |
| Rooms State | "rooms/state" |
| Rooms Update | "rooms/update" |
| Rooms Validate | "rooms/validate" |
| Staff | "staff" |
| Staff Update | "staff/update" |
| Store Inventory | "store/inventory" |
| Store Products | "store/products" |
| Store Purchase | "store/purchase" |
| Store Purchase Username | "store/purchase/username" |
| Users | "users" |
| Users Avatar | "users/avatar" |
| Users Badge | "users/badge" |
| Users Bulk | "users/bulk" |
| Users Language | "users/language" |
| Users Me | "users/me" |
| Users Me History | "users/me/history" |
| Users Me Transactions | "users/me/transactions" |
| Users Settings | "users/settings" |
| Users Signup | "users/signup" |
| Users Validate | "users/validate" |
| Votes | "votes" |
*Ordered by Endpoint Name^