PlanningTrack API · Free beta

Errors and limits

Use HTTP status, a stable error code, and a request ID to handle failures.

Illustrative error response
{
  "error": {
    "code": "invalid_parameter",
    "message": "receivedFrom must not be after receivedTo.",
    "param": "receivedFrom",
    "requestId": "example-request-id"
  }
}
StatusCodeAction
400invalid_parameter / invalid_cursorCorrect input; restart pagination if filters changed.
401authentication_required / invalid_api_key / api_key_revokedSupply a valid active key.
403access_deniedVerify your account’s email.
404not_foundCheck the endpoint and returned resource ID.
405method_not_allowedUse GET or HEAD.
409snapshot_unavailableRestart document or timeline pagination.
429rate_limit_exceededWait for Retry-After, then retry.
429quota_exceededResume after the monthly reset; do not keep retrying.
503service_unavailableRetry with bounded exponential backoff and jitter.

Allowance headers

X-Quota-Limit, X-Quota-Remaining, and X-Quota-Reset describe the monthly allowance. X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset describe the UTC minute window. Reset values are ISO timestamps. Retry-After is a number of seconds.

X-Request-Id appears on developer responses. Include it when reporting a failed request; find accepted data requests in your dashboard. Allowance headers may be absent before account authentication succeeds.

What counts

Successful data requests count once, including empty results, HEAD requests, and each pagination page. Failed requests and /v1/me do not consume monthly allowance. In-flight requests reserve capacity, so remaining allowance can temporarily be below 500 minus completed requests. Retries after an uncertain network failure can count again if both requests succeeded.

Accounts receive 500 requests each UTC calendar month and 60 per fixed UTC minute. Network abuse limits also apply. There is no rollover or automatic overage charge. The API console shares your allowance.