Sample Bot API

The ER:LC tools an app needs again and again, as JSON.

Base URL

GET https://api.samplebot.app/v1 lists every endpoint, without a key.

Your API key

Register an application on Your applications to get a key. It starts with sb_ and is shown once, so store it somewhere safe. Send it with every request:

Authorization: Bearer sb_your_key_here

(X-API-Key: sb_your_key_here works too.) Keep the key on your server: anyone who has it can use your limits. If it leaks, delete the application and make a new one.

Requests and replies

Every endpoint is a GET with query parameters. Every reply looks like this:

{
  "ok": true,
  "tool": "snowflake",
  "data": { ... },
  "text": "A ready-to-post version, where there is one"
}

Rate limits

Every reply carries X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset (seconds until the window resets). Over the limit, you get 429 with a Retry-After header: wait that many seconds. Cache what does not change (postals) instead of asking every time.

Errors

{ "ok": false, "error": { "status": 404, "message": "There is no postal 999 in Liberty County." } }

Endpoints