API scopes and limits

Each API key carries scopes. A scope is a group of things the key may do. A call outside the key's scopes is refused.

The scopes#

• Read: search, listings, categories and sales, with higher limits than anonymous calls.
• Listings: create and update your own listings, and pause, resume or submit them.
• Profile: your account details, watchlist, notifications and membership.
• Trade: your offers and orders.
• Portfolio: read your portfolio, add domains and start a registrar sync.
• Webhooks: list, create, delete and test your webhook endpoints.

Some routes are public and need no key, such as the domain search and public reviews. The API documentation lists every route with its method and scope.

Rate limits#

Calls are limited per key per minute. Your membership plan sets the limit. When you go over it, the API answers with status 429 until the next minute. Build your app to slow down and retry.

Errors#

An error answer is JSON with ok set to false and an error text that says what went wrong: an invalid key, a missing scope, a bad value or a record that is not yours.

Watch your usage#

The API Keys page shows when each key was last used. Revoke keys you no longer use.

Want to be told about events instead of asking? See Webhooks: get events pushed to you.