# SocialCrawl API: google endpoints
# Base URL: https://www.socialcrawl.dev
# Auth: x-api-key header
# Full docs: https://www.socialcrawl.dev/docs/google

## GET /v1/google/search
Google web search
Credit cost: 1 (standard)
Parameters:
- query (required): Search keyword or phrase. Google operators such as site:example.com work.
- region (optional, string): 2 letter country code, ie US, UK, CA, KR, etc This will show results from that country
- date_posted (optional, enum: last-hour | last-day | last-week | last-month | last-year): Only pages Google dates within this window: last-hour, last-day, last-week, last-month or last-year. The strongest recency filter for forum and community posts.
- page (optional, integer): Page number to retrieve
- max_pages (optional, integer): 1 to 50 (default 1, or 50 when `max_items` or `max_credits` is sent). Walk up to this many pages in one call and return the rows from all of them. Each page walked is billed exactly as one call to this endpoint (a cached page is free) and counts against your rate limit; its charge and any refund are recorded under the page's own request id, listed in `data.walk.request_ids`. The walk stops early at the last page, or when the request's time budget runs low; `data.walk.stopped` says why (`end`, `max_pages`, `max_items`, `max_credits`, `time_budget`, `page_error`) and `pagination.next_cursor` continues from where it stopped.
- max_items (optional, integer): 1 to 5000. Get more in one call: keep walking pages until the response holds at least this many rows, then stop with `data.walk.stopped: "max_items"`. The last page is returned whole (it was billed), so `data.items` can hold up to one page more than this, and `pagination.next_cursor` resumes right after it without skipping a row. Walks up to 50 pages unless `max_pages` says fewer; each page is billed as one call (a cached page is free). Add `max_credits` to cap the spend. A long walk can stop on the time budget first (`"time_budget"`): send the returned cursor with the same params to continue.
- max_credits (optional, integer): 1 to 100000. The most this call may spend, across every page it walks. A page starts only while the credits already spent plus that page's price (or, when higher, the most any page of this walk has cost) still fit, so the call never goes past it; the walk then stops with `data.walk.stopped: "max_credits"` and the cursor to resume. Sent alone, it walks as far as the budget goes (up to 50 pages). A value below the price of one page is a free 400 whose `error.details.page_credits` names that price. Credits a row join (`include=`) adds are known only once a page has run, so page 1 is checked against its own price.
Worth sending:
- date_posted=last-hour: Only posts from this time window.
curl -G "https://www.socialcrawl.dev/v1/google/search" \
  --data-urlencode "query=best restaurants in London" \
  --data-urlencode "date_posted=last-hour" \
  -H "x-api-key: YOUR_API_KEY"

## GET /v1/google/ad
Get Google ad details
Credit cost: 5 (advanced)
Parameters:
- url (required): Ads Transparency Center CREATIVE URL: must include both the advertiser and creative segments (`…/advertiser/{AR…}/creative/{CR…}`). Get one from `/v1/google/company/ads`.
curl -G "https://www.socialcrawl.dev/v1/google/ad" \
  --data-urlencode "url=https://adstransparency.google.com/advertiser/AR01614014350098432001/creative/CR04647239345386815489" \
  -H "x-api-key: YOUR_API_KEY"

## GET /v1/google/adlibrary/advertisers/search
Search Google Ad Library advertisers
Credit cost: 5 (advanced)
Parameters:
- query (required): Search keyword or phrase to find advertisers in the Google Ads Transparency Center.
- region (optional, string): 2-letter country code to search in. Defaults to US.
curl -G "https://www.socialcrawl.dev/v1/google/adlibrary/advertisers/search" \
  --data-urlencode "query=lululemon" \
  -H "x-api-key: YOUR_API_KEY"

## GET /v1/google/company/ads
List Google ads by company
Credit cost: 5 (advanced)
Parameters:
- domain (optional, string): Company domain name to look up ads for
- advertiser_id (optional, string): The advertiser id of the company
- topic (optional, enum: all | political): The topic to search for. If you search for 'political', you will also need to pass a 'region', like 'US' or 'AU'
- region (optional, string): The region to search for. Defaults to anywhere
- start_date (optional, string): Start date to search for. Format: YYYY-MM-DD
- end_date (optional, string): End date to search for. Format: YYYY-MM-DD
- platform (optional, enum: google_maps | google_play | google_search | google_shopping | youtube): Google surface to filter ads by (e.g. youtube, google_search)
- format (optional, enum: text | image | video): Ad format to filter by: text, image, or video
- get_ad_details (optional, string): Set to true to get the ad details. Will cost 25 credits.
- cursor (optional, string): Cursor to paginate through results
- since (optional, string): Only rows published on or after this date: YYYY-MM-DD (midnight UTC) or an ISO 8601 timestamp. Rows older than it are left off each page. This list is not in date order, so the walk does not stop at the date: keep following `next_cursor`, and each page costs what a page costs even when every row on it is filtered out. A row with no date is kept. `published_after`, `start_date`, `from_date`, `publish_time` (`yesterday`, `this-week`, `this-month`, `last-3-months`, `last-6-months`) and `max_age_days` are accepted and applied as `since`.
- until (optional, string): Only rows published on or before this date: YYYY-MM-DD (that whole UTC day is included) or an ISO 8601 timestamp. Newer rows are left off each page and the walk does not stop, so older pages follow. A row with no date is kept. `published_before`, `end_date` and `to_date` are accepted and applied as `until`.
- max_pages (optional, integer): 1 to 50 (default 1, or 50 when `max_items` or `max_credits` is sent). Walk up to this many pages in one call and return the rows from all of them. Each page walked is billed exactly as one call to this endpoint (a cached page is free) and counts against your rate limit; its charge and any refund are recorded under the page's own request id, listed in `data.walk.request_ids`. The walk stops early at the last page, or when the request's time budget runs low; `data.walk.stopped` says why (`end`, `max_pages`, `max_items`, `max_credits`, `time_budget`, `page_error`) and `pagination.next_cursor` continues from where it stopped.
- max_items (optional, integer): 1 to 5000. Get more in one call: keep walking pages until the response holds at least this many rows, then stop with `data.walk.stopped: "max_items"`. The last page is returned whole (it was billed), so `data.items` can hold up to one page more than this, and `pagination.next_cursor` resumes right after it without skipping a row. Walks up to 50 pages unless `max_pages` says fewer; each page is billed as one call (a cached page is free). Add `max_credits` to cap the spend. A long walk can stop on the time budget first (`"time_budget"`): send the returned cursor with the same params to continue.
- max_credits (optional, integer): 1 to 100000. The most this call may spend, across every page it walks. A page starts only while the credits already spent plus that page's price (or, when higher, the most any page of this walk has cost) still fit, so the call never goes past it; the walk then stops with `data.walk.stopped: "max_credits"` and the cursor to resume. Sent alone, it walks as far as the budget goes (up to 50 pages). A value below the price of one page is a free 400 whose `error.details.page_credits` names that price. Credits a row join (`include=`) adds are known only once a page has run, so page 1 is checked against its own price.
- Constraint: one of domain, advertiser_id (at least one required)
curl -G "https://www.socialcrawl.dev/v1/google/company/ads" \
  --data-urlencode "domain=lululemon.com" \
  -H "x-api-key: YOUR_API_KEY"

## GET /v1/google/business/info
Get a Google Business Profile
Credit cost: 1 (standard)
Parameters:
- keyword (optional, string): Business name + address (e.g. 'Irving Farm New York 645 5th Ave'). Use cid/place_id when known for an exact match.
- cid (optional, string): Google customer id (cid) of the place: the most reliable identifier.
- place_id (optional, string): Google place_id of the place.
- location_name (optional, string): Geographic context as 'City,Region,Country'. Without it, a keyword that looks Polish (a Polish postcode or Polish-only letters) is searched in Poland and every other keyword in 'New York,New York,United States'.
- language_name (optional, string): Result language (default 'English').
- Constraint: one of keyword, cid, place_id (at least one required)
curl -G "https://www.socialcrawl.dev/v1/google/business/info" \
  --data-urlencode "keyword=Irving Farm New York 645 5th Ave" \
  -H "x-api-key: YOUR_API_KEY"

## GET /v1/google/business/extended-reviews
Get Google extended (multi-source) reviews
Credit cost: 5-9 (metered): 5 credits per page. The default labels (sentiment, issue) are free. label=reports, incentivized or injection holds 4 extra credits and refunds down to 1 credit per started 25 reviews that were newly judged (the first 100 reviews of a page are judged): reviews already labelled are free, a page where nothing could be judged refunds the whole extra, and a cached page is free.
Parameters:
- keyword (optional, string): Business name + address. Use cid/place_id for an exact match.
- cid (optional, string): Google customer id (cid) of the place.
- place_id (optional, string): Google place_id of the place.
- location_name (optional, string): Geographic context as 'City,Region,Country'.
- language_name (optional, string): Result language (default 'English').
- depth (optional, integer): Number of reviews to return (default 20, step 20, max 1000).
- label (optional, string): Optional CSV of SocialCrawl labels to add to every review. Without this param every page already carries sentiment and issue, free; label= adds the labels you name to them (the defaults keep running). sentiment and issue are free when asked for too; reports, incentivized and injection add 1 credit per started 25 newly judged reviews. judgments=off (or label=none) turns the default labels off. They read the review's title and text, never its stars. sentiment: how the reviewer feels, on five levels (level 0 to 4, score_0_1, confidence), plus rating_mismatch, true when the words clearly contradict the star rating (a glowing text under 1 star, a furious one under 5), null when the review has no rating. issue: the main problem the review reports (label: product_defect, sizing_or_fit, shipping_or_delivery, customer_service, price_or_value, missing_feature, other, or none, with confidence; label is null when unsure). reports (needs reports=): does this review say that the thing you describe happened (p, 0 to 1). incentivized: does the reviewer say they got the product free, discounted or rewarded for the review (p), and did the text carry a disclosure such as 'in exchange for my honest review', Vine or 체험단 (disclosed). injection flags text that addresses an AI system and tries to direct it (flagged, p); it never drops or rewrites a row. These are signals to read, never a verdict on a review or a reviewer. A review that could not be judged carries labels: null. Reviews already labelled for anyone are free, and so is a cached page. data.labels reports what was judged and billed.
- reports (optional, string): Required by label=reports, ignored otherwise. What to look for, in plain words, up to 300 characters, for example reports=the battery drains quickly or reports=배송이 늦음. Every review gains labels.reports.p, the probability that it says so, in any wording or language. Without it label=reports is skipped with the warning label_reports_needs_reports and is not billed.
- judgments (optional, enum: on | off): Optional, on (the default) or off. By default every row gains free SocialCrawl judgments (computed.labels, and computed.relevance on search endpoints), reported in data.labels (mode default) and data.relevance (origin default), each with a status (complete, partial or skipped) and pending: the rows still being judged when the page was sent, which carry null now and are filled on your next call or cached read. Default judgments never add credits, never change an existing field, and never drop or reorder a row. off returns the page exactly as before, with none of those keys. label=none does the same.
- dry_run (optional, enum: 1): Optional. When 1, return a cost preview for this labelled or relevance-filtered request without fetching the page or judging any row. data.estimate reports rows_expected, rows_cached, label_credits_min, label_credits_max and base_credits. 0 credits charged.
- label_evidence (optional, enum: 1): Optional, only with label=. When 1, every labelled row also carries computed.labels_evidence.<preset> = { quote, sentence_index }: the sentence in the row that most clearly shows the label, copied verbatim. Absent or null when no single sentence shows it.
- fit (optional, enum: goal): Optional. When goal, keep the rows and fields needed for the goal you pass in goal= (plus any that are uncertain, and the first and last), and replace the rest with a stub. data.held_back lists the held ids and a recall id that re-reads the full page from cache at no extra charge. Without this param the page is unchanged.
- goal (optional, string): Required by fit=goal. What you are trying to do, in your own words, up to 300 characters.
- fit_tokens (optional, integer): Optional, only with fit=goal. Soft cap on how much of the page to keep, in tokens. Uncertain blocks and the first and last block are kept even if they exceed it.
- since (optional, string): Only rows published on or after this date: YYYY-MM-DD (midnight UTC) or an ISO 8601 timestamp. Rows older than it are left off each page. This list is not in date order, so the walk does not stop at the date: keep following `next_cursor`, and each page costs what a page costs even when every row on it is filtered out. A row with no date is kept. `published_after`, `start_date`, `from_date`, `publish_time` (`yesterday`, `this-week`, `this-month`, `last-3-months`, `last-6-months`) and `max_age_days` are accepted and applied as `since`.
- until (optional, string): Only rows published on or before this date: YYYY-MM-DD (that whole UTC day is included) or an ISO 8601 timestamp. Newer rows are left off each page and the walk does not stop, so older pages follow. A row with no date is kept. `published_before`, `end_date` and `to_date` are accepted and applied as `until`.
- Constraint: one of keyword, cid, place_id (at least one required)
Worth sending:
- label=issue: Names the product issue each review raises, at no extra credits; sentiment is free too.
curl -G "https://www.socialcrawl.dev/v1/google/business/extended-reviews" \
  --data-urlencode "keyword=Irving Farm New York 645 5th Ave" \
  --data-urlencode "label=issue" \
  -H "x-api-key: YOUR_API_KEY"

## GET /v1/google/business/updates
Get Google Business Profile posts (updates)
Credit cost: 1 (standard)
Parameters:
- keyword (optional, string): Business name + location (e.g. 'Toyota of Manhattan New York').
- cid (optional, string): Google customer id (cid) of the business.
- location_name (optional, string): Geographic context as 'City,Region,Country'.
- language_name (optional, string): Result language (default 'English').
- since (optional, string): Only rows published on or after this date: YYYY-MM-DD (midnight UTC) or an ISO 8601 timestamp. Rows older than it are left off each page. This list is not in date order, so the walk does not stop at the date: keep following `next_cursor`, and each page costs what a page costs even when every row on it is filtered out. A row with no date is kept. `published_after`, `start_date`, `from_date`, `publish_time` (`yesterday`, `this-week`, `this-month`, `last-3-months`, `last-6-months`) and `max_age_days` are accepted and applied as `since`.
- until (optional, string): Only rows published on or before this date: YYYY-MM-DD (that whole UTC day is included) or an ISO 8601 timestamp. Newer rows are left off each page and the walk does not stop, so older pages follow. A row with no date is kept. `published_before`, `end_date` and `to_date` are accepted and applied as `until`.
- Constraint: one of keyword, cid (at least one required)
curl -G "https://www.socialcrawl.dev/v1/google/business/updates" \
  --data-urlencode "keyword=Toyota of Manhattan New York" \
  -H "x-api-key: YOUR_API_KEY"

## GET /v1/google/business/questions
Get Google Business Profile questions & answers
Credit cost: 5 (advanced)
Parameters:
- keyword (optional, string): Business name + location (e.g. 'Starbucks Reserve Roastery New York').
- cid (optional, string): Google customer id (cid) of the business.
- place_id (optional, string): Google place_id of the business.
- location_name (optional, string): Geographic context as 'City,Region,Country'.
- language_name (optional, string): Result language (default 'English').
- depth (optional, integer): Number of questions to return (default 20).
- since (optional, string): Only rows published on or after this date: YYYY-MM-DD (midnight UTC) or an ISO 8601 timestamp. Rows older than it are left off each page. This list is not in date order, so the walk does not stop at the date: keep following `next_cursor`, and each page costs what a page costs even when every row on it is filtered out. A row with no date is kept. `published_after`, `start_date`, `from_date`, `publish_time` (`yesterday`, `this-week`, `this-month`, `last-3-months`, `last-6-months`) and `max_age_days` are accepted and applied as `since`.
- until (optional, string): Only rows published on or before this date: YYYY-MM-DD (that whole UTC day is included) or an ISO 8601 timestamp. Newer rows are left off each page and the walk does not stop, so older pages follow. A row with no date is kept. `published_before`, `end_date` and `to_date` are accepted and applied as `until`.
- Constraint: one of keyword, cid, place_id (at least one required)
curl -G "https://www.socialcrawl.dev/v1/google/business/questions" \
  --data-urlencode "keyword=Starbucks Reserve Roastery New York" \
  -H "x-api-key: YOUR_API_KEY"

## GET /v1/google/business/search
Search Google Maps businesses
Credit cost: 5 (advanced)
Parameters:
- query (required): What to look for, as you would type it into Google Maps: a category or trade ('dentista', 'ristorante', 'commercialista') or a business name. Use the local language for local results.
- location (optional, string): Where to search: 'City, Country' (e.g. 'Milano, Italy'), a country name or ISO code ('Italy', 'IT'), or a full City,Region,Country name ('Milan,Lombardy,Italy'). Required unless lat and lng are sent.
- lat (optional, string): Latitude of the search centre (-90 to 90). Send with lng instead of location.
- lng (optional, string): Longitude of the search centre (-180 to 180). Send with lat instead of location.
- zoom (optional, integer): Google Maps zoom level around lat/lng, 3 (continent) to 21 (street). Defaults to 14, about a city district. Only with lat/lng.
- language (optional, string): Language code for the results ('it', 'en', 'de'). Defaults to the main language of the country in location ('it' for Italy), or 'en' for coordinates.
- limit (optional, integer): How many places to return, 1-100 (default 20). The price is the same at any limit.
- Constraint: one of location, lat (at least one required)
curl -G "https://www.socialcrawl.dev/v1/google/business/search" \
  --data-urlencode "query=dentista" \
  --data-urlencode "location=Milano, Italy" \
  -H "x-api-key: YOUR_API_KEY"

## GET /v1/google/hotels/search
Search Google hotels
Credit cost: 1 (standard)
Parameters:
- keyword (required): Hotel search query (e.g. 'hotels in New York').
- location_name (optional, string): Geographic context as 'City,Region,Country'.
- language_name (optional, string): Result language (default 'English').
- check_in (optional, string): Check-in date (YYYY-MM-DD). Defaults to the next day.
- check_out (optional, string): Check-out date (YYYY-MM-DD). Defaults to one night.
curl -G "https://www.socialcrawl.dev/v1/google/hotels/search" \
  --data-urlencode "keyword=hotels in New York" \
  -H "x-api-key: YOUR_API_KEY"

## GET /v1/google/hotels/info
Get Google hotel detail
Credit cost: 5 (advanced)
Parameters:
- hotel_identifier (required): Opaque hotel id returned by GET /v1/google/hotels/search.
- location_name (optional, string): Geographic context as 'City,Region,Country'.
- language_name (optional, string): Result language (default 'English').
curl -G "https://www.socialcrawl.dev/v1/google/hotels/info" \
  --data-urlencode "hotel_identifier=ChkIoYjXwK-S_okHGg0vZy8xMW1fd3MzY243EAE" \
  -H "x-api-key: YOUR_API_KEY"

## GET /v1/google/keyword-volume
Get Google keyword search volume by country
Credit cost: 16 (override; tier premium)
Parameters:
- keywords (required): 1-20 comma-separated keywords (e.g. 'lip gloss,lip oil'). Each keyword may be up to 80 characters. Duplicates are ignored. More than 20 keywords, or a keyword over 80 characters, is rejected with a free 400 before the request is billed.
- location (optional, string): Country as an ISO code ('US', 'GB', 'KR'), a full country name ('United Kingdom', 'South Korea') or a numeric location code ('2826'). Defaults to the United States. Volume is published for 94 countries; any other location is rejected with a free 400 naming the accepted forms.
- language (optional, string): Language code ('en', 'de', 'ko') the keywords are searched in. Defaults to the first language listed for the country: Germany is 'de' and Belgium is 'fr', but Vietnam, Indonesia, India, Malaysia, Pakistan, the Philippines, Hong Kong and Singapore default to 'en', so pass their local language (e.g. 'vi', 'id', 'hi') explicitly. A language the country does not hold (Germany in English) is rejected with a free 400 listing the ones it does.
curl -G "https://www.socialcrawl.dev/v1/google/keyword-volume" \
  --data-urlencode "keywords=lip gloss,lip oil" \
  -H "x-api-key: YOUR_API_KEY"