Skip to main content
GET
Usage
Reports your key’s plan, current rate limit state, consumption history, and your remaining match credits. Costs no credits. Because it costs nothing and reports all three rate limit windows and your match balance at once, this is the right endpoint to poll from a dashboard or to check before starting a large job. It does not need a balance. A key whose credits are at zero can still call this endpoint and read the zero for itself; that reading is the signal to top up, and refusing it here would lock a drained agent out of its own meter. Only the metered endpoints return 402 NO_CREDITS.

Query parameters

string
default:"month"
Window for the usage figures. One of day, week, month. Anything else returns INVALID_PARAMETER.

Request

Response

object

Notes

plan reports the rate-limit preset currently serving this account, not the pack you bought: Developer by default, Startup while a Scale pack is unexpired, Enterprise while an Index pack is. See plans. total_credits counts rate-limit units, not match credits, and it is not your bill: a 50-wallet batch is one request and 50 rate-limit units, while what it costs you is one match credit per wallet that resolved. total_credits exceeding total_requests is expected. For what you have left to spend, read credits.available. error_rate is already a percentage. 0.24 means 0.24%, not 24%. plan_limits can carry the string "unlimited" instead of a number on a custom plan with no ceiling in a given window. Nothing issued today does, but parse defensively. requests_by_endpoint is keyed by route template, so single-wallet and reverse lookups each stay one entry (/v1/wallet/{address}, /v1/reverse/twitter/{handle}, /v1/reverse/farcaster/{username}). The object holds at most one key per route, whatever the volume. The addresses and handles you looked up are not stored and never appear here. Calls made through the MCP server appear under these same keys. The tools carry your key into the same handlers, so a tool call is recorded as the endpoint it actually used, and there is no separate MCP entry to reconcile.
Requests made before 2026-08-22 were keyed by the concrete request path. That history has been rewritten to the templates, so a period that spans the change still aggregates correctly.

Errors

INVALID_PARAMETER, plus the standard errors.