ScraperData
Sign up

Getting started

Authentication

Every request needs your API key. You find it on the API key page of your dashboard.

Sending the key

Use one of these three ways. The header is the safest, because addresses end up in logs.

  • The X-API-Key header (recommended): X-API-Key: YOUR_API_KEY
  • A bearer token: Authorization: Bearer YOUR_API_KEY
  • The api_key query parameter: /v1/search?q=coffee&api_key=YOUR_API_KEY

The example on the right reads your account, a free call that is handy to check that a key works.

Keep it secret

Call the API from your server, not from code that runs in a browser or an app, where anyone could read the key. If a key leaks, create a new one on the API key page: the old key stops working at once.

Free endpoint without a key

Locations needs no key at all, so you can look up place names from anywhere.

Errors

  • 401 missing_api_key: no key was sent.
  • 401 invalid_api_key: the key is wrong or was replaced.
  • 403 account_disabled: the account is disabled. Contact support.