Board API
Every public endpoint.
JSON in and out, no API key. These are the calls behind every payment, from a person or a program. Machine-readable: openapi.json.
Base URL
Base URL
https://nimbill.mblob.me
Errors
Errors are { error: { code, message } } with a matching HTTP status; the message is safe to show a person. Each endpoint's page lists the errors it can return.
Rate limits
Endpoints that start something (an invoice, a quote) are limited, and their answers say where you stand. The headers can be read from browsers on other sites too. On a 429, wait Retry-After seconds.
response headers
RateLimit-Limit: 30 requests allowed in the window RateLimit-Remaining: 12 left after this one RateLimit-Reset: 412 seconds until the window frees up Retry-After: 412 only on 429 Too Many Requests
Endpoints
- GET/api/pay/{tag}Read a board
- POST/api/pay/{tag}/invoicesCreate an invoice on a board
- GET/api/invoices/{id}Read an invoice
- POST/api/invoices/{id}/quoteLock the price
- POST/api/invoices/{id}/verifyConfirm the payment
- GET/api/tags/{tag}Look up a tag
- GET/api/ratesLive prices