Rate Limit
Returns your API key's current usage: the monthly quota and any per-endpoint-group sub-quotas, each with limit, used, remaining, and reset. Poll it to track remaining requests without spending one — this endpoint does not count against your quota.
Free & Unlimited. This endpoint does not count toward your monthly usage limits on any plan.
/v2/rate-limitQuery Parameters
Response Schema
Always true on a 2xx response.
Plan tier of the calling key (free, dev, pro, enterprise).
Per-second burst cap. Reports limit only — the live remaining count rides on the X-RateLimit-Remaining-Second response header.
Maximum requests per second for your tier.
Global monthly quota for your key.
Cap for this window. null means unlimited (enterprise).
Requests counted so far this window. null if the usage store is briefly unavailable.
limit − used, floored at 0. null when the limit is unlimited or usage is unavailable.
Unix timestamp (UTC seconds) when this window resets.
Per-endpoint-group monthly sub-quotas, keyed by group slug (matched-markets, arb, ev, smart-money, fade-finder). Empty when your tier has no group caps.
One bucket per group, same shape as month.
Cap for this window. null means unlimited (enterprise).
Requests counted so far this window. null if the usage store is briefly unavailable.
limit − used, floored at 0. null when the limit is unlimited or usage is unavailable.
Unix timestamp (UTC seconds) when this window resets.
Error Responses
All errors return the same envelope. The code field is stable and programmatically branchable; error and message are human-readable. errors[] is present only on validation failures with field-level detail. See the full error code reference →
Always `false` on error responses.
Short, human-readable title (e.g. 'Invalid API Key.').
Human-readable explanation for the error. Safe to surface in UIs.
Stable, hierarchical machine-readable code (e.g. 'validation.invalid_enum'). Use for programmatic handling.
Link to this code's entry in the Error Reference.
Optional. Present only on validation failures with field-level detail.
Name of the offending parameter.
Field-level machine code.
Human-readable explanation.
Authentication
API Key
To secure your requests, we strongly recommend passing your API key via the X-API-Key header. This prevents sensitive keys from being exposed in access logs or browser history.
X-API-Key: pmx_test_5e8f...Rate Limits
API rate limits are enforced based on the tier associated with your API key. Limits are tracked on two dimensions: requests per second and requests per month. Each completed request counts toward the global monthly quota. Separate endpoint-group monthly limits (matched markets, arbitrage, EV) only advance when the response body has success: true.
Usage is returned on responses via headers such as:
X-RateLimit-Limit-Second: 10X-RateLimit-Remaining-Second: 9X-RateLimit-Reset-Second: 1781290801X-RateLimit-Limit-Month: 1000X-RateLimit-Remaining-Month: 842X-RateLimit-Reset-Month: 1782864000Example (endpoint-group, when applicable)X-RateLimit-Limit-Arb-Month: 500X-RateLimit-Remaining-Arb-Month: 412If you exceed a rate limit, the API returns a 429 status with a Retry-After header indicating when you can resume.
Request
Live API Key
Response
—Click EXECUTE to send a request →