v1

Your plan and remaining budgets

Changed on

Returns your plan and what is left of it: tier, how far back your history calls reach (historyDays, or historyAllArchive: true when you can read everything we hold), the earliest day you may ask for, and two budgets: rateLimit, the request limit every call counts against, and historyRateLimit, the hourly history budget. Each budget has unmetered; when it is false, it also has limit, windowSeconds, remaining and reset, the same figures as the RateLimit headers. Use it on an unmetered plan, which gets no such headers, or to check your history budget without spending it. The call counts as one ordinary request and needs an API key.

get/v1/me

Request

  • Base URL
    https://api.themeparks.wiki
  • URL
    https://api.themeparks.wiki/v1/me
  • Auth
    API key in header X-API-Key

Response

Successful response

tierstring required

Your plan, e.g. "free", "pro", "business", "enterprise".

historyDaysinteger nullable required

How many days back your history calls may reach, today included. null when historyAllArchive is true.

historyAllArchiveboolean required

true when this key can read everything we hold for an entity, back to the first day we recorded it. historyDays and historyEarliestDate are then null.

historyEarliestDatestring date nullable required

The earliest day (YYYY-MM-DD) a history call may ask for, computed in UTC. Each park counts days in its own time zone, so near midnight this can be off by one. Earlier days answer 403 HISTORY_WINDOW_EXCEEDED. null when historyAllArchive is true.

Changes