Build with Basement

Basement doesn't have an SDK or a supported public API. You can still build on what the app already does in public. You can verify any round's result, link to matches with preview cards, and read the same live state the app reads. The endpoints behind that last one are unversioned and can change without notice.

What you can build on

Some things that fit inside those limits:

• A bot that posts a round's result card when it ends
• A fairness checker that saves each round's lock before it plays and checks it afterwards
• A chat command that shows which arenas are live and who's in them

Ground rules

• Everything on these pages is a GET or a read-only WebSocket. Picks, Drops and anything tied to an account happen in the app, and the server refuses a POST that a browser sends from another site.
• Call the endpoints from a server, a bot or a script. They send no CORS headers, so a web page on another site can't read them in the browser.
• Limits count per network, meaning one IPv4 address or one IPv6 /64, over 10-second windows. A network gets 300 reads and 40 socket connections per window, and at most 20 of those reads can be leaderboard reads. Past a limit you get a 429 with a retry-after header in seconds.
• Field names, shapes and URLs can change with any release. Nothing here is versioned yet.
• Basement can't be shown in an iframe. To put a match on your page or in a post, link to it. See links and embeds.

Full limits and error codes are in read-only endpoints.

Looking for the old developer API?

The API, engine guides and developer program in the old docs belonged to the previous version of Basement. None of them work with this one. What happened to them is on the previous Basement.

For partnerships, or to say what you'd build on a stable API, reach the team through Report a problem.

Next steps