Skip to main content

API Usage Scores

Each call to an authenticated endpoint adds the endpoint's score to your client's usage for the current calendar month. When the client has a monthly_limit and the month's total reaches it, further calls are refused with HTTP 429 until the next month starts.

What a call costs​

Every authenticated endpoint currently costs 1000. The health probes (GET /health, /v1/health, /v2/health) and the token endpoint are not scored.

Treat the flat rate as today's pricing, not a contract: the platform can price endpoints individually later. Budget with the X-Monthlylimit-* headers, which always report the live figures.

How usage accrues​

  • Usage is counted per client, not per user or per node.
  • A call is counted once it has passed authentication, the certificate and IP checks and the rate limit, whatever its outcome: a call the endpoint then refuses (validation error, not found, …) still costs its score.
  • The total resets at the start of each calendar month.

Reading your remaining budget​

When your client has a monthly limit, every authenticated response carries:

HeaderMeaning
X-Monthlylimit-LimitThe client's monthly allowance
X-Monthlylimit-UsedUsage so far this month
X-Monthlylimit-RemainingWhat is left before calls are refused

When the limit is reached​

HTTP/1.1 429 Too Many Requests
Retry-After: 3600
X-Monthlylimit-Limit: 1000000
X-Monthlylimit-Used: 1000000
X-Monthlylimit-Remaining: 0
{
"code": 10012,
"domain": 100,
"message": "monthly usage limit exceeded"
}

Ask the platform operator for a higher monthly_limit before X-Monthlylimit-Remaining reaches zero. See Create Client and Errors.