Skip to main content
This guide is a high-level map for teams already integrated on v2 — what moved, what to call instead, and how to recheck your plan. For field-by-field details, follow the links to each endpoint’s reference page.

​
What changed at a glance

v2 exposed a few monolithic full-metadata endpoints that returned everything about an entity in one response. Data is split into granular endpoints, each returning one focused slice. This is the core shift to plan around — see Endpoint mapping for the full table.

Plans & limits

Per-plan rate limits and credit allowances, and how the new call pattern affects consumption.

Endpoint mapping

Every v2 endpoint and its v3 replacement(s).

​
Base conventions

  • Prefix. All routes live under /v3. There is no shared-version mode — a key calls v3 routes directly.
  • Authentication. Pass your key in the X-Api-Key header. v3 never accepts the key as a query parameter.
  • Response envelope. Object responses return { data, status }; list responses return { data, meta, status }. Read your payload from data.

​
Migration timeline

1

Parallel window — v2 and v3 run together

For several months after v3 ships, v2 and v3 are both live. Integrate and validate v3 against your real traffic during this window.
2

v2 shutdown

After the parallel window, v2 plans can’t be purchased or renewed. Active subscriptions run until their paid period ends, then you’ll need v3.