Frequently asked questions

For the catalog, yes: 118 of 135 operations refuse a keyless call with a 401. Blog, changelog, notices and shared collections are open. A free Explorer key takes a minute. See Authentication.

Either. Both carry the same key on every endpoint and neither is being retired; the SDKs send Bearer, the samples here send X-API-Key. If you send both, X-API-Key wins.

A 403 means the credential is fine and the plan or account is not permitted: the endpoint needs a higher plan, the account is suspended, or the key is not attached to the account or shop being acted on. error.reason names which. A new key never fixes a 403. See Error handling.

Not with your key in the page: anyone can read it. Call from a server, or through your own proxy that adds the key. The docs playground is the one exception and keeps the key in your browser only.

No. The site reaches the API through a proxy with a server-side token the browser never sees, holds no plan and no key, and is rate-limited per visitor. See How we protect your data.

Every call that reaches a handler, including errors. A 304 Not Modified does not count against the daily cap, but it still uses a per-minute slot, which is what makes conditional requests worth sending. See Caching.

Per minute, per day, and per month, each answering a different question: burst, sustained scraping, and what the plan sells. Per-minute and daily limits are enforced by the API and named in the 429; the monthly figure is your allowance. See Rate limits and plans.

Upgrade the plan, from $29 a month. Enterprise carries custom limits; ask through a support ticket. Changing plans re-issues nothing: the same key carries the new plan immediately.

Send If-None-Match with the ETag you got; 33 endpoints answer 304 when nothing changed. For mirrors, compare the version field on each record and subscribe to webhooks instead of polling.

The endpoint access matrix answers it per endpoint, and the comparison table per feature: full specifications from Builder, the compatibility engine and webhooks from Studio, the seller listing on Enterprise.

Every record carries updatedAt and version, maintained by the database when a served column changes. Subscribe to webhooks for pushes, or read the changelog for catalog-wide notes.

dataConfidence says how completely a record is specified and how well it is sourced, 0 to 1; sources lists the pages it came from. It is a record-level measure, not a per-field probability. See the field reference.

Caching is designed for: honour Cache-Control, revalidate with ETags, and use webhooks to stay current. What you may redistribute is governed by the Terms of Service, and the free plan is deliberately shaped so that a full copy is not something it can take.

File a data report, over the API or from the record's page, naming the section and citing a source. A person reviews it and an accepted correction reaches every subscriber. See Feedback and data reports.

Null means unknown or not applicable, never zero. A field absent on the free plan is a paid field: Explorer receives a summary view. The field reference marks which fields start at Builder.

TypeScript and Python, generated from the same OpenAPI spec as this reference. See the SDK tab and Tools and spec for the spec file, Postman collection and Swagger UI.

Yes: llms.txt, agent instruction packs, tool-calling examples and an MCP note are on AI and LLMs, and every docs page has Open in ChatGPT / Claude / Perplexity and a Markdown version.

Every endpoint page has a Try It console: fill parameters, send with your key, download the response as JSON, YAML or CSV, and share a link to the exact request. The key stays in your browser.