Data API reference

Read-only reference data over HTTPS. Stable schemas, versioned paths, and predictable pagination.

Operational

Authentication

Every request carries a bearer token in the Authorization header. Tokens are scoped per environment and do not expire on a fixed schedule; rotate them from the account console.

curl https://api-us.itsforthevante.ir/data/v2/regions \
  -H "Authorization: Bearer $TOKEN" \
  -H "Accept: application/json"

Unauthenticated requests receive 401 with a JSON body. There is no anonymous tier.

Rate limits

WindowLimitHeader
per minute600 requestsX-RateLimit-Remaining
per day250,000 requestsX-RateLimit-Reset
burst60 requests / 5sRetry-After

Endpoints

MethodPathDescription
GET/data/v2/regionsList available regions
GET/data/v2/regions/{code}Fetch a single region
GET/data/v2/currenciesCurrency codes and precision
GET/data/v2/timezonesIANA zones with offsets
POST/data/v2/lookupBatch resolve up to 500 keys

Responses

Collections are wrapped in an envelope with a cursor. Pass cursor back verbatim to page forward.

{
  "data": [
    { "code": "us-east", "label": "US East",  "active": true  },
    { "code": "us-west", "label": "US West",  "active": true  },
    { "code": "eu-cent", "label": "EU Central","active": false }
  ],
  "cursor": "eyJvIjoxMjB9",
  "has_more": true
}

Error codes

StatusCodeMeaning
400invalid_requestMalformed query or body
401unauthorizedMissing or invalid token
404not_foundUnknown resource identifier
429rate_limitedWindow exhausted; see Retry-After
503unavailableUpstream refresh in progress

Changelog