Documentation Index
Fetch the complete documentation index at: https://docs.blockdb.io/llms.txt
Use this file to discover all available pages before exploring further.
Overview
Account & Usage endpoints help you confirm API availability and monitor consumption so you can:- Verify that the service is up (
/health) before or during deploys - See your plan, compute unit (CU) usage, remaining balance, and reset time (
/usage) - Read your configured requests-per-second limit for client-side throttling
- Validate that automation is behaving as expected (no runaway queries)
Endpoint Matrix
| Endpoint | Summary |
|---|---|
GET /health | Liveness check ({"status":"ok"}) |
GET /usage | Plan, CU usage, cu_reset_at, and rate_limit_rps |
Key Concepts
- Subscription plan: The
planfield on/usagereflects your current tier. - Compute units (CU): Each API call consumes a fixed number of CUs by endpoint family;
cu_used,cu_limit, andcu_remainingtrack your monthly allowance. - Reset:
cu_reset_atis when the CU counter rolls over for the next billing period. - Rate limits:
rate_limit_rpsis the account-wide RPS ceiling shared by all API keys (not per-key). See Rate limiting.
Best Practices
- Poll
/usageon a schedule to watchcu_remainingand avoid surprises nearcu_reset_at. - Use
/healthfor load balancer or uptime checks without sending an API key when your setup allows it. - Use efficient filtering and ranges on data endpoints, and cursor-based pagination for large pulls.
See Also
- Pricing — BlockDB subscription tiers
- Rate Limiting — RPS limits and quotas
- Authorization — API key usage and auth