API reference

Conventions shared by every API, then one page per API with every endpoint.

Base URL and authentication

All endpoints live under https://api.scrapecrate.com/v1, use GET and answer JSON. Authenticate with X-API-Key: YOUR_API_KEY or Authorization: Bearer YOUR_API_KEY (details).

Response format

{
  "data": { },                    // object for lookups, array for lists
  "pagination": {                 // lists only
    "next_cursor": "eyJwIjoyfQ",  // null on the last page
    "has_more": true
  },
  "meta": {
    "request_id": "req_8f2c1a9b0d3e4f5a6b7c",
    "credits_used": 3,
    "credits_remaining": 9997
  }
}

Some APIs add their own documented meta fields.

Pagination

Lists use cursors. A call returns at most one page (the limit maximum of each endpoint is one page of the source; a larger value is refused with 400 invalid_parameter). Pass pagination.next_cursor as the cursor parameter to get the next page, with the same other parameters; stop when has_more is false. Every page is a new call. Cursors are opaque and can expire (410 cursor_expired): restart from the first page.

Response headers

HeaderMeaning
X-Request-IdUnique id of the call; quote it when you contact support.
X-Credits-UsedCredits charged for this call (0 for errors).
X-Credits-RemainingYour balance after the call.
Retry-AfterOn 429 and some 503 errors: seconds to wait before retrying.

Billing

Every successful call costs the credits of its API, the same on every endpoint and whatever it returns: YouTube 1, Google Maps 3, Meta Ad Library 5, Trustpilot 8. YouTube comments cost 1 credit per 100 comments. An empty list is a successful call. Errors cost nothing. Free monthly credits are used first; purchased credits are valid for 12 months from purchase and the ones that expire first are used first.

Rate limits

300 requests per minute and 20 concurrent requests per API key. Over the limit you get 429 rate_limited with Retry-After.

APIs

YouTube API

EndpointDescriptionPrice
GET /v1/youtube/transcripts/{video_id}Get a transcript1 credit / call
GET /v1/youtube/transcripts/{video_id}/languagesList transcript languages1 credit / call
GET /v1/youtube/videos/{video_id}Get video metadata1 credit / call
GET /v1/youtube/videos/{video_id}/chaptersGet video chapters1 credit / call
GET /v1/youtube/videos/{video_id}/commentsList video comments1 credit / 100 items
GET /v1/youtube/channels/{channel_id}Get a channel1 credit / call
GET /v1/youtube/channels/{channel_id}/videosList channel videos1 credit / call
GET /v1/youtube/searchSearch videos1 credit / call

Google Maps API

EndpointDescriptionPrice
GET /v1/maps/places/searchSearch places3 credits / call
GET /v1/maps/places/{place_id}Get place details3 credits / call
GET /v1/maps/places/{place_id}/reviewsList place reviews3 credits / call
GET /v1/maps/places/resolveResolve a Maps URL or ID3 credits / call

Trustpilot Reviews API

EndpointDescriptionPrice
GET /v1/trustpilot/companies/searchSearch companies8 credits / call
GET /v1/trustpilot/companies/{domain}Get a company8 credits / call
GET /v1/trustpilot/companies/{domain}/reviewsList company reviews8 credits / call
GET /v1/trustpilot/categoriesList categories8 credits / call
GET /v1/trustpilot/categories/{category_id}/companiesList companies in a category8 credits / call

Meta Ad Library API

EndpointDescriptionPrice
GET /v1/ads/searchSearch ads5 credits / call
GET /v1/ads/{ad_id}Get an ad5 credits / call
GET /v1/ads/pages/searchSearch advertisers5 credits / call
GET /v1/ads/pages/{page_id}Get an advertiser5 credits / call
GET /v1/ads/pages/{page_id}/adsList an advertiser's ads5 credits / call

Machine-readable: OpenAPI 3.1 and catalog JSON.