Authentication
Every request must include your API token in theAuthorization header as a Bearer token:
• If a request is sent without a token or with an invalid token, the API responds with 401 Unauthorized.
Google SERP options
Google results on/api/v1/serp, /api/v1/serp_html, /api/v1/serp_text and /api/v1/ranking are rendered in a real browser, so they take a few extra, Google-only parameters:
Every Google page is scored for poisoning and the score comes back in
quality (score, flags, suspected_poisoned). When a later page of a multi-page request fails, the pages that did load are returned with a warnings array instead of an error; only a request with no results at all fails. The full parameter and response schemas are on each endpoint’s page.
Rate Limits
We allow up to 600 requests per minute per account (aggregated across all endpoints). When the limit is exceeded the API responds with 429 Too Many Requests plus aRetry-After header indicating how many seconds to wait before retrying.
If you need higher throughput, please contact support and we’ll bump the limit for your workspace.
Need a quick start? Head over to the Quickstart guide or explore a specific endpoint in the sidebar.