notabotDocs

Account API

Read your balance, keys and usage from code. Read-only, same keys as the solver.

Account endpoints
EndpointReturns
GET /v1/meWho the key belongs to and the discount level the account is on.
GET /v1/balanceYour wallet balance, the solves it buys, and the solves left on each key.
GET /v1/keysEvery active key with its spend limit and remaining capacity. Secrets are never returned.
GET /v1/keys/7The same fields for a single key, by id. Another account’s key id answers 404.
GET /v1/usageTotals, a time series, and the split by site and by key. Filter with range (24h, 7d, 30d, 90d), key and type.

Account

Who the key belongs to and the discount level the account is on.

curl "https://api.notabot.sh/v1/me" \
  -H "Authorization: Bearer nab_live_YOUR_KEY"
200 OK
{
  "id": 42,
  "username": "pedro",
  "createdAt": "2026-10-16T09:12:44.000Z",
  "partner": false,
  "level": { "discount": 0.2, "discountBp": 2000 },
  "requestId": "req_…"
}

Balance

Your wallet balance, the solves it buys, and the solves left on each key.

curl "https://api.notabot.sh/v1/balance" \
  -H "Authorization: Bearer nab_live_YOUR_KEY"
200 OK
{
  "currency": "EUR",
  "balance": 37.11,
  "balanceMicro": 37110000,
  "lifetimeTopup": 50,
  "level": { "discountBp": 2000, "next": { "atLifetimeTopupMicro": 250000000, "discountBp": 3000 } },
  "solvesLeft": { "akamai.sbsd": 14844, "cloudflare.jsd": 24740 },
  "keys": [ { "id": 7, "name": "prod", "limit": null, "solvesLeft": { "akamai.sbsd": 14844 } } ],
  "requestId": "req_…"
}

List keys

Every active key with its spend limit and remaining capacity. Secrets are never returned.

curl "https://api.notabot.sh/v1/keys" \
  -H "Authorization: Bearer nab_live_YOUR_KEY"
200 OK
{
  "keys": [
    {
      "id": 7, "name": "prod", "display": "nab_live_Ab3d…9k",
      "createdAt": "2026-10-16T09:20:01.000Z", "lastUsedAt": "2026-10-27T10:58:12.000Z",
      "limit": { "kind": "daily", "amountMicro": 5000000, "spentMicro": 1200000, "resetsAt": "2026-10-28T00:00:00.000Z" },
      "solvesLeft": { "akamai.sbsd": 1520, "cloudflare.jsd": 2533 }
    }
  ],
  "requestId": "req_…"
}

One key

The same fields for a single key, by id. Another account’s key id answers 404.

curl "https://api.notabot.sh/v1/keys/7" \
  -H "Authorization: Bearer nab_live_YOUR_KEY"
200 OK
{
  "id": 7, "name": "prod", "display": "nab_live_Ab3d…9k",
  "limit": null,
  "solvesLeft": { "akamai.sbsd": 14844 },
  "requestId": "req_…"
}

Usage

Totals, a time series, and the split by site and by key. Filter with range (24h, 7d, 30d, 90d), key and type.

curl "https://api.notabot.sh/v1/usage?range=7d" \
  -H "Authorization: Bearer nab_live_YOUR_KEY"
200 OK
{
  "range": "7d", "bucket": "day",
  "totals": { "ok": 3324, "failed": 41, "spent": 8.31, "spentMicro": 8310000, "p50LatencyMs": 612, "p95LatencyMs": 1480, "busiestHourUtc": 19 },
  "series": [ { "start": "2026-10-21T00:00Z", "ok": 480, "failed": 6, "p50LatencyMs": 598 } ],
  "bySite": [ { "site": "shop.example.com", "ok": 3324, "failed": 41, "spentMicro": 8310000 } ],
  "byKey": [ { "key": "prod", "ok": 3324, "failed": 41, "spentMicro": 8310000 } ],
  "requestId": "req_…"
}

Usage filters

Usage query parameters
FieldTypeDescription
rangestringOne of 24h, 7d (default), 30d or 90d. 24h is bucketed by hour, the rest by day.
keyintegerOnly this key (its id from /v1/keys).
typestringOnly this solver, for example akamai.sbsd. An unknown type answers bad_params (400).

The dashboard’s Usage page also exports the same data as CSV or JSON.