Get started
Authentication
Every request carries your API key in the
x-api-key header, in v1 and v2 alike, the v2 stream included.Header
x-api-key: <your API key>A missing or unknown key is answered with 401 Invalid or missing API Key.
Your credit balance
Every response sent with a valid key carries your remaining credits in the x-credit-balance header. In v2, the final event of a search also gives your balance once the search is settled. When your balance reaches 0, the account owner receives an email.
Keep the key on your server
Call the API from your backend, never from a browser or a mobile app: anything shipped to a client can be read, and anyone holding the key spends your credits.
Your backend opens the stream and relays the events to your own front end, over your own channel.