PrismCrawl API
Retrieve search results, places, products, and public reviews as structured JSON. Supported endpoints can also return the encoded source response. Each completed search consumes one credit, including recognized empty, unavailable, or changed-source results returned with HTTP 200. Validation, authentication, and operational failures remain errors and do not consume a search credit. Continuations are opaque, account-bound, and expire after one hour; restart pagination when a token expires.
Base URL: https://api.prismcrawl.com
POST /v1/google/search
Search Google
Returns normalized Google results, or encoded source HTML.
Requires the x-api-key header.
Request body
Successful query: 1 credit. Search failures are free. Optional parameters may be omitted or set to `null` to use the endpoint default. Only parameters documented for this endpoint are used; other top-level fields are ignored.
| Field | Type | Required | Default | Description |
|---|
query | string | yes | — | The search query. The UTF-8 representation must not exceed 8,192 bytes; non-ASCII characters may use more than one byte. When query_encoded is true, supply a URL-encoded query value; the 8,192-byte limit applies after decoding. |
query_encoded | boolean | null | no | false | When true, query is already a URL-encoded query value and is sent without encoding it again. Use %HH escapes for reserved and non-ASCII characters; + or %20 represents a space and %2B a literal plus. Unreserved characters and !'()* may remain literal. Do not supply a URL or q= prefix. Malformed escapes, raw separators, and invalid UTF-8 are rejected. The decoded query must be nonempty and at most 8,192 UTF-8 bytes; the encoded value is limited to 24,576 characters. A query containing only unreserved characters is valid. Response search_parameters.q contains decoded text. |
uule | string | null | no | — | Raw Google-encoded location, forwarded unchanged. Accepts a w+/a+ prefix and a nonempty standard or URL-safe Base64 payload, with or without padding; existing values do not need to be converted. Mutually exclusive with location, coordinates, and radius. Google may ignore unsupported payloads; acceptance does not guarantee location targeting. Invalid types or formats return an uncharged HTTP 400 before a search is sent to Google. Normal search billing applies to accepted inputs. |
html | boolean | null | no | false | Return Brotli-compressed, Base64-encoded source HTML instead of normalized JSON. |
rewrite_links | boolean | null | no | false | Set rewrite_links to true to replace Google /goto and /url anchor links in returned and archived HTML, including HTML archived for JSON requests. Default: false. JSON results are unaffected and have always used resolved destination URLs when available. |
zero_trace | boolean | null | no | false | When true, PrismCrawl does not store the source HTML or parsed JSON. Audit and billing metadata is retained, but all other data is permanently discarded. Request history exposes only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged. |
device | string | null | no | — | Search as a mobile, tablet, or desktop device. Allowed: mobile, tablet, desktop, |
safe | string | null | no | — | Safe-search mode. `active` enables Google's filtering and Bing Strict SafeSearch; `off` requests unfiltered results. Search providers may still suppress content required by law or policy. Allowed: active, off, |
color_scheme | string | null | no | — | Request the provider's light or dark result-page theme. This affects source-page presentation, not ranking, and providers may ignore it. Allowed: light, dark, |
pws | integer | null | no | — | Requests Google personalization off (`0`) or permits it (`1`). Omit to leave Google’s default unchanged. This does not disable location, language, or device effects, and does not personalize results to a PrismCrawl account. Allowed: 0, 1, |
nfpr | integer | null | no | — | Controls Google query correction. `1` asks Google to search the submitted query without automatic spelling correction; `0` keeps normal correction behavior. Allowed: 0, 1, |
filter | integer | null | no | — | Requests Google duplicate-result filtering (`1`) or disables it (`0`). Google documents this behavior for Programmable Search, but does not guarantee it for the consumer HTML endpoint used here. Allowed: 0, 1, |
lr | string | null | no | — | Restrict Google result documents by language using `lang_<code>` syntax. Join alternatives with `|`, for example `lang_fr|lang_de`. |
cr | string | null | no | — | Restrict Google result documents by country using `country<CC>` syntax. Join alternatives with `|`, for example `countryUS|countryCA`. |
start | integer | null | no | — | Zero-based result offset. Off-grid values are accepted. |
google_domain | string | null | no | google.com | Google domain used for the search, written without a scheme or `www.` prefix. This is independent of `gl`, `hl`, `location`, and `coordinates`. Supported values follow the search-capable entries in [Google's current domain list](https://www.google.com/supported_domains); `google.cn` is excluded. Case-insensitive. Allowed: google.com, google.ad, google.ae, google.com.af, google.com.ag, google.al, google.am, google.co.ao, … (+179 more) |
gl | string | null | no | us | Two-letter Google result-country code. Matching results are boosted rather than strictly filtered. Case-insensitive. Allowed: ad, ae, af, ag, ai, al, am, an, … (+245 more) |
hl | string | null | no | en-US | Google interface language. This can also influence result selection for international queries. Case-insensitive. Allowed: af, sq, am, ar, hy, az, bn, bg, … (+69 more) |
location | string | null | no | — | An Active Google `Canonical Name` from the [pinned geo-target dataset](https://developers.google.com/static/google-ads/api/data/geo/geotargets-2026-07-16.csv.zip). Mutually exclusive with `coordinates` and `uule`. |
coordinates | Coordinates | null | no | — | The searcher's latitude and longitude. Mutually exclusive with `location` and `uule`. |
radius | integer | null | no | — | Radius in meters used to bias results around `coordinates`; results outside it may still appear. Requires `coordinates`. The maximum is 199 for desktop or an omitted device, and 1,000 for mobile or tablet. |
tbs | string | null | no | — | Google's native comma-separated `key:value` advanced-filter container, up to 512 characters. It supports time filters, sorting, and filters associated with a selected search tab. Relative time ranges use `qdr:<unit>[amount]`; custom inclusive ranges use `cdr:1,cd_min:M/D/YYYY,cd_max:M/D/YYYY`. Native filters may vary by search vertical and Google market. The unreliable `li` verbatim filter is not supported. |
tbm | string | null | no | — | Select a supported Google search vertical using its native `tbm` code. Mutually exclusive with `udm`. Allowed: nws, vid, isch, shop, lcl, bks, |
udm | integer | null | no | — | Select a supported Google search tab using its native numeric `udm` value: 1 (Local), 2 (Images), 6 (Forums), 7 (Videos), 12 (News), 14 (Web), 28 (Shopping), 36 (Books), or 50 (AI Mode). Availability may vary by market. Mutually exclusive with `tbm`. Allowed: 1, 2, 6, 7, 12, 14, 28, 36, … (+2 more) |
Example request
{
"query": "coffee shops",
"uule": "w+CAIQICIaQXVzdGluLFRleGFzLFVuaXRlZCBTdGF0ZXM",
"pws": 0
}Responses
- 200 — Search completed.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"format": "json",
"content": {
"search_parameters": {
"q": "best espresso machines",
"type": "search",
"engine": "google",
"device": null,
"start": null,
"google_domain": "google.com",
"gl": "us",
"hl": "en-US",
"location": null,
"coordinates": null,
"radius": null,
"tbs": null,
"tbm": null,
"udm": null,
"safe": null,
"uule": null,
"pws": null,
"query_encoded": false,
"nfpr": null,
"filter": null,
"lr": null,
"cr": null,
"color_scheme": null
},
"has_next_page": true,
"results": [
{
"id": "s_972c538a8734a8b7",
"rank": 1,
"type": "organic",
"title": "The 14 Best Espresso Machines, Tested & Reviewed",
"url": "https://www.seriouseats.com/best-espresso-machines-5185482",
"display_url": "seriouseats.com › best-espresso-machines-5185482",
"snippet": "Our favorite espresso machine is the Breville Bambino Plus.",
"domain": "seriouseats.com",
"favicon": "https://seriouseats.com/favicon.ico",
"source_name": "Serious Eats",
"position": {
"absolute": 1
},
"engine": "google",
"domain_info": {
"tld": "com",
"sld": "seriouseats",
"category": null
},
"classification": null
}
],
"serp_features": [
{
"id": "f_5236e4e73b2337d4",
"engine": "google",
"type": "people_also_ask",
"title": "People also ask",
"text": null,
"items": [
{
"title": "Which espresso machine brand is most reliable?",
"text": "Which espresso machine brand is most reliable?",
"link": null
}
],
"links": [],
"source_result_ids": [
"s_972c538a8734a8b7"
],
"position": {
"absolute": 1
},
"confidence": 0.8,
"extracted_at": "2026-07-01T16:45:24Z"
}
]
}
}
}- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — The API token has no credits remaining.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "credits_exhausted",
"message": "no credits remaining"
}
}- 405 — Only POST is supported for this endpoint.
Schema: ErrorResponse
- 413 — The JSON request body exceeds 64 KiB.
Schema: ErrorResponse
- 429 — Rate limit exceeded.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "quota_exceeded",
"message": "rate limit exceeded",
"rule": "10s",
"reset_at": "2026-07-15T18:42:10Z"
}
}- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/google/ads
Google Ads
Retrieve Google Search ad results. ads_available is false when the valid search page contains no ads.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
query | string | yes | — | Text to search for on the selected service. At most 8,192 UTF-8 bytes. |
country | string | no | — | Two-letter country or storefront code, such as us or gb. |
language | string | no | — | Provider-supported language code, such as en. |
location | string | no | — | Location to search around, such as Austin, TX. |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"query": "car insurance"
}Responses
- 200 — Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.
Schema: Catalog_google_ads_Response
- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/google/ads/transparency
Google Ads Transparency
Find ad creatives by a website domain in query or an advertiser ID in id; supply exactly one. Returns advertiser identity, preview assets, formats, serving dates and scoped pagination.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
query | string | no | — | Text to search for on the selected service. At most 8,192 UTF-8 bytes. |
country | string | no | — | Two-letter country or storefront code, such as us or gb. Allowed: ad, ae, af, ag, ai, al, am, ao, … (+236 more) |
language | string | no | — | Provider-supported language code, such as en. |
limit | integer | no | — | Maximum number of items to return. The provider may return fewer. |
id | string | no | — | The provider's identifier, as returned by its search results. |
category | string | no | — | A category identifier supported by this operation. Allowed: image, text, video |
next_page_token | string | no | — | Copy the opaque next_page_token from the previous response using the same account, search parameters, device, and result limit. Tokens expire after one hour; restart pagination if rejected or expired. |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"query": "nike.com"
}Responses
- 200 — Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.
Schema: Catalog_google_ads_transparency_Response
- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/google/ai-mode
Google AI Mode
Retrieve Google AI Mode using its native source data.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
query | string | yes | — | Text to search for on the selected service. At most 8,192 UTF-8 bytes. |
country | string | no | — | Two-letter country or storefront code, such as us or gb. |
language | string | no | — | Provider-supported language code, such as en. |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"query": "how do solar panels work"
}Responses
- 200 — Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.
Schema: Catalog_google_ai_mode_Response
- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/google/ai-overview
Google AI Overview
Retrieve the AI Overview supplied for a query. feature_available is false when the valid search page contains no overview.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
query | string | yes | — | Text to search for on the selected service. At most 8,192 UTF-8 bytes. |
country | string | no | — | Two-letter country or storefront code, such as us or gb. |
language | string | no | — | Provider-supported language code, such as en. |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"query": "how do solar panels work"
}Responses
- 200 — Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.
Schema: Catalog_google_ai_overview_Response
- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/google/autocomplete
Google Autocomplete
Retrieve Google Autocomplete using its native source data.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
query | string | yes | — | Text to search for on the selected service. At most 8,192 UTF-8 bytes. |
country | string | no | — | Two-letter country or storefront code, such as us or gb. |
language | string | no | — | Provider-supported language code, such as en. |
limit | integer | no | — | Maximum number of items to return. The provider may return fewer. |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"query": "coffee"
}Responses
- 200 — Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.
Schema: Catalog_google_autocomplete_Response
- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/google/contributor/reviews
Google Contributor Reviews
Retrieve full Google contributor reviews in newest order, with pagination over the first 200 reviews.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
id | string | yes | — | The numeric contributor ID in a Google Maps contributor profile URL. |
country | string | no | — | Two-letter country or storefront code, such as us or gb. |
language | string | no | — | Provider-supported language code, such as en. |
next_page_token | string | no | — | Copy the opaque next_page_token from the previous response using the same account, search parameters, device, and result limit. Tokens expire after one hour; restart pagination if rejected or expired. |
page | integer | no | — | One-based page within the first 200 reviews. With limit 20, pages 1 through 10 are available. Do not combine a page after page 1 with next_page_token. |
limit | integer | no | — | Maximum number of items to return. The provider may return fewer. |
sort_by | string | no | — | The provider's supported sort order. Allowed: newest |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"country": "us",
"id": "112967280418127956987",
"language": "en",
"limit": 10,
"sort_by": "newest"
}Responses
- 200 — Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.
Schema: Catalog_google_contributor_reviews_Response
- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/google/events
Google Events
Retrieve actual event cards from Google Search. source_surface is search_events; events_available is false when no event pack is shown. The retired immersive Events surface and its pagination are not used.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
query | string | yes | — | Text to search for on the selected service. At most 8,192 UTF-8 bytes. |
country | string | no | — | Two-letter country or storefront code, such as us or gb. |
language | string | no | — | Provider-supported language code, such as en. |
location | string | no | — | Location to search around, such as Austin, TX. |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"location": "Chicago,Illinois,United States",
"query": "concerts in Chicago"
}Responses
- 200 — Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.
Schema: Catalog_google_events_Response
- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/google/finance
Google Finance
Retrieve Google Finance using its native source data.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
id | string | yes | — | The provider's identifier, as returned by its search results. |
language | string | no | — | Provider-supported language code, such as en. |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"id": "GOOGL:NASDAQ"
}Responses
- 200 — Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.
Schema: Catalog_google_finance_Response
- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/google/finance/markets
Google Finance Markets
Retrieve Google Finance Markets using its native source data.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
language | string | no | — | Provider-supported language code, such as en. |
limit | integer | no | — | Maximum number of items to return. The provider may return fewer. |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"limit": 20
}Responses
- 200 — Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.
Schema: Catalog_google_finance_markets_Response
- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/google/flights/search
Google Flights
Search flights using departure_id, arrival_id, and outbound_date. Omit return_date for one-way travel. Supports up to nine travelers; each infant on a lap requires an adult. Use flight autocomplete to resolve airport IDs.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
departure_id | string | yes | — | IATA airport code or airport identifier returned by flight autocomplete. |
arrival_id | string | yes | — | IATA airport code or airport identifier returned by flight autocomplete. |
outbound_date | string | yes | — | Departure date in YYYY-MM-DD format. |
return_date | string | no | — | Return date in YYYY-MM-DD format; omit for a one-way trip. |
adults | integer | no | — | Number of adult travelers, from 1 to 9. |
children | integer | no | — | Number of children aged 2–11. At most nine travelers total. |
infants_in_seat | integer | no | — | Number of infants under 2 traveling in their own seats. At most nine travelers total. |
infants_on_lap | integer | no | — | Number of infants under 2 traveling on an adult’s lap; cannot exceed adults. At most nine travelers total. |
travel_class | string | no | — | Cabin class supported by the selected flight operation. Allowed: economy, premium_economy, business, first |
currency | string | no | — | Three-letter currency code, such as USD. Allowed: ALL, DZD, ARS, AMD, AWG, AUD, AZN, BSD, … (+63 more) |
country | string | no | — | Two-letter country or storefront code, such as us or gb. |
language | string | no | — | Provider-supported language code, such as en. |
limit | integer | no | — | Maximum number of items to return. The provider may return fewer. |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"arrival_id": "LAX",
"currency": "USD",
"departure_id": "JFK",
"outbound_date": "2026-11-09"
}Responses
- 200 — Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.
Schema: Catalog_google_flights_Response
- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/google/flights/autocomplete
Google Flights Autocomplete
Retrieve Google Flights Autocomplete data.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
query | string | yes | — | Text to search for on the selected service. At most 8,192 UTF-8 bytes. |
country | string | no | — | Two-letter country or storefront code, such as us or gb. |
language | string | no | — | Provider-supported language code, such as en. |
limit | integer | no | — | Maximum number of items to return. The provider may return fewer. |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"query": "New York"
}Responses
- 200 — Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.
Schema: Catalog_google_flights_autocomplete_Response
- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/google/flights/deals
Google Flights Deals
Find Google Flight Deals matching a natural-language trip request. Supports up to nine travelers, including children and infants; each infant on a lap requires an adult.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
query | string | yes | — | Text to search for on the selected service. At most 8,192 UTF-8 bytes. |
departure_id | string | yes | — | IATA airport code or airport identifier returned by flight autocomplete. |
adults | integer | no | — | Number of adult travelers, from 1 to 9. |
children | integer | no | — | Number of children aged 2–11. At most nine travelers total. |
infants_in_seat | integer | no | — | Number of infants under 2 traveling in their own seats. At most nine travelers total. |
infants_on_lap | integer | no | — | Number of infants under 2 traveling on an adult’s lap; cannot exceed adults. At most nine travelers total. |
travel_class | string | no | — | Cabin class supported by the selected flight operation. Allowed: economy, premium_economy, business, first |
currency | string | no | — | Three-letter currency code, such as USD. Allowed: ALL, DZD, ARS, AMD, AWG, AUD, AZN, BSD, … (+63 more) |
country | string | no | — | Two-letter country or storefront code, such as us or gb. |
language | string | no | — | Provider-supported language code, such as en. |
limit | integer | no | — | Maximum number of items to return. The provider may return fewer. |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"departure_id": "JFK",
"limit": 10,
"query": "Week long trip to a city with great food"
}Responses
- 200 — Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.
Schema: Catalog_google_flights_deals_Response
- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/google/forums
Google Forums
Retrieve Google Forums using its native source data.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
query | string | yes | — | Text to search for on the selected service. At most 8,192 UTF-8 bytes. |
country | string | no | — | Two-letter country or storefront code, such as us or gb. |
language | string | no | — | Provider-supported language code, such as en. |
page | integer | no | — | One-based page number. |
location | string | no | — | Location to search around, such as Austin, TX. |
safe | string | no | — | Provider safe-search filtering. Allowed: active, off |
time_range | string | no | — | Provider-supported time filter. |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"query": "best coffee grinder"
}Responses
- 200 — Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.
Schema: Catalog_google_forums_Response
- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/google/hotels/search
Google Hotels
Retrieve Google Hotels data.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
query | string | yes | — | Text to search for on the selected service. At most 8,192 UTF-8 bytes. |
next_page_token | string | no | — | Copy the opaque next_page_token from the previous response using the same account, search parameters, device, and result limit. Tokens expire after one hour; restart pagination if rejected or expired. |
currency | string | no | — | Three-letter currency code, such as USD. Allowed: ALL, DZD, ARS, AMD, AWG, AUD, AZN, BSD, … (+63 more) |
country | string | no | — | Two-letter country or storefront code, such as us or gb. |
language | string | no | — | Provider-supported language code, such as en. |
limit | integer | no | — | Maximum number of items to return. The provider may return fewer. |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"currency": "USD",
"query": "hotels in New York"
}Responses
- 200 — Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.
Schema: Catalog_google_hotels_Response
- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/google/hotels/autocomplete
Google Hotels Autocomplete
Retrieve Google Hotels Autocomplete data.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
query | string | yes | — | Text to search for on the selected service. At most 8,192 UTF-8 bytes. |
country | string | no | — | Two-letter country or storefront code, such as us or gb. |
language | string | no | — | Provider-supported language code, such as en. |
limit | integer | no | — | Maximum number of items to return. The provider may return fewer. |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"query": "New York"
}Responses
- 200 — Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.
Schema: Catalog_google_hotels_autocomplete_Response
- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/google/hotels/photos
Google Hotels Photos
Retrieve Google Hotels Photos data.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
id | string | yes | — | The provider's identifier, as returned by its search results. |
country | string | no | — | Two-letter country or storefront code, such as us or gb. |
language | string | no | — | Provider-supported language code, such as en. |
limit | integer | no | — | Maximum number of items to return. The provider may return fewer. |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"id": "ChgI-N6n0Nnyw_K2ARoLL2cvMXRqZGgzMjkQAQ"
}Responses
- 200 — Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.
Schema: Catalog_google_hotels_photos_Response
- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/google/hotels/reviews
Google Hotels Reviews
Retrieve Google Hotels Reviews data.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
id | string | yes | — | The provider's identifier, as returned by its search results. |
next_page_token | string | no | — | Copy the opaque next_page_token from the previous response using the same account, search parameters, device, and result limit. Tokens expire after one hour; restart pagination if rejected or expired. |
sort_by | string | no | — | The provider's supported sort order. Allowed: relevance, newest, highest_rating, lowest_rating |
country | string | no | — | Two-letter country or storefront code, such as us or gb. |
language | string | no | — | Provider-supported language code, such as en. |
limit | integer | no | — | Maximum number of items to return. The provider may return fewer. |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"id": "ChgI-N6n0Nnyw_K2ARoLL2cvMXRqZGgzMjkQAQ",
"limit": 10
}Responses
- 200 — Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.
Schema: Catalog_google_hotels_reviews_Response
- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/google/images
Google Images
Retrieve Google Images using its native source data.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
query | string | yes | — | Text to search for on the selected service. At most 8,192 UTF-8 bytes. |
country | string | no | — | Two-letter country or storefront code, such as us or gb. |
language | string | no | — | Provider-supported language code, such as en. |
page | integer | no | — | One-based page number. |
safe | string | no | — | Provider safe-search filtering. Allowed: active, off |
time_range | string | no | — | Provider-supported time filter. |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"query": "red panda"
}Responses
- 200 — Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.
Schema: Catalog_google_images_Response
- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/google/images/light
Google Images Light
Retrieve Google Images Light using its native source data.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
query | string | yes | — | Text to search for on the selected service. At most 8,192 UTF-8 bytes. |
country | string | no | — | Two-letter country or storefront code, such as us or gb. |
language | string | no | — | Provider-supported language code, such as en. |
page | integer | no | — | One-based page number. |
safe | string | no | — | Provider safe-search filtering. Allowed: active, off |
time_range | string | no | — | Provider-supported time filter. |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"query": "red panda"
}Responses
- 200 — Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.
Schema: Catalog_google_images_light_Response
- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/google/images/related-content
Google Images Related Content
Retrieve Google Lens visual matches for a public HTTPS image URL supplied in id.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
id | string | yes | — | The provider's identifier, as returned by its search results. |
country | string | no | — | Two-letter country or storefront code, such as us or gb. |
language | string | no | — | Provider-supported language code, such as en. |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"id": "https://images.unsplash.com/photo-1546182990-dffeafbe841d"
}Responses
- 200 — Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.
Schema: Catalog_google_images_related_content_Response
- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/google/jobs
Google Jobs
Retrieve Google Jobs using its native source data.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
query | string | yes | — | Text to search for on the selected service. At most 8,192 UTF-8 bytes. |
country | string | no | — | Two-letter country or storefront code, such as us or gb. |
language | string | no | — | Provider-supported language code, such as en. |
location | string | no | — | Location to search around, such as Austin, TX. |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"query": "engineer jobs Austin"
}Responses
- 200 — Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.
Schema: Catalog_google_jobs_Response
- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/google/lens
Google Lens
Retrieve Google Lens visual matches for a public HTTPS image URL supplied in id.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
id | string | yes | — | The provider's identifier, as returned by its search results. |
country | string | no | — | Two-letter country or storefront code, such as us or gb. |
language | string | no | — | Provider-supported language code, such as en. |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"id": "https://images.unsplash.com/photo-1546182990-dffeafbe841d"
}Responses
- 200 — Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.
Schema: Catalog_google_lens_Response
- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/google/light/search
Google Light Search
Retrieve Google Light Search using its native source data.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
query | string | yes | — | Text to search for on the selected service. At most 8,192 UTF-8 bytes. |
country | string | no | — | Two-letter country or storefront code, such as us or gb. |
language | string | no | — | Provider-supported language code, such as en. |
page | integer | no | — | One-based page number. |
location | string | no | — | Location to search around, such as Austin, TX. |
safe | string | no | — | Provider safe-search filtering. Allowed: active, off |
time_range | string | no | — | Provider-supported time filter. |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"query": "coffee"
}Responses
- 200 — Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.
Schema: Catalog_google_light_Response
- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/google/local
Google Local
Retrieve Google Local using its native source data.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
query | string | yes | — | Text to search for on the selected service. At most 8,192 UTF-8 bytes. |
country | string | no | — | Two-letter country or storefront code, such as us or gb. |
language | string | no | — | Provider-supported language code, such as en. |
location | string | no | — | Location to search around, such as Austin, TX. |
coordinates | object | no | — | Latitude and longitude for location targeting. |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"query": "coffee Austin"
}Responses
- 200 — Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.
Schema: Catalog_google_local_Response
- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/google/local/services
Google Local Services
Search Google Local Services sponsored providers, returning names, ratings, review counts, phone numbers, service areas and source profiles.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
query | string | yes | — | Text to search for on the selected service. At most 8,192 UTF-8 bytes. |
country | string | no | — | Two-letter country or storefront code, such as us or gb. |
language | string | no | — | Provider-supported language code, such as en. |
limit | integer | no | — | Maximum number of items to return. The provider may return fewer. |
location | string | no | — | Location to search around, such as Austin, TX. |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"query": "plumber Austin"
}Responses
- 200 — Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.
Schema: Catalog_google_local_services_Response
- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/google/maps/search
Search Google Maps
Returns up to 20 normalized Google Maps places from a coordinate-centered viewport.
Requires the x-api-key header.
Request body
Successful query: 1 credit. Search failures are free. Optional parameters may be omitted or set to `null` to use the endpoint default. Only parameters documented for this endpoint are used; other top-level fields are ignored.
| Field | Type | Required | Default | Description |
|---|
query | string | yes | — | A place, business, product, or category query to search on Google Maps. |
zero_trace | boolean | null | no | false | When true, PrismCrawl does not store the normalized JSON response. Audit and billing metadata is retained, but all other data is permanently discarded. Request history exposes only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged. |
coordinates | object | yes | — | Required map center. |
zoom | number | null | no | 13.1 | Google Maps viewport zoom. Lower values cover a wider area; higher values focus more tightly around coordinates. |
start | integer | null | no | 0 | Zero-based Maps result offset. Use multiples of 20 for successive 20-place pages. |
gl | string | null | no | us | Two-letter Google country hint. Case-insensitive. Allowed: ad, ae, af, ag, ai, al, am, an, … (+245 more) |
hl | string | null | no | en-US | Google Maps interface language. Case-insensitive. Allowed: af, sq, am, ar, hy, az, bn, bg, … (+69 more) |
Example request
{
"query": "coffee shop",
"zero_trace": false,
"coordinates": {
"latitude": 30.2672,
"longitude": -97.7431
},
"zoom": 13.1,
"start": 0,
"gl": "us",
"hl": "en-US"
}Responses
- 200 — Google Maps search completed.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"format": "json",
"content": {
"search_parameters": {
"q": "coffee shop",
"type": "maps",
"engine": "google_maps",
"start": 0,
"gl": "us",
"hl": "en-US",
"coordinates": {
"latitude": 30.2672,
"longitude": -97.7431
},
"zoom": 13.1
},
"has_next_page": true,
"results": [
{
"id": "m_a7d14f4d349d5971",
"rank": 1,
"type": "place",
"title": "Terrible Love",
"place_id": "ChIJP8p2kJC1RIYR2qrGoXZtZCk",
"data_id": "0x8644b5909076ca3f:0x29646d76a1c6aada",
"data_cid": "2982629209513831130",
"kgmid": "/g/11ng70tdrd",
"google_maps_url": "https://www.google.com/maps/search/?api=1&query=coffee+shop&query_place_id=ChIJP8p2kJC1RIYR2qrGoXZtZCk",
"reviews_link": "https://search.google.com/local/reviews?placeid=ChIJP8p2kJC1RIYR2qrGoXZtZCk&q=coffee+shop&hl=en-US&gl=US",
"address": "3908 Avenue B, Austin, TX 78751",
"structured_address": {
"neighborhood": "Hyde Park",
"street": "3908 Avenue B",
"city": "Austin",
"postal_code": "78751",
"state": "Texas",
"country": "US"
},
"phone": null,
"phone_international": null,
"website": "http://terriblelovecoffee.com/",
"domain": "terriblelovecoffee.com",
"category": "Coffee shop",
"category_id": "coffee",
"categories": [
"Coffee shop",
"Coffee stand"
],
"rating": 4.9,
"reviews": 328,
"price": null,
"gps_coordinates": {
"latitude": 30.3045132,
"longitude": -97.735632
},
"service_area": false,
"plus_code": {
"global_code": "8642F62R+38",
"compound_code": "F62R+38 Austin, Texas"
},
"open_state": "Closed",
"hours": "Closed · Opens 7:30 AM Fri",
"operating_hours": {
"thursday": [
"7:30 AM–2 PM"
]
},
"secondary_operating_hours": {},
"description": null,
"snippet": "Dogs allowed",
"review_snippets": [
{
"text": "Great coffee and a welcoming patio.",
"rating": 5
}
],
"popular_times": {
"thursday": [
{
"hour": 9,
"busyness_percent": 75,
"description": "Usually a little busy",
"time": "9 AM"
}
]
},
"thumbnail": "https://lh3.googleusercontent.com/example=w408-h544-k-no",
"timezone": "America/Chicago",
"claimed": true,
"order_online_link": null,
"reservations_link": null,
"booking_link": null,
"hotel_class": null,
"check_in_time": null,
"check_out_time": null,
"amenities": [],
"highlights": [
"LGBTQ+ friendly"
],
"attributes": [
{
"id": "accessibility",
"name": "Accessibility",
"options": [
{
"name": "Wheelchair accessible entrance",
"enabled": true
}
]
}
]
}
],
"serp_features": []
}
}
}- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — The API token has no credits remaining.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "credits_exhausted",
"message": "no credits remaining"
}
}- 405 — Only POST is supported for this endpoint.
Schema: ErrorResponse
- 413 — The JSON request body exceeds 64 KiB.
Schema: ErrorResponse
- 429 — Rate limit exceeded.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "quota_exceeded",
"message": "rate limit exceeded",
"rule": "10s",
"reset_at": "2026-07-15T18:42:10Z"
}
}- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/google/maps/autocomplete
Google Maps Autocomplete
Retrieve Google Maps query and place suggestions.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
query | string | yes | — | Text to search for on the selected service. At most 8,192 UTF-8 bytes. |
coordinates | object | no | — | Latitude and longitude for location targeting. |
country | string | no | — | Two-letter country or storefront code, such as us or gb. |
language | string | no | — | Provider-supported language code, such as en. |
limit | integer | no | — | Maximum number of items to return. The provider may return fewer. |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"query": "Franklin Barbecue Austin"
}Responses
- 200 — Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.
Schema: Catalog_google_maps_autocomplete_Response
- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/google/maps/directions
Google Maps Directions
Retrieve Google Maps Directions data.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
origin | string | yes | — | Starting address or place for directions. |
destination | string | yes | — | Destination address or place for directions. |
travel_mode | string | no | — | Transport mode for the requested directions. Allowed: driving, walking, bicycling, transit, two-wheeler |
country | string | no | — | Two-letter country or storefront code, such as us or gb. |
language | string | no | — | Provider-supported language code, such as en. |
limit | integer | no | — | Maximum number of items to return. The provider may return fewer. |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"destination": "Dallas, TX",
"origin": "Austin, TX",
"travel_mode": "driving"
}Responses
- 200 — Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.
Schema: Catalog_google_maps_directions_Response
- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/google/maps/photos
Google Maps Photos
Retrieve Google Maps place gallery photos with native continuation.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
id | string | yes | — | The provider's identifier, as returned by its search results. |
next_page_token | string | no | — | Copy the opaque next_page_token from the previous response using the same account, search parameters, device, and result limit. Tokens expire after one hour; restart pagination if rejected or expired. |
country | string | no | — | Two-letter country or storefront code, such as us or gb. |
language | string | no | — | Provider-supported language code, such as en. |
limit | integer | no | — | Maximum number of items to return. The provider may return fewer. |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"id": "ChIJIQDZbb9ZwokRNRez4RviXGQ"
}Responses
- 200 — Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.
Schema: Catalog_google_maps_photos_Response
- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/google/maps/posts
Google Maps Posts
Retrieve business updates visible in the public Google Maps place preview; preview continuation is unavailable.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
id | string | yes | — | The provider's identifier, as returned by its search results. |
country | string | no | — | Two-letter country or storefront code, such as us or gb. |
language | string | no | — | Provider-supported language code, such as en. |
limit | integer | no | — | Maximum number of items to return. The provider may return fewer. |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"id": "ChIJM8w7rqS1RIYRhEz2-KuoqzE"
}Responses
- 200 — Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.
Schema: Catalog_google_maps_posts_Response
- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/google/maps/reviews
Google Maps Reviews
Retrieve complete Google Maps review text in relevance order with native continuation tokens. If Google restricts access and supplies a verified place preview, the response marks that subset with access_limited and pagination_limited and omits the next-page token. Restrictions without a verified preview return an upstream error.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
id | string | yes | — | Use place_id from Google Maps search results, rather than data_id. |
country | string | no | — | Two-letter country or storefront code, such as us or gb. |
language | string | no | — | Provider-supported language code, such as en. |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
next_page_token | string | no | — | Copy the opaque next_page_token from the previous response using the same account, search parameters, device, and result limit. Tokens expire after one hour; restart pagination if rejected or expired. |
limit | integer | no | — | Maximum number of items to return. The provider may return fewer. |
sort_by | string | no | — | The provider's supported sort order. Allowed: relevance |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"country": "us",
"id": "ChIJaXQRs6lZwokRY6EFpJnhNNE",
"language": "en",
"limit": 10,
"sort_by": "relevance"
}Responses
- 200 — Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.
Schema: Catalog_google_maps_reviews_Response
- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/google/news
Google News
Retrieve Google News using its native source data.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
query | string | yes | — | Text to search for on the selected service. At most 8,192 UTF-8 bytes. |
country | string | no | — | Two-letter country or storefront code, such as us or gb. |
language | string | no | — | Provider-supported language code, such as en. |
page | integer | no | — | One-based page number. |
safe | string | no | — | Provider safe-search filtering. Allowed: active, off |
time_range | string | no | — | Provider-supported time filter. |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"query": "space launch"
}Responses
- 200 — Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.
Schema: Catalog_google_news_Response
- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/google/news/light
Google News Light
Retrieve Google News Light using its native source data.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
query | string | yes | — | Text to search for on the selected service. At most 8,192 UTF-8 bytes. |
country | string | no | — | Two-letter country or storefront code, such as us or gb. |
language | string | no | — | Provider-supported language code, such as en. |
page | integer | no | — | One-based page number. |
safe | string | no | — | Provider safe-search filtering. Allowed: active, off |
time_range | string | no | — | Provider-supported time filter. |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"query": "space launch"
}Responses
- 200 — Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.
Schema: Catalog_google_news_light_Response
- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/google/patents/search
Google Patents
Retrieve Google Patents using its native source data.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
query | string | yes | — | Text to search for on the selected service. At most 8,192 UTF-8 bytes. |
language | string | no | — | Provider-supported language code, such as en. |
page | integer | no | — | One-based page number. |
limit | integer | no | — | Maximum number of items to return. The provider may return fewer. |
sort_by | string | no | — | The provider's supported sort order. Allowed: new, old, relevance |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"query": "lithium battery"
}Responses
- 200 — Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.
Schema: Catalog_google_patents_Response
- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/google/patents/details
Google Patents Details
Retrieve Google Patents Details using its native source data.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
id | string | yes | — | The provider's identifier, as returned by its search results. |
language | string | no | — | Provider-supported language code, such as en. |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"id": "US7654321B2"
}Responses
- 200 — Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.
Schema: Catalog_google_patents_details_Response
- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/google/play/apps/search
Google Play Apps
Retrieve Google Play Apps data with the existing PrismCrawl authentication, credits, and request-history behavior.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
query | string | yes | — | Text to search for on the selected service. At most 8,192 UTF-8 bytes. |
country | string | no | — | Two-letter country or storefront code, such as us or gb. |
language | string | no | — | Provider-supported language code, such as en. |
limit | integer | no | — | Maximum number of items to return. The provider may return fewer. |
next_page_token | string | no | — | Copy the opaque next_page_token from the previous response using the same account, search parameters, device, and result limit. Tokens expire after one hour; restart pagination if rejected or expired. |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"country": "us",
"language": "en",
"query": "weather"
}Responses
- 200 — Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.
Schema: Catalog_google_play_apps_Response
- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/google/play/books/search
Google Play Books
Retrieve Google Play Books data with the existing PrismCrawl authentication, credits, and request-history behavior.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
query | string | yes | — | Text to search for on the selected service. At most 8,192 UTF-8 bytes. |
country | string | no | — | Two-letter country or storefront code, such as us or gb. |
language | string | no | — | Provider-supported language code, such as en. |
limit | integer | no | — | Maximum number of items to return. The provider may return fewer. |
next_page_token | string | no | — | Copy the opaque next_page_token from the previous response using the same account, search parameters, device, and result limit. Tokens expire after one hour; restart pagination if rejected or expired. |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"country": "us",
"language": "en",
"query": "adventure"
}Responses
- 200 — Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.
Schema: Catalog_google_play_books_Response
- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/google/play/games/search
Google Play Games
Browse Google Play game categories or search a query, returning only candidates whose first-party product metadata identifies a game. Query pages can be shorter than the requested limit; follow next_page_token when present.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
query | string | no | — | Optional game query. Results follow Google Play's search order and include only products whose source category identifies them as games. Omit query to browse a category. At most 8,192 UTF-8 bytes. |
category | string | no | — | A category identifier supported by this operation. Allowed: GAME, GAME_ACTION, GAME_ADVENTURE, GAME_ARCADE, GAME_BOARD, GAME_CARD, GAME_CASINO, GAME_CASUAL, … (+10 more) |
country | string | no | — | Two-letter country or storefront code, such as us or gb. |
language | string | no | — | Provider-supported language code, such as en. |
limit | integer | no | — | Maximum games to return. Query searches inspect at most 32 source candidates per request; a filtered page may be shorter or empty while a next_page_token remains available. |
next_page_token | string | no | — | Copy the opaque next_page_token from the previous response using the same account, search parameters, device, and result limit. Tokens expire after one hour; restart pagination if rejected or expired. |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"category": "GAME_ACTION",
"country": "us"
}Responses
- 200 — Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.
Schema: Catalog_google_play_games_Response
- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/google/play/movies/search
Google Play Movies
Retrieve Google Play Movies data with the existing PrismCrawl authentication, credits, and request-history behavior.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
query | string | yes | — | Text to search for on the selected service. At most 8,192 UTF-8 bytes. |
country | string | no | — | Two-letter country or storefront code, such as us or gb. |
language | string | no | — | Provider-supported language code, such as en. |
limit | integer | no | — | Maximum number of items to return. The provider may return fewer. |
next_page_token | string | no | — | Copy the opaque next_page_token from the previous response using the same account, search parameters, device, and result limit. Tokens expire after one hour; restart pagination if rejected or expired. |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"country": "us",
"language": "en",
"query": "adventure"
}Responses
- 200 — Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.
Schema: Catalog_google_play_movies_Response
- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/google/play/product
Google Play Product
Retrieve Google Play Product data with the existing PrismCrawl authentication, credits, and request-history behavior.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
id | string | yes | — | The product ID from Google Play search results or the id parameter in its store URL. Use the matching category for apps, books, movies, or audiobooks. IDs contain 1–250 letters, digits, dots, underscores, or hyphens. |
category | string | no | — | A category identifier supported by this operation. Allowed: apps, books, movies, audiobooks |
country | string | no | — | Two-letter country or storefront code, such as us or gb. |
language | string | no | — | Provider-supported language code, such as en. |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"country": "us",
"id": "com.google.android.apps.maps",
"language": "en"
}Responses
- 200 — Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.
Schema: Catalog_google_play_product_Response
- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/google/play/reviews
Google Play Reviews
Retrieve Google Play Reviews data with the existing PrismCrawl authentication, credits, and request-history behavior.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
id | string | yes | — | The app's package ID from Google Play search results or the id parameter in its store URL, such as com.google.android.youtube. App and company names are not IDs. Use 1–250 letters, digits, dots, underscores, or hyphens. |
country | string | no | — | Two-letter country or storefront code, such as us or gb. |
language | string | no | — | Provider-supported language code, such as en. |
limit | integer | no | — | Maximum number of items to return. The provider may return fewer. |
next_page_token | string | no | — | Copy the opaque next_page_token from the previous response using the same account, search parameters, device, and result limit. Tokens expire after one hour; restart pagination if rejected or expired. |
sort_by | string | no | — | The provider's supported sort order. Allowed: newest, relevant, rating |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"country": "us",
"id": "com.google.android.apps.maps",
"language": "en"
}Responses
- 200 — Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.
Schema: Catalog_google_play_reviews_Response
- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/google/related-questions
Google Related Questions
Retrieve People Also Ask questions supplied for a query. feature_available is false when the valid search page contains no question panel.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
query | string | yes | — | Text to search for on the selected service. At most 8,192 UTF-8 bytes. |
country | string | no | — | Two-letter country or storefront code, such as us or gb. |
language | string | no | — | Provider-supported language code, such as en. |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"query": "how do solar panels work"
}Responses
- 200 — Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.
Schema: Catalog_google_related_questions_Response
- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/google/reverse-image
Google Reverse Image
Retrieve Google Lens visual matches for a public HTTPS image URL supplied in id.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
id | string | yes | — | The provider's identifier, as returned by its search results. |
country | string | no | — | Two-letter country or storefront code, such as us or gb. |
language | string | no | — | Provider-supported language code, such as en. |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"id": "https://images.unsplash.com/photo-1546182990-dffeafbe841d"
}Responses
- 200 — Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.
Schema: Catalog_google_reverse_image_Response
- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/google/scholar/search
Google Scholar
Retrieve Google Scholar using its native source data.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
query | string | yes | — | Text to search for on the selected service. At most 8,192 UTF-8 bytes. |
language | string | no | — | Provider-supported language code, such as en. |
page | integer | no | — | One-based page number. |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"query": "machine learning"
}Responses
- 200 — Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.
Schema: Catalog_google_scholar_Response
- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/google/scholar/author
Google Scholar Author
Retrieve a Scholar author profile, citation metrics and 20 articles per page.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
id | string | yes | — | The provider's identifier, as returned by its search results. |
language | string | no | — | Provider-supported language code, such as en. |
page | integer | no | — | One-based page number. |
sort_by | string | no | — | The provider's supported sort order. Allowed: year, citations |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"id": "qc6CJjYAAAAJ"
}Responses
- 200 — Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.
Schema: Catalog_google_scholar_author_Response
- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/google/scholar/case-law
Google Scholar Case Law
Retrieve Google Scholar Case Law using its native source data.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
query | string | yes | — | Text to search for on the selected service. At most 8,192 UTF-8 bytes. |
language | string | no | — | Provider-supported language code, such as en. |
page | integer | no | — | One-based page number. |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"query": "Brown v Board of Education"
}Responses
- 200 — Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.
Schema: Catalog_google_scholar_case_law_Response
- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/google/shopping
Google Shopping
Retrieve real catalog products, prices, merchants and ratings from the native Google Shopping surface. Responses identify source_surface as shopping and expose continuation only when the source supplies a next-page link.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
query | string | yes | — | Text to search for on the selected service. At most 8,192 UTF-8 bytes. |
country | string | no | — | Two-letter country or storefront code, such as us or gb. |
language | string | no | — | Provider-supported language code, such as en. |
page | integer | no | — | One-based page number. |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"query": "coffee grinder"
}Responses
- 200 — Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.
Schema: Catalog_google_shopping_Response
- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/google/shopping/light
Google Shopping Light
Retrieve real catalog products, prices, merchants and ratings from the native Google Shopping surface. Responses identify source_surface as shopping and expose continuation only when the source supplies a next-page link.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
query | string | yes | — | Text to search for on the selected service. At most 8,192 UTF-8 bytes. |
country | string | no | — | Two-letter country or storefront code, such as us or gb. |
language | string | no | — | Provider-supported language code, such as en. |
page | integer | no | — | One-based page number. |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"query": "coffee grinder"
}Responses
- 200 — Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.
Schema: Catalog_google_shopping_light_Response
- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/google/shopping/product
Google Shopping Product
Look up a product_id returned by Google Shopping using the original Shopping query. Returns the current product details, merchant offers, images, and specifications supplied by Google. A recognized unavailable product returns a successful, billable empty response with search_parameters.product_unavailable:true and product_unavailable_reason:not_in_results when the ID is absent from the current query's Shopping cards, or unavailable when the product viewer reports no details. Retrieved product details are also successful and billable when offers are out of stock or absent.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
id | string | yes | — | Use product_id from an item in a Google Shopping result. |
query | string | yes | — | Keep the query that returned this product_id so Google can supply its current product details. At most 8,192 UTF-8 bytes. |
country | string | no | — | Two-letter country or storefront code, such as us or gb. |
language | string | no | — | Provider-supported language code, such as en. |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"id": "17755277695162489284",
"query": "sony wh-1000xm5"
}Responses
- 200 — Request completed. One credit is charged, including an empty result when current Shopping results omit the requested ID or the product viewer reports unavailability. Inspect search_parameters.product_unavailable and product_unavailable_reason. Retrieved product details remain billable when offers are out of stock or absent.
{
"success": true,
"request_id": "11111111-1111-4111-8111-111111111111",
"data": {
"format": "json",
"content": {
"search_parameters": {
"engine": "google",
"type": "product",
"operation": "google_shopping_product",
"id": "17755277695162489284",
"query": "sony wh-1000xm5",
"country": "us",
"language": "en",
"product_unavailable": true,
"product_unavailable_reason": "not_in_results"
},
"results": [],
"has_next_page": false,
"serp_features": []
}
}
}- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/google/short-videos
Google Short Videos
Retrieve native Google Short Videos cards and source-reported continuation. Numeric pages use the native twelve-unit offset.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
query | string | yes | — | Text to search for on the selected service. At most 8,192 UTF-8 bytes. |
country | string | no | — | Two-letter country or storefront code, such as us or gb. |
language | string | no | — | Provider-supported language code, such as en. |
page | integer | no | — | One-based page number. |
safe | string | no | — | Provider safe-search filtering. Allowed: active, off |
time_range | string | no | — | Provider-supported time filter. |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"query": "red panda"
}Responses
- 200 — Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.
Schema: Catalog_google_short_videos_Response
- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/google/sports
Google Sports
Retrieve Google Sports using its native source data.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
query | string | yes | — | Text to search for on the selected service. At most 8,192 UTF-8 bytes. |
country | string | no | — | Two-letter country or storefront code, such as us or gb. |
language | string | no | — | Provider-supported language code, such as en. |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"query": "NFL scores"
}Responses
- 200 — Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.
Schema: Catalog_google_sports_Response
- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/google/travel/explore
Google Travel Explore
Explore destinations, flexible dates, and prices from a departure_id (IATA airport or Google travel location ID). Use flight autocomplete to resolve an origin.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
departure_id | string | yes | — | IATA airport code or airport identifier returned by flight autocomplete. |
currency | string | no | — | Three-letter currency code, such as USD. Allowed: ALL, DZD, ARS, AMD, AWG, AUD, AZN, BSD, … (+63 more) |
country | string | no | — | Two-letter country or storefront code, such as us or gb. |
language | string | no | — | Provider-supported language code, such as en. |
limit | integer | no | — | Maximum number of items to return. The provider may return fewer. |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"departure_id": "JFK",
"limit": 10
}Responses
- 200 — Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.
Schema: Catalog_google_travel_explore_Response
- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/google/trends
Google Trends
Retrieve Google Trends data for one to five comma-separated terms. time_range accepts all, now 1-H, now 4-H, now 1-d, now 7-d, today 1-m, today 3-m, today 12-m, today 5-y, or an ordered YYYY-MM-DD date pair from 2004 through today.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
query | string | yes | — | Text to search for on the selected service. At most 8,192 UTF-8 bytes. |
country | string | no | — | Two-letter country or storefront code, such as us or gb. |
language | string | no | — | Provider-supported language code, such as en. |
category | string | no | — | A category identifier supported by this operation. Allowed: interest_over_time, interest_by_region, related_queries, related_topics |
time_range | string | no | — | Provider-supported time filter. |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"query": "tesla"
}Responses
- 200 — Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.
Schema: Catalog_google_trends_Response
- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/google/trends/autocomplete
Google Trends Autocomplete
Retrieve Google Trends Autocomplete using its native source data.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
query | string | yes | — | Text to search for on the selected service. At most 8,192 UTF-8 bytes. |
language | string | no | — | Provider-supported language code, such as en. |
limit | integer | no | — | Maximum number of items to return. The provider may return fewer. |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"query": "tesla"
}Responses
- 200 — Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.
Schema: Catalog_google_trends_autocomplete_Response
- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/google/trends/trending-now
Google Trends Trending Now
Retrieve Google Trends Trending Now using its native source data.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
country | string | no | — | Two-letter country or storefront code, such as us or gb. |
language | string | no | — | Provider-supported language code, such as en. |
limit | integer | no | — | Maximum number of items to return. The provider may return fewer. |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"country": "us"
}Responses
- 200 — Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.
Schema: Catalog_google_trends_trending_now_Response
- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/google/videos
Google Videos
Retrieve Google Videos using its native source data.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
query | string | yes | — | Text to search for on the selected service. At most 8,192 UTF-8 bytes. |
country | string | no | — | Two-letter country or storefront code, such as us or gb. |
language | string | no | — | Provider-supported language code, such as en. |
page | integer | no | — | One-based page number. |
safe | string | no | — | Provider safe-search filtering. Allowed: active, off |
time_range | string | no | — | Provider-supported time filter. |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"query": "red panda"
}Responses
- 200 — Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.
Schema: Catalog_google_videos_Response
- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/google/videos/light
Google Videos Light
Retrieve Google Videos Light using its native source data.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
query | string | yes | — | Text to search for on the selected service. At most 8,192 UTF-8 bytes. |
country | string | no | — | Two-letter country or storefront code, such as us or gb. |
language | string | no | — | Provider-supported language code, such as en. |
page | integer | no | — | One-based page number. |
safe | string | no | — | Provider safe-search filtering. Allowed: active, off |
time_range | string | no | — | Provider-supported time filter. |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"query": "red panda"
}Responses
- 200 — Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.
Schema: Catalog_google_videos_light_Response
- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/amazon/search
Search Amazon
Returns normalized Amazon product results, a typed navigation or empty-results surface, or encoded source HTML.
Requires the x-api-key header.
Request body
Successful query: 1 credit. Search failures are free. Optional parameters may be omitted or set to `null` to use the endpoint default. Only parameters documented for this endpoint are used; other top-level fields are ignored.
| Field | Type | Required | Default | Description |
|---|
query | string | yes | — | The search query. The UTF-8 representation must not exceed 8,192 bytes; non-ASCII characters may use more than one byte. |
html | boolean | null | no | false | Return Brotli-compressed, Base64-encoded source HTML instead of normalized JSON. |
zero_trace | boolean | null | no | false | When true, PrismCrawl does not store the source HTML or parsed JSON. Audit and billing metadata is retained, but all other data is permanently discarded. Request history exposes only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged. |
device | string | null | no | desktop | Device profile used for the Amazon request. Allowed: desktop, mobile, |
amazon_domain | string | null | no | amazon.com | Amazon marketplace domain, without a scheme or `www.` prefix. Allowed: amazon.com, amazon.ca, amazon.com.mx, amazon.com.br, amazon.co.uk, amazon.ie, amazon.de, amazon.es, … (+15 more) |
language | string | null | no | — | Amazon locale supported by the selected marketplace. Omit it to use the marketplace default (the first locale shown): amazon.com: en_US, es_US, ar_AE, de_US, he_IL, ko_KR, pt_BR, zh_CN, zh_TW; amazon.ca: en_CA, fr_CA; amazon.com.mx: es_MX; amazon.com.br: pt_BR; amazon.co.uk: en_GB; amazon.ie: en_IE; amazon.de: de_DE, en_GB, cs_CZ, nl_NL, pl_PL, tr_TR, da_DK; amazon.es: es_ES, pt_PT, en_GB; amazon.fr: fr_FR, en_GB; amazon.it: it_IT, en_GB; amazon.nl: nl_NL, en_GB; amazon.se: sv_SE, en_GB; amazon.pl: pl_PL; amazon.com.be: nl_BE, fr_BE, en_GB; amazon.com.tr: tr_TR; amazon.ae: en_AE, ar_AE; amazon.sa: ar_AE, en_AE; amazon.eg: ar_AE, en_AE; amazon.in: en_IN, hi_IN, ta_IN, te_IN, kn_IN, ml_IN, bn_IN, mr_IN; amazon.co.jp: ja_JP, en_US, zh_CN; amazon.com.au: en_AU; amazon.sg: en_SG. Allowed: en_US, es_US, ar_AE, de_US, he_IL, ko_KR, pt_BR, zh_CN, … (+32 more) |
delivery_country | string | null | no | — | Amazon delivery destination as an ISO 3166-1 alpha-2 country code. This is independent of marketplace, interface language, and server egress. Omit it to use the selected marketplace's home country. It controls catalog availability, delivery promises, and shipping context. Allowed: AD, AE, AF, AG, AI, AL, AM, AO, … (+231 more) |
postal_code | string | null | no | — | Exact delivery postal code. It is accepted only when `delivery_country` is the selected marketplace's home country. Supported marketplace examples: amazon.com: 10001; amazon.ca: M5V 3L9; amazon.com.mx: 06600; amazon.com.br: 01310-100; amazon.co.uk: SW1A 1AA; amazon.ie: D02 X285; amazon.de: 10115; amazon.es: 28001; amazon.fr: 75001; amazon.it: 00100; amazon.se: 111 20; amazon.pl: 00-001; amazon.com.tr: 34000; amazon.in: 110001; amazon.co.jp: 100-0001; amazon.com.au: 2000; amazon.sg: 018956. Amazon-defined city/area marketplaces without reliable postal targeting reject this field. |
currency | string | null | no | — | Three-letter display-currency override. This changes displayed prices only; it does not change delivery eligibility or destination. Omit it for the marketplace's native currency. Most marketplaces accept only their native currency; amazon.com and amazon.ae support additional currencies exposed by Amazon's selector. For amazon.com with US delivery (including an omitted delivery_country), only USD is supported; requesting another currency returns HTTP 400. Select an international delivery country to use another supported currency on amazon.com. Allowed: AED, AMD, ARS, AUD, AWG, AZN, BBD, BGN, … (+79 more) |
page | integer | null | no | 1 | One-based Amazon results page. |
category_id | string | null | no | — | Amazon category or browse-node identifier. |
sort_by | string | null | no | — | Amazon-native result ordering. Allowed: featured, price_low_to_high, price_high_to_low, average_review, most_recent, bestsellers, bestseller_rankings, |
rh | string | null | no | — | Comma-separated Amazon `key:value` refinements. |
merchant_id | string | null | no | — | Restrict results to an Amazon merchant ID. |
direct_search | boolean | null | no | false | Use Amazon's direct category-search mode. |
Example request
{
"query": "best espresso machines",
"html": false,
"zero_trace": false,
"device": null,
"amazon_domain": "amazon.com",
"language": null,
"delivery_country": null,
"postal_code": null,
"currency": null,
"page": 1,
"category_id": null,
"sort_by": null,
"rh": null,
"merchant_id": null,
"direct_search": false
}Responses
- 200 — Search completed.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"format": "json",
"content": {
"search_parameters": {
"q": "best espresso machines",
"type": "search",
"engine": "amazon",
"device": "desktop",
"amazon_domain": "amazon.com",
"language": "en_US",
"delivery_country": "US",
"postal_code": null,
"currency": null,
"page": 1,
"category_id": null,
"sort_by": null,
"rh": null,
"merchant_id": null,
"direct_search": false
},
"search_information": {
"surface": "product_results",
"page_title": "Amazon.com : best espresso machines",
"total_results": 1247,
"results_text": "1-48 of 1,247 results",
"query_displayed": "best espresso machines",
"original_query": null,
"page": 1,
"total_pages": 7,
"store": "aps"
},
"results": [
{
"asin": "B0D1234567",
"rank": 1,
"type": "organic",
"sponsored": false,
"title": "Compact Espresso Machine",
"url": "https://www.amazon.com/example/dp/B0D1234567",
"clean_url": "https://www.amazon.com/dp/B0D1234567",
"image": "https://m.media-amazon.com/images/example.jpg",
"price": {
"raw": "$199.99",
"value": 199.99,
"currency": "USD"
},
"old_price": null,
"unit_price": null,
"rating": 4.6,
"reviews": 2318,
"prime": true,
"best_seller": true,
"amazon_choice": false,
"limited_time_deal": false,
"amazon_brand": false,
"kindle_unlimited": false,
"prime_video": false,
"exclusive_to_amazon": false,
"small_business": false,
"amazon_fresh": false,
"whole_foods_market": false,
"climate_pledge_friendly": false,
"badges": [
"Best Seller"
],
"bought_last_month": "1K+ bought in past month",
"coupon": null,
"offers": [],
"delivery": "FREE delivery Tomorrow",
"availability": null,
"variations": null,
"tags": [],
"position": {
"absolute": 1
}
}
],
"filters": [],
"categories": [],
"related_searches": [],
"has_next_page": true,
"serp_features": []
}
}
}- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — The API token has no credits remaining.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "credits_exhausted",
"message": "no credits remaining"
}
}- 405 — Only POST is supported for this endpoint.
Schema: ErrorResponse
- 413 — The JSON request body exceeds 64 KiB.
Schema: ErrorResponse
- 429 — Rate limit exceeded.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "quota_exceeded",
"message": "rate limit exceeded",
"rule": "10s",
"reset_at": "2026-07-15T18:42:10Z"
}
}- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/amazon/autocomplete
Amazon Autocomplete
Retrieve native Amazon Autocomplete data.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
query | string | yes | — | Text to search for on the selected service. At most 8,192 UTF-8 bytes. |
limit | integer | no | — | Maximum number of items to return. The provider may return fewer. |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"query": "coffee"
}Responses
- 200 — Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.
Schema: Catalog_amazon_autocomplete_Response
- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/amazon/product
Amazon Product
Retrieve native Amazon Product data.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
id | string | yes | — | The provider's identifier, as returned by its search results. |
language | string | no | — | Provider-supported language code, such as en. |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"id": "B0BSHF7WHW"
}Responses
- 200 — Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.
Schema: Catalog_amazon_product_Response
- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/apple/app-store/search
Apple App Store Search
Search Apple App Store apps and paginate the source's returned inventory of up to 200 results. Continuation is scoped to the query and fails if the ordered source inventory changes.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
query | string | yes | — | Text to search for on the selected service. At most 8,192 UTF-8 bytes. |
country | string | no | — | Two-letter country or storefront code, such as us or gb. |
language | string | no | — | Provider-supported language code, such as en. Allowed: en, ja |
category | string | no | — | A category identifier supported by this operation. Allowed: software, iPadSoftware, macSoftware |
limit | integer | no | — | Maximum number of items to return. The provider may return fewer. |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
next_page_token | string | no | — | Continue within Apple's returned catalog inventory, up to 200 apps per search. Use the same account, query, category, country, language, device, and result limit. The opaque token expires after one hour. Expired tokens are rejected before execution. If Apple's inventory changes during a valid continuation, the completed response costs one credit and marks pagination_reason: stale_cursor; restart the search. |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"country": "us",
"query": "weather"
}Responses
- 200 — Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.
Schema: Catalog_apple_app_store_Response
- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/apple/app-store/product
Apple App Store Product
Retrieve Apple App Store Product data with the existing PrismCrawl authentication, credits, and request-history behavior.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
id | string | yes | — | The provider's identifier, as returned by its search results. |
country | string | no | — | Two-letter country or storefront code, such as us or gb. |
language | string | no | — | Provider-supported language code, such as en. |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"country": "us",
"id": "284882215"
}Responses
- 200 — Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.
Schema: Catalog_apple_app_store_product_Response
- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/apple/app-store/reviews
Apple App Store Reviews
Retrieve Apple App Store Reviews data with the existing PrismCrawl authentication, credits, and request-history behavior.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
id | string | yes | — | The provider's identifier, as returned by its search results. |
country | string | no | — | Two-letter country or storefront code, such as us or gb. |
page | integer | no | — | Apple's public review feed exposes pages 1 through 10. |
limit | integer | no | — | Maximum number of items to return. The provider may return fewer. |
next_page_token | string | no | — | Copy the opaque next_page_token from the previous response using the same account, search parameters, device, and result limit. Tokens expire after one hour; restart pagination if rejected or expired. |
sort_by | string | no | — | The provider's supported sort order. Allowed: newest, helpful |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"country": "us",
"id": "284882215"
}Responses
- 200 — Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.
Schema: Catalog_apple_app_store_reviews_Response
- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/apple/maps/search
Apple Maps Search
Retrieve Apple Maps Places data with the existing PrismCrawl authentication, credits, and request-history behavior.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
query | string | yes | — | Text to search for on the selected service. At most 8,192 UTF-8 bytes. |
country | string | no | — | Two-letter country or storefront code, such as us or gb. |
language | string | no | — | Provider-supported language code, such as en. |
location | string | no | — | Location to search around, such as Austin, TX. |
coordinates | object | no | — | Latitude and longitude for location targeting. |
limit | integer | no | — | Maximum number of items to return. The provider may return fewer. |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"location": "Austin, TX",
"query": "coffee"
}Responses
- 200 — Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.
Schema: Catalog_apple_maps_Response
- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/apple/maps/place
Apple Maps Places
Retrieve Apple Maps Places data.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
id | string | yes | — | The provider's identifier, as returned by its search results. |
language | string | no | — | Provider-supported language code, such as en. |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"id": "IDBCCCA2A9059133"
}Responses
- 200 — Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.
Schema: Catalog_apple_maps_place_Response
- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/apple/maps/reviews
Apple Maps Reviews
Return Apple Maps' attributed review selection. Exact linked Yelp and Tripadvisor reviews include complete publisher text when available; other rows remain marked excerpts. Apple provides no additional review pages.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
id | string | yes | — | The provider's identifier, as returned by its search results. |
language | string | no | — | Provider-supported language code, such as en. |
limit | integer | no | — | Maximum number of items to return. The provider may return fewer. |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"id": "I15FF30DE01EC121F"
}Responses
- 200 — Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.
Schema: Catalog_apple_maps_reviews_Response
- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/baidu/search
Baidu Search
Retrieve native Baidu Search data.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
query | string | yes | — | Text to search for on the selected service. At most 8,192 UTF-8 bytes. |
page | integer | no | — | One-based page number. |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"query": "coffee"
}Responses
- 200 — Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.
Schema: Catalog_baidu_Response
- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/baidu/news/search
Baidu News
Retrieve native Baidu News data.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
query | string | yes | — | Text to search for on the selected service. At most 8,192 UTF-8 bytes. |
page | integer | no | — | One-based page number. |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"query": "coffee"
}Responses
- 200 — Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.
Schema: Catalog_baidu_news_Response
- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/microsoft/search
Search Bing
Returns normalized Bing results, or encoded source HTML.
Requires the x-api-key header.
Request body
Successful query: 1 credit. Search failures are free. Optional parameters may be omitted or set to `null` to use the endpoint default. Only parameters documented for this endpoint are used; other top-level fields are ignored.
| Field | Type | Required | Default | Description |
|---|
query | string | yes | — | The search query. The UTF-8 representation must not exceed 8,192 bytes; non-ASCII characters may use more than one byte. |
html | boolean | null | no | false | Return Brotli-compressed, Base64-encoded source HTML instead of normalized JSON. |
zero_trace | boolean | null | no | false | When true, PrismCrawl does not store the source HTML or parsed JSON. Audit and billing metadata is retained, but all other data is permanently discarded. Request history exposes only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged. |
device | string | null | no | — | Search as a mobile, tablet, or desktop device. Allowed: mobile, tablet, desktop, |
safe | string | null | no | — | Safe-search mode. `active` enables Google's filtering and Bing Strict SafeSearch; `off` requests unfiltered results. Search providers may still suppress content required by law or policy. Allowed: active, off, |
color_scheme | string | null | no | — | Request the provider's light or dark result-page theme. This affects source-page presentation, not ranking, and providers may ignore it. Allowed: light, dark, |
sp | integer | null | no | — | Bing-native spelling hint. The supported value is `-1`, an undocumented field observed in Bing-generated search URLs. Its behavior is best-effort and may change upstream. Allowed: -1, |
first | integer | null | no | 1 | Bing's one-based native page position. Omit it or use `1` for the front page. Values greater than `1` require the `next_page_token` returned by the preceding response and must match that token; arbitrary offsets are rejected. |
next_page_token | string | null | no | — | Opaque Bing continuation token from the preceding response, valid for one hour and the same account. When supplied, `first` may be omitted. Resend the same query, device, targeting, time range, and search controls. Restart pagination if the token is expired, rejected, or predates the authenticated-token rollout. |
cc | string | null | no | us | Two-letter Bing result-country code. Case-insensitive. The supported values follow Bing's published country-code list. Allowed: ar, au, at, be, br, ca, cl, dk, … (+29 more) |
setlang | string | null | no | en-US | Bing interface-language hint. It affects Bing-generated interface strings, such as related-search labels; it does not restrict search results to that language. Bing may fall back to English when it cannot localize a value. See Microsoft's current [`set_lang` guidance](https://learn.microsoft.com/en-us/azure/foundry/agents/how-to/tools/bing-tools#optional-parameters). |
coordinates | Coordinates | null | no | — | The searcher's latitude and longitude. PrismCrawl sends these to Bing as a client-location signal with 100-meter accuracy. Bing may also consider the query, request IP, and other signals, so this biases local relevance rather than imposing a strict geographic filter. |
tbs | string | null | no | — | Google-compatible time-range input translated to Bing's native date filter. Relative ranges use `qdr:<unit>[amount]`, where the unit is `d` (day), `w` (week), `m` (month), or `y` (year), and the optional positive amount is at most 10,000. Custom inclusive ranges use `cdr:1,cd_min:M/D/YYYY,cd_max:M/D/YYYY`. Bing has day-level precision, so hour ranges (`qdr:h`) are rejected. Resend the same value with a filtered search's `next_page_token`. |
Example request
{
"query": "best espresso machines",
"html": false,
"zero_trace": false,
"device": null,
"safe": null,
"color_scheme": null,
"sp": null,
"first": 1,
"next_page_token": null,
"cc": "us",
"setlang": "en-US",
"coordinates": null,
"tbs": null
}Responses
- 200 — Search completed.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"format": "json",
"next_page_token": "REPLACE_WITH_NEXT_PAGE_TOKEN_FROM_PREVIOUS_RESPONSE",
"content": {
"search_parameters": {
"q": "best espresso machines",
"type": "search",
"engine": "bing",
"device": null,
"first": null,
"cc": "us",
"setlang": "en-US",
"coordinates": null,
"tbs": null,
"safe": null,
"sp": null,
"color_scheme": null
},
"has_next_page": true,
"results": [
{
"id": "s_129cad18eb11c90a",
"rank": 1,
"type": "organic",
"title": "The Best Espresso Machines",
"url": "https://example.com/best-espresso-machines",
"display_url": "example.com › best-espresso-machines",
"snippet": "Independent reviews of leading espresso machines.",
"domain": "example.com",
"favicon": "https://example.com/favicon.ico",
"source_name": "Example",
"position": {
"absolute": 1
},
"engine": "bing",
"domain_info": {
"tld": "com",
"sld": "example",
"category": null
},
"classification": null
}
],
"serp_features": []
}
}
}- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — The API token has no credits remaining.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "credits_exhausted",
"message": "no credits remaining"
}
}- 405 — Only POST is supported for this endpoint.
Schema: ErrorResponse
- 413 — The JSON request body exceeds 64 KiB.
Schema: ErrorResponse
- 429 — Rate limit exceeded.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "quota_exceeded",
"message": "rate limit exceeded",
"rule": "10s",
"reset_at": "2026-07-15T18:42:10Z"
}
}- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/microsoft/copilot
Bing Copilot
Retrieve native Bing Copilot data.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
query | string | yes | — | Text to search for on the selected service. At most 8,192 UTF-8 bytes. |
country | string | no | — | Two-letter country or storefront code, such as us or gb. |
language | string | no | — | Provider-supported language code, such as en. |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"query": "What is coffee?"
}Responses
- 200 — Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.
Schema: Catalog_bing_copilot_Response
- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/microsoft/images/search
Bing Images
Retrieve native Bing Images data.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
query | string | yes | — | Text to search for on the selected service. At most 8,192 UTF-8 bytes. |
page | integer | no | — | One-based page number. |
country | string | no | — | Two-letter country or storefront code, such as us or gb. |
language | string | no | — | Provider-supported language code, such as en. |
safe | string | no | — | Provider safe-search filtering. Allowed: active, strict, moderate, off |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"query": "coffee"
}Responses
- 200 — Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.
Schema: Catalog_bing_images_Response
- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/microsoft/images/reverse
Bing Reverse Image
Retrieve native Bing Reverse Image data.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
id | string | yes | — | The provider's identifier, as returned by its search results. |
country | string | no | — | Two-letter country or storefront code, such as us or gb. |
language | string | no | — | Provider-supported language code, such as en. |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"id": "https://upload.wikimedia.org/wikipedia/commons/a/a9/Example.jpg"
}Responses
- 200 — Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.
Schema: Catalog_bing_reverse_image_Response
- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/microsoft/maps/search
Bing Maps
Retrieve Bing Maps data with the existing PrismCrawl authentication, credits, and request-history behavior.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
query | string | yes | — | Text to search for on the selected service. At most 8,192 UTF-8 bytes. |
country | string | no | — | Two-letter country or storefront code, such as us or gb. |
language | string | no | — | Provider-supported language code, such as en. |
location | string | no | — | Location to search around, such as Austin, TX. |
coordinates | object | no | — | Latitude and longitude for location targeting. |
limit | integer | no | — | Maximum number of items to return. The provider may return fewer. |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"location": "Austin, TX",
"query": "coffee"
}Responses
- 200 — Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.
Schema: Catalog_bing_maps_Response
- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/microsoft/news/search
Bing News
Retrieve native Bing News data.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
query | string | yes | — | Text to search for on the selected service. At most 8,192 UTF-8 bytes. |
page | integer | no | — | One-based page number. |
country | string | no | — | Two-letter country or storefront code, such as us or gb. |
language | string | no | — | Provider-supported language code, such as en. |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"query": "coffee"
}Responses
- 200 — Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.
Schema: Catalog_bing_news_Response
- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/microsoft/shopping/search
Bing Shopping
Retrieve native Bing Shopping data.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
query | string | yes | — | Text to search for on the selected service. At most 8,192 UTF-8 bytes. |
page | integer | no | — | One-based page number. |
country | string | no | — | Two-letter country or storefront code, such as us or gb. |
language | string | no | — | Provider-supported language code, such as en. |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"query": "coffee"
}Responses
- 200 — Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.
Schema: Catalog_bing_shopping_Response
- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/microsoft/shopping/product
Bing Product
Retrieve native Bing Product data.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
id | string | yes | — | The provider's identifier, as returned by its search results. |
query | string | no | — | Text to search for on the selected service. At most 8,192 UTF-8 bytes. |
country | string | no | — | Two-letter country or storefront code, such as us or gb. |
language | string | no | — | Provider-supported language code, such as en. |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"id": "17464159263"
}Responses
- 200 — Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.
Schema: Catalog_bing_product_Response
- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/microsoft/videos/search
Bing Videos
Retrieve native Bing Videos data.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
query | string | yes | — | Text to search for on the selected service. At most 8,192 UTF-8 bytes. |
page | integer | no | — | One-based page number. |
country | string | no | — | Two-letter country or storefront code, such as us or gb. |
language | string | no | — | Provider-supported language code, such as en. |
safe | string | no | — | Provider safe-search filtering. Allowed: active, strict, moderate, off |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"query": "coffee"
}Responses
- 200 — Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.
Schema: Catalog_bing_videos_Response
- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/brave/ai-mode
Brave AI Mode
Retrieve native Brave AI Mode data.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
query | string | yes | — | Text to search for on the selected service. At most 8,192 UTF-8 bytes. |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"query": "What is coffee?"
}Responses
- 200 — Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.
Schema: Catalog_brave_ai_mode_Response
- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/duckduckgo/search
DuckDuckGo Search
Retrieve DuckDuckGo Search data with the existing PrismCrawl authentication, credits, and request-history behavior.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
query | string | yes | — | Text to search for on the selected service. At most 8,192 UTF-8 bytes. |
country | string | no | — | Two-letter country or storefront code, such as us or gb. |
language | string | no | — | Provider-supported language code, such as en. |
safe | string | no | — | Provider safe-search filtering. Allowed: active, strict, moderate, off |
time_range | string | no | — | Provider-supported time filter. Allowed: d, w, m, y |
next_page_token | string | no | — | Copy the opaque next_page_token from the previous response using the same account, search parameters, device, and result limit. Tokens expire after one hour; restart pagination if rejected or expired. |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"country": "us",
"language": "en",
"query": "best hiking boots"
}Responses
- 200 — Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.
Schema: Catalog_duckduckgo_Response
- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/duckduckgo/search/light
DuckDuckGo Light
Retrieve native DuckDuckGo Light data.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
query | string | yes | — | Text to search for on the selected service. At most 8,192 UTF-8 bytes. |
country | string | no | — | Two-letter country or storefront code, such as us or gb. |
language | string | no | — | Provider-supported language code, such as en. |
time_range | string | no | — | Provider-supported time filter. Allowed: d, w, m, y |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"query": "coffee"
}Responses
- 200 — Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.
Schema: Catalog_duckduckgo_light_Response
- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/duckduckgo/maps/search
DuckDuckGo Maps
Retrieve DuckDuckGo Maps data with the existing PrismCrawl authentication, credits, and request-history behavior.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
query | string | yes | — | Text to search for on the selected service. At most 8,192 UTF-8 bytes. |
location | string | no | — | Location to search around, such as Austin, TX. |
coordinates | object | no | — | Latitude and longitude for location targeting. |
limit | integer | no | — | Maximum number of items to return. The provider may return fewer. |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"location": "Austin, TX",
"query": "coffee"
}Responses
- 200 — Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.
Schema: Catalog_duckduckgo_maps_Response
- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/duckduckgo/news/search
DuckDuckGo News
Retrieve native DuckDuckGo News data.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
query | string | yes | — | Text to search for on the selected service. At most 8,192 UTF-8 bytes. |
country | string | no | — | Two-letter country or storefront code, such as us or gb. |
language | string | no | — | Provider-supported language code, such as en. |
page | integer | no | — | One-based page number. |
safe | string | no | — | Provider safe-search filtering. Allowed: active, strict, moderate, off |
time_range | string | no | — | Provider-supported time filter. Allowed: d, w, m, y |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"query": "coffee"
}Responses
- 200 — Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.
Schema: Catalog_duckduckgo_news_Response
- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/ebay/search
eBay Search
Retrieve native eBay Search data.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
query | string | yes | — | Text to search for on the selected service. At most 8,192 UTF-8 bytes. |
page | integer | no | — | One-based page number. |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"query": "coffee"
}Responses
- 200 — Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.
Schema: Catalog_ebay_Response
- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/ebay/product
eBay Product
Retrieve native eBay Product data.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
id | string | yes | — | The provider's identifier, as returned by its search results. |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"id": "153019705014"
}Responses
- 200 — Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.
Schema: Catalog_ebay_product_Response
- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/ebay/seller
eBay Seller
Retrieve native eBay Seller data.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
id | string | yes | — | The provider's identifier, as returned by its search results. |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"id": "second.sale"
}Responses
- 200 — Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.
Schema: Catalog_ebay_seller_Response
- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/facebook/profile
Facebook Profile
Retrieve native Facebook Profile data.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
id | string | yes | — | The provider's identifier, as returned by its search results. |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"id": "NASA"
}Responses
- 200 — Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.
Schema: Catalog_facebook_profile_Response
- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/home-depot/search
Home Depot Search
Retrieve native Home Depot Search data.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
query | string | yes | — | Text to search for on the selected service. At most 8,192 UTF-8 bytes. |
page | integer | no | — | One-based page number. |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"query": "coffee"
}Responses
- 200 — Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.
Schema: Catalog_home_depot_Response
- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/home-depot/product
Home Depot Product
Retrieve native Home Depot Product data.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
id | string | yes | — | The provider's identifier, as returned by its search results. |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"id": "336764862"
}Responses
- 200 — Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.
Schema: Catalog_home_depot_product_Response
- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/home-depot/reviews
Home Depot Reviews
Retrieve native Home Depot Reviews data.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
id | string | yes | — | The provider's identifier, as returned by its search results. |
page | integer | no | — | One-based page number. |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"id": "336764862"
}Responses
- 200 — Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.
Schema: Catalog_home_depot_reviews_Response
- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/instagram/profile
Instagram Profile
Retrieve native Instagram Profile data.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
id | string | yes | — | The provider's identifier, as returned by its search results. |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"id": "nasa"
}Responses
- 200 — Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.
Schema: Catalog_instagram_profile_Response
- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/naver/search
Naver Search
Retrieve native Naver Search data.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
query | string | yes | — | Text to search for on the selected service. At most 8,192 UTF-8 bytes. |
page | integer | no | — | One-based page number. |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"query": "커피"
}Responses
- 200 — Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.
Schema: Catalog_naver_Response
- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/naver/ai-overview
Naver AI Overview
Retrieve native Naver AI Overview data.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
query | string | yes | — | Text to search for on the selected service. At most 8,192 UTF-8 bytes. |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"query": "커피란 무엇인가"
}Responses
- 200 — Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.
Schema: Catalog_naver_ai_overview_Response
- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/opentable/reviews
OpenTable Reviews
Retrieve native OpenTable restaurant reviews and source-reported pagination. Bounded regional acquisition preserves the requested restaurant identity and English presentation.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
id | string | yes | — | The provider's identifier, as returned by its search results. |
page | integer | no | — | One-based page number. |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"id": "central-park-boathouse-new-york-2"
}Responses
- 200 — Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.
Schema: Catalog_opentable_reviews_Response
- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/tripadvisor/search
Tripadvisor Search
Retrieve Tripadvisor Search data with the existing PrismCrawl authentication, credits, and request-history behavior.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
query | string | yes | — | Text to search for on the selected service. At most 8,192 UTF-8 bytes. |
location | string | no | — | Location to search around, such as Austin, TX. |
language | string | no | — | Provider-supported language code, such as en. |
next_page_token | string | no | — | Copy the opaque next_page_token from the previous response using the same account, search parameters, device, and result limit. Tokens expire after one hour; restart pagination if rejected or expired. |
limit | integer | no | — | Maximum number of items to return. The provider may return fewer. |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"location": "Austin, TX",
"query": "restaurants"
}Responses
- 200 — Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.
Schema: Catalog_tripadvisor_Response
- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/tripadvisor/place
Tripadvisor Place
Retrieve Tripadvisor Place data with the existing PrismCrawl authentication, credits, and request-history behavior.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
id | string | yes | — | The canonical hotel, restaurant, or attraction URL returned by Tripadvisor Search. |
language | string | no | — | Provider-supported language code, such as en. |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"id": "https://www.tripadvisor.com/Restaurant_Review-g33997-d27936245-Reviews-The_Parkway_Restaurant-Bethany_Beach_Delaware.html"
}Responses
- 200 — Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.
Schema: Catalog_tripadvisor_place_Response
- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/tripadvisor/reviews
Tripadvisor Reviews
Retrieve Tripadvisor Reviews data with the existing PrismCrawl authentication, credits, and request-history behavior.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
id | string | yes | — | The canonical hotel, restaurant, or attraction URL returned by Tripadvisor Search. |
language | string | no | — | Provider-supported language code, such as en. |
next_page_token | string | no | — | Copy the opaque next_page_token from the previous response using the same account, search parameters, device, and result limit. Tokens expire after one hour; restart pagination if rejected or expired. |
limit | integer | no | — | Maximum number of items to return. The provider may return fewer. |
sort_by | string | no | — | The provider's supported sort order. Allowed: recommended, newest |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"id": "https://www.tripadvisor.com/Restaurant_Review-g33997-d27936245-Reviews-The_Parkway_Restaurant-Bethany_Beach_Delaware.html"
}Responses
- 200 — Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.
Schema: Catalog_tripadvisor_reviews_Response
- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/walmart/search
Walmart Search
Retrieve native Walmart Search data.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
query | string | yes | — | Text to search for on the selected service. At most 8,192 UTF-8 bytes. |
page | integer | no | — | One-based page number. |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"query": "coffee"
}Responses
- 200 — Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.
Schema: Catalog_walmart_Response
- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/walmart/product
Walmart Product
Retrieve native Walmart Product data.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
id | string | yes | — | The provider's identifier, as returned by its search results. |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"id": "510561525"
}Responses
- 200 — Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.
Schema: Catalog_walmart_product_Response
- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/walmart/reviews
Walmart Reviews
Retrieve native Walmart Reviews data.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
id | string | yes | — | The provider's identifier, as returned by its search results. |
page | integer | no | — | One-based page number. |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"id": "510561525"
}Responses
- 200 — Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.
Schema: Catalog_walmart_reviews_Response
- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/yahoo/search
Yahoo Search
Retrieve native Yahoo Search data.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
query | string | yes | — | Text to search for on the selected service. At most 8,192 UTF-8 bytes. |
page | integer | no | — | One-based page number. |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"query": "coffee"
}Responses
- 200 — Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.
Schema: Catalog_yahoo_Response
- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/yahoo/images/search
Yahoo Images
Retrieve native Yahoo Images data.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
query | string | yes | — | Text to search for on the selected service. At most 8,192 UTF-8 bytes. |
page | integer | no | — | One-based page number. |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"query": "coffee"
}Responses
- 200 — Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.
Schema: Catalog_yahoo_images_Response
- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/yahoo/videos/search
Yahoo Videos
Retrieve native Yahoo Videos data.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
query | string | yes | — | Text to search for on the selected service. At most 8,192 UTF-8 bytes. |
page | integer | no | — | One-based page number. |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"query": "coffee"
}Responses
- 200 — Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.
Schema: Catalog_yahoo_videos_Response
- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/yandex/search
Yandex Search
Retrieve native Yandex Search data. Responses identify the source domain, interface language, and regional context; native regional defaults can affect ranking.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
query | string | yes | — | Text to search for on the selected service. At most 8,192 UTF-8 bytes. |
page | integer | no | — | One-based page number. |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"query": "coffee"
}Responses
- 200 — Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.
Schema: Catalog_yandex_Response
- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/yandex/images/search
Yandex Images
Retrieve native Yandex Images data.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
query | string | yes | — | Text to search for on the selected service. At most 8,192 UTF-8 bytes. |
page | integer | no | — | One-based page number. |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"query": "coffee"
}Responses
- 200 — Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.
Schema: Catalog_yandex_images_Response
- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/yandex/videos/search
Yandex Videos
Retrieve native Yandex Videos data.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
query | string | yes | — | Text to search for on the selected service. At most 8,192 UTF-8 bytes. |
page | integer | no | — | One-based page number. |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"query": "coffee"
}Responses
- 200 — Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.
Schema: Catalog_yandex_videos_Response
- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/yelp/search
Yelp Business Lookup
Search Yelp's native business lookup by query and exactly one of location or coordinates. Results follow the lookup's native order within its first 200 businesses. Category filters and alternative sorts are unsupported. A location Yelp cannot resolve returns a successful empty result with search_parameters.location_not_found set to true and consumes one search credit. Keep query, location, device, language, and limit unchanged when increasing page.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
query | string | yes | — | Text to search for on the selected service. At most 8,192 UTF-8 bytes. |
language | string | no | — | Provider-supported language code, such as en. |
location | string | no | — | Location to search around, such as Austin, TX. Yelp Business Lookup requires exactly one of location or coordinates. If Yelp cannot resolve the location, a completed lookup returns HTTP 200 with an empty results array and search_parameters.location_not_found: true. This successful response costs one credit. |
coordinates | object | no | — | Latitude and longitude for location targeting. Yelp Business Lookup requires exactly one of location or coordinates. If Yelp cannot resolve the location, a completed lookup returns HTTP 200 with an empty results array and search_parameters.location_not_found: true. This successful response costs one credit. |
page | integer | no | — | One-based page within the first 200 businesses. The starting offset (page - 1) × limit must be less than 200. With limit 20, pages 1 through 10 are available. Keep the other search parameters unchanged. |
limit | integer | no | — | Maximum businesses to return, from 1 to 100; defaults to 20. The final page stops at Yelp's 200-result lookup window. |
sort_by | string | no | — | Omit this field or use recommended for Yelp's native business lookup order. Rating, review-count, and distance sorting are unsupported. Allowed: recommended |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"location": "Austin, TX",
"query": "restaurants"
}Responses
- 200 — Request completed. One credit is charged, including an empty result when Yelp cannot resolve the supplied location. The response marks search_parameters.location_not_found: true and source_result_count: 0, with no further pages.
{
"success": true,
"request_id": "11111111-1111-4111-8111-111111111111",
"data": {
"format": "json",
"content": {
"search_parameters": {
"engine": "yelp",
"type": "search",
"operation": "yelp",
"source": "business_lookup",
"location": "Unrecognized location",
"query": "restaurants",
"device": "desktop",
"page": 1,
"limit": 20,
"pagination_limit": 200,
"location_not_found": true,
"source_result_count": 0
},
"results": [],
"has_next_page": false,
"serp_features": []
}
}
}- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/yelp/place
Yelp Place
Retrieve native Yelp Place data.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
id | string | yes | — | The provider's identifier, as returned by its search results. |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"id": "halcyon-austin-2"
}Responses
- 200 — Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.
Schema: Catalog_yelp_place_Response
- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/yelp/reviews
Yelp Reviews
Return complete Yelp business reviews by public business alias, with native sorting and page-based pagination. Keep language, sort_by, and limit unchanged when increasing page.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
id | string | yes | — | The business alias from its Yelp URL, such as halcyon-austin-2. |
language | string | no | — | Provider-supported language code, such as en. |
page | integer | no | — | One-based page number. |
limit | integer | no | — | Maximum number of items to return. The provider may return fewer. |
sort_by | string | no | — | The provider's supported sort order. Allowed: recommended, newest, oldest, highest_rating, lowest_rating |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"id": "halcyon-austin-2"
}Responses
- 200 — Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.
Schema: Catalog_yelp_reviews_Response
- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/youtube/search
YouTube Search
Search public YouTube videos, channels, and playlists. Results retain the native source order and page size.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
query | string | yes | — | Text to search for on the selected service. At most 8,192 UTF-8 bytes. |
country | string | no | — | Two-letter country or storefront code, such as us or gb. |
language | string | no | — | Provider-supported language code, such as en. |
next_page_token | string | no | — | Copy the opaque next_page_token from the previous response using the same account, search parameters, device, and result limit. Tokens expire after one hour; restart pagination if rejected or expired. |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"query": "coffee"
}Responses
- 200 — Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.
Schema: Catalog_youtube_Response
- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/youtube/channel
YouTube Channel
Read a public channel profile and its video inventory. Use a channel ID or @handle; channel metadata appears in search_parameters.channel on the first page.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
id | string | yes | — | The provider's identifier, as returned by its search results. |
country | string | no | — | Two-letter country or storefront code, such as us or gb. |
language | string | no | — | Provider-supported language code, such as en. |
next_page_token | string | no | — | Copy the opaque next_page_token from the previous response using the same account, search parameters, device, and result limit. Tokens expire after one hour; restart pagination if rejected or expired. |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"id": "@Google"
}Responses
- 200 — Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.
Schema: Catalog_youtube_channel_Response
- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/youtube/video
YouTube Video
Read public video metadata.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
id | string | yes | — | The provider's identifier, as returned by its search results. |
country | string | no | — | Two-letter country or storefront code, such as us or gb. |
language | string | no | — | Provider-supported language code, such as en. |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"id": "jNQXAC9IVRw"
}Responses
- 200 — Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.
Schema: Catalog_youtube_video_Response
- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
POST /v1/zillow/search
Zillow Search
Search Zillow property listings by city and state, neighborhood, or postal code. Returns the native listing page and pagination availability.
Requires the x-api-key header.
Request body
| Field | Type | Required | Default | Description |
|---|
query | string | yes | — | Text to search for on the selected service. At most 8,192 UTF-8 bytes. |
page | integer | no | — | One-based page number. |
device | string | no | — | Device presentation for the source request. Allowed: desktop, mobile, tablet |
html | boolean | no | — | Return the encoded original response rather than parsed JSON. |
zero_trace | boolean | no | — | Do not archive source or parsed response artifacts. |
Example request
{
"query": "Austin, TX"
}Responses
- 200 — Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.
Schema: Catalog_zillow_Response
- 400 — The JSON body or continuation is invalid. Invalid, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "invalid_request",
"message": "query is required"
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 402 — No credits remain.
Schema: ErrorResponse
- 429 — Account rate limit exceeded.
Schema: ErrorResponse
- 500 — The request could not be completed.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "internal_failure",
"message": "request failed. no quota has been deducted, please try again or contact support with the request ID."
}
}
GET /v1/google/search/{request_id}
Retrieve a Google request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"request_params": {
"search_provider": "google",
"html": true,
"rewrite_links": true,
"zero_trace": false
}
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/google/ads/{request_id}
Retrieve a Google Ads request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/google/ads/transparency/{request_id}
Retrieve a Google Ads Transparency request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/google/ai-mode/{request_id}
Retrieve a Google AI Mode request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/google/ai-overview/{request_id}
Retrieve a Google AI Overview request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/google/autocomplete/{request_id}
Retrieve a Google Autocomplete request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/google/contributor/reviews/{request_id}
Retrieve a Google Contributor Reviews request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/google/events/{request_id}
Retrieve a Google Events request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/google/finance/{request_id}
Retrieve a Google Finance request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/google/finance/markets/{request_id}
Retrieve a Google Finance Markets request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/google/flights/search/{request_id}
Retrieve a Google Flights request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/google/flights/autocomplete/{request_id}
Retrieve a Google Flights Autocomplete request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/google/flights/deals/{request_id}
Retrieve a Google Flights Deals request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/google/forums/{request_id}
Retrieve a Google Forums request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/google/hotels/search/{request_id}
Retrieve a Google Hotels request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/google/hotels/autocomplete/{request_id}
Retrieve a Google Hotels Autocomplete request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/google/hotels/photos/{request_id}
Retrieve a Google Hotels Photos request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/google/hotels/reviews/{request_id}
Retrieve a Google Hotels Reviews request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/google/images/{request_id}
Retrieve a Google Images request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/google/images/light/{request_id}
Retrieve a Google Images Light request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/google/images/related-content/{request_id}
Retrieve a Google Images Related Content request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/google/jobs/{request_id}
Retrieve a Google Jobs request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/google/lens/{request_id}
Retrieve a Google Lens request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/google/light/search/{request_id}
Retrieve a Google Light Search request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/google/local/{request_id}
Retrieve a Google Local request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/google/local/services/{request_id}
Retrieve a Google Local Services request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/google/maps/search/{request_id}
Retrieve a Google Maps request
Returns request metadata by default. Set `artifact=json` to download the normalized response. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/google/maps/autocomplete/{request_id}
Retrieve a Google Maps Autocomplete request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/google/maps/directions/{request_id}
Retrieve a Google Maps Directions request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/google/maps/photos/{request_id}
Retrieve a Google Maps Photos request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/google/maps/posts/{request_id}
Retrieve a Google Maps Posts request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/google/maps/reviews/{request_id}
Retrieve a Google Maps Reviews request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/google/news/{request_id}
Retrieve a Google News request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/google/news/light/{request_id}
Retrieve a Google News Light request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/google/patents/search/{request_id}
Retrieve a Google Patents request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/google/patents/details/{request_id}
Retrieve a Google Patents Details request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/google/play/apps/search/{request_id}
Retrieve a Google Play Apps request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/google/play/books/search/{request_id}
Retrieve a Google Play Books request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/google/play/games/search/{request_id}
Retrieve a Google Play Games request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/google/play/movies/search/{request_id}
Retrieve a Google Play Movies request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/google/play/product/{request_id}
Retrieve a Google Play Product request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/google/play/reviews/{request_id}
Retrieve a Google Play Reviews request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/google/related-questions/{request_id}
Retrieve a Google Related Questions request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/google/reverse-image/{request_id}
Retrieve a Google Reverse Image request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/google/scholar/search/{request_id}
Retrieve a Google Scholar request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/google/scholar/author/{request_id}
Retrieve a Google Scholar Author request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/google/scholar/case-law/{request_id}
Retrieve a Google Scholar Case Law request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/google/shopping/{request_id}
Retrieve a Google Shopping request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/google/shopping/light/{request_id}
Retrieve a Google Shopping Light request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/google/shopping/product/{request_id}
Retrieve a Google Shopping Product request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/google/short-videos/{request_id}
Retrieve a Google Short Videos request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/google/sports/{request_id}
Retrieve a Google Sports request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/google/travel/explore/{request_id}
Retrieve a Google Travel Explore request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/google/trends/{request_id}
Retrieve a Google Trends request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/google/trends/autocomplete/{request_id}
Retrieve a Google Trends Autocomplete request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/google/trends/trending-now/{request_id}
Retrieve a Google Trends Trending Now request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/google/videos/{request_id}
Retrieve a Google Videos request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/google/videos/light/{request_id}
Retrieve a Google Videos Light request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/amazon/search/{request_id}
Retrieve a Amazon request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/amazon/autocomplete/{request_id}
Retrieve a Amazon Autocomplete request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/amazon/product/{request_id}
Retrieve a Amazon Product request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/apple/app-store/search/{request_id}
Retrieve a Apple App Store Search request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/apple/app-store/product/{request_id}
Retrieve a Apple App Store Product request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/apple/app-store/reviews/{request_id}
Retrieve a Apple App Store Reviews request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/apple/maps/search/{request_id}
Retrieve a Apple Maps Search request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/apple/maps/place/{request_id}
Retrieve a Apple Maps Places request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/apple/maps/reviews/{request_id}
Retrieve a Apple Maps Reviews request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/baidu/search/{request_id}
Retrieve a Baidu Search request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/baidu/news/search/{request_id}
Retrieve a Baidu News request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/microsoft/search/{request_id}
Retrieve a Bing request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/microsoft/copilot/{request_id}
Retrieve a Bing Copilot request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/microsoft/images/search/{request_id}
Retrieve a Bing Images request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/microsoft/images/reverse/{request_id}
Retrieve a Bing Reverse Image request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/microsoft/maps/search/{request_id}
Retrieve a Bing Maps request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/microsoft/news/search/{request_id}
Retrieve a Bing News request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/microsoft/shopping/search/{request_id}
Retrieve a Bing Shopping request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/microsoft/shopping/product/{request_id}
Retrieve a Bing Product request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/microsoft/videos/search/{request_id}
Retrieve a Bing Videos request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/brave/ai-mode/{request_id}
Retrieve a Brave AI Mode request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/duckduckgo/search/{request_id}
Retrieve a DuckDuckGo Search request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/duckduckgo/search/light/{request_id}
Retrieve a DuckDuckGo Light request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/duckduckgo/maps/search/{request_id}
Retrieve a DuckDuckGo Maps request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/duckduckgo/news/search/{request_id}
Retrieve a DuckDuckGo News request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/ebay/search/{request_id}
Retrieve a eBay Search request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/ebay/product/{request_id}
Retrieve a eBay Product request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/ebay/seller/{request_id}
Retrieve a eBay Seller request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/facebook/profile/{request_id}
Retrieve a Facebook Profile request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/home-depot/search/{request_id}
Retrieve a Home Depot Search request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/home-depot/product/{request_id}
Retrieve a Home Depot Product request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/home-depot/reviews/{request_id}
Retrieve a Home Depot Reviews request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/instagram/profile/{request_id}
Retrieve a Instagram Profile request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/naver/search/{request_id}
Retrieve a Naver Search request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/naver/ai-overview/{request_id}
Retrieve a Naver AI Overview request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/opentable/reviews/{request_id}
Retrieve a OpenTable Reviews request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/tripadvisor/search/{request_id}
Retrieve a Tripadvisor Search request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/tripadvisor/place/{request_id}
Retrieve a Tripadvisor Place request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/tripadvisor/reviews/{request_id}
Retrieve a Tripadvisor Reviews request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/walmart/search/{request_id}
Retrieve a Walmart Search request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/walmart/product/{request_id}
Retrieve a Walmart Product request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/walmart/reviews/{request_id}
Retrieve a Walmart Reviews request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/yahoo/search/{request_id}
Retrieve a Yahoo Search request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/yahoo/images/search/{request_id}
Retrieve a Yahoo Images request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/yahoo/videos/search/{request_id}
Retrieve a Yahoo Videos request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/yandex/search/{request_id}
Retrieve a Yandex Search request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/yandex/images/search/{request_id}
Retrieve a Yandex Images request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/yandex/videos/search/{request_id}
Retrieve a Yandex Videos request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/yelp/search/{request_id}
Retrieve a Yelp Business Lookup request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/yelp/place/{request_id}
Retrieve a Yelp Place request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/yelp/reviews/{request_id}
Retrieve a Yelp Reviews request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/youtube/search/{request_id}
Retrieve a YouTube Search request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/youtube/channel/{request_id}
Retrieve a YouTube Channel request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/youtube/video/{request_id}
Retrieve a YouTube Video request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse
GET /v1/zillow/search/{request_id}
Retrieve a Zillow Search request
Returns request metadata by default. Set `artifact=json` to download the parsed response or `artifact=html` to download the decoded source HTML as plain HTML. Google HTML artifacts reflect the original request’s `rewrite_links` setting. For a `zero_trace` request, no artifacts exist and the metadata response contains only type `ZERO_TRACE`, the request HTTP status code, and whether the account was charged.
Requires the x-api-key header.
Responses
- 200 — Request metadata or the selected archived artifact. Standard metadata includes data.is_mcp: true for MCP tool searches, false for direct API searches, or null for older records without attribution. Zero-trace metadata does not expose origin.
{
"success": true,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": {
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"is_mcp": true
}
}- 401 — The API token is missing, invalid, expired, or revoked.
{
"success": false,
"request_id": "66ca8deb-1dc2-4017-865f-c4fb0e3c7c0d",
"data": null,
"error": {
"code": "missing_api_key",
"message": "missing x-api-key"
}
}- 404 — The request or selected archive does not belong to this API key or is unavailable.
Schema: ErrorResponse
- 429 — The request-history rate limit was exceeded.
Schema: ErrorResponse