{ "openapi": "3.1.0", "x-zeroclick-navigation": { "fullSpec": "https://agents.openwebninja.com/zcj/wsqwtmip0rp5/openapi.json", "services": "https://agents.openwebninja.com/zcj/wsqwtmip0rp5/services", "serviceSpecTemplate": "https://agents.openwebninja.com/zcj/wsqwtmip0rp5/services/{slug}/openapi.json", "searchTemplate": "https://agents.openwebninja.com/zcj/wsqwtmip0rp5/openapi.json?q={text}", "operationTemplate": "https://agents.openwebninja.com/zcj/wsqwtmip0rp5/openapi.json?path={path}&method={method}", "firstPage": "https://agents.openwebninja.com/zcj/wsqwtmip0rp5/openapi.json?page=1", "instructions": [ "Use this spec if it contains the operation and details you need. Otherwise, search or open a relevant service spec using the links below.", "Find service slugs in x-zeroclick-services or x-payment-info.rates[].service; use them in serviceSpecTemplate, never as request values.", "URL-encode template values. Search is ranked; service, path, and method filters are exact. Filters combine.", "Pages contain up to 10 operations; follow info.x-next or the Link header if you need more results. Shared operations retain all selector values." ] }, "info": { "title": "OpenWeb Ninja", "version": "1.0.0", "description": "OpenWeb Ninja returns real-time public web data as JSON: Google search results and AI answers, local business listings and reviews from Google Maps and Yelp, job postings and salaries from LinkedIn, Indeed, Glassdoor, ZipRecruiter and Monster, product data from Amazon, Walmart, eBay, Costco, Wayfair and Home Depot, property listings from Zillow and Redfin, stock and currency data, news, events, images and videos. Each API is a service with its own routes, and each call is one request. This server is a transparent proxy in front of OpenWeb Ninja's own API that sells access on plans (credit or subscription) rather than per call: it handles identity, payment, and proxying. Agents can purchase autonomously or with their human's approval. The complete verified paid surface is listed at /openapi.json, the source of truth for available operations. Each operation here carries its pricing in x-payment-info. Use the operations and details here when they meet your needs. Filtered specs contain only matching operations; if you cannot find what you need here, use search or the service catalog. The live catalog at /manifest.json is authoritative for prices and any free included units (prices[].includedUnits) - some meters include free usage per account before any charge, reserved for agents claimed by a human with a verified email.", "contact": { "email": "support@openwebninja.com" }, "x-guidance": "Start with the free seller advisor: POST https://agents.openwebninja.com/zcj/wsqwtmip0rp5/zeroclick/agent/quote with your goal and known budget or requirements. This operation costs $0 and requires only an x402 or MPP wallet proof; it returns a guide and never executes a purchase. Without a wallet, GET https://agents.openwebninja.com/zcj/wsqwtmip0rp5/zeroclick/agent/guide?goal=URL_ENCODED_TASK or POST to that guide. Other operations below are the direct API reference; their own prices and access requirements still apply. Call the operations listed in this document at https://agents.openwebninja.com. Each service's full price matrix, plans, and how to buy are at https://agents.openwebninja.com/zcj/wsqwtmip0rp5/services/{slug}; each operation's x-payment-info names the service it bills by slug (rates[].service). Slugs identify services in prices and usage reports and are never request values: when one operation serves several services, its request body schema lists the accepted values of the field that selects the service, so send one of those exactly as written. Calls here are sold on plans, not per call: an unidentified call returns 401 bearer_required with a registration recipe, never a per-call 402. Reuse your existing agent identity; register only if new (anonymous registration is one free API call; the recipe is at https://agents.openwebninja.com/zcj/wsqwtmip0rp5/auth.md), buy a plan at POST https://agents.openwebninja.com/zcj/wsqwtmip0rp5/plans/{planId}/purchase (its priced 402 settles with a supported payment method - x402 (Base USDC) or MPP (Tempo USDC) today - or by card), then retry with Authorization: Bearer . No upstream API key is needed. Read GET https://agents.openwebninja.com/zcj/wsqwtmip0rp5/manifest.json for the live services, meters, plans, and prices, and https://agents.openwebninja.com/zcj/wsqwtmip0rp5/llms-full.txt for the full agent guide." }, "x-service-info": { "docs": { "homepage": "https://www.openwebninja.com", "apiReference": "https://agents.openwebninja.com/zcj/wsqwtmip0rp5/openapi.json", "llms": "https://agents.openwebninja.com/zcj/wsqwtmip0rp5/llms.txt" } }, "externalDocs": { "url": "https://agents.openwebninja.com/zcj/wsqwtmip0rp5/llms-full.txt", "description": "How to authenticate, pay, and call this API; links the upstream API reference." }, "servers": [ { "url": "https://agents.openwebninja.com/zcj/wsqwtmip0rp5", "description": "Plan-based access to OpenWeb Ninja's API" } ], "security": [ { "planAccess": [] } ], "components": { "securitySchemes": { "planAccess": { "type": "http", "scheme": "bearer", "description": "Plan access. Calls are sold on plans (credit or subscription), not per call: an unidentified call returns 401 bearer_required with a registration recipe, and an identified call with no covering plan returns 403 plan_required listing the plans that cover it. Reuse your existing agent identity; register only if new (anonymous registration is one free API call; the recipe is at https://agents.openwebninja.com/zcj/wsqwtmip0rp5/auth.md), buy a plan at POST https://agents.openwebninja.com/zcj/wsqwtmip0rp5/plans/{planId}/purchase (its priced 402 settles with a supported payment method - x402 or MPP today - or by card), then retry with the access token as Authorization: Bearer . No upstream API key is needed." }, "sellerAgentX402": { "type": "apiKey", "in": "header", "name": "Payment-Signature", "description": "Signed $0 x402 proof from the 402 challenge" }, "sellerAgentMpp": { "type": "http", "scheme": "Payment", "description": "Signed $0 MPP proof from the 402 challenge" } }, "schemas": { "sds_L_Fsr74jXxRwFrRFUiukT_5cadede568158cae_ref0": { "type": "object", "required": [ "job_id", "country", "language" ], "properties": { "fields": { "type": "string", "example": "job_title,job_description", "description": "The projection exactly as sent." }, "job_id": { "type": "string", "example": "YmluZzotNDYyNDU5MzAzLlJldHJv", "description": "The comma-separated id list exactly as sent." }, "country": { "type": "string", "example": "us", "description": "The country code used, lowercased." }, "language": { "type": "string", "example": "en", "description": "The language code used, lowercased. The primary language of `country` when none was sent." } }, "description": "Echo of the parameters the API used. `job_id`, `country` and `language` are always present; `fields` only when sent." }, "sds_L_Fsr74jXxRwFrRFUiukT_5cadede568158cae_ref1": { "type": "object", "required": [ "job_id", "job_title", "employer_name", "employer_logo", "employer_website", "job_publisher", "job_publishers", "job_employment_type", "job_employment_types", "job_apply_link", "job_apply_is_direct", "apply_options", "job_description", "job_is_remote", "job_posted_at", "job_posted_at_bing_label", "job_posted_at_timestamp", "job_posted_at_datetime_utc", "job_offer_expiration_timestamp", "job_offer_expiration_datetime_utc", "job_location", "job_city", "job_state", "job_country", "job_latitude", "job_longitude", "job_benefits", "job_benefits_strings", "job_google_link", "job_salary", "job_salary_string", "job_min_salary", "job_max_salary", "job_salary_period", "job_highlights", "job_onet_soc", "job_onet_job_zone", "employer_reviews", "job_uid", "job_normalized_title" ], "properties": { "job_id": { "type": "string", "example": "YmluZzotNDYyNDU5MzAzLlJldHJv", "description": "Opaque public id for the posting, `base64url('bing:' + )`. Pass it to `/job-details`. Stable for the life of the posting." }, "job_uid": { "type": "string", "example": "-462459303.Retro", "description": "Bing's own job id, for example `-462459303.Retro`. Accepted directly by `/job-details`." }, "industry": { "type": "string", "example": "Real Estate / Affordable Housing / Financial Services", "nullable": true, "description": "Industry of the employer, extracted by AI. `/job-details` only." }, "job_city": { "type": "string", "example": "New York", "nullable": true, "description": "The first part of `job_location`. `null` on a fully-remote `Anywhere` posting. On `/job-details` an empty city can be filled by AI enrichment." }, "job_state": { "type": "string", "example": "New York", "nullable": true, "description": "The last part of `job_location`, with US state codes expanded to the full name (`DC` becomes `District of Columbia`). `null` when the location has one part. On `/job-details` an empty state can be filled by AI enrichment." }, "job_title": { "type": "string", "example": "Application Developer", "nullable": true, "description": "The job title as posted." }, "job_salary": { "type": "number", "example": null, "nullable": true, "description": "Always `null`. Bing publishes no salary field." }, "start_date": { "type": "string", "example": "ASAP", "nullable": true, "description": "Expected start date if stated, extracted by AI. `/job-details` only." }, "job_country": { "type": "string", "example": "US", "nullable": true, "description": "Uppercase ISO 3166-1 alpha-2 country code, taken from the location where it names a country (`London, England` is `GB`) and otherwise the requested `country`." }, "soft_skills": { "type": "array", "items": { "type": "string" }, "example": [ "analytical skills", "collaboration" ], "nullable": true, "description": "Soft skills the posting asks for, extracted by AI. `/job-details` only." }, "job_benefits": { "type": "array", "items": { "type": "string" }, "example": null, "nullable": true, "description": "Always `null`. Bing publishes benefits only as display text, in `job_benefits_strings`." }, "job_function": { "enum": [ "backend", "frontend", "full-stack", "mobile", "devops", "data-engineering", "ml-ai", "systems", "qa", "security", "other", null ], "type": "string", "example": "full-stack", "nullable": true, "description": "Technical function of the role, extracted by AI. `/job-details` only." }, "job_latitude": { "type": "number", "example": null, "nullable": true, "description": "Always `null`. Bing publishes no coordinates." }, "job_location": { "type": "string", "example": "New York, NY", "nullable": true, "description": "Location as Bing displays it, for example `New York, NY`, `London, England` or `Anywhere, CA` for a fully-remote posting." }, "job_onet_soc": { "type": "string", "example": null, "nullable": true, "description": "Always `null`. Bing publishes no O*NET occupation code." }, "job_position": { "type": "integer", "example": 1, "nullable": true, "description": "0-based rank of the posting in Bing's full result list, not within the page. Ranks of removed repeats are skipped, so gaps can occur. `/search` only." }, "apply_options": { "type": "array", "items": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_5cadede568158cae_ref2" }, "description": "Every board carrying the posting, with its apply link. One entry on 101 of 110 measured jobs, up to 4. Empty on `/search` when `include_descriptions=false`." }, "employer_logo": { "type": "string", "format": "uri", "example": "https://th.bing.com/th/id/OJA.39482811NS?w=24&h=24&o=6&pid=JobAns", "nullable": true, "description": "The employer's logo, a 24x24 thumbnail from Bing's own image CDN. When Bing has none, it can fall back to a favicon of the employer domain in the apply link." }, "employer_name": { "type": "string", "example": "New York City Housing Development Corporation", "nullable": true, "description": "Name of the hiring company." }, "job_is_remote": { "type": "boolean", "example": false, "description": "`true` when Bing marks the posting fully remote, with an `Anywhere` location or a `Remote` or `Work from home` marker on the location line. Always a boolean." }, "job_longitude": { "type": "number", "example": null, "nullable": true, "description": "Always `null`. Bing publishes no coordinates." }, "job_posted_at": { "type": "string", "example": "30 days ago", "nullable": true, "description": "Relative posting age in JSearch's vocabulary: `today`, `1 day ago`, `N days ago` up to 30, then `N month(s) ago`. Derived from `job_posted_at_timestamp`, falling back to Bing's badge when there is none." }, "job_publisher": { "type": "string", "example": "LinkedIn", "nullable": true, "description": "Display name of the board this posting was found on. Values measured: `LinkedIn`, `ZipRecruiter`, `CareerBuilder`, `Jobrapido`, `Glassdoor`, `Monster`, `Adzuna`." }, "methodologies": { "type": "array", "items": { "type": "string" }, "example": [ "Agile", "CI/CD" ], "nullable": true, "description": "Development methodologies mentioned, extracted by AI. `/job-details` only." }, "ai_ml_involved": { "type": "boolean", "example": false, "nullable": true, "description": "Whether the role involves AI or ML work, extracted by AI. `/job-details` only." }, "job_apply_link": { "type": "string", "format": "uri", "example": "https://www.linkedin.com/jobs/view/application-developer-at-new-york-city-housing-development-corporation-4452278514?trk=bingjobs", "nullable": true, "description": "The first apply link, equal to `apply_options[0].apply_link`. On `/search` it is `null` when `include_descriptions=false`, because Bing's search cards carry no apply link." }, "job_highlights": { "type": "object", "example": {}, "description": "Always `{}`. Bing publishes the description as a single block, and the key is kept for JSearch shape parity.", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "job_max_salary": { "type": "number", "example": 125000, "nullable": true, "description": "Top of the salary range, in the `job_salary_period` unit. `null` on `/search`. On `/job-details`, extracted by AI from the description when it states pay." }, "job_min_salary": { "type": "number", "example": 115000, "nullable": true, "description": "Bottom of the salary range, in the `job_salary_period` unit. `null` on `/search`. On `/job-details`, extracted by AI from the description when it states pay." }, "job_publishers": { "type": "array", "items": { "type": "string" }, "example": [ "LinkedIn" ], "nullable": true, "description": "Every board Bing knows to carry this posting, including the one named in `job_publisher`. One entry on 101 of 110 measured jobs, up to 4." }, "job_description": { "type": "string", "example": "The New York City Housing Development Corporation (HDC) is a public benefit corporation ...", "nullable": true, "description": "The full job description as plain text, with paragraph and list breaks kept. On `/search` it is fetched from each job's detail page, and is `null` with `include_descriptions=false`, past the 100-job cap, or when that fetch failed. Measured lengths: 471 to 7,359 characters." }, "job_google_link": { "type": "string", "example": null, "nullable": true, "description": "Always `null`. Kept for JSearch shape parity." }, "seniority_level": { "enum": [ "entry", "mid", "senior", "principal", "lead", "manager", null ], "type": "string", "example": "mid", "nullable": true, "description": "Seniority level, extracted by AI. `/job-details` only." }, "employer_reviews": { "type": "array", "items": { "type": "object" }, "example": null, "nullable": true, "description": "Always `null`. Bing publishes no employer reviews." }, "employer_website": { "type": "string", "example": null, "nullable": true, "description": "Always `null`. Bing publishes no employer website." }, "visa_sponsorship": { "type": "boolean", "example": null, "nullable": true, "description": "Whether visa sponsorship is offered, extracted by AI. `/job-details` only." }, "work_arrangement": { "enum": [ "onsite", "remote", "hybrid", null ], "type": "string", "example": "onsite", "nullable": true, "description": "Work arrangement, extracted by AI. `/job-details` only." }, "benefits_extended": { "type": "array", "items": { "type": "string" }, "example": [ "Health Benefits", "Pension plan", "Paid parental leave" ], "nullable": true, "description": "Benefits named in the description, extracted by AI. `/job-details` only." }, "contract_duration": { "type": "string", "example": "6 weeks", "nullable": true, "description": "Duration of a contract role, extracted by AI. `/job-details` only." }, "job_bing_title_id": { "type": "string", "example": "231", "nullable": true, "description": "Bing's internal normalized-title id. `/search` only." }, "job_onet_job_zone": { "type": "string", "example": null, "nullable": true, "description": "Always `null`. Bing publishes no O*NET job zone." }, "job_salary_period": { "enum": [ "YEAR", "MONTH", "HOUR", null ], "type": "string", "example": "YEAR", "nullable": true, "description": "The period the salary figures are expressed in. `null` on `/search`. On `/job-details`, extracted by AI alongside the figures." }, "job_salary_string": { "type": "string", "example": null, "nullable": true, "description": "Always `null`. Bing publishes no salary field." }, "education_required": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_5cadede568158cae_ref3" }, "job_apply_is_direct": { "type": "boolean", "example": false, "description": "Always `false`. Bing reports only which board an apply link points at." }, "job_bing_company_id": { "type": "string", "example": "90994", "nullable": true, "description": "Bing's internal company id. `/search` only." }, "job_employment_type": { "type": "string", "example": "Full-time", "nullable": true, "description": "Employment type as Bing labels it, verbatim, for example `Full-time` or `Contract`. The normalized values are in `job_employment_types`." }, "relocation_required": { "type": "boolean", "example": null, "nullable": true, "description": "Whether relocation is required, extracted by AI. `/job-details` only." }, "job_benefits_strings": { "type": "array", "items": { "type": "string" }, "example": [ "Health Insurance", "Dental Insurance" ], "nullable": true, "description": "Benefit chips as Bing displays them, for example `Health Insurance`. A search card shows only the first few chips; `/job-details` returns the full list. `null` when Bing shows none." }, "job_employment_types": { "type": "array", "items": { "enum": [ "FULLTIME", "PARTTIME", "CONTRACTOR", "INTERN" ], "type": "string" }, "example": [ "FULLTIME" ], "description": "Normalized employment types. Bing's `Temporary` is reported as `CONTRACTOR`. An empty array when Bing states no type." }, "job_normalized_title": { "type": "string", "example": "application developer", "nullable": true, "description": "Bing's normalized, lowercased form of the job title." }, "relocation_assistance": { "type": "boolean", "example": null, "nullable": true, "description": "Whether relocation assistance is provided, extracted by AI. `/job-details` only." }, "required_technologies": { "type": "array", "items": { "type": "string" }, "example": [ "C#", ".NET", "SQL" ], "nullable": true, "description": "Required technologies and tools, extracted by AI. `/job-details` only." }, "preferred_technologies": { "type": "array", "items": { "type": "string" }, "example": [ "Azure DevOps", "Microsoft Azure" ], "nullable": true, "description": "Preferred technologies, extracted by AI. `/job-details` only." }, "job_posted_at_timestamp": { "type": "integer", "example": 1786962780, "nullable": true, "description": "Unix epoch seconds of the posting date, from Bing's own record. Midnight UTC where Bing published a bare date, 41 of 110 measured jobs." }, "job_posted_at_bing_label": { "type": "string", "example": "30 days ago", "nullable": true, "description": "Bing's posted-date badge, verbatim, for example `30 days ago` or `July 23`. Kept separate from `job_posted_at` because Bing mixes relative and absolute forms." }, "required_experience_years": { "type": "number", "example": 4, "nullable": true, "description": "Minimum years of experience required, extracted by AI. Can be fractional, for example `0.5`. `/job-details` only." }, "job_posted_at_datetime_utc": { "type": "string", "format": "date-time", "example": "2026-08-17T10:33:00.000Z", "nullable": true, "description": "ISO 8601 UTC form of `job_posted_at_timestamp`." }, "job_offer_expiration_timestamp": { "type": "integer", "example": 1789554780, "nullable": true, "description": "Unix epoch seconds at which Bing expires the posting." }, "has_management_responsibilities": { "type": "boolean", "example": false, "nullable": true, "description": "Whether the role manages or mentors others, extracted by AI. `/job-details` only." }, "job_offer_expiration_datetime_utc": { "type": "string", "format": "date-time", "example": "2026-09-16T10:33:00.000Z", "nullable": true, "description": "ISO 8601 UTC form of `job_offer_expiration_timestamp`." } }, "description": "A Bing job posting, a superset of the 35-key JSearch `/search` contract. `/search` returns the full set in a fixed order, three keys of it (`job_bing_company_id`, `job_bing_title_id`, `job_position`) search-only. `/job-details` returns the rest plus the AI-extracted fields. A key with no value is `null`, `[]` or `{}`, unless narrowed by the `fields` projection." }, "sds_L_Fsr74jXxRwFrRFUiukT_5cadede568158cae_ref2": { "type": "object", "required": [ "apply_link", "is_direct", "publisher" ], "properties": { "is_direct": { "type": "boolean", "example": false, "description": "Always `false`. Bing reports only which board a link points at." }, "publisher": { "type": "string", "example": "LinkedIn", "nullable": true, "description": "Display name of the board, derived from the link's hostname, for example `LinkedIn`, `ZipRecruiter` or `CareerBuilder`." }, "apply_link": { "type": "string", "format": "uri", "example": "https://www.linkedin.com/jobs/view/application-developer-at-new-york-city-housing-development-corporation-4452278514?trk=bingjobs", "description": "The apply URL on this board." } }, "description": "One board carrying this posting, with its apply link. Bing's `bing.com/ck/a` tracking redirect is decoded, so the link is the board's own URL." }, "sds_L_Fsr74jXxRwFrRFUiukT_5cadede568158cae_ref3": { "type": "object", "required": [ "level", "field" ], "properties": { "field": { "type": "string", "example": "Computer Science, Information Systems, or a related field", "nullable": true, "description": "Required field of study. `null` when the description states none." }, "level": { "enum": [ "high_school", "bachelor", "master", "phd", null ], "type": "string", "example": "bachelor", "nullable": true, "description": "Required degree level. `null` when the description states none." } }, "description": "Education the posting requires, extracted by AI from the description. `/job-details` only." }, "sds_L_Fsr74jXxRwFrRFUiukT_5cadede568158cae_ref4": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_5cadede568158cae_ref5" } } }, "description": "Invalid or missing parameter." }, "sds_L_Fsr74jXxRwFrRFUiukT_5cadede568158cae_ref5": { "type": "object", "required": [ "status", "request_id", "error" ], "properties": { "error": { "type": "object", "required": [ "message", "code" ], "properties": { "code": { "type": "integer", "example": 400, "description": "The HTTP status code, repeated in the body." }, "message": { "type": "string", "example": "Missing query. The 'query' parameter is required.", "description": "Human-readable description of what was wrong with the request." } } }, "status": { "enum": [ "ERROR" ], "type": "string", "example": "ERROR", "description": "Always `ERROR` on a failed request." }, "request_id": { "type": "string", "example": "92680c13-601d-4faf-9468-40e26249948a", "description": "Unique id for this request, for tracing and support." } } }, "sds_L_Fsr74jXxRwFrRFUiukT_5cadede568158cae_ref6": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_5cadede568158cae_ref5" } } }, "description": "Missing or invalid API key." }, "sds_L_Fsr74jXxRwFrRFUiukT_5cadede568158cae_ref7": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_5cadede568158cae_ref5" } } }, "description": "Not subscribed to this API." }, "sds_L_Fsr74jXxRwFrRFUiukT_5cadede568158cae_ref8": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_5cadede568158cae_ref5" } } }, "description": "Unknown route." }, "sds_L_Fsr74jXxRwFrRFUiukT_5cadede568158cae_ref9": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_5cadede568158cae_ref5" } } }, "description": "Quota exhausted." }, "sds_L_Fsr74jXxRwFrRFUiukT_5cadede568158cae_ref10": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_5cadede568158cae_ref5" } } }, "description": "Unexpected error." }, "sds_L_Fsr74jXxRwFrRFUiukT_5cadede568158cae_ref11": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_5cadede568158cae_ref5" } } }, "description": "Bing could not be reached for this request. Retry; the request is not billed.\n\nA successful search that found no matches is a `200` with `data: []`." }, "sds_L_Fsr74jXxRwFrRFUiukT_5c14de8d6e9d3e66_ref0": { "type": "object", "required": [ "query", "page", "num_pages", "include_descriptions", "country", "language" ], "properties": { "page": { "type": "integer", "example": 1, "description": "The page the response starts at." }, "query": { "type": "string", "example": "developer jobs in new york", "description": "The search query, trimmed, before *jobs* is appended." }, "fields": { "type": "string", "example": "job_title,employer_name", "description": "The projection exactly as sent." }, "radius": { "type": "number", "example": 32, "description": "The radius in kilometres as sent, before conversion to miles. Absent when `0`." }, "country": { "type": "string", "example": "us", "description": "The country code used, lowercased." }, "language": { "type": "string", "example": "en", "description": "The language code used, lowercased. The primary language of `country` when none was sent." }, "location": { "type": "string", "example": "New York, NY", "description": "The location as sent, trimmed." }, "num_pages": { "type": "integer", "example": 1, "description": "The number of pages requested." }, "date_posted": { "enum": [ "all", "today", "3days", "week", "month" ], "type": "string", "example": "week", "description": "The date window exactly as sent, `all` included." }, "work_from_home": { "type": "boolean", "example": true, "description": "`true` when `true` or `1` was sent, otherwise `false`." }, "employment_types": { "type": "array", "items": { "enum": [ "FULLTIME", "CONTRACTOR", "PARTTIME", "INTERN" ], "type": "string" }, "example": [ "FULLTIME", "CONTRACTOR" ], "description": "The employment types as sent, split on commas and uppercased." }, "include_descriptions": { "type": "boolean", "example": true, "description": "Whether descriptions were fetched. `false` only when `false` or `0` was sent." }, "exclude_job_publishers": { "type": "array", "items": { "type": "string" }, "example": [ "linkedin", "indeed" ], "description": "The excluded publishers as sent, split on commas and lowercased." } }, "description": "Echo of the parameters the API used. `query`, `page`, `num_pages`, `include_descriptions`, `country` and `language` are always present with the value actually used, after defaults are applied. The others are present only when sent." }, "sds_L_Fsr74jXxRwFrRFUiukT_5c14de8d6e9d3e66_ref1": { "type": "object", "required": [ "job_id", "job_title", "employer_name", "employer_logo", "employer_website", "job_publisher", "job_publishers", "job_employment_type", "job_employment_types", "job_apply_link", "job_apply_is_direct", "apply_options", "job_description", "job_is_remote", "job_posted_at", "job_posted_at_bing_label", "job_posted_at_timestamp", "job_posted_at_datetime_utc", "job_offer_expiration_timestamp", "job_offer_expiration_datetime_utc", "job_location", "job_city", "job_state", "job_country", "job_latitude", "job_longitude", "job_benefits", "job_benefits_strings", "job_google_link", "job_salary", "job_salary_string", "job_min_salary", "job_max_salary", "job_salary_period", "job_highlights", "job_onet_soc", "job_onet_job_zone", "employer_reviews", "job_uid", "job_normalized_title" ], "properties": { "job_id": { "type": "string", "example": "YmluZzotNDYyNDU5MzAzLlJldHJv", "description": "Opaque public id for the posting, `base64url('bing:' + )`. Pass it to `/job-details`. Stable for the life of the posting." }, "job_uid": { "type": "string", "example": "-462459303.Retro", "description": "Bing's own job id, for example `-462459303.Retro`. Accepted directly by `/job-details`." }, "industry": { "type": "string", "example": "Real Estate / Affordable Housing / Financial Services", "nullable": true, "description": "Industry of the employer, extracted by AI. `/job-details` only." }, "job_city": { "type": "string", "example": "New York", "nullable": true, "description": "The first part of `job_location`. `null` on a fully-remote `Anywhere` posting. On `/job-details` an empty city can be filled by AI enrichment." }, "job_state": { "type": "string", "example": "New York", "nullable": true, "description": "The last part of `job_location`, with US state codes expanded to the full name (`DC` becomes `District of Columbia`). `null` when the location has one part. On `/job-details` an empty state can be filled by AI enrichment." }, "job_title": { "type": "string", "example": "Application Developer", "nullable": true, "description": "The job title as posted." }, "job_salary": { "type": "number", "example": null, "nullable": true, "description": "Always `null`. Bing publishes no salary field." }, "start_date": { "type": "string", "example": "ASAP", "nullable": true, "description": "Expected start date if stated, extracted by AI. `/job-details` only." }, "job_country": { "type": "string", "example": "US", "nullable": true, "description": "Uppercase ISO 3166-1 alpha-2 country code, taken from the location where it names a country (`London, England` is `GB`) and otherwise the requested `country`." }, "soft_skills": { "type": "array", "items": { "type": "string" }, "example": [ "analytical skills", "collaboration" ], "nullable": true, "description": "Soft skills the posting asks for, extracted by AI. `/job-details` only." }, "job_benefits": { "type": "array", "items": { "type": "string" }, "example": null, "nullable": true, "description": "Always `null`. Bing publishes benefits only as display text, in `job_benefits_strings`." }, "job_function": { "enum": [ "backend", "frontend", "full-stack", "mobile", "devops", "data-engineering", "ml-ai", "systems", "qa", "security", "other", null ], "type": "string", "example": "full-stack", "nullable": true, "description": "Technical function of the role, extracted by AI. `/job-details` only." }, "job_latitude": { "type": "number", "example": null, "nullable": true, "description": "Always `null`. Bing publishes no coordinates." }, "job_location": { "type": "string", "example": "New York, NY", "nullable": true, "description": "Location as Bing displays it, for example `New York, NY`, `London, England` or `Anywhere, CA` for a fully-remote posting." }, "job_onet_soc": { "type": "string", "example": null, "nullable": true, "description": "Always `null`. Bing publishes no O*NET occupation code." }, "job_position": { "type": "integer", "example": 1, "nullable": true, "description": "0-based rank of the posting in Bing's full result list, not within the page. Ranks of removed repeats are skipped, so gaps can occur. `/search` only." }, "apply_options": { "type": "array", "items": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_5c14de8d6e9d3e66_ref2" }, "description": "Every board carrying the posting, with its apply link. One entry on 101 of 110 measured jobs, up to 4. Empty on `/search` when `include_descriptions=false`." }, "employer_logo": { "type": "string", "format": "uri", "example": "https://th.bing.com/th/id/OJA.39482811NS?w=24&h=24&o=6&pid=JobAns", "nullable": true, "description": "The employer's logo, a 24x24 thumbnail from Bing's own image CDN. When Bing has none, it can fall back to a favicon of the employer domain in the apply link." }, "employer_name": { "type": "string", "example": "New York City Housing Development Corporation", "nullable": true, "description": "Name of the hiring company." }, "job_is_remote": { "type": "boolean", "example": false, "description": "`true` when Bing marks the posting fully remote, with an `Anywhere` location or a `Remote` or `Work from home` marker on the location line. Always a boolean." }, "job_longitude": { "type": "number", "example": null, "nullable": true, "description": "Always `null`. Bing publishes no coordinates." }, "job_posted_at": { "type": "string", "example": "30 days ago", "nullable": true, "description": "Relative posting age in JSearch's vocabulary: `today`, `1 day ago`, `N days ago` up to 30, then `N month(s) ago`. Derived from `job_posted_at_timestamp`, falling back to Bing's badge when there is none." }, "job_publisher": { "type": "string", "example": "LinkedIn", "nullable": true, "description": "Display name of the board this posting was found on. Values measured: `LinkedIn`, `ZipRecruiter`, `CareerBuilder`, `Jobrapido`, `Glassdoor`, `Monster`, `Adzuna`." }, "methodologies": { "type": "array", "items": { "type": "string" }, "example": [ "Agile", "CI/CD" ], "nullable": true, "description": "Development methodologies mentioned, extracted by AI. `/job-details` only." }, "ai_ml_involved": { "type": "boolean", "example": false, "nullable": true, "description": "Whether the role involves AI or ML work, extracted by AI. `/job-details` only." }, "job_apply_link": { "type": "string", "format": "uri", "example": "https://www.linkedin.com/jobs/view/application-developer-at-new-york-city-housing-development-corporation-4452278514?trk=bingjobs", "nullable": true, "description": "The first apply link, equal to `apply_options[0].apply_link`. On `/search` it is `null` when `include_descriptions=false`, because Bing's search cards carry no apply link." }, "job_highlights": { "type": "object", "example": {}, "description": "Always `{}`. Bing publishes the description as a single block, and the key is kept for JSearch shape parity.", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "job_max_salary": { "type": "number", "example": 125000, "nullable": true, "description": "Top of the salary range, in the `job_salary_period` unit. `null` on `/search`. On `/job-details`, extracted by AI from the description when it states pay." }, "job_min_salary": { "type": "number", "example": 115000, "nullable": true, "description": "Bottom of the salary range, in the `job_salary_period` unit. `null` on `/search`. On `/job-details`, extracted by AI from the description when it states pay." }, "job_publishers": { "type": "array", "items": { "type": "string" }, "example": [ "LinkedIn" ], "nullable": true, "description": "Every board Bing knows to carry this posting, including the one named in `job_publisher`. One entry on 101 of 110 measured jobs, up to 4." }, "job_description": { "type": "string", "example": "The New York City Housing Development Corporation (HDC) is a public benefit corporation ...", "nullable": true, "description": "The full job description as plain text, with paragraph and list breaks kept. On `/search` it is fetched from each job's detail page, and is `null` with `include_descriptions=false`, past the 100-job cap, or when that fetch failed. Measured lengths: 471 to 7,359 characters." }, "job_google_link": { "type": "string", "example": null, "nullable": true, "description": "Always `null`. Kept for JSearch shape parity." }, "seniority_level": { "enum": [ "entry", "mid", "senior", "principal", "lead", "manager", null ], "type": "string", "example": "mid", "nullable": true, "description": "Seniority level, extracted by AI. `/job-details` only." }, "employer_reviews": { "type": "array", "items": { "type": "object" }, "example": null, "nullable": true, "description": "Always `null`. Bing publishes no employer reviews." }, "employer_website": { "type": "string", "example": null, "nullable": true, "description": "Always `null`. Bing publishes no employer website." }, "visa_sponsorship": { "type": "boolean", "example": null, "nullable": true, "description": "Whether visa sponsorship is offered, extracted by AI. `/job-details` only." }, "work_arrangement": { "enum": [ "onsite", "remote", "hybrid", null ], "type": "string", "example": "onsite", "nullable": true, "description": "Work arrangement, extracted by AI. `/job-details` only." }, "benefits_extended": { "type": "array", "items": { "type": "string" }, "example": [ "Health Benefits", "Pension plan", "Paid parental leave" ], "nullable": true, "description": "Benefits named in the description, extracted by AI. `/job-details` only." }, "contract_duration": { "type": "string", "example": "6 weeks", "nullable": true, "description": "Duration of a contract role, extracted by AI. `/job-details` only." }, "job_bing_title_id": { "type": "string", "example": "231", "nullable": true, "description": "Bing's internal normalized-title id. `/search` only." }, "job_onet_job_zone": { "type": "string", "example": null, "nullable": true, "description": "Always `null`. Bing publishes no O*NET job zone." }, "job_salary_period": { "enum": [ "YEAR", "MONTH", "HOUR", null ], "type": "string", "example": "YEAR", "nullable": true, "description": "The period the salary figures are expressed in. `null` on `/search`. On `/job-details`, extracted by AI alongside the figures." }, "job_salary_string": { "type": "string", "example": null, "nullable": true, "description": "Always `null`. Bing publishes no salary field." }, "education_required": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_5c14de8d6e9d3e66_ref3" }, "job_apply_is_direct": { "type": "boolean", "example": false, "description": "Always `false`. Bing reports only which board an apply link points at." }, "job_bing_company_id": { "type": "string", "example": "90994", "nullable": true, "description": "Bing's internal company id. `/search` only." }, "job_employment_type": { "type": "string", "example": "Full-time", "nullable": true, "description": "Employment type as Bing labels it, verbatim, for example `Full-time` or `Contract`. The normalized values are in `job_employment_types`." }, "relocation_required": { "type": "boolean", "example": null, "nullable": true, "description": "Whether relocation is required, extracted by AI. `/job-details` only." }, "job_benefits_strings": { "type": "array", "items": { "type": "string" }, "example": [ "Health Insurance", "Dental Insurance" ], "nullable": true, "description": "Benefit chips as Bing displays them, for example `Health Insurance`. A search card shows only the first few chips; `/job-details` returns the full list. `null` when Bing shows none." }, "job_employment_types": { "type": "array", "items": { "enum": [ "FULLTIME", "PARTTIME", "CONTRACTOR", "INTERN" ], "type": "string" }, "example": [ "FULLTIME" ], "description": "Normalized employment types. Bing's `Temporary` is reported as `CONTRACTOR`. An empty array when Bing states no type." }, "job_normalized_title": { "type": "string", "example": "application developer", "nullable": true, "description": "Bing's normalized, lowercased form of the job title." }, "relocation_assistance": { "type": "boolean", "example": null, "nullable": true, "description": "Whether relocation assistance is provided, extracted by AI. `/job-details` only." }, "required_technologies": { "type": "array", "items": { "type": "string" }, "example": [ "C#", ".NET", "SQL" ], "nullable": true, "description": "Required technologies and tools, extracted by AI. `/job-details` only." }, "preferred_technologies": { "type": "array", "items": { "type": "string" }, "example": [ "Azure DevOps", "Microsoft Azure" ], "nullable": true, "description": "Preferred technologies, extracted by AI. `/job-details` only." }, "job_posted_at_timestamp": { "type": "integer", "example": 1786962780, "nullable": true, "description": "Unix epoch seconds of the posting date, from Bing's own record. Midnight UTC where Bing published a bare date, 41 of 110 measured jobs." }, "job_posted_at_bing_label": { "type": "string", "example": "30 days ago", "nullable": true, "description": "Bing's posted-date badge, verbatim, for example `30 days ago` or `July 23`. Kept separate from `job_posted_at` because Bing mixes relative and absolute forms." }, "required_experience_years": { "type": "number", "example": 4, "nullable": true, "description": "Minimum years of experience required, extracted by AI. Can be fractional, for example `0.5`. `/job-details` only." }, "job_posted_at_datetime_utc": { "type": "string", "format": "date-time", "example": "2026-08-17T10:33:00.000Z", "nullable": true, "description": "ISO 8601 UTC form of `job_posted_at_timestamp`." }, "job_offer_expiration_timestamp": { "type": "integer", "example": 1789554780, "nullable": true, "description": "Unix epoch seconds at which Bing expires the posting." }, "has_management_responsibilities": { "type": "boolean", "example": false, "nullable": true, "description": "Whether the role manages or mentors others, extracted by AI. `/job-details` only." }, "job_offer_expiration_datetime_utc": { "type": "string", "format": "date-time", "example": "2026-09-16T10:33:00.000Z", "nullable": true, "description": "ISO 8601 UTC form of `job_offer_expiration_timestamp`." } }, "description": "A Bing job posting, a superset of the 35-key JSearch `/search` contract. `/search` returns the full set in a fixed order, three keys of it (`job_bing_company_id`, `job_bing_title_id`, `job_position`) search-only. `/job-details` returns the rest plus the AI-extracted fields. A key with no value is `null`, `[]` or `{}`, unless narrowed by the `fields` projection." }, "sds_L_Fsr74jXxRwFrRFUiukT_5c14de8d6e9d3e66_ref2": { "type": "object", "required": [ "apply_link", "is_direct", "publisher" ], "properties": { "is_direct": { "type": "boolean", "example": false, "description": "Always `false`. Bing reports only which board a link points at." }, "publisher": { "type": "string", "example": "LinkedIn", "nullable": true, "description": "Display name of the board, derived from the link's hostname, for example `LinkedIn`, `ZipRecruiter` or `CareerBuilder`." }, "apply_link": { "type": "string", "format": "uri", "example": "https://www.linkedin.com/jobs/view/application-developer-at-new-york-city-housing-development-corporation-4452278514?trk=bingjobs", "description": "The apply URL on this board." } }, "description": "One board carrying this posting, with its apply link. Bing's `bing.com/ck/a` tracking redirect is decoded, so the link is the board's own URL." }, "sds_L_Fsr74jXxRwFrRFUiukT_5c14de8d6e9d3e66_ref3": { "type": "object", "required": [ "level", "field" ], "properties": { "field": { "type": "string", "example": "Computer Science, Information Systems, or a related field", "nullable": true, "description": "Required field of study. `null` when the description states none." }, "level": { "enum": [ "high_school", "bachelor", "master", "phd", null ], "type": "string", "example": "bachelor", "nullable": true, "description": "Required degree level. `null` when the description states none." } }, "description": "Education the posting requires, extracted by AI from the description. `/job-details` only." }, "sds_L_Fsr74jXxRwFrRFUiukT_5c14de8d6e9d3e66_ref4": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_5c14de8d6e9d3e66_ref5" } } }, "description": "Invalid or missing parameter." }, "sds_L_Fsr74jXxRwFrRFUiukT_5c14de8d6e9d3e66_ref5": { "type": "object", "required": [ "status", "request_id", "error" ], "properties": { "error": { "type": "object", "required": [ "message", "code" ], "properties": { "code": { "type": "integer", "example": 400, "description": "The HTTP status code, repeated in the body." }, "message": { "type": "string", "example": "Missing query. The 'query' parameter is required.", "description": "Human-readable description of what was wrong with the request." } } }, "status": { "enum": [ "ERROR" ], "type": "string", "example": "ERROR", "description": "Always `ERROR` on a failed request." }, "request_id": { "type": "string", "example": "92680c13-601d-4faf-9468-40e26249948a", "description": "Unique id for this request, for tracing and support." } } }, "sds_L_Fsr74jXxRwFrRFUiukT_5c14de8d6e9d3e66_ref6": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_5c14de8d6e9d3e66_ref5" } } }, "description": "Missing or invalid API key." }, "sds_L_Fsr74jXxRwFrRFUiukT_5c14de8d6e9d3e66_ref7": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_5c14de8d6e9d3e66_ref5" } } }, "description": "Not subscribed to this API." }, "sds_L_Fsr74jXxRwFrRFUiukT_5c14de8d6e9d3e66_ref8": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_5c14de8d6e9d3e66_ref5" } } }, "description": "Unknown route." }, "sds_L_Fsr74jXxRwFrRFUiukT_5c14de8d6e9d3e66_ref9": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_5c14de8d6e9d3e66_ref5" } } }, "description": "Quota exhausted." }, "sds_L_Fsr74jXxRwFrRFUiukT_5c14de8d6e9d3e66_ref10": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_5c14de8d6e9d3e66_ref5" } } }, "description": "Unexpected error." }, "sds_L_Fsr74jXxRwFrRFUiukT_5c14de8d6e9d3e66_ref11": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_5c14de8d6e9d3e66_ref5" } } }, "description": "Bing could not be reached for this request. Retry; the request is not billed.\n\nA successful search that found no matches is a `200` with `data: []`." }, "sds_L_Fsr74jXxRwFrRFUiukT_d41aad9c952cdb08_ref0": { "type": "object", "required": [ "query", "page", "country", "language", "size", "color", "type", "aspect_ratio", "people", "time_period", "usage_rights", "safe_search" ], "properties": { "page": { "type": "integer", "example": 1, "description": "The page returned." }, "size": { "enum": [ "any", "small", "medium", "large", "wallpaper" ], "type": "string", "example": "any", "description": "The size filter used, lowercased. `any` when none was sent." }, "type": { "enum": [ "any", "photo", "clipart", "lineart", "animated", "transparent" ], "type": "string", "example": "any", "description": "The image type filter used, lowercased. `any` when none was sent." }, "color": { "enum": [ "any", "full", "grayscale", "red", "orange", "yellow", "green", "teal", "blue", "purple", "pink", "brown", "black", "gray", "white" ], "type": "string", "example": "any", "description": "The color filter used, lowercased. `any` when none was sent." }, "query": { "type": "string", "example": "golden retriever puppy", "description": "The search query, trimmed." }, "people": { "enum": [ "any", "face", "portrait" ], "type": "string", "example": "any", "description": "The people filter used, lowercased. `any` when none was sent." }, "country": { "type": "string", "example": "us", "description": "The country code used, lowercased." }, "language": { "type": "string", "example": "en", "description": "The language code used, lowercased." }, "safe_search": { "enum": [ "off", "moderate", "strict" ], "type": "string", "example": "off", "description": "The safe search level used, lowercased." }, "time_period": { "enum": [ "any", "last_day", "last_week", "last_month", "last_year" ], "type": "string", "example": "any", "description": "The time period filter used, lowercased. `any` when none was sent." }, "aspect_ratio": { "enum": [ "any", "square", "wide", "tall" ], "type": "string", "example": "any", "description": "The aspect ratio filter used, lowercased. `any` when none was sent." }, "usage_rights": { "enum": [ "any", "creative_commons", "public_domain", "free_to_share", "free_to_share_commercially", "free_to_modify", "free_to_modify_commercially" ], "type": "string", "example": "any", "description": "The usage rights filter used, lowercased. `any` when none was sent." } }, "description": "Echo of the parameters the API used. Every key is always present with the value actually used, after defaults are applied." }, "sds_L_Fsr74jXxRwFrRFUiukT_d41aad9c952cdb08_ref1": { "type": "object", "required": [ "id", "title", "url", "width", "height", "background_color", "thumbnail_url", "thumbnail_width", "thumbnail_height", "source", "source_url", "source_domain", "position" ], "properties": { "id": { "type": "string", "example": "544223E9FF2A807E45815A7113F6B10EAA10C71E", "nullable": true, "description": "Bing's id for the image, a 40-character hex string. Filled on every image measured." }, "url": { "type": "string", "example": "https://getwallpapers.com/wallpaper/full/7/e/c/419010.jpg", "description": "Direct URL of the full-size image, on the source site's own server." }, "title": { "type": "string", "example": "Cute Golden Retriever Puppies Wallpaper (56+ images)", "nullable": true, "description": "Title of the image, taken from the page it appears on." }, "width": { "type": "integer", "example": 1920, "nullable": true, "description": "Width of the full-size image in pixels." }, "height": { "type": "integer", "example": 1080, "nullable": true, "description": "Height of the full-size image in pixels." }, "source": { "type": "string", "example": "getwallpapers.com", "nullable": true, "description": "Name of the site the image was found on, as Bing labels it, usually its domain." }, "position": { "type": "integer", "example": 1, "description": "Bing's 1-based rank of the image in the whole result list, so page 2 starts at 36." }, "source_url": { "type": "string", "example": "https://getwallpapers.com/collection/cute-golden-retriever-puppies-wallpaper", "nullable": true, "description": "URL of the page the image appears on." }, "source_domain": { "type": "string", "example": "getwallpapers.com", "nullable": true, "description": "Hostname of `source_url`." }, "thumbnail_url": { "type": "string", "example": "https://th.bing.com/th/id/OIP.3Sjn8S6nS6Din0WEBzORqgHaEK?w=333&h=187&c=7&r=0&o=7&pid=1.7&rm=3", "nullable": true, "description": "URL of the image thumbnail, hosted on Bing's image CDN." }, "thumbnail_width": { "type": "integer", "example": 333, "nullable": true, "description": "Width of the thumbnail in pixels." }, "background_color": { "type": "string", "example": "#213718", "nullable": true, "description": "Dominant color of the image as a hex code, the color Bing shows while the thumbnail loads." }, "thumbnail_height": { "type": "integer", "example": 187, "nullable": true, "description": "Height of the thumbnail in pixels." } }, "description": "One image result." }, "sds_L_Fsr74jXxRwFrRFUiukT_d41aad9c952cdb08_ref2": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_d41aad9c952cdb08_ref3" } } }, "description": "Invalid or missing parameter." }, "sds_L_Fsr74jXxRwFrRFUiukT_d41aad9c952cdb08_ref3": { "type": "object", "required": [ "status", "request_id", "error" ], "properties": { "error": { "type": "object", "required": [ "message", "code" ], "properties": { "code": { "type": "integer", "example": 400, "description": "The HTTP status code, repeated in the body." }, "message": { "type": "string", "example": "Missing query. The 'query' parameter is required.", "description": "Human-readable description of what was wrong with the request." } } }, "status": { "enum": [ "ERROR" ], "type": "string", "example": "ERROR", "description": "Always `ERROR` on a failed request." }, "request_id": { "type": "string", "example": "f5a68d84-0dd8-4ecb-b17d-7dc61faa5df5", "description": "Unique id for this request, for tracing and support." } } }, "sds_L_Fsr74jXxRwFrRFUiukT_d41aad9c952cdb08_ref4": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_d41aad9c952cdb08_ref3" } } }, "description": "Missing or invalid API key." }, "sds_L_Fsr74jXxRwFrRFUiukT_d41aad9c952cdb08_ref5": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_d41aad9c952cdb08_ref3" } } }, "description": "Not subscribed to this API." }, "sds_L_Fsr74jXxRwFrRFUiukT_d41aad9c952cdb08_ref6": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_d41aad9c952cdb08_ref3" } } }, "description": "Unknown route, or on `/product-details` a product Bing no longer lists." }, "sds_L_Fsr74jXxRwFrRFUiukT_d41aad9c952cdb08_ref7": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_d41aad9c952cdb08_ref3" } } }, "description": "Quota exhausted." }, "sds_L_Fsr74jXxRwFrRFUiukT_d41aad9c952cdb08_ref8": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_d41aad9c952cdb08_ref3" } } }, "description": "Unexpected error." }, "sds_L_Fsr74jXxRwFrRFUiukT_d41aad9c952cdb08_ref9": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_d41aad9c952cdb08_ref3" } } }, "description": "Bing could not be reached for this request. Retry; the request is not billed.\n\nA successful search that found no matches is a `200` with an empty result array." }, "sds_L_Fsr74jXxRwFrRFUiukT_a9550f97ff1c0555_ref0": { "type": "object", "required": [ "query", "country", "language", "lat", "lng", "limit", "page" ], "properties": { "lat": { "type": "number", "example": 34.0522, "nullable": true, "description": "The latitude as sent. `null` when none was sent." }, "lng": { "type": "number", "example": -118.2437, "nullable": true, "description": "The longitude as sent. `null` when none was sent." }, "page": { "type": "integer", "example": 1, "description": "The page returned." }, "limit": { "type": "integer", "example": 20, "description": "The page size used." }, "query": { "type": "string", "example": "coffee new york", "description": "The search query, trimmed." }, "country": { "type": "string", "example": "us", "description": "The country code used, lowercased." }, "language": { "type": "string", "example": "en", "description": "The language code used, lowercased." } }, "description": "Echo of the parameters the API used. Every key is always present with the value actually used, after defaults are applied." }, "sds_L_Fsr74jXxRwFrRFUiukT_a9550f97ff1c0555_ref1": { "type": "object", "required": [ "place_id", "name", "full_address", "latitude", "longitude", "phone_number", "website", "type", "rating", "review_count", "rating_source", "opening_status", "service_options", "thumbnail_url", "position" ], "properties": { "name": { "type": "string", "example": "787 Coffee", "description": "Name of the place." }, "type": { "type": "string", "example": "Cafe", "nullable": true, "description": "Main category of the place, for example `Cafe` or `Dentist`." }, "rating": { "type": "number", "example": 4.5, "nullable": true, "description": "Average rating, out of 5, from `rating_source`." }, "website": { "type": "string", "example": "http://www.787coffee.com/", "nullable": true, "description": "The place's own website." }, "latitude": { "type": "number", "example": 40.7034912109375, "nullable": true, "description": "Latitude of the place. Filled on every place measured." }, "place_id": { "type": "string", "example": "ypid:YN268699C8CAF3FC01", "nullable": true, "description": "Bing's id for the place, for example `ypid:YN268699C8CAF3FC01`. Filled on every place measured." }, "position": { "type": "integer", "example": 1, "description": "1-based rank of the place across pages, so with `limit=20` page 2 starts at 21." }, "longitude": { "type": "number", "example": -74.01083374023438, "nullable": true, "description": "Longitude of the place. Filled on every place measured." }, "full_address": { "type": "string", "example": "66 Pearl St, New York, NY 10004", "nullable": true, "description": "Full street address." }, "phone_number": { "type": "string", "example": "(646) 449-9200", "nullable": true, "description": "Phone number, as Bing prints it." }, "review_count": { "type": "integer", "example": 237, "nullable": true, "description": "Number of reviews behind `rating`." }, "rating_source": { "type": "string", "example": "Yelp", "nullable": true, "description": "The site the rating comes from, for example `Yelp` or `Tripadvisor`." }, "thumbnail_url": { "type": "string", "example": "https://www.bing.com/th?id=OLC.G+4WhoMiPTO2Mg480x360&pid=Local", "nullable": true, "description": "URL of a photo of the place, hosted on Bing." }, "opening_status": { "type": "string", "example": "Open · Closes 8 PM", "nullable": true, "description": "Current opening status as Bing shows it, in the requested `language`, for example `Open · Closes 8 PM`." }, "service_options": { "type": "array", "items": { "type": "string" }, "example": [ "Dine-in", "Takeout" ], "description": "Service options Bing lists for the place, for example `Dine-in` or `Takeout / Delivery`." } }, "description": "One place on Bing Maps." }, "sds_L_Fsr74jXxRwFrRFUiukT_a9550f97ff1c0555_ref2": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_a9550f97ff1c0555_ref3" } } }, "description": "Invalid or missing parameter." }, "sds_L_Fsr74jXxRwFrRFUiukT_a9550f97ff1c0555_ref3": { "type": "object", "required": [ "status", "request_id", "error" ], "properties": { "error": { "type": "object", "required": [ "message", "code" ], "properties": { "code": { "type": "integer", "example": 400, "description": "The HTTP status code, repeated in the body." }, "message": { "type": "string", "example": "Missing query. The 'query' parameter is required.", "description": "Human-readable description of what was wrong with the request." } } }, "status": { "enum": [ "ERROR" ], "type": "string", "example": "ERROR", "description": "Always `ERROR` on a failed request." }, "request_id": { "type": "string", "example": "f5a68d84-0dd8-4ecb-b17d-7dc61faa5df5", "description": "Unique id for this request, for tracing and support." } } }, "sds_L_Fsr74jXxRwFrRFUiukT_a9550f97ff1c0555_ref4": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_a9550f97ff1c0555_ref3" } } }, "description": "Missing or invalid API key." }, "sds_L_Fsr74jXxRwFrRFUiukT_a9550f97ff1c0555_ref5": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_a9550f97ff1c0555_ref3" } } }, "description": "Not subscribed to this API." }, "sds_L_Fsr74jXxRwFrRFUiukT_a9550f97ff1c0555_ref6": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_a9550f97ff1c0555_ref3" } } }, "description": "Unknown route, or on `/product-details` a product Bing no longer lists." }, "sds_L_Fsr74jXxRwFrRFUiukT_a9550f97ff1c0555_ref7": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_a9550f97ff1c0555_ref3" } } }, "description": "Quota exhausted." }, "sds_L_Fsr74jXxRwFrRFUiukT_a9550f97ff1c0555_ref8": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_a9550f97ff1c0555_ref3" } } }, "description": "Unexpected error." }, "sds_L_Fsr74jXxRwFrRFUiukT_a9550f97ff1c0555_ref9": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_a9550f97ff1c0555_ref3" } } }, "description": "Bing could not be reached for this request. Retry; the request is not billed.\n\nA successful search that found no matches is a `200` with an empty result array." }, "sds_L_Fsr74jXxRwFrRFUiukT_edaf982f6e6fa993_ref0": { "type": "object", "required": [ "query", "page", "country", "language", "sort_by", "time_period" ], "properties": { "page": { "type": "integer", "example": 1, "description": "The page returned." }, "query": { "type": "string", "example": "nvidia", "description": "The search query, trimmed." }, "country": { "type": "string", "example": "us", "description": "The country code used, lowercased." }, "sort_by": { "enum": [ "RELEVANCE", "DATE" ], "type": "string", "example": "RELEVANCE", "description": "The sort order used, uppercased." }, "language": { "type": "string", "example": "en", "description": "The language code used, lowercased." }, "time_period": { "enum": [ "any", "last_hour", "last_day", "last_week", "last_month" ], "type": "string", "example": "any", "description": "The time period filter used, lowercased. `any` when none was sent." } }, "description": "Echo of the parameters the API used. Every key is always present with the value actually used, after defaults are applied." }, "sds_L_Fsr74jXxRwFrRFUiukT_edaf982f6e6fa993_ref1": { "type": "object", "required": [ "title", "link", "snippet", "source_name", "source_logo_url", "thumbnail_url", "published_date", "published_datetime_utc", "position" ], "properties": { "link": { "type": "string", "example": "https://www.forbes.com/sites/jonmarkman/2026/09/28/nvidia-adds-record-150-billion-to-stock-buyback-largest-in-history/", "description": "URL of the article on the publisher's site." }, "title": { "type": "string", "example": "Nvidia Ramps Up Buybacks With Historic $150 Billion Authorization", "description": "Headline of the article." }, "snippet": { "type": "string", "example": "Nvidia added $150 billion to its buyback, the largest expansion ever, lifting its repurchase capacity to $235 billion as it ...", "nullable": true, "description": "Opening lines of the article, as Bing shows them. Filled on every article measured." }, "position": { "type": "integer", "example": 2, "description": "1-based rank of the article across pages, so page 2 starts at 11." }, "source_name": { "type": "string", "example": "Forbes", "nullable": true, "description": "Name of the publisher, as Bing labels it, for example `Forbes` or `Reuters on MSN`. Filled on every article measured." }, "thumbnail_url": { "type": "string", "example": "https://www.bing.com/th?id=ONUT.JyzfNXGkAyO9c_YQtZpd-Q&pid=News&w=234&h=132&c=14&rs=2&qlt=90", "nullable": true, "description": "URL of the article thumbnail, hosted on Bing." }, "published_date": { "type": "string", "example": "2 days ago", "nullable": true, "description": "Publication time as Bing prints it, in the requested `language`: an age for recent articles (`2 days ago`, `Vor 4 Stunden`), the date for older ones (`7/20/2026`)." }, "source_logo_url": { "type": "string", "example": "https://www.bing.com/th?id=OJ.BK94CQJsUwsKUA&pid=news&w=61&h=16&rs=2", "nullable": true, "description": "URL of the publisher's logo, hosted on Bing." }, "published_datetime_utc": { "type": "string", "example": "2026-09-29T13:14:11.720Z", "nullable": true, "description": "ISO 8601 UTC form of `published_date`. An age is counted back from the time of the request, so it is accurate to Bing's rounding (minutes, hours or days)." } }, "description": "One news article." }, "sds_L_Fsr74jXxRwFrRFUiukT_edaf982f6e6fa993_ref2": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_edaf982f6e6fa993_ref3" } } }, "description": "Invalid or missing parameter." }, "sds_L_Fsr74jXxRwFrRFUiukT_edaf982f6e6fa993_ref3": { "type": "object", "required": [ "status", "request_id", "error" ], "properties": { "error": { "type": "object", "required": [ "message", "code" ], "properties": { "code": { "type": "integer", "example": 400, "description": "The HTTP status code, repeated in the body." }, "message": { "type": "string", "example": "Missing query. The 'query' parameter is required.", "description": "Human-readable description of what was wrong with the request." } } }, "status": { "enum": [ "ERROR" ], "type": "string", "example": "ERROR", "description": "Always `ERROR` on a failed request." }, "request_id": { "type": "string", "example": "f5a68d84-0dd8-4ecb-b17d-7dc61faa5df5", "description": "Unique id for this request, for tracing and support." } } }, "sds_L_Fsr74jXxRwFrRFUiukT_edaf982f6e6fa993_ref4": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_edaf982f6e6fa993_ref3" } } }, "description": "Missing or invalid API key." }, "sds_L_Fsr74jXxRwFrRFUiukT_edaf982f6e6fa993_ref5": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_edaf982f6e6fa993_ref3" } } }, "description": "Not subscribed to this API." }, "sds_L_Fsr74jXxRwFrRFUiukT_edaf982f6e6fa993_ref6": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_edaf982f6e6fa993_ref3" } } }, "description": "Unknown route, or on `/product-details` a product Bing no longer lists." }, "sds_L_Fsr74jXxRwFrRFUiukT_edaf982f6e6fa993_ref7": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_edaf982f6e6fa993_ref3" } } }, "description": "Quota exhausted." }, "sds_L_Fsr74jXxRwFrRFUiukT_edaf982f6e6fa993_ref8": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_edaf982f6e6fa993_ref3" } } }, "description": "Unexpected error." }, "sds_L_Fsr74jXxRwFrRFUiukT_edaf982f6e6fa993_ref9": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_edaf982f6e6fa993_ref3" } } }, "description": "Bing could not be reached for this request. Retry; the request is not billed.\n\nA successful search that found no matches is a `200` with an empty result array." }, "sds_L_Fsr74jXxRwFrRFUiukT_d3d8531f0bbfc66c_ref0": { "type": "object", "required": [ "product_id", "country", "language" ], "properties": { "country": { "type": "string", "example": "us", "description": "The country code used, lowercased. The market inside `product_id` when none was sent." }, "language": { "type": "string", "example": "en", "description": "The language code used, lowercased." }, "product_id": { "type": "string", "example": "MXx1c3wxN3wzfDA3MDc4NjJEN0FEQkU2NTY3OEFBMzIyQzkwNEJCQUMyfDQyODcwMDgwOTA3OXxjb2ZmZWUgbWFrZXI", "description": "The product id as sent, trimmed." } }, "description": "Echo of the parameters the API used. Every key is always present with the value actually used, after defaults are applied." }, "sds_L_Fsr74jXxRwFrRFUiukT_d3d8531f0bbfc66c_ref1": { "type": "object", "required": [ "product_id", "offer_id", "product_title", "product_description", "product_photos", "price", "extracted_price", "original_price", "extracted_original_price", "currency", "min_price", "max_price", "availability", "product_rating", "product_num_reviews", "rating_distribution", "review_highlights", "review_summary", "review_pros", "review_cons", "variants", "specifications", "product_page_url", "offers_count", "offers" ], "properties": { "price": { "type": "string", "example": "$98.58", "nullable": true, "description": "Price of the primary offer, the first entry in `offers`, as displayed." }, "offers": { "type": "array", "items": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_d3d8531f0bbfc66c_ref6" }, "description": "Every store offering the product, primary offer first, de-duplicated by store, price and link." }, "currency": { "type": "string", "example": "USD", "nullable": true, "description": "ISO 4217 code of the price currency." }, "offer_id": { "type": "string", "example": "48020867475", "nullable": true, "description": "Bing's id for the product's primary offer." }, "variants": { "type": "array", "items": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_d3d8531f0bbfc66c_ref3" }, "description": "Variant dimensions of the product, such as color or storage capacity, with their options." }, "max_price": { "type": "number", "example": 119.95, "nullable": true, "description": "Highest offer price across `offers`. `null` when no offer carries a price." }, "min_price": { "type": "number", "example": 76.49, "nullable": true, "description": "Lowest offer price across `offers`. `null` when no offer carries a price." }, "product_id": { "type": "string", "example": "MXx1c3wxN3wzfDA3MDc4NjJEN0FEQkU2NTY3OEFBMzIyQzkwNEJCQUMyfDQyODcwMDgwOTA3OXxjb2ZmZWUgbWFrZXI", "description": "The product id requested." }, "review_cons": { "type": "array", "items": { "type": "string" }, "example": [ "Coffee doesn't stay hot long" ], "description": "Weaknesses customers mention, from Bing's AI-written review insights, in the requested `language`." }, "review_pros": { "type": "array", "items": { "type": "string" }, "example": [ "Easy to use", "Programmable" ], "description": "Strengths customers mention, from Bing's AI-written review insights, in the requested `language`." }, "availability": { "type": "string", "example": "InStock", "nullable": true, "description": "Stock status of the primary offer, as a schema.org availability value, for example `InStock`." }, "offers_count": { "type": "integer", "example": 4, "description": "Number of entries in `offers`." }, "product_title": { "type": "string", "example": "Cuisinart 14-Cup Coffee Maker, Programmable Perfectemp Glass Carafe Coffee Machine With 1-4 Cup Setting, Brew Strength Control And Pause, Stainless", "description": "Product title." }, "original_price": { "type": "string", "example": "$119.95", "nullable": true, "description": "Previous price of the primary offer as displayed, when the store shows it as discounted." }, "product_photos": { "type": "array", "items": { "type": "string" }, "example": [ "https://th.bing.com/th?id=OPHS.8EHg%2b%2b4JIaRp6A474C474&o=5&pid=21.1" ], "description": "URLs of the product photos, hosted on Bing's image CDN." }, "product_rating": { "type": "number", "example": 4.6, "nullable": true, "description": "Average customer rating, out of 5." }, "review_summary": { "type": "string", "example": "This coffee maker is praised for its ease of use, programmable features, and ability to produce delicious coffee.", "nullable": true, "description": "Bing's AI-written summary of customer reviews, in the requested `language`." }, "specifications": { "type": "array", "items": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_d3d8531f0bbfc66c_ref5" }, "description": "Product specifications as name and value pairs." }, "extracted_price": { "type": "number", "example": 98.58, "nullable": true, "description": "Price of the primary offer as a number." }, "product_page_url": { "type": "string", "example": "https://www.bing.com/shop/productpage?q=coffee+maker&filters=scenario%3A%2217%22+gType%3A%223%22+gId%3A%22177B04A72CEA846025840A11359B4338%22+gGlobalOfferIds%3A%2248020867475%22&productpage=true", "description": "URL of the product's page on Bing Shopping." }, "review_highlights": { "type": "array", "items": { "type": "string" }, "example": [ "Easy To Clean", "Perfect Size Coffee Maker" ], "description": "Short themes Bing highlights from customer reviews." }, "product_description": { "type": "string", "example": "Please refer to user guide or user manual or user guide (provided below in PDF) before first use State-of-the-art technology to ensure hotter Coffee without sacrificing flavor or quality", "nullable": true, "description": "Full product description." }, "product_num_reviews": { "type": "string", "example": "10K+", "nullable": true, "description": "Number of ratings as Bing prints it, abbreviated for large counts, for example `460` or `10K+`." }, "rating_distribution": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_d3d8531f0bbfc66c_ref2" }, "extracted_original_price": { "type": "number", "example": 119.95, "nullable": true, "description": "Previous price of the primary offer as a number." } }, "description": "One product, as Bing Shopping's product page shows it." }, "sds_L_Fsr74jXxRwFrRFUiukT_d3d8531f0bbfc66c_ref2": { "type": "object", "nullable": true, "properties": { "1": { "type": "integer", "example": 3, "description": "Percent of 1-star ratings." }, "2": { "type": "integer", "example": 3, "description": "Percent of 2-star ratings." }, "3": { "type": "integer", "example": 6, "description": "Percent of 3-star ratings." }, "4": { "type": "integer", "example": 17, "description": "Percent of 4-star ratings." }, "5": { "type": "integer", "example": 71, "description": "Percent of 5-star ratings." } }, "description": "Share of ratings per star level, in percent, keyed by star (`1` to `5`). `null` when Bing shows no rating breakdown." }, "sds_L_Fsr74jXxRwFrRFUiukT_d3d8531f0bbfc66c_ref3": { "type": "object", "required": [ "name", "options" ], "properties": { "name": { "type": "string", "example": "Color", "description": "Name of the dimension, as Bing prints it, for example `Color` or `Storage Capacity`." }, "options": { "type": "array", "items": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_d3d8531f0bbfc66c_ref4" }, "description": "The options available for this dimension." } }, "description": "One variant dimension of the product." }, "sds_L_Fsr74jXxRwFrRFUiukT_d3d8531f0bbfc66c_ref4": { "type": "object", "required": [ "value", "selected", "thumbnail_url" ], "properties": { "value": { "type": "string", "example": "Black", "description": "The option, for example `Black` or `256 GB`." }, "selected": { "type": "boolean", "example": false, "description": "Whether this option is the one the requested product has, when Bing marks it." }, "thumbnail_url": { "type": "string", "example": "https://th.bing.com/th?id=OPHS.sKOOVUTNZ%2f50SA474C474&w=46&h=46", "nullable": true, "description": "URL of the option's swatch image, for options Bing shows as a picture." } }, "description": "One option of a variant dimension." }, "sds_L_Fsr74jXxRwFrRFUiukT_d3d8531f0bbfc66c_ref5": { "type": "object", "required": [ "name", "value" ], "properties": { "name": { "type": "string", "example": "Capacity", "description": "Specification name." }, "value": { "type": "string", "example": "14 cups", "description": "Specification value." } }, "description": "One product specification." }, "sds_L_Fsr74jXxRwFrRFUiukT_d3d8531f0bbfc66c_ref6": { "type": "object", "required": [ "store_name", "store_favicon", "price", "extracted_price", "original_price", "extracted_original_price", "currency", "installment_down_payment", "installment_monthly_payment", "installment_months", "shipping", "offer_note", "sponsored", "offer_page_url", "position" ], "properties": { "price": { "type": "string", "example": "$98.58", "nullable": true, "description": "Offer price as displayed, with its currency symbol." }, "currency": { "type": "string", "example": "USD", "nullable": true, "description": "ISO 4217 code of the price currency." }, "position": { "type": "integer", "example": 1, "description": "1-based rank of the offer in Bing's buying options." }, "shipping": { "type": "string", "example": "Free shipping", "nullable": true, "description": "Shipping note as Bing prints it, for example `Free shipping`." }, "sponsored": { "type": "boolean", "example": true, "description": "Whether the offer is a paid listing, labelled as sponsored on Bing." }, "offer_note": { "type": "string", "example": "39 % price drop", "nullable": true, "description": "Deal note Bing prints under the store name, for example `39 % price drop`." }, "store_name": { "type": "string", "example": "Amazon.com", "nullable": true, "description": "Name of the store. Filled on every offer measured." }, "store_favicon": { "type": "string", "example": "https://th.bing.com/th/id/ODF.R78Eph0Za3lAUNkY3fwTSg?w=20&h=20&dpr=2&pid=retail", "nullable": true, "description": "URL of the store's icon, hosted on Bing's image CDN." }, "offer_page_url": { "type": "string", "example": "https://www.amazon.com/Cuisinart-DCC-3200BKS-Perfectemp-Coffee-Stainless/dp/B077K9YW7D", "nullable": true, "description": "URL of the offer on the store's own website, unwrapped from Bing's redirect. Ads can point at the advertiser's click tracker." }, "original_price": { "type": "string", "example": "$119.95", "nullable": true, "description": "Previous price as displayed, when the store shows the offer as discounted." }, "extracted_price": { "type": "number", "example": 98.58, "nullable": true, "description": "Offer price as a number, parsed from `price`." }, "installment_months": { "type": "integer", "example": 36, "nullable": true, "description": "Number of monthly payments on a carrier installment offer." }, "extracted_original_price": { "type": "number", "example": 119.95, "nullable": true, "description": "Previous price as a number, parsed from `original_price`." }, "installment_down_payment": { "type": "string", "example": "$0.00", "nullable": true, "description": "Amount due upfront on a carrier installment offer (phones on a carrier plan), as displayed." }, "installment_monthly_payment": { "type": "string", "example": "$17.50/mo", "nullable": true, "description": "Monthly payment on a carrier installment offer, as displayed." } }, "description": "One store's offer for the product." }, "sds_L_Fsr74jXxRwFrRFUiukT_d3d8531f0bbfc66c_ref7": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_d3d8531f0bbfc66c_ref8" } } }, "description": "Invalid or missing parameter." }, "sds_L_Fsr74jXxRwFrRFUiukT_d3d8531f0bbfc66c_ref8": { "type": "object", "required": [ "status", "request_id", "error" ], "properties": { "error": { "type": "object", "required": [ "message", "code" ], "properties": { "code": { "type": "integer", "example": 400, "description": "The HTTP status code, repeated in the body." }, "message": { "type": "string", "example": "Missing query. The 'query' parameter is required.", "description": "Human-readable description of what was wrong with the request." } } }, "status": { "enum": [ "ERROR" ], "type": "string", "example": "ERROR", "description": "Always `ERROR` on a failed request." }, "request_id": { "type": "string", "example": "f5a68d84-0dd8-4ecb-b17d-7dc61faa5df5", "description": "Unique id for this request, for tracing and support." } } }, "sds_L_Fsr74jXxRwFrRFUiukT_d3d8531f0bbfc66c_ref9": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_d3d8531f0bbfc66c_ref8" } } }, "description": "Missing or invalid API key." }, "sds_L_Fsr74jXxRwFrRFUiukT_d3d8531f0bbfc66c_ref10": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_d3d8531f0bbfc66c_ref8" } } }, "description": "Not subscribed to this API." }, "sds_L_Fsr74jXxRwFrRFUiukT_d3d8531f0bbfc66c_ref11": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_d3d8531f0bbfc66c_ref8" } } }, "description": "Unknown route, or on `/product-details` a product Bing no longer lists." }, "sds_L_Fsr74jXxRwFrRFUiukT_d3d8531f0bbfc66c_ref12": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_d3d8531f0bbfc66c_ref8" } } }, "description": "Quota exhausted." }, "sds_L_Fsr74jXxRwFrRFUiukT_d3d8531f0bbfc66c_ref13": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_d3d8531f0bbfc66c_ref8" } } }, "description": "Unexpected error." }, "sds_L_Fsr74jXxRwFrRFUiukT_d3d8531f0bbfc66c_ref14": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_d3d8531f0bbfc66c_ref8" } } }, "description": "Bing could not be reached for this request. Retry; the request is not billed.\n\nA successful search that found no matches is a `200` with an empty result array." }, "sds_L_Fsr74jXxRwFrRFUiukT_14dad9422cc64658_ref0": { "type": "object", "required": [ "query", "country", "language", "safe_search", "time_period" ], "properties": { "query": { "type": "string", "example": "how to make sourdough bread", "description": "The search query, trimmed." }, "country": { "type": "string", "example": "us", "description": "The country code used, lowercased." }, "language": { "type": "string", "example": "en", "description": "The language code used, lowercased." }, "safe_search": { "enum": [ "off", "moderate", "strict" ], "type": "string", "example": "off", "description": "The safe search level used, lowercased." }, "time_period": { "enum": [ "any", "last_day", "last_week", "last_month", "last_year" ], "type": "string", "example": "any", "description": "The time period filter used, lowercased. `any` when none was sent." } }, "description": "Echo of the parameters the API used. Every key is always present with the value actually used, after defaults are applied." }, "sds_L_Fsr74jXxRwFrRFUiukT_14dad9422cc64658_ref1": { "type": "object", "required": [ "title", "link", "displayed_link", "source", "domain", "snippet", "date", "position" ], "properties": { "date": { "type": "string", "example": "Jul 27, 2026", "nullable": true, "description": "Date Bing shows at the start of the snippet, as printed, absolute (`Jul 27, 2026`) or relative (`2 days ago`)." }, "link": { "type": "string", "example": "https://www.allrecipes.com/article/how-to-make-sourdough-bread/", "description": "URL of the result, unwrapped from Bing's click-tracking redirect. On a video result it is Bing's video viewer page." }, "title": { "type": "string", "example": "How to Make Sourdough Bread - Allrecipes", "description": "Title of the result." }, "domain": { "type": "string", "example": "www.allrecipes.com", "nullable": true, "description": "Hostname of `link`." }, "source": { "type": "string", "example": "Allrecipes", "nullable": true, "description": "Name of the site, as Bing shows it above the URL. Filled on every result measured." }, "snippet": { "type": "string", "example": "Beginner’s Guide to Making Sourdough Bread Tangy, chewy …", "nullable": true, "description": "Text snippet Bing shows for the result. Filled on every result measured." }, "position": { "type": "integer", "example": 2, "description": "1-based rank of the result on the page." }, "displayed_link": { "type": "string", "example": "https://www.allrecipes.com › article › how-to-make...", "nullable": true, "description": "The URL as Bing displays it under the title. Filled on every result measured." } }, "description": "One organic web result." }, "sds_L_Fsr74jXxRwFrRFUiukT_14dad9422cc64658_ref2": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_14dad9422cc64658_ref3" } } }, "description": "Invalid or missing parameter." }, "sds_L_Fsr74jXxRwFrRFUiukT_14dad9422cc64658_ref3": { "type": "object", "required": [ "status", "request_id", "error" ], "properties": { "error": { "type": "object", "required": [ "message", "code" ], "properties": { "code": { "type": "integer", "example": 400, "description": "The HTTP status code, repeated in the body." }, "message": { "type": "string", "example": "Missing query. The 'query' parameter is required.", "description": "Human-readable description of what was wrong with the request." } } }, "status": { "enum": [ "ERROR" ], "type": "string", "example": "ERROR", "description": "Always `ERROR` on a failed request." }, "request_id": { "type": "string", "example": "f5a68d84-0dd8-4ecb-b17d-7dc61faa5df5", "description": "Unique id for this request, for tracing and support." } } }, "sds_L_Fsr74jXxRwFrRFUiukT_14dad9422cc64658_ref4": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_14dad9422cc64658_ref3" } } }, "description": "Missing or invalid API key." }, "sds_L_Fsr74jXxRwFrRFUiukT_14dad9422cc64658_ref5": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_14dad9422cc64658_ref3" } } }, "description": "Not subscribed to this API." }, "sds_L_Fsr74jXxRwFrRFUiukT_14dad9422cc64658_ref6": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_14dad9422cc64658_ref3" } } }, "description": "Unknown route, or on `/product-details` a product Bing no longer lists." }, "sds_L_Fsr74jXxRwFrRFUiukT_14dad9422cc64658_ref7": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_14dad9422cc64658_ref3" } } }, "description": "Quota exhausted." }, "sds_L_Fsr74jXxRwFrRFUiukT_14dad9422cc64658_ref8": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_14dad9422cc64658_ref3" } } }, "description": "Unexpected error." }, "sds_L_Fsr74jXxRwFrRFUiukT_14dad9422cc64658_ref9": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_14dad9422cc64658_ref3" } } }, "description": "Bing could not be reached for this request. Retry; the request is not billed.\n\nA successful search that found no matches is a `200` with an empty result array." }, "sds_L_Fsr74jXxRwFrRFUiukT_f8c1ecbcc7206917_ref0": { "type": "object", "required": [ "query", "country", "language", "page", "sort_by", "min_price", "max_price" ], "properties": { "page": { "type": "integer", "example": 1, "description": "The page returned." }, "query": { "type": "string", "example": "coffee maker", "description": "The search query, trimmed." }, "country": { "type": "string", "example": "us", "description": "The country code used, lowercased." }, "sort_by": { "enum": [ "BEST_MATCH", "LOWEST_PRICE", "HIGHEST_PRICE" ], "type": "string", "example": "BEST_MATCH", "description": "The sort order used, uppercased." }, "language": { "type": "string", "example": "en", "description": "The language code used, lowercased." }, "max_price": { "type": "number", "example": 200, "nullable": true, "description": "The maximum price as sent. `null` when none was sent." }, "min_price": { "type": "number", "example": 100, "nullable": true, "description": "The minimum price as sent. `null` when none was sent." } }, "description": "Echo of the parameters the API used. Every key is always present with the value actually used, after defaults are applied." }, "sds_L_Fsr74jXxRwFrRFUiukT_f8c1ecbcc7206917_ref1": { "type": "object", "required": [ "product_id", "offer_id", "product_title", "price", "extracted_price", "original_price", "extracted_original_price", "currency", "on_sale", "installment_down_payment", "installment_monthly_payment", "installment_months", "product_condition", "offer_badge", "product_rating", "product_num_reviews", "store_name", "store_favicon", "shipping", "product_photo", "product_page_url", "offer_page_url", "sponsored", "position" ], "properties": { "price": { "type": "string", "example": "$98.58", "nullable": true, "description": "Current price as displayed, with its currency symbol." }, "on_sale": { "type": "boolean", "example": true, "description": "Whether the product is on sale, shown with a previous price, a sale badge or a deal price." }, "currency": { "type": "string", "example": "USD", "nullable": true, "description": "ISO 4217 code of the price currency, derived from the price symbol and the market." }, "offer_id": { "type": "string", "example": "48020867475", "description": "Bing's id for this offer, one store's listing of the product." }, "position": { "type": "integer", "example": 4, "description": "1-based rank of the product. In `products` it counts across pages, so page 2 starts at 37 on 36-product pages; in `sponsored_products` it counts within the page." }, "shipping": { "type": "string", "example": "Free shipping", "nullable": true, "description": "Shipping note as Bing prints it, for example `Free shipping`." }, "sponsored": { "type": "boolean", "example": false, "description": "`true` on `sponsored_products`, the paid listings, and `false` on `products`." }, "product_id": { "type": "string", "example": "MXx1c3wxN3wzfDE3N0IwNEE3MkNFQTg0NjAyNTg0MEExMTM1OUI0MzM4fDQ4MDIwODY3NDc1fGNvZmZlZSBtYWtlcg", "description": "Opaque id of this product on this market, to pass to `/product-details`. It encodes the search query, so the same product found through two queries carries two ids. Ids keep resolving on later days." }, "store_name": { "type": "string", "example": "Amazon.com", "nullable": true, "description": "Name of the store selling the product. Filled on every product measured." }, "offer_badge": { "type": "string", "example": "SALE", "nullable": true, "description": "Promotional badge on the product, as Bing prints it, for example `SALE` or `Special Offer`." }, "product_photo": { "type": "string", "example": "https://th.bing.com/th?id=OPHS.8EHg%2b%2b4JIaRp6A474C474&w=220&h=210&c=17&o=5&pid=21.1", "nullable": true, "description": "URL of the product photo, hosted on Bing's image CDN." }, "product_title": { "type": "string", "example": "Cuisinart 14-Cup Coffee Maker, Programmable Perfectemp Glass Carafe Coffee Machine With 1-4 Cup Setting, Brew Strength Control And Pause, Stainless", "nullable": true, "description": "Product title as the store lists it. Filled on every product measured." }, "store_favicon": { "type": "string", "example": "https://th.bing.com/th/id/ODF.R78Eph0Za3lAUNkY3fwTSg?w=16&h=16&r=0&dpr=2&pid=retail", "nullable": true, "description": "URL of the store's icon, hosted on Bing's image CDN." }, "offer_page_url": { "type": "string", "example": "https://www.amazon.com/Cuisinart-DCC-3200BKS-Perfectemp-Coffee-Stainless/dp/B077K9YW7D?source=ps-sl-shoppingads-lpcontext&ref_=bing_fplfs&psc=1", "nullable": true, "description": "URL of the product on the store's own website." }, "original_price": { "type": "string", "example": "$119.95", "nullable": true, "description": "Previous price as displayed, when the store shows the product as discounted." }, "product_rating": { "type": "number", "example": 4.6, "nullable": true, "description": "Average customer rating, out of 5." }, "extracted_price": { "type": "number", "example": 98.58, "nullable": true, "description": "Current price as a number, parsed from `price`." }, "product_page_url": { "type": "string", "example": "https://www.bing.com/shop/productpage?q=coffee+maker&filters=scenario%3A%2217%22+gType%3A%223%22+gId%3A%22177B04A72CEA846025840A11359B4338%22+gGlobalOfferIds%3A%2248020867475%22&productpage=true", "description": "URL of the product's page on Bing Shopping, the page `/product-details` reads." }, "product_condition": { "type": "string", "example": "Refurbished", "nullable": true, "description": "Condition label of a refurbished, used or open-box product, as Bing prints it, for example `Refurbished` or `Used`." }, "installment_months": { "type": "integer", "example": 36, "nullable": true, "description": "Number of monthly payments on a carrier installment offer." }, "product_num_reviews": { "type": "string", "example": "10K+", "nullable": true, "description": "Number of ratings as Bing prints it, abbreviated for large counts, for example `460` or `10K+`." }, "extracted_original_price": { "type": "number", "example": 119.95, "nullable": true, "description": "Previous price as a number, parsed from `original_price`." }, "installment_down_payment": { "type": "string", "example": "$0.00", "nullable": true, "description": "Amount due upfront on a carrier installment offer (phones on a carrier plan), as displayed." }, "installment_monthly_payment": { "type": "string", "example": "$17.50/mo", "nullable": true, "description": "Monthly payment on a carrier installment offer, as displayed." } }, "description": "One product offer from Bing Shopping." }, "sds_L_Fsr74jXxRwFrRFUiukT_f8c1ecbcc7206917_ref2": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_f8c1ecbcc7206917_ref3" } } }, "description": "Invalid or missing parameter." }, "sds_L_Fsr74jXxRwFrRFUiukT_f8c1ecbcc7206917_ref3": { "type": "object", "required": [ "status", "request_id", "error" ], "properties": { "error": { "type": "object", "required": [ "message", "code" ], "properties": { "code": { "type": "integer", "example": 400, "description": "The HTTP status code, repeated in the body." }, "message": { "type": "string", "example": "Missing query. The 'query' parameter is required.", "description": "Human-readable description of what was wrong with the request." } } }, "status": { "enum": [ "ERROR" ], "type": "string", "example": "ERROR", "description": "Always `ERROR` on a failed request." }, "request_id": { "type": "string", "example": "f5a68d84-0dd8-4ecb-b17d-7dc61faa5df5", "description": "Unique id for this request, for tracing and support." } } }, "sds_L_Fsr74jXxRwFrRFUiukT_f8c1ecbcc7206917_ref4": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_f8c1ecbcc7206917_ref3" } } }, "description": "Missing or invalid API key." }, "sds_L_Fsr74jXxRwFrRFUiukT_f8c1ecbcc7206917_ref5": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_f8c1ecbcc7206917_ref3" } } }, "description": "Not subscribed to this API." }, "sds_L_Fsr74jXxRwFrRFUiukT_f8c1ecbcc7206917_ref6": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_f8c1ecbcc7206917_ref3" } } }, "description": "Unknown route, or on `/product-details` a product Bing no longer lists." }, "sds_L_Fsr74jXxRwFrRFUiukT_f8c1ecbcc7206917_ref7": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_f8c1ecbcc7206917_ref3" } } }, "description": "Quota exhausted." }, "sds_L_Fsr74jXxRwFrRFUiukT_f8c1ecbcc7206917_ref8": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_f8c1ecbcc7206917_ref3" } } }, "description": "Unexpected error." }, "sds_L_Fsr74jXxRwFrRFUiukT_f8c1ecbcc7206917_ref9": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_f8c1ecbcc7206917_ref3" } } }, "description": "Bing could not be reached for this request. Retry; the request is not billed.\n\nA successful search that found no matches is a `200` with an empty result array." }, "sds_L_Fsr74jXxRwFrRFUiukT_b2b84a70e24d2a2c_ref0": { "type": "object", "required": [ "query", "page", "country", "language", "duration", "time_period", "source_site", "safe_search" ], "properties": { "page": { "type": "integer", "example": 1, "description": "The page returned." }, "query": { "type": "string", "example": "python tutorial for beginners", "description": "The search query, trimmed." }, "country": { "type": "string", "example": "us", "description": "The country code used, lowercased." }, "duration": { "enum": [ "any", "short", "medium", "long" ], "type": "string", "example": "any", "description": "The duration filter used, lowercased. `any` when none was sent." }, "language": { "type": "string", "example": "en", "description": "The language code used, lowercased." }, "safe_search": { "enum": [ "off", "moderate", "strict" ], "type": "string", "example": "off", "description": "The safe search level used, lowercased." }, "source_site": { "type": "string", "example": "youtube.com", "nullable": true, "description": "The site filter used, reduced to a lowercase domain. `null` when none was sent." }, "time_period": { "enum": [ "any", "last_day", "last_week", "last_month", "last_year" ], "type": "string", "example": "any", "description": "The time period filter used, lowercased. `any` when none was sent." } }, "description": "Echo of the parameters the API used. Every key is always present with the value actually used, after defaults are applied." }, "sds_L_Fsr74jXxRwFrRFUiukT_b2b84a70e24d2a2c_ref1": { "type": "object", "required": [ "id", "title", "link", "source", "channel_name", "channel_url", "thumbnail_url", "duration", "duration_seconds", "views", "views_text", "published_date", "published_datetime_utc", "position" ], "properties": { "id": { "type": "string", "example": "80C03ED585259211995480C03ED5852592119954", "nullable": true, "description": "Bing's id for the video, a 40-character hex string. Filled on every video measured." }, "link": { "type": "string", "example": "https://www.youtube.com/watch?v=F_4RkWLSlPc", "description": "URL of the video on its hosting site." }, "title": { "type": "string", "example": "Python Fundamentals You MUST Know in 2026 🔥 | Beginner to Job-Ready", "nullable": true, "description": "Title of the video." }, "views": { "type": "integer", "example": 6100, "nullable": true, "description": "View count, parsed from `views_text`. Bing abbreviates large counts, so `52.7M views` becomes `52700000`." }, "source": { "type": "string", "example": "YouTube", "nullable": true, "description": "Name of the platform hosting the video, as Bing labels it, for example `YouTube`, `TikTok` or `Dailymotion`." }, "duration": { "type": "string", "example": "00:39", "nullable": true, "description": "Length of the video as Bing prints it, `MM:SS` or `H:MM:SS`." }, "position": { "type": "integer", "example": 1, "description": "1-based rank of the video across pages, so page 2 starts at 36." }, "views_text": { "type": "string", "example": "6.1K views", "nullable": true, "description": "View count as Bing prints it, in the requested `language`, for example `52.7M views` or `53,3Tsd. Aufrufe`." }, "channel_url": { "type": "string", "example": "https://www.youtube.com/channel/UCtSgvR0074NWsMEk64VxTzA", "nullable": true, "description": "URL of the publishing channel. Bing links it on page 1 results only, so it is `null` on pages 2 to 4." }, "channel_name": { "type": "string", "example": "Harshit Trehan", "nullable": true, "description": "Name of the channel or account that published the video." }, "thumbnail_url": { "type": "string", "example": "https://th.bing.com/th/id/OVP.yQA-on2mUZe5BmNr7hOU1wEkII?w=354&h=199&c=7&rs=1&qlt=70&o=7&pid=2.1&rm=3", "nullable": true, "description": "URL of the video thumbnail, hosted on Bing's image CDN." }, "published_date": { "type": "string", "example": "1 month ago", "nullable": true, "description": "Publication date as Bing prints it, in the requested `language`, absolute (`Sep 3, 2020`) or relative (`4 months ago`)." }, "duration_seconds": { "type": "integer", "example": 39, "nullable": true, "description": "Length of the video in seconds, parsed from `duration`." }, "published_datetime_utc": { "type": "string", "example": "2026-09-12T13:19:46.637Z", "nullable": true, "description": "ISO 8601 UTC form of `published_date`, parsed when `language` is `en`. A relative date is counted back from the time of the request, so it is approximate." } }, "description": "One video result." }, "sds_L_Fsr74jXxRwFrRFUiukT_b2b84a70e24d2a2c_ref2": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_b2b84a70e24d2a2c_ref3" } } }, "description": "Invalid or missing parameter." }, "sds_L_Fsr74jXxRwFrRFUiukT_b2b84a70e24d2a2c_ref3": { "type": "object", "required": [ "status", "request_id", "error" ], "properties": { "error": { "type": "object", "required": [ "message", "code" ], "properties": { "code": { "type": "integer", "example": 400, "description": "The HTTP status code, repeated in the body." }, "message": { "type": "string", "example": "Missing query. The 'query' parameter is required.", "description": "Human-readable description of what was wrong with the request." } } }, "status": { "enum": [ "ERROR" ], "type": "string", "example": "ERROR", "description": "Always `ERROR` on a failed request." }, "request_id": { "type": "string", "example": "f5a68d84-0dd8-4ecb-b17d-7dc61faa5df5", "description": "Unique id for this request, for tracing and support." } } }, "sds_L_Fsr74jXxRwFrRFUiukT_b2b84a70e24d2a2c_ref4": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_b2b84a70e24d2a2c_ref3" } } }, "description": "Missing or invalid API key." }, "sds_L_Fsr74jXxRwFrRFUiukT_b2b84a70e24d2a2c_ref5": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_b2b84a70e24d2a2c_ref3" } } }, "description": "Not subscribed to this API." }, "sds_L_Fsr74jXxRwFrRFUiukT_b2b84a70e24d2a2c_ref6": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_b2b84a70e24d2a2c_ref3" } } }, "description": "Unknown route, or on `/product-details` a product Bing no longer lists." }, "sds_L_Fsr74jXxRwFrRFUiukT_b2b84a70e24d2a2c_ref7": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_b2b84a70e24d2a2c_ref3" } } }, "description": "Quota exhausted." }, "sds_L_Fsr74jXxRwFrRFUiukT_b2b84a70e24d2a2c_ref8": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_b2b84a70e24d2a2c_ref3" } } }, "description": "Unexpected error." }, "sds_L_Fsr74jXxRwFrRFUiukT_b2b84a70e24d2a2c_ref9": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_b2b84a70e24d2a2c_ref3" } } }, "description": "Bing could not be reached for this request. Retry; the request is not billed.\n\nA successful search that found no matches is a `200` with an empty result array." }, "sds_L_Fsr74jXxRwFrRFUiukT_44607288241e2156_ref0": { "type": "object", "required": [ "status", "request_id", "parameters", "data" ], "properties": { "data": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_44607288241e2156_ref1" }, "status": { "type": "string", "example": "OK", "description": "Response status. Always OK on success." }, "parameters": { "type": "object", "description": "The request parameters as received by the server.", "additionalProperties": true }, "request_id": { "type": "string", "example": "4f2a9d6e-1b3c-4f5a-8c7d-9e0f1a2b3c4d", "description": "Unique request identifier (UUID)." } } }, "sds_L_Fsr74jXxRwFrRFUiukT_44607288241e2156_ref1": { "type": "object", "required": [ "total_results", "total_pages", "current_page", "results_count", "items_per_page", "products" ], "properties": { "filters": { "type": "array", "items": { "type": "object", "required": [ "label", "is_color_swatch", "is_visual_nav", "options" ], "properties": { "label": { "type": "string", "example": "Brand", "description": "Filter (dimension) label." }, "options": { "type": "array", "items": { "type": "object", "required": [ "label" ], "properties": { "url": { "type": "string", "example": "/b/DEWALT/N-5yc1vZ4j2/Ntk-elastic/Ntt-DCD800B?NCNI-5", "nullable": true, "description": "URL applying this refinement." }, "label": { "type": "string", "example": "DEWALT", "description": "Refinement option label." }, "record_count": { "type": "string", "example": "54", "nullable": true, "description": "Number of products matching this refinement, returned as a string." }, "refinement_key": { "type": "string", "example": "4j2", "nullable": true, "description": "Refinement key (used to build filtered category URLs)." } } }, "description": "Up to 50 refinement options for this filter." }, "dimension_id": { "type": "string", "example": "4", "nullable": true, "description": "Home Depot dimension id." }, "is_visual_nav": { "type": "boolean", "example": true, "description": "Whether the filter is a visual navigation element." }, "is_color_swatch": { "type": "boolean", "example": false, "description": "Whether the filter is rendered as color swatches." } } }, "description": "Available refinement dimensions (filters) for the result set. Present when available." }, "keyword": { "type": "string", "example": "drill", "description": "The resolved search keyword. Present for Search and Item Lookup." }, "products": { "type": "array", "items": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_44607288241e2156_ref2" }, "description": "Products on this page." }, "brand_link": { "type": "object", "properties": { "url": { "type": "string", "nullable": true, "description": "Brand landing-page URL." }, "label": { "type": "string", "description": "Brand label." } }, "description": "Brand landing-page link. Present for some category browses." }, "breadcrumbs": { "type": "array", "items": { "type": "object", "required": [ "label" ], "properties": { "url": { "type": "string", "example": "https://www.homedepot.com/b/Tools/N-5yc1vZc1xy", "nullable": true, "description": "Breadcrumb URL." }, "label": { "type": "string", "example": "Tools", "description": "Breadcrumb label." }, "dimension_name": { "type": "string", "example": "Category", "nullable": true, "description": "Dimension name for the breadcrumb." }, "refinement_key": { "type": "string", "example": "c1xy", "nullable": true, "description": "Refinement key for the breadcrumb." } } }, "description": "Category breadcrumb trail for the result set. Present when available." }, "category_id": { "type": "string", "example": "fc67ed91-4c88-454f-a837-e3a3a07f27a9", "description": "Home Depot category id associated with the result set. Present when available." }, "total_pages": { "type": "integer", "example": 30, "description": "Total number of pages available (capped at 30)." }, "current_page": { "type": "integer", "example": 1, "description": "The page number returned." }, "canonical_url": { "type": "string", "example": "https://www.homedepot.com/b/Tools/N-5yc1vZc1xy/Ntk-elasticplus/Ntt-drill?NCNI-5", "description": "Canonical Home Depot listing URL for this result set. Present when available." }, "results_count": { "type": "integer", "example": 24, "description": "Number of products returned on this page." }, "total_results": { "type": "integer", "example": 4939, "description": "Total number of matching products across all pages." }, "items_per_page": { "type": "integer", "example": 24, "description": "Page size used for this request." }, "applied_filters": { "type": "array", "items": { "type": "object", "properties": { "deselect_url": { "type": "string", "nullable": true, "description": "URL that removes (deselects) this refinement." }, "refinement_key": { "type": "string", "nullable": true, "description": "Applied refinement key." }, "dimension_label": { "type": "string", "description": "Dimension label of the applied refinement." }, "refinement_label": { "type": "string", "description": "Applied refinement label." } } }, "description": "Currently applied refinements. Present only when filters are active." }, "search_redirect": { "type": "string", "description": "Redirect target when Home Depot redirects the search. Present only when a redirect occurs." }, "related_searches": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string", "nullable": true, "description": "Related search URL." }, "title": { "type": "string", "description": "Related search title." } } }, "description": "Related search suggestions. Present when available." }, "spelling_correction": { "type": "string", "example": "drill", "description": "Corrected keyword when Home Depot applied a spelling correction. Present only when corrected." } }, "description": "Result-set metadata shared by Search, Products By Category, and Item Lookup." }, "sds_L_Fsr74jXxRwFrRFUiukT_44607288241e2156_ref2": { "type": "object", "required": [ "item_id", "title", "brand", "model_no", "sku_id", "upc", "product_type", "sku_classification", "thumbnail", "images", "pricing", "rating", "total_reviews", "in_stock", "is_buyable", "availability_type", "is_discontinued", "backordered", "is_sponsored", "is_live_goods", "hide_price", "eco_rebates", "url" ], "properties": { "upc": { "type": "string", "example": "0033287225422", "nullable": true, "description": "UPC / GTIN-13 barcode. Null when not provided by Home Depot." }, "url": { "type": "string", "example": "https://www.homedepot.com/p/DEWALT-20V-MAX-Cordless-Drill-Driver-DCD771C2/204279858", "nullable": true, "description": "Canonical Home Depot product page URL." }, "brand": { "type": "string", "example": "DEWALT", "nullable": true, "description": "Brand / manufacturer name." }, "title": { "type": "string", "example": "20V MAX Cordless 1/2 in. Drill/Driver, (2) 20V 1.3Ah Batteries, Charger and Bag", "nullable": true, "description": "Full product title as shown on Home Depot." }, "badges": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "example": "top rated", "nullable": true, "description": "Badge internal name." }, "label": { "type": "string", "example": "Top Rated", "nullable": true, "description": "Badge display label." } } }, "description": "Merchandising badges on the product (e.g. Best Seller, Top Rated). Present when available." }, "images": { "type": "array", "items": { "type": "string", "description": "Product image URL." }, "nullable": true, "description": "List of product image URLs. Null when no images are available." }, "rating": { "type": "number", "example": 4.6241, "nullable": true, "description": "Average customer rating (0-5). Null when the product has no reviews." }, "sku_id": { "type": "string", "example": "1000014677", "nullable": true, "description": "Home Depot store SKU number." }, "item_id": { "type": "string", "example": "204279858", "description": "Home Depot internet number (unique product id)." }, "pricing": { "allOf": [ { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_44607288241e2156_ref3" } ], "nullable": true, "description": "Pricing information. Null when the product has no displayable price." }, "features": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "example": "Voltage", "description": "Feature name." }, "value": { "type": "string", "example": "20V", "description": "Feature value." } } }, "description": "Key product feature name/value pairs. Present when available on search results." }, "in_stock": { "type": "boolean", "example": true, "description": "Whether the product is currently in stock / buyable." }, "model_no": { "type": "string", "example": "DCD771C2", "nullable": true, "description": "Manufacturer model number." }, "thumbnail": { "type": "string", "example": "https://images.thdstatic.com/productImages/8c8e6b8d/svn/dewalt-power-drills-dcd771c2-64_1000.jpg", "nullable": true, "description": "Primary product image URL." }, "department": { "type": "string", "example": "Power Drills", "description": "Product department name. Present when Home Depot provides department taxonomy." }, "hide_price": { "type": "boolean", "example": false, "description": "Whether Home Depot hides the price for this product." }, "is_buyable": { "type": "boolean", "example": true, "description": "Whether the product can currently be purchased." }, "backordered": { "type": "boolean", "example": false, "description": "Whether the product is currently backordered." }, "breadcrumbs": { "type": "array", "items": { "type": "string", "example": "Tools", "description": "Breadcrumb label." }, "description": "Category breadcrumb labels (top-level to leaf). Present when available." }, "description": { "type": "string", "description": "Short product description. Rarely present on search results." }, "eco_rebates": { "type": "string", "example": null, "nullable": true, "description": "Eco-rebate information when available, otherwise null." }, "fulfillment": { "allOf": [ { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_44607288241e2156_ref4" } ], "description": "Pickup and delivery fulfillment options. Present when available." }, "class_number": { "type": "string", "example": "9", "description": "Product class number. Present when available." }, "is_sponsored": { "type": "boolean", "example": false, "description": "Whether this is a sponsored / paid-placement result." }, "product_type": { "type": "string", "example": "MERCHANDISE", "nullable": true, "description": "Product type classification (e.g. MERCHANDISE)." }, "subscription": { "type": "object", "properties": { "enabled": { "type": "boolean", "example": true, "description": "Whether subscription purchase is enabled." }, "default_frequency": { "type": "string", "nullable": true, "description": "Default delivery frequency." }, "discount_percentage": { "type": "number", "example": 5, "nullable": true, "description": "Subscription discount percentage." } }, "description": "Subscribe & Save information. Present only when subscription is enabled." }, "department_id": { "type": "string", "example": "569647", "description": "Product department id. Present when available." }, "is_live_goods": { "type": "boolean", "example": false, "description": "Whether the product is a live good (e.g. live plants)." }, "total_reviews": { "type": "string", "example": "11296", "description": "Total number of customer reviews, returned as a string. \"0\" when there are no reviews." }, "is_discontinued": { "type": "boolean", "example": false, "description": "Whether the product has been discontinued." }, "seo_description": { "type": "string", "description": "SEO product description. Present when available." }, "product_sub_type": { "type": "object", "properties": { "url": { "type": "string", "nullable": true, "description": "Sub-type category URL." }, "name": { "type": "string", "example": "Cordless Drills", "description": "Sub-type name." } }, "description": "Product sub-type (sub-category). Present when available." }, "availability_type": { "type": "string", "example": "Online", "nullable": true, "description": "Availability channel (e.g. Online, Shared, In Store)." }, "sub_department_id": { "type": "string", "example": "569648", "description": "Product sub-department id. Present when available." }, "sku_classification": { "type": "string", "example": null, "nullable": true, "description": "SKU classification code. Null when not provided." }, "excluded_ship_states": { "type": "array", "items": { "type": "string", "example": "CA", "description": "2-letter US state code." }, "description": "US states the product cannot ship to. Present only when shipping is restricted." } }, "description": "A single Home Depot product as returned by Search, Products By Category, and Item Lookup." }, "sds_L_Fsr74jXxRwFrRFUiukT_44607288241e2156_ref3": { "type": "object", "required": [ "current_price", "original_price", "currency" ], "properties": { "message": { "type": "string", "description": "Pricing message (e.g. map pricing notice). Present when available." }, "currency": { "type": "string", "example": "USD", "description": "ISO 4217 currency code. Always USD." }, "discount": { "type": "object", "properties": { "type": { "type": "string", "nullable": true, "description": "Promotion type." }, "amount": { "type": "number", "example": 50, "nullable": true, "description": "Dollar amount off." }, "campaign": { "type": "string", "example": "Special Buys", "nullable": true, "description": "Promotion campaign / savings center name." }, "end_date": { "type": "string", "nullable": true, "description": "Promotion end date." }, "percentage": { "type": "number", "example": 28, "nullable": true, "description": "Percentage off." }, "start_date": { "type": "string", "nullable": true, "description": "Promotion start date." }, "long_description": { "type": "string", "nullable": true, "description": "Long promotion description." }, "short_description": { "type": "string", "nullable": true, "description": "Short promotion description." } }, "description": "Discount / promotion details. Present only when the product is on promotion." }, "special_buy": { "type": "boolean", "example": true, "description": "Whether the item is a Special Buy. Present only when true." }, "bulk_pricing": { "type": "object", "properties": { "value": { "type": "number", "nullable": true, "description": "Bulk price value." }, "price_per_unit": { "type": "number", "nullable": true, "description": "Price per unit at the bulk threshold." }, "threshold_quantity": { "type": "number", "nullable": true, "description": "Quantity required to qualify for the bulk price." } }, "description": "Bulk pricing tier. Present only when available." }, "unit_pricing": { "type": "object", "properties": { "value": { "type": "number", "nullable": true, "description": "Unit price value." }, "units_per_case": { "type": "number", "nullable": true, "description": "Number of units per case." }, "unit_of_measure": { "type": "string", "nullable": true, "description": "Case unit of measure." } }, "description": "Per-unit / per-case pricing. Present when available." }, "current_price": { "type": "number", "example": 129, "nullable": true, "description": "Current displayed price. Null when no price is shown." }, "original_price": { "type": "number", "example": 179, "nullable": true, "description": "Original (was) price before discount. Null when there is no markdown." }, "clearance_price": { "type": "number", "example": 89.99, "description": "Clearance price. Present only for clearance items." }, "unit_of_measure": { "type": "string", "example": "/sq. ft.", "description": "Unit-of-measure coverage text. Present when available." }, "alternate_price_display": { "type": "string", "description": "Alternate price display text. Present when available." }, "map_above_original_price": { "type": "boolean", "example": true, "description": "Whether MAP pricing is above the original price. Present only when true." } }, "description": "Product pricing details." }, "sds_L_Fsr74jXxRwFrRFUiukT_44607288241e2156_ref4": { "type": "object", "properties": { "pickup": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_44607288241e2156_ref5" }, "delivery": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_44607288241e2156_ref5" } }, "description": "Pickup and delivery fulfillment options. Each key is present only when that fulfillment method is available." }, "sds_L_Fsr74jXxRwFrRFUiukT_44607288241e2156_ref5": { "type": "object", "required": [ "fulfillable", "services" ], "properties": { "services": { "type": "array", "items": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_44607288241e2156_ref6" }, "description": "Available services for this fulfillment method." }, "fulfillable": { "type": "boolean", "example": true, "description": "Whether the method can fulfill the product for the requested location." } }, "description": "A fulfillment method (pickup or delivery) with its available services." }, "sds_L_Fsr74jXxRwFrRFUiukT_44607288241e2156_ref6": { "type": "object", "required": [ "type", "has_free_shipping", "optimal" ], "properties": { "type": { "type": "string", "example": "sth", "nullable": true, "description": "Service type code (e.g. sth, boss, bopis)." }, "optimal": { "type": "boolean", "example": true, "description": "Whether this is the optimal (recommended) fulfillment option." }, "locations": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "online", "nullable": true, "description": "Location type." }, "state": { "type": "string", "example": "GA", "nullable": true, "description": "Store state (2-letter code)." }, "distance": { "type": "number", "example": 0, "nullable": true, "description": "Distance to the store." }, "inventory": { "type": "object", "nullable": true, "properties": { "in_stock": { "type": "boolean", "example": true, "description": "Whether the item is in stock." }, "quantity": { "type": "number", "example": 1515, "nullable": true, "description": "Available quantity." }, "unavailable": { "type": "boolean", "example": false, "description": "Whether the item is unavailable." }, "out_of_stock": { "type": "boolean", "example": false, "description": "Whether the item is out of stock." }, "max_bopis_qty": { "type": "number", "nullable": true, "description": "Maximum buy-online-pickup-in-store quantity." }, "min_bopis_qty": { "type": "number", "nullable": true, "description": "Minimum buy-online-pickup-in-store quantity." }, "limited_quantity": { "type": "boolean", "example": false, "description": "Whether quantity is limited." } }, "description": "Inventory at this location." }, "store_name": { "type": "string", "example": "Cumberland", "nullable": true, "description": "Store name." }, "location_id": { "type": "string", "example": "121", "nullable": true, "description": "Store / location id." }, "store_phone": { "type": "string", "example": "(770)432-9930", "nullable": true, "description": "Store phone number." }, "curbside_pickup": { "type": "boolean", "example": false, "description": "Whether curbside pickup is available." } } }, "description": "Up to 5 store/fulfillment locations for this service. Present when provided." }, "dynamic_eta": { "type": "object", "properties": { "hours": { "type": "number", "nullable": true, "description": "ETA hours." }, "minutes": { "type": "number", "nullable": true, "description": "ETA minutes." } }, "description": "Dynamic ETA. Present when provided." }, "total_charge": { "type": "number", "example": 0, "nullable": true, "description": "Total charge for this service." }, "delivery_dates": { "type": "object", "properties": { "end": { "type": "string", "example": "2026-06-09", "nullable": true, "description": "End of the delivery window." }, "start": { "type": "string", "example": "2026-06-09", "nullable": true, "description": "Start of the delivery window." } }, "description": "Delivery date window. Present when provided." }, "delivery_charge": { "type": "number", "nullable": true, "description": "Delivery charge for this service." }, "delivery_timeline": { "type": "string", "example": "tomorrow", "nullable": true, "description": "Human-readable delivery timeline (e.g. tomorrow)." }, "has_free_shipping": { "type": "boolean", "example": true, "description": "Whether this service offers free shipping." }, "latest_delivery_date": { "type": "string", "nullable": true, "description": "Latest delivery date." }, "earliest_delivery_date": { "type": "string", "nullable": true, "description": "Earliest delivery date." }, "free_delivery_threshold": { "type": "number", "nullable": true, "description": "Order value required for free delivery." } }, "description": "A single fulfillment service (e.g. ship-to-home, buy-online-ship-to-store)." }, "sds_L_Fsr74jXxRwFrRFUiukT_4cc5291d5f1e29dd_ref0": { "type": "object", "required": [ "status", "request_id", "parameters", "data" ], "properties": { "data": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_4cc5291d5f1e29dd_ref1" }, "status": { "type": "string", "example": "OK", "description": "Response status. Always OK on success." }, "parameters": { "type": "object", "description": "The request parameters as received by the server.", "additionalProperties": true }, "request_id": { "type": "string", "example": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "description": "Unique request identifier (UUID)." } } }, "sds_L_Fsr74jXxRwFrRFUiukT_4cc5291d5f1e29dd_ref1": { "type": "object", "required": [ "item_id", "url", "title", "brand", "model_no", "sku_id", "upc", "product_type", "parent_id", "description", "seo_description", "highlights", "images", "thumbnail", "videos", "has_360_view", "pricing", "rating", "total_reviews", "rating_histogram", "in_stock", "is_buyable", "availability_type", "is_discontinued", "backordered", "online_store_only", "is_live_goods", "favorites_count", "is_gift_card", "is_generic_product", "replacement_omsid" ], "properties": { "upc": { "type": "string", "example": "0033287225422", "nullable": true, "description": "UPC / GTIN-13 barcode. Null when not provided." }, "url": { "type": "string", "example": "https://www.homedepot.com/p/RYOBI-ONE-18V-Cordless-Drill-Driver-Kit-PCL201K1/326680222", "nullable": true, "description": "Canonical Home Depot product page URL." }, "brand": { "type": "string", "example": "RYOBI", "nullable": true, "description": "Brand / manufacturer name." }, "title": { "type": "string", "example": "ONE+ 18V Cordless 3/8 in. Drill/Driver Kit with Compact Battery and Charger", "nullable": true, "description": "Full product title." }, "badges": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "example": "Event Badge", "nullable": true, "description": "Badge internal name." }, "label": { "type": "string", "example": "Father's Day Gifts", "nullable": true, "description": "Badge display label." } } }, "description": "Merchandising badges on the product. Present when available." }, "images": { "type": "array", "items": { "type": "string", "description": "Product image URL." }, "nullable": true, "description": "Product image URLs. Null when none." }, "rating": { "type": "number", "example": 4.606, "nullable": true, "description": "Average customer rating (0-5). Null when no reviews." }, "sku_id": { "type": "string", "example": "1010127831", "nullable": true, "description": "Home Depot store SKU number." }, "videos": { "type": "array", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "description": "Video URL." }, "title": { "type": "string", "nullable": true, "description": "Video title." }, "thumbnail": { "type": "string", "nullable": true, "description": "Video thumbnail URL." } } }, "nullable": true, "description": "Product videos. Null when none." }, "item_id": { "type": "string", "example": "326680222", "description": "Home Depot internet number (unique product id)." }, "pricing": { "allOf": [ { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_4cc5291d5f1e29dd_ref2" } ], "nullable": true, "description": "Pricing information. Null when no displayable price." }, "in_stock": { "type": "boolean", "example": true, "description": "Whether the product is currently in stock / buyable." }, "model_no": { "type": "string", "example": "PCL201K1", "nullable": true, "description": "Manufacturer model number." }, "parent_id": { "type": "string", "example": "321561137", "nullable": true, "description": "Parent product id for variant products. Null when not a variant." }, "thumbnail": { "type": "string", "example": "https://images.thdstatic.com/productImages/4bc923ed/svn/ryobi-power-drills-pcl201k1-64_1000.jpg", "nullable": true, "description": "Primary product image URL." }, "attributes": { "type": "object", "example": { "Bullet01": "This drill set is ideal for everyday DIY - fasten materials, drill pilot holes, and more" }, "description": "Flat key-value list of descriptive attributes. Present when available.", "additionalProperties": { "type": "string", "nullable": true, "description": "Attribute value." } }, "brand_link": { "type": "object", "properties": { "url": { "type": "string", "nullable": true, "description": "Brand landing-page URL." }, "label": { "type": "string", "description": "Brand label." }, "logo_url": { "type": "string", "nullable": true, "description": "Brand logo URL." } }, "description": "Brand / manufacturer landing-page link. Present when available." }, "department": { "type": "string", "example": "25", "description": "Product department. Present when available." }, "dimensions": { "type": "array", "items": { "type": "object", "required": [ "name", "value" ], "properties": { "name": { "type": "string", "example": "Product Height (in.)", "description": "Dimension attribute name." }, "value": { "type": "string", "example": "8.25 in", "description": "Dimension attribute value." }, "dimensions": { "type": "string", "nullable": true, "description": "Raw dimensions string when provided." } } }, "description": "Product dimension attributes. Present when available." }, "highlights": { "type": "array", "items": { "type": "string", "example": "Lightweight Design For Increased Comfort During Use", "description": "Highlight text." }, "nullable": true, "description": "Bulleted product highlights. Null when not provided." }, "is_buyable": { "type": "boolean", "example": true, "description": "Whether the product can currently be purchased." }, "backordered": { "type": "boolean", "example": false, "description": "Whether the product is currently backordered." }, "breadcrumbs": { "type": "array", "items": { "type": "object", "required": [ "label" ], "properties": { "url": { "type": "string", "example": "https://www.homedepot.com/b/Tools/N-5yc1vZc1xy", "nullable": true, "description": "Breadcrumb URL." }, "label": { "type": "string", "example": "Tools", "description": "Breadcrumb label." } } }, "description": "Category breadcrumb trail. Present when available." }, "description": { "type": "string", "example": "The RYOBI 18V ONE+ 3/8 in. Cordless Drill/Driver has the power and speed to tackle DIY weekend projects.", "nullable": true, "description": "Full product description." }, "fulfillment": { "allOf": [ { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_4cc5291d5f1e29dd_ref3" } ], "description": "Pickup and delivery fulfillment options. Present when available." }, "class_number": { "type": "string", "example": "9", "description": "Product class number. Present when available." }, "configurator": { "type": "object", "properties": { "type": { "type": "string", "nullable": true, "description": "Configurator type." }, "enabled": { "type": "boolean", "example": true, "description": "Whether the configurator is enabled." }, "entry_flow": { "type": "string", "nullable": true, "description": "Configurator entry flow." } }, "description": "Custom-build / configurator info. Present only when enabled." }, "has_360_view": { "type": "boolean", "example": false, "description": "Whether the product has a 360-degree image view." }, "is_gift_card": { "type": "boolean", "example": false, "description": "Whether the product is a gift card." }, "key_features": { "type": "array", "items": { "type": "object", "required": [ "name", "value" ], "properties": { "name": { "type": "string", "example": "Battery Voltage (V)", "description": "Feature name." }, "image": { "type": "string", "nullable": true, "description": "Feature image URL." }, "value": { "type": "string", "example": "18V", "description": "Feature value." }, "refinement_id": { "type": "string", "example": "4296349262", "nullable": true, "description": "Refinement id for this feature value." }, "refinement_url": { "type": "string", "example": "/b/Tools-Power-Tools-Drills-Power-Drills/18V/N-5yc1vZc7jjZ1z1xob2", "nullable": true, "description": "URL filtering the category by this feature value." } } }, "description": "Key product feature name/value pairs with refinement links. Present when available." }, "product_type": { "type": "string", "example": "MERCHANDISE", "nullable": true, "description": "Product type classification (e.g. MERCHANDISE)." }, "subscription": { "type": "object", "properties": { "enabled": { "type": "boolean", "example": true, "description": "Whether subscription purchase is enabled." }, "default_frequency": { "type": "string", "nullable": true, "description": "Default delivery frequency." }, "discount_percentage": { "type": "number", "nullable": true, "description": "Subscription discount percentage." } }, "description": "Subscribe & Save information. Present only when enabled." }, "department_id": { "type": "string", "example": "569647", "description": "Product department id. Present when available." }, "is_live_goods": { "type": "boolean", "example": false, "description": "Whether the product is a live good (e.g. live plants)." }, "paint_details": { "type": "object", "properties": { "brand": { "type": "string", "nullable": true, "description": "Paint brand." }, "family": { "type": "string", "nullable": true, "description": "Paint family." }, "finish": { "type": "string", "nullable": true, "description": "Paint finish." }, "product": { "type": "string", "nullable": true, "description": "Paint product name." }, "brand_finish_image": { "type": "string", "nullable": true, "description": "Brand/finish image URL." } }, "description": "Paint-specific details. Present only for paint products." }, "total_reviews": { "type": "string", "example": "3881", "description": "Total number of customer reviews, returned as a string. \"0\" when none." }, "specifications": { "type": "object", "example": { "Details": { "Chuck Size (In.)": "3/8 In.", "Battery Power Type": "Lithium Ion" }, "Dimensions": { "Product Height (in.)": "8.25 in" } }, "description": "Product specifications grouped by section title. Each value is an object of spec-name to spec-value. Present when available.", "additionalProperties": { "type": "object", "additionalProperties": { "type": "string", "nullable": true, "description": "Specification value." } } }, "favorites_count": { "type": "integer", "example": 1200, "nullable": true, "description": "Number of times the product has been favorited. Null when not provided." }, "is_discontinued": { "type": "boolean", "example": false, "description": "Whether the product has been discontinued." }, "seo_description": { "type": "string", "nullable": true, "description": "SEO product description. Null when not provided." }, "product_sub_type": { "type": "object", "properties": { "url": { "type": "string", "nullable": true, "description": "Sub-type category URL." }, "name": { "type": "string", "description": "Sub-type name." } }, "description": "Product sub-type (sub-category). Present when available." }, "rating_histogram": { "type": "array", "items": { "type": "object", "required": [ "rating", "count" ], "properties": { "count": { "type": "integer", "example": 9567, "description": "Number of ratings at this star level." }, "rating": { "type": "integer", "example": 5, "description": "Star level (1-5)." } } }, "nullable": true, "description": "Per-star rating counts. Null when not provided on the product detail page (use the Product Reviews endpoint for a guaranteed histogram)." }, "availability_type": { "type": "string", "example": "Shared", "nullable": true, "description": "Availability channel (e.g. Online, Shared, In Store)." }, "online_store_only": { "type": "boolean", "example": false, "description": "Whether the product is available online only." }, "replacement_omsid": { "type": "string", "example": null, "nullable": true, "description": "Replacement product OMSID when the product has been replaced. Null otherwise." }, "sub_department_id": { "type": "string", "description": "Product sub-department id. Present when available." }, "category_hierarchy": { "type": "array", "items": { "type": "string", "description": "Category hierarchy entry." }, "description": "Category hierarchy ids/labels. Present when available." }, "is_generic_product": { "type": "boolean", "example": false, "description": "Whether the product is a generic product." }, "excluded_ship_states": { "type": "array", "items": { "type": "string", "description": "2-letter US state code." }, "description": "US states the product cannot ship to. Present only when shipping is restricted." } }, "description": "Full product detail object returned by Product Details." }, "sds_L_Fsr74jXxRwFrRFUiukT_4cc5291d5f1e29dd_ref2": { "type": "object", "required": [ "current_price", "original_price", "currency" ], "properties": { "message": { "type": "string", "description": "Pricing message (e.g. map pricing notice). Present when available." }, "currency": { "type": "string", "example": "USD", "description": "ISO 4217 currency code. Always USD." }, "discount": { "type": "object", "properties": { "type": { "type": "string", "nullable": true, "description": "Promotion type." }, "amount": { "type": "number", "example": 50, "nullable": true, "description": "Dollar amount off." }, "campaign": { "type": "string", "example": "Special Buys", "nullable": true, "description": "Promotion campaign / savings center name." }, "end_date": { "type": "string", "nullable": true, "description": "Promotion end date." }, "percentage": { "type": "number", "example": 28, "nullable": true, "description": "Percentage off." }, "start_date": { "type": "string", "nullable": true, "description": "Promotion start date." }, "long_description": { "type": "string", "nullable": true, "description": "Long promotion description." }, "short_description": { "type": "string", "nullable": true, "description": "Short promotion description." } }, "description": "Discount / promotion details. Present only when the product is on promotion." }, "special_buy": { "type": "boolean", "example": true, "description": "Whether the item is a Special Buy. Present only when true." }, "bulk_pricing": { "type": "object", "properties": { "value": { "type": "number", "nullable": true, "description": "Bulk price value." }, "price_per_unit": { "type": "number", "nullable": true, "description": "Price per unit at the bulk threshold." }, "threshold_quantity": { "type": "number", "nullable": true, "description": "Quantity required to qualify for the bulk price." } }, "description": "Bulk pricing tier. Present only when available." }, "unit_pricing": { "type": "object", "properties": { "value": { "type": "number", "nullable": true, "description": "Unit price value." }, "units_per_case": { "type": "number", "nullable": true, "description": "Number of units per case." }, "unit_of_measure": { "type": "string", "nullable": true, "description": "Case unit of measure." } }, "description": "Per-unit / per-case pricing. Present when available." }, "current_price": { "type": "number", "example": 129, "nullable": true, "description": "Current displayed price. Null when no price is shown." }, "original_price": { "type": "number", "example": 179, "nullable": true, "description": "Original (was) price before discount. Null when there is no markdown." }, "clearance_price": { "type": "number", "example": 89.99, "description": "Clearance price. Present only for clearance items." }, "unit_of_measure": { "type": "string", "example": "/sq. ft.", "description": "Unit-of-measure coverage text. Present when available." }, "alternate_price_display": { "type": "string", "description": "Alternate price display text. Present when available." }, "map_above_original_price": { "type": "boolean", "example": true, "description": "Whether MAP pricing is above the original price. Present only when true." } }, "description": "Product pricing details." }, "sds_L_Fsr74jXxRwFrRFUiukT_4cc5291d5f1e29dd_ref3": { "type": "object", "properties": { "pickup": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_4cc5291d5f1e29dd_ref4" }, "delivery": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_4cc5291d5f1e29dd_ref4" } }, "description": "Pickup and delivery fulfillment options. Each key is present only when that fulfillment method is available." }, "sds_L_Fsr74jXxRwFrRFUiukT_4cc5291d5f1e29dd_ref4": { "type": "object", "required": [ "fulfillable", "services" ], "properties": { "services": { "type": "array", "items": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_4cc5291d5f1e29dd_ref5" }, "description": "Available services for this fulfillment method." }, "fulfillable": { "type": "boolean", "example": true, "description": "Whether the method can fulfill the product for the requested location." } }, "description": "A fulfillment method (pickup or delivery) with its available services." }, "sds_L_Fsr74jXxRwFrRFUiukT_4cc5291d5f1e29dd_ref5": { "type": "object", "required": [ "type", "has_free_shipping", "optimal" ], "properties": { "type": { "type": "string", "example": "sth", "nullable": true, "description": "Service type code (e.g. sth, boss, bopis)." }, "optimal": { "type": "boolean", "example": true, "description": "Whether this is the optimal (recommended) fulfillment option." }, "locations": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "online", "nullable": true, "description": "Location type." }, "state": { "type": "string", "example": "GA", "nullable": true, "description": "Store state (2-letter code)." }, "distance": { "type": "number", "example": 0, "nullable": true, "description": "Distance to the store." }, "inventory": { "type": "object", "nullable": true, "properties": { "in_stock": { "type": "boolean", "example": true, "description": "Whether the item is in stock." }, "quantity": { "type": "number", "example": 1515, "nullable": true, "description": "Available quantity." }, "unavailable": { "type": "boolean", "example": false, "description": "Whether the item is unavailable." }, "out_of_stock": { "type": "boolean", "example": false, "description": "Whether the item is out of stock." }, "max_bopis_qty": { "type": "number", "nullable": true, "description": "Maximum buy-online-pickup-in-store quantity." }, "min_bopis_qty": { "type": "number", "nullable": true, "description": "Minimum buy-online-pickup-in-store quantity." }, "limited_quantity": { "type": "boolean", "example": false, "description": "Whether quantity is limited." } }, "description": "Inventory at this location." }, "store_name": { "type": "string", "example": "Cumberland", "nullable": true, "description": "Store name." }, "location_id": { "type": "string", "example": "121", "nullable": true, "description": "Store / location id." }, "store_phone": { "type": "string", "example": "(770)432-9930", "nullable": true, "description": "Store phone number." }, "curbside_pickup": { "type": "boolean", "example": false, "description": "Whether curbside pickup is available." } } }, "description": "Up to 5 store/fulfillment locations for this service. Present when provided." }, "dynamic_eta": { "type": "object", "properties": { "hours": { "type": "number", "nullable": true, "description": "ETA hours." }, "minutes": { "type": "number", "nullable": true, "description": "ETA minutes." } }, "description": "Dynamic ETA. Present when provided." }, "total_charge": { "type": "number", "example": 0, "nullable": true, "description": "Total charge for this service." }, "delivery_dates": { "type": "object", "properties": { "end": { "type": "string", "example": "2026-06-09", "nullable": true, "description": "End of the delivery window." }, "start": { "type": "string", "example": "2026-06-09", "nullable": true, "description": "Start of the delivery window." } }, "description": "Delivery date window. Present when provided." }, "delivery_charge": { "type": "number", "nullable": true, "description": "Delivery charge for this service." }, "delivery_timeline": { "type": "string", "example": "tomorrow", "nullable": true, "description": "Human-readable delivery timeline (e.g. tomorrow)." }, "has_free_shipping": { "type": "boolean", "example": true, "description": "Whether this service offers free shipping." }, "latest_delivery_date": { "type": "string", "nullable": true, "description": "Latest delivery date." }, "earliest_delivery_date": { "type": "string", "nullable": true, "description": "Earliest delivery date." }, "free_delivery_threshold": { "type": "number", "nullable": true, "description": "Order value required for free delivery." } }, "description": "A single fulfillment service (e.g. ship-to-home, buy-online-ship-to-store)." }, "sds_L_Fsr74jXxRwFrRFUiukT_c31636a96b1a678b_ref0": { "type": "object", "required": [ "status", "request_id", "parameters", "data" ], "properties": { "data": { "type": "object", "required": [ "total_reviews", "total_pages", "current_page", "reviews_count", "items_per_page", "rating", "rating_histogram", "sort_by", "item_id", "reviews" ], "properties": { "rating": { "type": "number", "example": 4.33, "nullable": true, "description": "Average overall product rating (0-5). Null when no rating statistics are available." }, "item_id": { "type": "string", "example": "300569432", "description": "The Home Depot internet number the reviews belong to." }, "reviews": { "type": "array", "items": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_c31636a96b1a678b_ref1" }, "description": "Reviews on this page." }, "sort_by": { "type": "string", "example": "helpful", "description": "The sort order applied to the reviews." }, "total_pages": { "type": "integer", "example": 701, "description": "Total number of pages available." }, "current_page": { "type": "integer", "example": 1, "description": "The page number returned." }, "reviews_count": { "type": "integer", "example": 20, "description": "Number of reviews returned on this page." }, "total_reviews": { "type": "integer", "example": 14003, "description": "Total number of reviews across all pages." }, "items_per_page": { "type": "integer", "example": 20, "description": "Page size used for this request." }, "rating_histogram": { "type": "array", "items": { "type": "object", "required": [ "rating", "count" ], "properties": { "count": { "type": "integer", "example": 9567, "description": "Number of ratings at this star level." }, "rating": { "type": "integer", "example": 5, "description": "Star level (1-5)." } } }, "nullable": true, "description": "Per-star rating counts (always 5 down to 1 when statistics are available). Null when no statistics." }, "total_recommended": { "type": "integer", "example": 2062, "description": "Number of reviewers who recommend the product. Present when statistics are available." }, "total_not_recommended": { "type": "integer", "example": 753, "description": "Number of reviewers who do not recommend the product. Present when statistics are available." } } }, "status": { "type": "string", "example": "OK", "description": "Response status. Always OK on success." }, "parameters": { "type": "object", "description": "The request parameters as received by the server.", "additionalProperties": true }, "request_id": { "type": "string", "example": "f1e2d3c4-b5a6-9788-7654-321098765432", "description": "Unique request identifier (UUID)." } } }, "sds_L_Fsr74jXxRwFrRFUiukT_c31636a96b1a678b_ref1": { "type": "object", "required": [ "review_id", "title", "review_text", "rating", "date", "last_modified", "is_recommended", "is_featured", "is_verified_purchaser", "badges", "helpful_count", "unhelpful_count", "comment_count", "author_id", "author_name", "author_location", "images", "product_id", "original_product_name", "merchant_responses", "context_data", "content_locale", "source_client" ], "properties": { "date": { "type": "string", "example": "2026-05-17T00:38:28.000+00:00", "nullable": true, "description": "Review submission timestamp (ISO 8601)." }, "title": { "type": "string", "example": null, "nullable": true, "description": "Review title. Null when not provided." }, "badges": { "type": "array", "items": { "type": "string", "example": "REVIEW", "description": "Badge identifier." }, "nullable": true, "description": "Review badges (e.g. verified purchaser, incentivized review). Null when none." }, "images": { "type": "array", "items": { "type": "string", "description": "Photo URL." }, "nullable": true, "description": "Reviewer-submitted photo URLs. Null when none." }, "rating": { "type": "integer", "example": 5, "nullable": true, "description": "Star rating given by the reviewer (1-5). Null when not provided." }, "author_id": { "type": "string", "example": "0312F027B573844E0S", "nullable": true, "description": "Reviewer id. Null when anonymous." }, "review_id": { "type": "string", "example": "301051925", "description": "Unique review id." }, "product_id": { "type": "string", "example": "327469574", "nullable": true, "description": "Product id the review is attached to (may be a variant). Null when not provided." }, "author_name": { "type": "string", "example": "User", "nullable": true, "description": "Reviewer nickname. Null when not provided." }, "is_featured": { "type": "boolean", "example": false, "description": "Whether the review is featured." }, "review_text": { "type": "string", "example": "Ortho Home Defense Insect Killer is a convenient retail product that effectively kills insects.", "nullable": true, "description": "Full review text. Null when not provided." }, "context_data": { "type": "object", "example": { "EarlyReviewerIncentive": "True" }, "nullable": true, "description": "Additional context flags recorded with the review (e.g. incentive flags, variant info). Null when none.", "additionalProperties": { "type": "string", "description": "Context value." } }, "comment_count": { "type": "integer", "example": 0, "description": "Number of comments on the review." }, "helpful_count": { "type": "integer", "example": 1, "description": "Number of positive (helpful) feedback votes." }, "last_modified": { "type": "string", "example": "2026-05-27T21:27:45.000+00:00", "nullable": true, "description": "Last modification timestamp (ISO 8601)." }, "source_client": { "type": "string", "example": "homedepot", "nullable": true, "description": "Source client that submitted the review." }, "content_locale": { "type": "string", "example": "en_US", "nullable": true, "description": "Review content locale." }, "is_recommended": { "type": "boolean", "example": null, "nullable": true, "description": "Whether the reviewer recommends the product. Null when the reviewer did not indicate." }, "author_location": { "type": "string", "example": null, "nullable": true, "description": "Reviewer location. Null when not provided." }, "unhelpful_count": { "type": "integer", "example": 0, "description": "Number of negative (unhelpful) feedback votes." }, "merchant_responses": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "string", "nullable": true, "description": "Response date." }, "response": { "type": "string", "nullable": true, "description": "Response text." }, "department": { "type": "string", "nullable": true, "description": "Responding department." } } }, "nullable": true, "description": "Merchant / client responses to the review. Null when none." }, "is_verified_purchaser": { "type": "boolean", "example": true, "description": "Whether the reviewer is a verified purchaser." }, "original_product_name": { "type": "string", "example": "Home Defense Insect Killer for Indoor and Perimeter 2 with Comfort Wand", "nullable": true, "description": "Product name as recorded with the review. Null when not provided." } }, "description": "A single customer review." }, "sds_L_Fsr74jXxRwFrRFUiukT_31f88892c8f25ad6_ref0": { "type": "object", "required": [ "status", "request_id", "parameters", "data" ], "properties": { "data": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_31f88892c8f25ad6_ref1" }, "status": { "type": "string", "example": "OK", "description": "Response status. Always OK on success." }, "parameters": { "type": "object", "description": "The request parameters as received by the server.", "additionalProperties": true }, "request_id": { "type": "string", "example": "4f2a9d6e-1b3c-4f5a-8c7d-9e0f1a2b3c4d", "description": "Unique request identifier (UUID)." } } }, "sds_L_Fsr74jXxRwFrRFUiukT_31f88892c8f25ad6_ref1": { "type": "object", "required": [ "total_results", "total_pages", "current_page", "results_count", "items_per_page", "products" ], "properties": { "filters": { "type": "array", "items": { "type": "object", "required": [ "label", "is_color_swatch", "is_visual_nav", "options" ], "properties": { "label": { "type": "string", "example": "Brand", "description": "Filter (dimension) label." }, "options": { "type": "array", "items": { "type": "object", "required": [ "label" ], "properties": { "url": { "type": "string", "example": "/b/DEWALT/N-5yc1vZ4j2/Ntk-elastic/Ntt-DCD800B?NCNI-5", "nullable": true, "description": "URL applying this refinement." }, "label": { "type": "string", "example": "DEWALT", "description": "Refinement option label." }, "record_count": { "type": "string", "example": "54", "nullable": true, "description": "Number of products matching this refinement, returned as a string." }, "refinement_key": { "type": "string", "example": "4j2", "nullable": true, "description": "Refinement key (used to build filtered category URLs)." } } }, "description": "Up to 50 refinement options for this filter." }, "dimension_id": { "type": "string", "example": "4", "nullable": true, "description": "Home Depot dimension id." }, "is_visual_nav": { "type": "boolean", "example": true, "description": "Whether the filter is a visual navigation element." }, "is_color_swatch": { "type": "boolean", "example": false, "description": "Whether the filter is rendered as color swatches." } } }, "description": "Available refinement dimensions (filters) for the result set. Present when available." }, "keyword": { "type": "string", "example": "drill", "description": "The resolved search keyword. Present for Search and Item Lookup." }, "products": { "type": "array", "items": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_31f88892c8f25ad6_ref2" }, "description": "Products on this page." }, "brand_link": { "type": "object", "properties": { "url": { "type": "string", "nullable": true, "description": "Brand landing-page URL." }, "label": { "type": "string", "description": "Brand label." } }, "description": "Brand landing-page link. Present for some category browses." }, "breadcrumbs": { "type": "array", "items": { "type": "object", "required": [ "label" ], "properties": { "url": { "type": "string", "example": "https://www.homedepot.com/b/Tools/N-5yc1vZc1xy", "nullable": true, "description": "Breadcrumb URL." }, "label": { "type": "string", "example": "Tools", "description": "Breadcrumb label." }, "dimension_name": { "type": "string", "example": "Category", "nullable": true, "description": "Dimension name for the breadcrumb." }, "refinement_key": { "type": "string", "example": "c1xy", "nullable": true, "description": "Refinement key for the breadcrumb." } } }, "description": "Category breadcrumb trail for the result set. Present when available." }, "category_id": { "type": "string", "example": "fc67ed91-4c88-454f-a837-e3a3a07f27a9", "description": "Home Depot category id associated with the result set. Present when available." }, "total_pages": { "type": "integer", "example": 30, "description": "Total number of pages available (capped at 30)." }, "current_page": { "type": "integer", "example": 1, "description": "The page number returned." }, "canonical_url": { "type": "string", "example": "https://www.homedepot.com/b/Tools/N-5yc1vZc1xy/Ntk-elasticplus/Ntt-drill?NCNI-5", "description": "Canonical Home Depot listing URL for this result set. Present when available." }, "results_count": { "type": "integer", "example": 24, "description": "Number of products returned on this page." }, "total_results": { "type": "integer", "example": 4939, "description": "Total number of matching products across all pages." }, "items_per_page": { "type": "integer", "example": 24, "description": "Page size used for this request." }, "applied_filters": { "type": "array", "items": { "type": "object", "properties": { "deselect_url": { "type": "string", "nullable": true, "description": "URL that removes (deselects) this refinement." }, "refinement_key": { "type": "string", "nullable": true, "description": "Applied refinement key." }, "dimension_label": { "type": "string", "description": "Dimension label of the applied refinement." }, "refinement_label": { "type": "string", "description": "Applied refinement label." } } }, "description": "Currently applied refinements. Present only when filters are active." }, "search_redirect": { "type": "string", "description": "Redirect target when Home Depot redirects the search. Present only when a redirect occurs." }, "related_searches": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string", "nullable": true, "description": "Related search URL." }, "title": { "type": "string", "description": "Related search title." } } }, "description": "Related search suggestions. Present when available." }, "spelling_correction": { "type": "string", "example": "drill", "description": "Corrected keyword when Home Depot applied a spelling correction. Present only when corrected." } }, "description": "Result-set metadata shared by Search, Products By Category, and Item Lookup." }, "sds_L_Fsr74jXxRwFrRFUiukT_31f88892c8f25ad6_ref2": { "type": "object", "required": [ "item_id", "title", "brand", "model_no", "sku_id", "upc", "product_type", "sku_classification", "thumbnail", "images", "pricing", "rating", "total_reviews", "in_stock", "is_buyable", "availability_type", "is_discontinued", "backordered", "is_sponsored", "is_live_goods", "hide_price", "eco_rebates", "url" ], "properties": { "upc": { "type": "string", "example": "0033287225422", "nullable": true, "description": "UPC / GTIN-13 barcode. Null when not provided by Home Depot." }, "url": { "type": "string", "example": "https://www.homedepot.com/p/DEWALT-20V-MAX-Cordless-Drill-Driver-DCD771C2/204279858", "nullable": true, "description": "Canonical Home Depot product page URL." }, "brand": { "type": "string", "example": "DEWALT", "nullable": true, "description": "Brand / manufacturer name." }, "title": { "type": "string", "example": "20V MAX Cordless 1/2 in. Drill/Driver, (2) 20V 1.3Ah Batteries, Charger and Bag", "nullable": true, "description": "Full product title as shown on Home Depot." }, "badges": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "example": "top rated", "nullable": true, "description": "Badge internal name." }, "label": { "type": "string", "example": "Top Rated", "nullable": true, "description": "Badge display label." } } }, "description": "Merchandising badges on the product (e.g. Best Seller, Top Rated). Present when available." }, "images": { "type": "array", "items": { "type": "string", "description": "Product image URL." }, "nullable": true, "description": "List of product image URLs. Null when no images are available." }, "rating": { "type": "number", "example": 4.6241, "nullable": true, "description": "Average customer rating (0-5). Null when the product has no reviews." }, "sku_id": { "type": "string", "example": "1000014677", "nullable": true, "description": "Home Depot store SKU number." }, "item_id": { "type": "string", "example": "204279858", "description": "Home Depot internet number (unique product id)." }, "pricing": { "allOf": [ { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_31f88892c8f25ad6_ref3" } ], "nullable": true, "description": "Pricing information. Null when the product has no displayable price." }, "features": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "example": "Voltage", "description": "Feature name." }, "value": { "type": "string", "example": "20V", "description": "Feature value." } } }, "description": "Key product feature name/value pairs. Present when available on search results." }, "in_stock": { "type": "boolean", "example": true, "description": "Whether the product is currently in stock / buyable." }, "model_no": { "type": "string", "example": "DCD771C2", "nullable": true, "description": "Manufacturer model number." }, "thumbnail": { "type": "string", "example": "https://images.thdstatic.com/productImages/8c8e6b8d/svn/dewalt-power-drills-dcd771c2-64_1000.jpg", "nullable": true, "description": "Primary product image URL." }, "department": { "type": "string", "example": "Power Drills", "description": "Product department name. Present when Home Depot provides department taxonomy." }, "hide_price": { "type": "boolean", "example": false, "description": "Whether Home Depot hides the price for this product." }, "is_buyable": { "type": "boolean", "example": true, "description": "Whether the product can currently be purchased." }, "backordered": { "type": "boolean", "example": false, "description": "Whether the product is currently backordered." }, "breadcrumbs": { "type": "array", "items": { "type": "string", "example": "Tools", "description": "Breadcrumb label." }, "description": "Category breadcrumb labels (top-level to leaf). Present when available." }, "description": { "type": "string", "description": "Short product description. Rarely present on search results." }, "eco_rebates": { "type": "string", "example": null, "nullable": true, "description": "Eco-rebate information when available, otherwise null." }, "fulfillment": { "allOf": [ { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_31f88892c8f25ad6_ref4" } ], "description": "Pickup and delivery fulfillment options. Present when available." }, "class_number": { "type": "string", "example": "9", "description": "Product class number. Present when available." }, "is_sponsored": { "type": "boolean", "example": false, "description": "Whether this is a sponsored / paid-placement result." }, "product_type": { "type": "string", "example": "MERCHANDISE", "nullable": true, "description": "Product type classification (e.g. MERCHANDISE)." }, "subscription": { "type": "object", "properties": { "enabled": { "type": "boolean", "example": true, "description": "Whether subscription purchase is enabled." }, "default_frequency": { "type": "string", "nullable": true, "description": "Default delivery frequency." }, "discount_percentage": { "type": "number", "example": 5, "nullable": true, "description": "Subscription discount percentage." } }, "description": "Subscribe & Save information. Present only when subscription is enabled." }, "department_id": { "type": "string", "example": "569647", "description": "Product department id. Present when available." }, "is_live_goods": { "type": "boolean", "example": false, "description": "Whether the product is a live good (e.g. live plants)." }, "total_reviews": { "type": "string", "example": "11296", "description": "Total number of customer reviews, returned as a string. \"0\" when there are no reviews." }, "is_discontinued": { "type": "boolean", "example": false, "description": "Whether the product has been discontinued." }, "seo_description": { "type": "string", "description": "SEO product description. Present when available." }, "product_sub_type": { "type": "object", "properties": { "url": { "type": "string", "nullable": true, "description": "Sub-type category URL." }, "name": { "type": "string", "example": "Cordless Drills", "description": "Sub-type name." } }, "description": "Product sub-type (sub-category). Present when available." }, "availability_type": { "type": "string", "example": "Online", "nullable": true, "description": "Availability channel (e.g. Online, Shared, In Store)." }, "sub_department_id": { "type": "string", "example": "569648", "description": "Product sub-department id. Present when available." }, "sku_classification": { "type": "string", "example": null, "nullable": true, "description": "SKU classification code. Null when not provided." }, "excluded_ship_states": { "type": "array", "items": { "type": "string", "example": "CA", "description": "2-letter US state code." }, "description": "US states the product cannot ship to. Present only when shipping is restricted." } }, "description": "A single Home Depot product as returned by Search, Products By Category, and Item Lookup." }, "sds_L_Fsr74jXxRwFrRFUiukT_31f88892c8f25ad6_ref3": { "type": "object", "required": [ "current_price", "original_price", "currency" ], "properties": { "message": { "type": "string", "description": "Pricing message (e.g. map pricing notice). Present when available." }, "currency": { "type": "string", "example": "USD", "description": "ISO 4217 currency code. Always USD." }, "discount": { "type": "object", "properties": { "type": { "type": "string", "nullable": true, "description": "Promotion type." }, "amount": { "type": "number", "example": 50, "nullable": true, "description": "Dollar amount off." }, "campaign": { "type": "string", "example": "Special Buys", "nullable": true, "description": "Promotion campaign / savings center name." }, "end_date": { "type": "string", "nullable": true, "description": "Promotion end date." }, "percentage": { "type": "number", "example": 28, "nullable": true, "description": "Percentage off." }, "start_date": { "type": "string", "nullable": true, "description": "Promotion start date." }, "long_description": { "type": "string", "nullable": true, "description": "Long promotion description." }, "short_description": { "type": "string", "nullable": true, "description": "Short promotion description." } }, "description": "Discount / promotion details. Present only when the product is on promotion." }, "special_buy": { "type": "boolean", "example": true, "description": "Whether the item is a Special Buy. Present only when true." }, "bulk_pricing": { "type": "object", "properties": { "value": { "type": "number", "nullable": true, "description": "Bulk price value." }, "price_per_unit": { "type": "number", "nullable": true, "description": "Price per unit at the bulk threshold." }, "threshold_quantity": { "type": "number", "nullable": true, "description": "Quantity required to qualify for the bulk price." } }, "description": "Bulk pricing tier. Present only when available." }, "unit_pricing": { "type": "object", "properties": { "value": { "type": "number", "nullable": true, "description": "Unit price value." }, "units_per_case": { "type": "number", "nullable": true, "description": "Number of units per case." }, "unit_of_measure": { "type": "string", "nullable": true, "description": "Case unit of measure." } }, "description": "Per-unit / per-case pricing. Present when available." }, "current_price": { "type": "number", "example": 129, "nullable": true, "description": "Current displayed price. Null when no price is shown." }, "original_price": { "type": "number", "example": 179, "nullable": true, "description": "Original (was) price before discount. Null when there is no markdown." }, "clearance_price": { "type": "number", "example": 89.99, "description": "Clearance price. Present only for clearance items." }, "unit_of_measure": { "type": "string", "example": "/sq. ft.", "description": "Unit-of-measure coverage text. Present when available." }, "alternate_price_display": { "type": "string", "description": "Alternate price display text. Present when available." }, "map_above_original_price": { "type": "boolean", "example": true, "description": "Whether MAP pricing is above the original price. Present only when true." } }, "description": "Product pricing details." }, "sds_L_Fsr74jXxRwFrRFUiukT_31f88892c8f25ad6_ref4": { "type": "object", "properties": { "pickup": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_31f88892c8f25ad6_ref5" }, "delivery": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_31f88892c8f25ad6_ref5" } }, "description": "Pickup and delivery fulfillment options. Each key is present only when that fulfillment method is available." }, "sds_L_Fsr74jXxRwFrRFUiukT_31f88892c8f25ad6_ref5": { "type": "object", "required": [ "fulfillable", "services" ], "properties": { "services": { "type": "array", "items": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_31f88892c8f25ad6_ref6" }, "description": "Available services for this fulfillment method." }, "fulfillable": { "type": "boolean", "example": true, "description": "Whether the method can fulfill the product for the requested location." } }, "description": "A fulfillment method (pickup or delivery) with its available services." }, "sds_L_Fsr74jXxRwFrRFUiukT_31f88892c8f25ad6_ref6": { "type": "object", "required": [ "type", "has_free_shipping", "optimal" ], "properties": { "type": { "type": "string", "example": "sth", "nullable": true, "description": "Service type code (e.g. sth, boss, bopis)." }, "optimal": { "type": "boolean", "example": true, "description": "Whether this is the optimal (recommended) fulfillment option." }, "locations": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "online", "nullable": true, "description": "Location type." }, "state": { "type": "string", "example": "GA", "nullable": true, "description": "Store state (2-letter code)." }, "distance": { "type": "number", "example": 0, "nullable": true, "description": "Distance to the store." }, "inventory": { "type": "object", "nullable": true, "properties": { "in_stock": { "type": "boolean", "example": true, "description": "Whether the item is in stock." }, "quantity": { "type": "number", "example": 1515, "nullable": true, "description": "Available quantity." }, "unavailable": { "type": "boolean", "example": false, "description": "Whether the item is unavailable." }, "out_of_stock": { "type": "boolean", "example": false, "description": "Whether the item is out of stock." }, "max_bopis_qty": { "type": "number", "nullable": true, "description": "Maximum buy-online-pickup-in-store quantity." }, "min_bopis_qty": { "type": "number", "nullable": true, "description": "Minimum buy-online-pickup-in-store quantity." }, "limited_quantity": { "type": "boolean", "example": false, "description": "Whether quantity is limited." } }, "description": "Inventory at this location." }, "store_name": { "type": "string", "example": "Cumberland", "nullable": true, "description": "Store name." }, "location_id": { "type": "string", "example": "121", "nullable": true, "description": "Store / location id." }, "store_phone": { "type": "string", "example": "(770)432-9930", "nullable": true, "description": "Store phone number." }, "curbside_pickup": { "type": "boolean", "example": false, "description": "Whether curbside pickup is available." } } }, "description": "Up to 5 store/fulfillment locations for this service. Present when provided." }, "dynamic_eta": { "type": "object", "properties": { "hours": { "type": "number", "nullable": true, "description": "ETA hours." }, "minutes": { "type": "number", "nullable": true, "description": "ETA minutes." } }, "description": "Dynamic ETA. Present when provided." }, "total_charge": { "type": "number", "example": 0, "nullable": true, "description": "Total charge for this service." }, "delivery_dates": { "type": "object", "properties": { "end": { "type": "string", "example": "2026-06-09", "nullable": true, "description": "End of the delivery window." }, "start": { "type": "string", "example": "2026-06-09", "nullable": true, "description": "Start of the delivery window." } }, "description": "Delivery date window. Present when provided." }, "delivery_charge": { "type": "number", "nullable": true, "description": "Delivery charge for this service." }, "delivery_timeline": { "type": "string", "example": "tomorrow", "nullable": true, "description": "Human-readable delivery timeline (e.g. tomorrow)." }, "has_free_shipping": { "type": "boolean", "example": true, "description": "Whether this service offers free shipping." }, "latest_delivery_date": { "type": "string", "nullable": true, "description": "Latest delivery date." }, "earliest_delivery_date": { "type": "string", "nullable": true, "description": "Earliest delivery date." }, "free_delivery_threshold": { "type": "number", "nullable": true, "description": "Order value required for free delivery." } }, "description": "A single fulfillment service (e.g. ship-to-home, buy-online-ship-to-store)." }, "sds_L_Fsr74jXxRwFrRFUiukT_dedb39e1cfebac02_ref0": { "type": "object", "required": [ "status", "request_id", "parameters", "data" ], "properties": { "data": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_dedb39e1cfebac02_ref1" }, "status": { "type": "string", "example": "OK", "description": "Response status. Always OK on success." }, "parameters": { "type": "object", "description": "The request parameters as received by the server.", "additionalProperties": true }, "request_id": { "type": "string", "example": "4f2a9d6e-1b3c-4f5a-8c7d-9e0f1a2b3c4d", "description": "Unique request identifier (UUID)." } } }, "sds_L_Fsr74jXxRwFrRFUiukT_dedb39e1cfebac02_ref1": { "type": "object", "required": [ "total_results", "total_pages", "current_page", "results_count", "items_per_page", "products" ], "properties": { "filters": { "type": "array", "items": { "type": "object", "required": [ "label", "is_color_swatch", "is_visual_nav", "options" ], "properties": { "label": { "type": "string", "example": "Brand", "description": "Filter (dimension) label." }, "options": { "type": "array", "items": { "type": "object", "required": [ "label" ], "properties": { "url": { "type": "string", "example": "/b/DEWALT/N-5yc1vZ4j2/Ntk-elastic/Ntt-DCD800B?NCNI-5", "nullable": true, "description": "URL applying this refinement." }, "label": { "type": "string", "example": "DEWALT", "description": "Refinement option label." }, "record_count": { "type": "string", "example": "54", "nullable": true, "description": "Number of products matching this refinement, returned as a string." }, "refinement_key": { "type": "string", "example": "4j2", "nullable": true, "description": "Refinement key (used to build filtered category URLs)." } } }, "description": "Up to 50 refinement options for this filter." }, "dimension_id": { "type": "string", "example": "4", "nullable": true, "description": "Home Depot dimension id." }, "is_visual_nav": { "type": "boolean", "example": true, "description": "Whether the filter is a visual navigation element." }, "is_color_swatch": { "type": "boolean", "example": false, "description": "Whether the filter is rendered as color swatches." } } }, "description": "Available refinement dimensions (filters) for the result set. Present when available." }, "keyword": { "type": "string", "example": "drill", "description": "The resolved search keyword. Present for Search and Item Lookup." }, "products": { "type": "array", "items": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_dedb39e1cfebac02_ref2" }, "description": "Products on this page." }, "brand_link": { "type": "object", "properties": { "url": { "type": "string", "nullable": true, "description": "Brand landing-page URL." }, "label": { "type": "string", "description": "Brand label." } }, "description": "Brand landing-page link. Present for some category browses." }, "breadcrumbs": { "type": "array", "items": { "type": "object", "required": [ "label" ], "properties": { "url": { "type": "string", "example": "https://www.homedepot.com/b/Tools/N-5yc1vZc1xy", "nullable": true, "description": "Breadcrumb URL." }, "label": { "type": "string", "example": "Tools", "description": "Breadcrumb label." }, "dimension_name": { "type": "string", "example": "Category", "nullable": true, "description": "Dimension name for the breadcrumb." }, "refinement_key": { "type": "string", "example": "c1xy", "nullable": true, "description": "Refinement key for the breadcrumb." } } }, "description": "Category breadcrumb trail for the result set. Present when available." }, "category_id": { "type": "string", "example": "fc67ed91-4c88-454f-a837-e3a3a07f27a9", "description": "Home Depot category id associated with the result set. Present when available." }, "total_pages": { "type": "integer", "example": 30, "description": "Total number of pages available (capped at 30)." }, "current_page": { "type": "integer", "example": 1, "description": "The page number returned." }, "canonical_url": { "type": "string", "example": "https://www.homedepot.com/b/Tools/N-5yc1vZc1xy/Ntk-elasticplus/Ntt-drill?NCNI-5", "description": "Canonical Home Depot listing URL for this result set. Present when available." }, "results_count": { "type": "integer", "example": 24, "description": "Number of products returned on this page." }, "total_results": { "type": "integer", "example": 4939, "description": "Total number of matching products across all pages." }, "items_per_page": { "type": "integer", "example": 24, "description": "Page size used for this request." }, "applied_filters": { "type": "array", "items": { "type": "object", "properties": { "deselect_url": { "type": "string", "nullable": true, "description": "URL that removes (deselects) this refinement." }, "refinement_key": { "type": "string", "nullable": true, "description": "Applied refinement key." }, "dimension_label": { "type": "string", "description": "Dimension label of the applied refinement." }, "refinement_label": { "type": "string", "description": "Applied refinement label." } } }, "description": "Currently applied refinements. Present only when filters are active." }, "search_redirect": { "type": "string", "description": "Redirect target when Home Depot redirects the search. Present only when a redirect occurs." }, "related_searches": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string", "nullable": true, "description": "Related search URL." }, "title": { "type": "string", "description": "Related search title." } } }, "description": "Related search suggestions. Present when available." }, "spelling_correction": { "type": "string", "example": "drill", "description": "Corrected keyword when Home Depot applied a spelling correction. Present only when corrected." } }, "description": "Result-set metadata shared by Search, Products By Category, and Item Lookup." }, "sds_L_Fsr74jXxRwFrRFUiukT_dedb39e1cfebac02_ref2": { "type": "object", "required": [ "item_id", "title", "brand", "model_no", "sku_id", "upc", "product_type", "sku_classification", "thumbnail", "images", "pricing", "rating", "total_reviews", "in_stock", "is_buyable", "availability_type", "is_discontinued", "backordered", "is_sponsored", "is_live_goods", "hide_price", "eco_rebates", "url" ], "properties": { "upc": { "type": "string", "example": "0033287225422", "nullable": true, "description": "UPC / GTIN-13 barcode. Null when not provided by Home Depot." }, "url": { "type": "string", "example": "https://www.homedepot.com/p/DEWALT-20V-MAX-Cordless-Drill-Driver-DCD771C2/204279858", "nullable": true, "description": "Canonical Home Depot product page URL." }, "brand": { "type": "string", "example": "DEWALT", "nullable": true, "description": "Brand / manufacturer name." }, "title": { "type": "string", "example": "20V MAX Cordless 1/2 in. Drill/Driver, (2) 20V 1.3Ah Batteries, Charger and Bag", "nullable": true, "description": "Full product title as shown on Home Depot." }, "badges": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "example": "top rated", "nullable": true, "description": "Badge internal name." }, "label": { "type": "string", "example": "Top Rated", "nullable": true, "description": "Badge display label." } } }, "description": "Merchandising badges on the product (e.g. Best Seller, Top Rated). Present when available." }, "images": { "type": "array", "items": { "type": "string", "description": "Product image URL." }, "nullable": true, "description": "List of product image URLs. Null when no images are available." }, "rating": { "type": "number", "example": 4.6241, "nullable": true, "description": "Average customer rating (0-5). Null when the product has no reviews." }, "sku_id": { "type": "string", "example": "1000014677", "nullable": true, "description": "Home Depot store SKU number." }, "item_id": { "type": "string", "example": "204279858", "description": "Home Depot internet number (unique product id)." }, "pricing": { "allOf": [ { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_dedb39e1cfebac02_ref3" } ], "nullable": true, "description": "Pricing information. Null when the product has no displayable price." }, "features": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "example": "Voltage", "description": "Feature name." }, "value": { "type": "string", "example": "20V", "description": "Feature value." } } }, "description": "Key product feature name/value pairs. Present when available on search results." }, "in_stock": { "type": "boolean", "example": true, "description": "Whether the product is currently in stock / buyable." }, "model_no": { "type": "string", "example": "DCD771C2", "nullable": true, "description": "Manufacturer model number." }, "thumbnail": { "type": "string", "example": "https://images.thdstatic.com/productImages/8c8e6b8d/svn/dewalt-power-drills-dcd771c2-64_1000.jpg", "nullable": true, "description": "Primary product image URL." }, "department": { "type": "string", "example": "Power Drills", "description": "Product department name. Present when Home Depot provides department taxonomy." }, "hide_price": { "type": "boolean", "example": false, "description": "Whether Home Depot hides the price for this product." }, "is_buyable": { "type": "boolean", "example": true, "description": "Whether the product can currently be purchased." }, "backordered": { "type": "boolean", "example": false, "description": "Whether the product is currently backordered." }, "breadcrumbs": { "type": "array", "items": { "type": "string", "example": "Tools", "description": "Breadcrumb label." }, "description": "Category breadcrumb labels (top-level to leaf). Present when available." }, "description": { "type": "string", "description": "Short product description. Rarely present on search results." }, "eco_rebates": { "type": "string", "example": null, "nullable": true, "description": "Eco-rebate information when available, otherwise null." }, "fulfillment": { "allOf": [ { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_dedb39e1cfebac02_ref4" } ], "description": "Pickup and delivery fulfillment options. Present when available." }, "class_number": { "type": "string", "example": "9", "description": "Product class number. Present when available." }, "is_sponsored": { "type": "boolean", "example": false, "description": "Whether this is a sponsored / paid-placement result." }, "product_type": { "type": "string", "example": "MERCHANDISE", "nullable": true, "description": "Product type classification (e.g. MERCHANDISE)." }, "subscription": { "type": "object", "properties": { "enabled": { "type": "boolean", "example": true, "description": "Whether subscription purchase is enabled." }, "default_frequency": { "type": "string", "nullable": true, "description": "Default delivery frequency." }, "discount_percentage": { "type": "number", "example": 5, "nullable": true, "description": "Subscription discount percentage." } }, "description": "Subscribe & Save information. Present only when subscription is enabled." }, "department_id": { "type": "string", "example": "569647", "description": "Product department id. Present when available." }, "is_live_goods": { "type": "boolean", "example": false, "description": "Whether the product is a live good (e.g. live plants)." }, "total_reviews": { "type": "string", "example": "11296", "description": "Total number of customer reviews, returned as a string. \"0\" when there are no reviews." }, "is_discontinued": { "type": "boolean", "example": false, "description": "Whether the product has been discontinued." }, "seo_description": { "type": "string", "description": "SEO product description. Present when available." }, "product_sub_type": { "type": "object", "properties": { "url": { "type": "string", "nullable": true, "description": "Sub-type category URL." }, "name": { "type": "string", "example": "Cordless Drills", "description": "Sub-type name." } }, "description": "Product sub-type (sub-category). Present when available." }, "availability_type": { "type": "string", "example": "Online", "nullable": true, "description": "Availability channel (e.g. Online, Shared, In Store)." }, "sub_department_id": { "type": "string", "example": "569648", "description": "Product sub-department id. Present when available." }, "sku_classification": { "type": "string", "example": null, "nullable": true, "description": "SKU classification code. Null when not provided." }, "excluded_ship_states": { "type": "array", "items": { "type": "string", "example": "CA", "description": "2-letter US state code." }, "description": "US states the product cannot ship to. Present only when shipping is restricted." } }, "description": "A single Home Depot product as returned by Search, Products By Category, and Item Lookup." }, "sds_L_Fsr74jXxRwFrRFUiukT_dedb39e1cfebac02_ref3": { "type": "object", "required": [ "current_price", "original_price", "currency" ], "properties": { "message": { "type": "string", "description": "Pricing message (e.g. map pricing notice). Present when available." }, "currency": { "type": "string", "example": "USD", "description": "ISO 4217 currency code. Always USD." }, "discount": { "type": "object", "properties": { "type": { "type": "string", "nullable": true, "description": "Promotion type." }, "amount": { "type": "number", "example": 50, "nullable": true, "description": "Dollar amount off." }, "campaign": { "type": "string", "example": "Special Buys", "nullable": true, "description": "Promotion campaign / savings center name." }, "end_date": { "type": "string", "nullable": true, "description": "Promotion end date." }, "percentage": { "type": "number", "example": 28, "nullable": true, "description": "Percentage off." }, "start_date": { "type": "string", "nullable": true, "description": "Promotion start date." }, "long_description": { "type": "string", "nullable": true, "description": "Long promotion description." }, "short_description": { "type": "string", "nullable": true, "description": "Short promotion description." } }, "description": "Discount / promotion details. Present only when the product is on promotion." }, "special_buy": { "type": "boolean", "example": true, "description": "Whether the item is a Special Buy. Present only when true." }, "bulk_pricing": { "type": "object", "properties": { "value": { "type": "number", "nullable": true, "description": "Bulk price value." }, "price_per_unit": { "type": "number", "nullable": true, "description": "Price per unit at the bulk threshold." }, "threshold_quantity": { "type": "number", "nullable": true, "description": "Quantity required to qualify for the bulk price." } }, "description": "Bulk pricing tier. Present only when available." }, "unit_pricing": { "type": "object", "properties": { "value": { "type": "number", "nullable": true, "description": "Unit price value." }, "units_per_case": { "type": "number", "nullable": true, "description": "Number of units per case." }, "unit_of_measure": { "type": "string", "nullable": true, "description": "Case unit of measure." } }, "description": "Per-unit / per-case pricing. Present when available." }, "current_price": { "type": "number", "example": 129, "nullable": true, "description": "Current displayed price. Null when no price is shown." }, "original_price": { "type": "number", "example": 179, "nullable": true, "description": "Original (was) price before discount. Null when there is no markdown." }, "clearance_price": { "type": "number", "example": 89.99, "description": "Clearance price. Present only for clearance items." }, "unit_of_measure": { "type": "string", "example": "/sq. ft.", "description": "Unit-of-measure coverage text. Present when available." }, "alternate_price_display": { "type": "string", "description": "Alternate price display text. Present when available." }, "map_above_original_price": { "type": "boolean", "example": true, "description": "Whether MAP pricing is above the original price. Present only when true." } }, "description": "Product pricing details." }, "sds_L_Fsr74jXxRwFrRFUiukT_dedb39e1cfebac02_ref4": { "type": "object", "properties": { "pickup": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_dedb39e1cfebac02_ref5" }, "delivery": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_dedb39e1cfebac02_ref5" } }, "description": "Pickup and delivery fulfillment options. Each key is present only when that fulfillment method is available." }, "sds_L_Fsr74jXxRwFrRFUiukT_dedb39e1cfebac02_ref5": { "type": "object", "required": [ "fulfillable", "services" ], "properties": { "services": { "type": "array", "items": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_dedb39e1cfebac02_ref6" }, "description": "Available services for this fulfillment method." }, "fulfillable": { "type": "boolean", "example": true, "description": "Whether the method can fulfill the product for the requested location." } }, "description": "A fulfillment method (pickup or delivery) with its available services." }, "sds_L_Fsr74jXxRwFrRFUiukT_dedb39e1cfebac02_ref6": { "type": "object", "required": [ "type", "has_free_shipping", "optimal" ], "properties": { "type": { "type": "string", "example": "sth", "nullable": true, "description": "Service type code (e.g. sth, boss, bopis)." }, "optimal": { "type": "boolean", "example": true, "description": "Whether this is the optimal (recommended) fulfillment option." }, "locations": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "online", "nullable": true, "description": "Location type." }, "state": { "type": "string", "example": "GA", "nullable": true, "description": "Store state (2-letter code)." }, "distance": { "type": "number", "example": 0, "nullable": true, "description": "Distance to the store." }, "inventory": { "type": "object", "nullable": true, "properties": { "in_stock": { "type": "boolean", "example": true, "description": "Whether the item is in stock." }, "quantity": { "type": "number", "example": 1515, "nullable": true, "description": "Available quantity." }, "unavailable": { "type": "boolean", "example": false, "description": "Whether the item is unavailable." }, "out_of_stock": { "type": "boolean", "example": false, "description": "Whether the item is out of stock." }, "max_bopis_qty": { "type": "number", "nullable": true, "description": "Maximum buy-online-pickup-in-store quantity." }, "min_bopis_qty": { "type": "number", "nullable": true, "description": "Minimum buy-online-pickup-in-store quantity." }, "limited_quantity": { "type": "boolean", "example": false, "description": "Whether quantity is limited." } }, "description": "Inventory at this location." }, "store_name": { "type": "string", "example": "Cumberland", "nullable": true, "description": "Store name." }, "location_id": { "type": "string", "example": "121", "nullable": true, "description": "Store / location id." }, "store_phone": { "type": "string", "example": "(770)432-9930", "nullable": true, "description": "Store phone number." }, "curbside_pickup": { "type": "boolean", "example": false, "description": "Whether curbside pickup is available." } } }, "description": "Up to 5 store/fulfillment locations for this service. Present when provided." }, "dynamic_eta": { "type": "object", "properties": { "hours": { "type": "number", "nullable": true, "description": "ETA hours." }, "minutes": { "type": "number", "nullable": true, "description": "ETA minutes." } }, "description": "Dynamic ETA. Present when provided." }, "total_charge": { "type": "number", "example": 0, "nullable": true, "description": "Total charge for this service." }, "delivery_dates": { "type": "object", "properties": { "end": { "type": "string", "example": "2026-06-09", "nullable": true, "description": "End of the delivery window." }, "start": { "type": "string", "example": "2026-06-09", "nullable": true, "description": "Start of the delivery window." } }, "description": "Delivery date window. Present when provided." }, "delivery_charge": { "type": "number", "nullable": true, "description": "Delivery charge for this service." }, "delivery_timeline": { "type": "string", "example": "tomorrow", "nullable": true, "description": "Human-readable delivery timeline (e.g. tomorrow)." }, "has_free_shipping": { "type": "boolean", "example": true, "description": "Whether this service offers free shipping." }, "latest_delivery_date": { "type": "string", "nullable": true, "description": "Latest delivery date." }, "earliest_delivery_date": { "type": "string", "nullable": true, "description": "Earliest delivery date." }, "free_delivery_threshold": { "type": "number", "nullable": true, "description": "Order value required for free delivery." } }, "description": "A single fulfillment service (e.g. ship-to-home, buy-online-ship-to-store)." }, "sds_L_Fsr74jXxRwFrRFUiukT_941e3589215dbcf8_ref0": { "type": "object", "required": [ "company", "page", "num_pages", "company_slug_resolved" ], "properties": { "page": { "type": "integer", "example": 1 }, "sort": { "enum": [ "relevance", "helpfulness", "rating_desc", "rating_asc" ], "type": "string", "example": "rating_desc" }, "text": { "type": "string", "example": "pay" }, "topic": { "enum": [ "wlbalance", "paybenefits", "jobsecadv", "mgmt", "culture" ], "type": "string", "example": "mgmt" }, "company": { "type": "string", "example": "Lutron Electronics", "description": "Exactly what the caller sent - slug, URL or free-text name." }, "country": { "type": "string", "example": "ALL" }, "location": { "type": "string", "example": "Coopersburg, PA" }, "job_title": { "type": "string", "example": "Engineer" }, "num_pages": { "type": "integer", "example": 1 }, "page_past_last": { "type": "boolean", "example": true, "description": "Present and `true` only when the requested page is past the company's last page of\nreviews. Indeed answers that with page 1's rows; they are discarded and `reviews`\ncomes back empty. Use it to tell a page past the end from a company that has no\nreviews at all.\n" }, "company_matches": { "type": "array", "items": { "type": "object", "required": [ "company_name", "company_slug", "company_rating", "company_review_count" ], "properties": { "company_name": { "type": "string", "example": "Lutron Electronics", "nullable": true }, "company_slug": { "type": "string", "example": "Lutron-Electronics" }, "company_rating": { "type": "number", "format": "float", "example": 3.5, "nullable": true }, "company_review_count": { "type": "integer", "example": 292, "nullable": true } } }, "description": "Present only when `company` was a free-text name. The top 5 candidates Indeed's\ncompany search returned, in its order; the first one is what was used.\n" }, "company_slug_resolved": { "type": "string", "example": "Lutron-Electronics", "description": "The Indeed `/cmp` slug the reviews were actually fetched for. Always present, so you\ncan see which slug a free-text name resolved to.\n" } }, "description": "Echo of the parameters as the caller sent them, before any internal transformation, plus\nthe resolved slug. Only the parameters actually supplied are present.\n" }, "sds_L_Fsr74jXxRwFrRFUiukT_941e3589215dbcf8_ref1": { "type": "object", "required": [ "company_name", "company_id", "company_slug", "company_url", "company_reviews_url", "company_logo", "company_header_image", "company_rating", "company_review_count", "company_filtered_review_count", "company_happiness_score", "company_happiness_grade", "company_category_ratings", "company_rating_distribution", "company_review_topics", "company_pros", "company_cons", "reviews" ], "properties": { "reviews": { "type": "array", "items": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_941e3589215dbcf8_ref4" }, "description": "The requested page(s) of reviews, deduplicated by `review_id` across pages. Empty\nwhen the company has no reviews matching the filters, or when `page` is past the last\npage - in which case `parameters.page_past_last` is `true`.\n" }, "company_id": { "type": "string", "example": "148ac80990a85a92", "nullable": true, "description": "Indeed's encoded company id. The same identifier a job's `job_indeed_employer_key` carries." }, "company_url": { "type": "string", "format": "uri", "example": "https://www.indeed.com/cmp/Lutron-Electronics" }, "company_cons": { "type": "array", "items": { "type": "string" }, "example": [ "Sense of belonging" ], "description": "Indeed's own summary of what reviewers rate lowest. Empty array when absent." }, "company_logo": { "type": "string", "format": "uri", "nullable": true }, "company_name": { "type": "string", "example": "Lutron Electronics", "nullable": true }, "company_pros": { "type": "array", "items": { "type": "string" }, "example": [ "Ability to meet personal goals", "Feeling of personal appreciation" ], "description": "Indeed's own summary of what reviewers rate highest. Empty array when absent." }, "company_slug": { "type": "string", "example": "Lutron-Electronics", "description": "The `/cmp` slug the reviews were fetched for." }, "company_rating": { "type": "number", "format": "float", "example": 3.5, "nullable": true, "description": "The company's overall star rating, 1-5, across all reviews." }, "company_reviews_url": { "type": "string", "format": "uri", "example": "https://www.indeed.com/cmp/Lutron-Electronics/reviews", "nullable": true }, "company_header_image": { "type": "string", "format": "uri", "nullable": true }, "company_review_count": { "type": "integer", "example": 292, "nullable": true, "description": "Every review the company has, in every country." }, "company_review_topics": { "type": "array", "items": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_941e3589215dbcf8_ref3" }, "description": "Per-topic review counts and ratings. Empty array when Indeed publishes none." }, "company_happiness_grade": { "type": "string", "example": "GOOD", "nullable": true, "description": "Indeed's grade band for `company_happiness_score`." }, "company_happiness_score": { "type": "integer", "example": 69, "nullable": true, "description": "Indeed's 0-100 \"work happiness\" score." }, "company_category_ratings": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_941e3589215dbcf8_ref2" }, "company_rating_distribution": { "type": "object", "nullable": true, "required": [ "1", "2", "3", "4", "5" ], "properties": { "1": { "type": "integer", "example": 33, "nullable": true }, "2": { "type": "integer", "example": 36, "nullable": true }, "3": { "type": "integer", "example": 62, "nullable": true }, "4": { "type": "integer", "example": 71, "nullable": true }, "5": { "type": "integer", "example": 90, "nullable": true } }, "description": "How many reviews gave each star rating. Verified to sum exactly to\n`company_review_count`.\n" }, "company_filtered_review_count": { "type": "integer", "example": 260, "nullable": true, "description": "How many reviews the **current filters** can page through. Lower than\n`company_review_count` whenever a filter is active - including Indeed's own default\ncountry scope, which is why the two differ even with no filter requested. Pass\n`country=ALL` to make them equal.\n" } }, "description": "The company, its aggregates, and the requested page(s) of reviews.\n\nAggregate fill rates measured over 5 live companies, 2026-09-11: every field 5/5 except\n`company_header_image` 4/5 and `company_cons` 2/5 (Indeed publishes a \"cons\" summary only\nfor companies with enough low-rated topics). All five `company_category_ratings` were\npopulated on 5/5.\n" }, "sds_L_Fsr74jXxRwFrRFUiukT_941e3589215dbcf8_ref2": { "type": "object", "required": [ "work_life_balance", "compensation_benefits", "job_security_advancement", "management", "culture" ], "properties": { "culture": { "type": "number", "format": "float", "example": 3.3, "nullable": true }, "management": { "type": "number", "format": "float", "example": 2.9, "nullable": true }, "work_life_balance": { "type": "number", "format": "float", "example": 3.3, "nullable": true }, "compensation_benefits": { "type": "number", "format": "float", "example": 3.5, "nullable": true }, "job_security_advancement": { "type": "number", "format": "float", "example": 3.3, "nullable": true } }, "description": "Indeed's five review categories, each 1-5. `null` where Indeed publishes no aggregate.\n" }, "sds_L_Fsr74jXxRwFrRFUiukT_941e3589215dbcf8_ref3": { "type": "object", "required": [ "topic_id", "topic_name", "review_count", "rating" ], "properties": { "rating": { "type": "number", "format": "float", "example": 2.9, "nullable": true }, "topic_id": { "enum": [ "wlbalance", "paybenefits", "jobsecadv", "mgmt", "culture" ], "type": "string", "example": "mgmt", "nullable": true, "description": "Pass this value as the `topic` parameter to filter to these reviews." }, "topic_name": { "type": "string", "example": "Management", "nullable": true }, "review_count": { "type": "integer", "example": 114, "nullable": true, "description": "How many of the company's reviews discuss this topic." } } }, "sds_L_Fsr74jXxRwFrRFUiukT_941e3589215dbcf8_ref4": { "type": "object", "required": [ "review_id", "review_uid", "review_title", "review_text", "review_rating", "review_category_ratings", "review_job_title", "review_job_title_normalized", "review_location", "review_country", "review_is_current_employee", "review_posted_at", "review_posted_at_date", "review_posted_at_timestamp", "review_posted_at_datetime_utc", "review_helpful_count", "review_unhelpful_count", "review_url", "review_share_url", "review_status", "review_is_redacted", "review_comment_count" ], "properties": { "review_id": { "type": "string", "example": "b488aaf878adeae6", "nullable": true, "description": "Indeed's encrypted review id. Stable, and the `id=` parameter on `review_url`." }, "review_uid": { "type": "string", "example": "1jug4q15nh72n801", "nullable": true, "description": "Indeed's internal review uid. Distinct from `review_id`; carried for completeness." }, "review_url": { "type": "string", "format": "uri", "example": "https://www.indeed.com/cmp/Lutron-Electronics/reviews/good-start-pay-but-very-strict-company?id=b488aaf878adeae6", "nullable": true }, "review_text": { "type": "string", "example": "While overall they are pretty good. They are very strict even if there is an emergency.", "nullable": true, "description": "The review body as plain text. Measured 62-2028 characters." }, "review_title": { "type": "string", "example": "Good start pay but very strict company", "nullable": true }, "review_rating": { "type": "number", "format": "float", "example": 3, "nullable": true, "description": "The reviewer's overall star rating, 1-5." }, "review_status": { "type": "string", "example": "APPROVED", "nullable": true, "description": "Indeed's moderation state. `APPROVED` on every review observed." }, "review_country": { "type": "string", "example": "US", "nullable": true, "description": "ISO 3166-1 alpha-2 country the reviewer worked in." }, "review_location": { "type": "string", "example": "Coopersburg, PA", "nullable": true }, "review_job_title": { "type": "string", "example": "Production Operator", "nullable": true, "description": "The reviewer's job title as they wrote it. Blank on many reviews." }, "review_posted_at": { "type": "string", "example": "July 26, 2026", "nullable": true, "description": "Indeed's own date string, verbatim." }, "review_share_url": { "type": "string", "format": "uri", "nullable": true }, "review_is_redacted": { "type": "boolean", "example": false, "description": "`true` when Indeed has redacted the review body." }, "review_comment_count": { "type": "integer", "example": 0, "description": "How many employer replies/comments the review carries. 0 on every review observed." }, "review_helpful_count": { "type": "integer", "example": 1, "nullable": true }, "review_posted_at_date": { "type": "string", "format": "date", "example": "2026-07-26", "nullable": true, "description": "`review_posted_at` parsed. Null if Indeed rendered a date this parser does not recognise, with the raw string still in `review_posted_at`." }, "review_unhelpful_count": { "type": "integer", "example": 0, "nullable": true }, "review_category_ratings": { "allOf": [ { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_941e3589215dbcf8_ref2" }, { "description": "This reviewer's per-category stars. Indeed lets a reviewer rate overall only, and\nrepresents \"not provided\" as `0` upstream; that is mapped to `null` here, because\nreturning 0 would drag any consumer's average down. Either all five are populated\nor all five are null.\n" } ] }, "review_is_current_employee": { "type": "boolean", "example": false, "description": "`true` when the reviewer says they still work there." }, "review_posted_at_timestamp": { "type": "integer", "example": 1785024000, "nullable": true, "description": "Unix seconds at **midnight UTC** of the posting date. Indeed publishes a day, not a time." }, "review_job_title_normalized": { "type": "string", "example": "production operator", "nullable": true, "description": "Indeed's normalised form of the same title." }, "review_posted_at_datetime_utc": { "type": "string", "format": "date-time", "example": "2026-07-26T00:00:00.000Z", "nullable": true } }, "description": "One employee review. Every key is always present; `null` where the reviewer left the\nfield blank.\n\nFill rates measured over **140 live reviews across 5 companies**, 2026-09-11:\n\n| field | fill |\n| --- | --- |\n| `review_id` `review_uid` `review_title` `review_text` `review_rating` | 140/140 |\n| `review_country` `review_is_current_employee` `review_status` `review_is_redacted` | 140/140 |\n| `review_posted_at` + all three parsed date fields | 140/140 |\n| `review_helpful_count` `review_unhelpful_count` `review_comment_count` | 140/140 |\n| `review_url` `review_share_url` | 140/140 |\n| `review_job_title` | 103/140 |\n| `review_job_title_normalized` | 101/140 |\n| `review_location` | 86/140 |\n| `review_category_ratings` (each of the five) | 52-54/140 |\n\nThe category ratings are sparse **because Indeed lets a reviewer rate overall only**, not\nbecause extraction is unreliable: they are populated or null as a group of five.\n" }, "sds_L_Fsr74jXxRwFrRFUiukT_941e3589215dbcf8_ref5": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_941e3589215dbcf8_ref6" } } }, "description": "Invalid or missing parameter." }, "sds_L_Fsr74jXxRwFrRFUiukT_941e3589215dbcf8_ref6": { "type": "object", "required": [ "status", "request_id", "error" ], "properties": { "error": { "type": "object", "required": [ "message", "code" ], "properties": { "code": { "type": "integer" }, "message": { "type": "string" } } }, "status": { "enum": [ "ERROR" ], "type": "string" }, "request_id": { "type": "string" } } }, "sds_L_Fsr74jXxRwFrRFUiukT_941e3589215dbcf8_ref7": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_941e3589215dbcf8_ref6" } } }, "description": "Missing or invalid credentials." }, "sds_L_Fsr74jXxRwFrRFUiukT_941e3589215dbcf8_ref8": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_941e3589215dbcf8_ref6" } } }, "description": "Not subscribed to this API." }, "sds_L_Fsr74jXxRwFrRFUiukT_941e3589215dbcf8_ref9": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_941e3589215dbcf8_ref6" } } }, "description": "Quota exhausted." }, "sds_L_Fsr74jXxRwFrRFUiukT_941e3589215dbcf8_ref10": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_941e3589215dbcf8_ref6" } } }, "description": "Unexpected error." }, "sds_L_Fsr74jXxRwFrRFUiukT_941e3589215dbcf8_ref11": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_941e3589215dbcf8_ref6" } } }, "description": "The upstream source was temporarily unreachable after the proxy ladder was exhausted.\nSafe to retry.\n" }, "sds_L_Fsr74jXxRwFrRFUiukT_91efb1241ec59088_ref0": { "type": "object", "required": [ "job_id", "country", "language" ], "properties": { "fields": { "type": "string" }, "job_id": { "type": "string" }, "country": { "type": "string" }, "language": { "type": "string" } } }, "sds_L_Fsr74jXxRwFrRFUiukT_91efb1241ec59088_ref1": { "type": "object", "required": [ "job_id", "job_title", "employer_name", "employer_logo", "employer_website", "job_publisher", "job_employment_type", "job_employment_types", "job_apply_link", "job_apply_is_direct", "apply_options", "job_description", "job_is_remote", "job_posted_at", "job_posted_at_timestamp", "job_posted_at_datetime_utc", "job_location", "job_city", "job_state", "job_country", "job_latitude", "job_longitude", "job_benefits", "job_benefits_strings", "job_google_link", "job_salary", "job_salary_string", "job_min_salary", "job_max_salary", "job_salary_period", "job_highlights", "job_onet_soc", "job_onet_job_zone", "employer_reviews", "job_uid", "job_indeed_ref_num", "job_indeed_normalized_title", "job_indeed_source_employer_name", "job_indeed_employer_key", "job_indeed_company_page_url", "job_indeed_employer_header_image", "job_indeed_employer_industry", "job_indeed_occupations", "job_indeed_attributes", "job_indeed_experience_levels", "job_indeed_is_hybrid", "job_indeed_is_urgent_hire", "job_indeed_is_high_volume_hiring", "job_indeed_expired", "job_indeed_language", "job_indeed_postal_code", "job_indeed_street_address", "job_published_at_timestamp", "job_published_at_datetime_utc", "job_description_html", "job_position" ], "properties": { "job_id": { "type": "string", "example": "aW5kZWVkOjNkNjM4ZGI0MjBiZmM4MmY", "nullable": true, "description": "Stable, opaque job identifier: base64url(\"indeed:\" + the Indeed job key). Pass this to /job-details. Always present." }, "job_uid": { "type": "string", "example": "3d638db420bfc82f", "nullable": true, "description": "The raw 16-hex Indeed job key that job_id encodes. Stable and valid indefinitely." }, "job_city": { "type": "string", "example": "New York", "nullable": true, "description": "City. 100% coverage." }, "job_state": { "type": "string", "example": "NY", "nullable": true, "description": "State / province / admin-1 code, e.g. \"NY\". 100% coverage." }, "job_title": { "type": "string", "example": "Full Stack Engineer (Laravel)", "nullable": true, "description": "Job title as posted by the employer." }, "job_salary": { "type": "number", "example": 187500, "nullable": true, "description": "Single headline salary figure: the midpoint of the stated range, or the single stated bound. Null when the employer stated no salary." }, "job_country": { "type": "string", "example": "US", "nullable": true, "description": "ISO 3166-1 alpha-2 country code. Resolved from Indeed's country name, which is localised per market (\"Deutschland\" for de-DE), and falls back to the requested `country` when unrecognised. Always a 2-letter code." }, "job_benefits": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "Always null. The normalized JSearch benefit enum has no Indeed equivalent; the raw benefit labels are in job_benefits_strings." }, "job_latitude": { "type": "number", "example": 40.71427, "nullable": true, "description": "Latitude. 100% coverage on measured jobs." }, "job_location": { "type": "string", "example": "New York, NY", "nullable": true, "description": "Full formatted location, e.g. \"New York, NY 10003\"." }, "job_onet_soc": { "type": "string", "nullable": true, "description": "Always null. Indeed's occupations[] are its own SUID taxonomy, not O*NET SOC codes; they are exposed verbatim as job_indeed_occupations." }, "job_position": { "type": "integer", "example": 1, "nullable": true, "description": "Absolute 1-based rank of the job within the full result set for this query. Null on /job-details, which has no notion of rank." }, "apply_options": { "type": "array", "items": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_91efb1241ec59088_ref2" }, "nullable": true, "description": "Application routes. Indeed exposes exactly one source per posting, so this array holds 0 or 1 entries." }, "employer_logo": { "type": "string", "nullable": true, "description": "Square employer logo. From Indeed's employer dossier (69% of 600 measured jobs); where Indeed has none, a Google faviconV2 URL derived from the employer website or apply domain is substituted. Null only when neither is available." }, "employer_name": { "type": "string", "example": "PactFi", "nullable": true, "description": "Employer name. Falls back to Indeed's `sourceEmployerName` when the employer record is absent. Populated on 100% of measured jobs." }, "job_is_remote": { "type": "boolean", "example": false, "description": "True when the posting carries Indeed's \"Remote\" attribute. Hybrid roles are false here and true on job_indeed_is_hybrid." }, "job_longitude": { "type": "number", "example": -74.00597, "nullable": true, "description": "Longitude. 100% coverage on measured jobs." }, "job_posted_at": { "type": "string", "example": "10 days ago", "nullable": true, "description": "Relative posting age in the JSearch vocabulary: \"today\", \"N days ago\" up to 30, then \"N month(s) ago\". Derived from job_posted_at_timestamp." }, "job_publisher": { "type": "string", "example": "Ashby", "nullable": true, "description": "Who is serving the application: the employer/ATS host derived from the apply URL, mapped to a friendly name for known ATSs (Workday, Greenhouse, Lever, iCIMS, ...)." }, "job_apply_link": { "type": "string", "example": "https://jobs.ashbyhq.com/pactfi/c4058bd0-55f3-49fd-a3de-994b4d2bb39e?utm_source=Zw9jOe6Ka6", "nullable": true, "description": "Direct application URL. On Indeed this is the employer's own careers page or ATS, not an Indeed redirect - populated on 600/600 measured jobs." }, "job_highlights": { "type": "object", "nullable": true, "description": "Always an empty object. Indeed ships one flat description with no qualifications/responsibilities/benefits split, so there is nothing to structure. Present for shape parity with the Google-backed surface.", "additionalProperties": true }, "job_max_salary": { "type": "number", "example": 200000, "nullable": true, "description": "Upper salary bound in the units of job_salary_period. Null when unstated or when only a lower bound was given." }, "job_min_salary": { "type": "number", "example": 175000, "nullable": true, "description": "Lower salary bound in the units of job_salary_period. Null when unstated or when only an upper bound was given." }, "job_description": { "type": "string", "nullable": true, "description": "Full plain-text job description, returned in the SEARCH response. See job_description_html for the markup." }, "job_google_link": { "type": "string", "nullable": true, "description": "Always null. Google-for-Jobs specific and not applicable to an Indeed-sourced posting." }, "employer_reviews": { "type": "array", "items": { "type": "object" }, "nullable": true, "description": "Always null here. Indeed publishes its company rating and review count on the /cmp company surface. GET /company-reviews returns them with the full review list, the category ratings and the 1-5 star distribution, at one request per 20 reviews. Pass job_indeed_company_page_url from any job here as the company parameter." }, "employer_website": { "type": "string", "example": "https://www.americanexpress.com", "nullable": true, "description": "Employer's corporate website (72% of 600 measured jobs)." }, "job_onet_job_zone": { "type": "string", "nullable": true, "description": "Always null. See job_onet_soc." }, "job_salary_period": { "enum": [ "YEAR", "MONTH", "WEEK", "DAY", "HOUR", null ], "type": "string", "example": "YEAR", "nullable": true, "description": "Unit the salary bounds are expressed in: YEAR, MONTH, WEEK, DAY or HOUR. Salary values keep the unit the employer stated." }, "job_salary_string": { "type": "string", "example": "$175,000 - $200,000 a year", "nullable": true, "description": "Salary exactly as Indeed renders it, e.g. \"$152,000 - $221,000 a year\" (60% of measured jobs)." }, "job_indeed_expired": { "type": "boolean", "example": false, "description": "True when Indeed has marked the posting expired." }, "job_indeed_ref_num": { "type": "string", "example": "c4058bd0-55f3-49fd-a3de-994b4d2bb39e", "nullable": true, "description": "The employer's own requisition id, e.g. \"JR2025219\". 100% coverage." }, "job_apply_is_direct": { "type": "boolean", "example": true, "description": "True when job_apply_link points at the employer/ATS rather than at another job board." }, "job_employment_type": { "enum": [ "FULLTIME", "CONTRACTOR", "PARTTIME", "INTERN", null ], "type": "string", "example": "FULLTIME", "nullable": true, "description": "Primary employment type. One of FULLTIME, CONTRACTOR, PARTTIME, INTERN. Null when Indeed tagged none of them." }, "job_indeed_language": { "type": "string", "example": "en", "nullable": true, "description": "ISO 639-1 language of the posting as detected by Indeed." }, "job_benefits_strings": { "type": "array", "items": { "type": "string" }, "example": [ "Health insurance", "401(k)" ], "nullable": true, "description": "Benefit labels as Indeed states them, e.g. \"401(k)\", \"Health insurance\", \"Paid time off\". Null when the posting lists none." }, "job_description_html": { "type": "string", "nullable": true, "description": "The job description with Indeed's original HTML markup preserved." }, "job_employment_types": { "type": "array", "items": { "type": "string" }, "example": [ "FULLTIME" ], "nullable": true, "description": "All employment types tagged on the posting, in the enum order FULLTIME, CONTRACTOR, PARTTIME, INTERN. Empty array when Indeed tagged none. Indeed also uses Temporary and Seasonal tags, which have no JSearch enum member and are exposed only in job_indeed_attributes rather than being folded into CONTRACTOR." }, "job_indeed_is_hybrid": { "type": "boolean", "example": true, "description": "True when the posting carries Indeed's \"Hybrid work\" attribute." }, "job_indeed_attributes": { "type": "array", "items": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_91efb1241ec59088_ref3" }, "nullable": true, "description": "Every attribute Indeed tagged on the posting - 27 to 66 per job, mixing skills, employment type, seniority, benefits and work arrangement. The SUIDs here are the same tokens the employment_types / experience_level / work_from_home filters use upstream." }, "job_indeed_occupations": { "type": "array", "items": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_91efb1241ec59088_ref3" }, "nullable": true, "description": "Indeed's occupation taxonomy for the posting." }, "job_indeed_postal_code": { "type": "string", "example": "10040", "nullable": true, "description": "Postal code (51% coverage)." }, "job_indeed_employer_key": { "type": "string", "example": "fda3f19471b1c223", "nullable": true, "description": "Indeed's stable company identifier (96% coverage). Also the encodedFccId used by the /cmp company pages." }, "job_posted_at_timestamp": { "type": "integer", "example": 1788222664, "nullable": true, "description": "Unix timestamp (seconds) of when the posting appeared on Indeed. 100% coverage." }, "job_indeed_is_urgent_hire": { "type": "boolean", "example": false, "description": "True when Indeed flags the posting as urgently hiring." }, "job_indeed_street_address": { "type": "string", "example": "World Financial Center", "nullable": true, "description": "Street address (41% coverage)." }, "job_posted_at_datetime_utc": { "type": "string", "format": "date-time", "example": "2026-09-01T00:31:04.000Z", "nullable": true, "description": "ISO 8601 UTC form of job_posted_at_timestamp." }, "job_published_at_timestamp": { "type": "integer", "example": 1788152400, "nullable": true, "description": "Unix timestamp (seconds) of the employer's own publish date. Distinct from job_posted_at_timestamp, which is when the posting reached Indeed." }, "job_indeed_company_page_url": { "type": "string", "example": "https://www.indeed.com/cmp/Haq-Bpo-Solutions", "nullable": true, "description": "Absolute URL of the employer's Indeed company page, e.g. \"https://www.indeed.com/cmp/Capgemini\"." }, "job_indeed_normalized_title": { "type": "string", "example": "full stack developer", "nullable": true, "description": "Indeed's normalized job title, e.g. \"devops engineer\"." }, "job_indeed_employer_industry": { "type": "string", "nullable": true, "description": "Industry from the Indeed company dossier (13% coverage)." }, "job_indeed_experience_levels": { "type": "array", "items": { "type": "string" }, "example": [ "MID_LEVEL" ], "nullable": true, "description": "Seniority tags on the posting: ENTRY_LEVEL, MID_LEVEL, SENIOR_LEVEL and/or NO_EXPERIENCE. Empty array when Indeed tagged none." }, "job_published_at_datetime_utc": { "type": "string", "format": "date-time", "example": "2026-08-31T05:00:00.000Z", "nullable": true, "description": "ISO 8601 UTC form of job_published_at_timestamp." }, "job_indeed_source_employer_name": { "type": "string", "example": "PactFi", "nullable": true, "description": "Employer name as it appeared on the source feed, before Indeed matched it to a company record." }, "job_indeed_employer_header_image": { "type": "string", "example": "https://d2q79iu7y748jz.cloudfront.net/s/_headerimage/1960x400/aae57269f3888005ede005b80239171b", "nullable": true, "description": "Employer banner image from the Indeed company dossier (54% coverage)." }, "job_indeed_is_high_volume_hiring": { "type": "boolean", "example": false, "description": "True when Indeed flags the posting as high-volume hiring." } }, "description": "A job posting. A superset of the 35-key JSearch `/search` contract: all 35 keys are\nalways present (null / [] / {} where Indeed cannot fill them), followed by 20+\nIndeed-specific keys.\n" }, "sds_L_Fsr74jXxRwFrRFUiukT_91efb1241ec59088_ref2": { "type": "object", "required": [ "publisher", "apply_link", "is_direct" ], "properties": { "is_direct": { "type": "boolean", "description": "True when the link goes to the employer/ATS rather than another job board." }, "publisher": { "type": "string", "example": "Workday", "description": "Who serves the application - the employer/ATS host, mapped to a friendly name where known." }, "apply_link": { "type": "string", "description": "The application URL." } }, "description": "A single route to apply for the job." }, "sds_L_Fsr74jXxRwFrRFUiukT_91efb1241ec59088_ref3": { "type": "object", "required": [ "key", "label" ], "properties": { "key": { "type": "string", "example": "CF3CP", "description": "Indeed's stable SUID for the term." }, "label": { "type": "string", "example": "Full-time", "description": "Human-readable label, localised to the requested language." } }, "description": "An Indeed taxonomy entry - a stable SUID plus its human label in the requested language." }, "sds_L_Fsr74jXxRwFrRFUiukT_91efb1241ec59088_ref4": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_91efb1241ec59088_ref5" } } }, "description": "Invalid or missing parameter." }, "sds_L_Fsr74jXxRwFrRFUiukT_91efb1241ec59088_ref5": { "type": "object", "required": [ "status", "request_id", "error" ], "properties": { "error": { "type": "object", "required": [ "message", "code" ], "properties": { "code": { "type": "integer" }, "message": { "type": "string" } } }, "status": { "enum": [ "ERROR" ], "type": "string" }, "request_id": { "type": "string" } } }, "sds_L_Fsr74jXxRwFrRFUiukT_91efb1241ec59088_ref6": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_91efb1241ec59088_ref5" } } }, "description": "Missing or invalid credentials." }, "sds_L_Fsr74jXxRwFrRFUiukT_91efb1241ec59088_ref7": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_91efb1241ec59088_ref5" } } }, "description": "Not subscribed to this API." }, "sds_L_Fsr74jXxRwFrRFUiukT_91efb1241ec59088_ref8": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_91efb1241ec59088_ref5" } } }, "description": "Quota exhausted." }, "sds_L_Fsr74jXxRwFrRFUiukT_91efb1241ec59088_ref9": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_91efb1241ec59088_ref5" } } }, "description": "Unexpected error." }, "sds_L_Fsr74jXxRwFrRFUiukT_91efb1241ec59088_ref10": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_91efb1241ec59088_ref5" } } }, "description": "The upstream source was temporarily unreachable after the proxy ladder was exhausted.\nSafe to retry.\n" }, "sds_L_Fsr74jXxRwFrRFUiukT_7bc4ac4354ea1318_ref0": { "type": "object", "required": [ "query", "page", "num_pages", "country", "language", "response_truncated" ], "properties": { "page": { "type": "integer" }, "query": { "type": "string" }, "fields": { "type": "string" }, "radius": { "type": "number" }, "country": { "type": "string" }, "language": { "type": "string" }, "location": { "type": "string" }, "num_pages": { "type": "integer" }, "max_salary": { "type": "number" }, "min_salary": { "type": "number" }, "date_posted": { "type": "string" }, "jobs_omitted": { "type": "integer", "description": "Matching jobs dropped to fit the payload limit. Present only when\n`response_truncated` is `true`. You are not billed for these.\n" }, "jobs_returned": { "type": "integer", "description": "Jobs in `data`. Present only when `response_truncated` is `true`." }, "work_from_home": { "type": "boolean" }, "employment_types": { "type": "array", "items": { "type": "string" } }, "experience_level": { "type": "array", "items": { "type": "string" } }, "response_truncated": { "type": "boolean", "description": "`true` when the response was trimmed to stay inside the 6 MB service payload limit,\nand some jobs that matched were therefore not returned. Always present.\n\nThis is a statement about the RESPONSE, not about the source: it does not mean\nIndeed ran out of jobs. A short response with `response_truncated: false` means the\ncursor was exhausted; a short response with `response_truncated: true` means we could\nnot fit any more. Narrow the window or pass `fields` to get the rest.\n" }, "exclude_job_publishers": { "type": "array", "items": { "type": "string" } } }, "description": "Echo of the parameters as the caller sent them, before any internal normalisation.\n`date_posted: all` is echoed verbatim even though it is applied as \"no date filter\".\nKeys the caller did not send are absent.\n\nThree keys are NOT an echo but a report on the response itself:\n`response_truncated`, and - only when it is `true` - `jobs_returned` and `jobs_omitted`.\n" }, "sds_L_Fsr74jXxRwFrRFUiukT_7bc4ac4354ea1318_ref1": { "type": "object", "required": [ "job_id", "job_title", "employer_name", "employer_logo", "employer_website", "job_publisher", "job_employment_type", "job_employment_types", "job_apply_link", "job_apply_is_direct", "apply_options", "job_description", "job_is_remote", "job_posted_at", "job_posted_at_timestamp", "job_posted_at_datetime_utc", "job_location", "job_city", "job_state", "job_country", "job_latitude", "job_longitude", "job_benefits", "job_benefits_strings", "job_google_link", "job_salary", "job_salary_string", "job_min_salary", "job_max_salary", "job_salary_period", "job_highlights", "job_onet_soc", "job_onet_job_zone", "employer_reviews", "job_uid", "job_indeed_ref_num", "job_indeed_normalized_title", "job_indeed_source_employer_name", "job_indeed_employer_key", "job_indeed_company_page_url", "job_indeed_employer_header_image", "job_indeed_employer_industry", "job_indeed_occupations", "job_indeed_attributes", "job_indeed_experience_levels", "job_indeed_is_hybrid", "job_indeed_is_urgent_hire", "job_indeed_is_high_volume_hiring", "job_indeed_expired", "job_indeed_language", "job_indeed_postal_code", "job_indeed_street_address", "job_published_at_timestamp", "job_published_at_datetime_utc", "job_description_html", "job_position" ], "properties": { "job_id": { "type": "string", "example": "aW5kZWVkOjNkNjM4ZGI0MjBiZmM4MmY", "nullable": true, "description": "Stable, opaque job identifier: base64url(\"indeed:\" + the Indeed job key). Pass this to /job-details. Always present." }, "job_uid": { "type": "string", "example": "3d638db420bfc82f", "nullable": true, "description": "The raw 16-hex Indeed job key that job_id encodes. Stable and valid indefinitely." }, "job_city": { "type": "string", "example": "New York", "nullable": true, "description": "City. 100% coverage." }, "job_state": { "type": "string", "example": "NY", "nullable": true, "description": "State / province / admin-1 code, e.g. \"NY\". 100% coverage." }, "job_title": { "type": "string", "example": "Full Stack Engineer (Laravel)", "nullable": true, "description": "Job title as posted by the employer." }, "job_salary": { "type": "number", "example": 187500, "nullable": true, "description": "Single headline salary figure: the midpoint of the stated range, or the single stated bound. Null when the employer stated no salary." }, "job_country": { "type": "string", "example": "US", "nullable": true, "description": "ISO 3166-1 alpha-2 country code. Resolved from Indeed's country name, which is localised per market (\"Deutschland\" for de-DE), and falls back to the requested `country` when unrecognised. Always a 2-letter code." }, "job_benefits": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "Always null. The normalized JSearch benefit enum has no Indeed equivalent; the raw benefit labels are in job_benefits_strings." }, "job_latitude": { "type": "number", "example": 40.71427, "nullable": true, "description": "Latitude. 100% coverage on measured jobs." }, "job_location": { "type": "string", "example": "New York, NY", "nullable": true, "description": "Full formatted location, e.g. \"New York, NY 10003\"." }, "job_onet_soc": { "type": "string", "nullable": true, "description": "Always null. Indeed's occupations[] are its own SUID taxonomy, not O*NET SOC codes; they are exposed verbatim as job_indeed_occupations." }, "job_position": { "type": "integer", "example": 1, "nullable": true, "description": "Absolute 1-based rank of the job within the full result set for this query. Null on /job-details, which has no notion of rank." }, "apply_options": { "type": "array", "items": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_7bc4ac4354ea1318_ref2" }, "nullable": true, "description": "Application routes. Indeed exposes exactly one source per posting, so this array holds 0 or 1 entries." }, "employer_logo": { "type": "string", "nullable": true, "description": "Square employer logo. From Indeed's employer dossier (69% of 600 measured jobs); where Indeed has none, a Google faviconV2 URL derived from the employer website or apply domain is substituted. Null only when neither is available." }, "employer_name": { "type": "string", "example": "PactFi", "nullable": true, "description": "Employer name. Falls back to Indeed's `sourceEmployerName` when the employer record is absent. Populated on 100% of measured jobs." }, "job_is_remote": { "type": "boolean", "example": false, "description": "True when the posting carries Indeed's \"Remote\" attribute. Hybrid roles are false here and true on job_indeed_is_hybrid." }, "job_longitude": { "type": "number", "example": -74.00597, "nullable": true, "description": "Longitude. 100% coverage on measured jobs." }, "job_posted_at": { "type": "string", "example": "10 days ago", "nullable": true, "description": "Relative posting age in the JSearch vocabulary: \"today\", \"N days ago\" up to 30, then \"N month(s) ago\". Derived from job_posted_at_timestamp." }, "job_publisher": { "type": "string", "example": "Ashby", "nullable": true, "description": "Who is serving the application: the employer/ATS host derived from the apply URL, mapped to a friendly name for known ATSs (Workday, Greenhouse, Lever, iCIMS, ...)." }, "job_apply_link": { "type": "string", "example": "https://jobs.ashbyhq.com/pactfi/c4058bd0-55f3-49fd-a3de-994b4d2bb39e?utm_source=Zw9jOe6Ka6", "nullable": true, "description": "Direct application URL. On Indeed this is the employer's own careers page or ATS, not an Indeed redirect - populated on 600/600 measured jobs." }, "job_highlights": { "type": "object", "nullable": true, "description": "Always an empty object. Indeed ships one flat description with no qualifications/responsibilities/benefits split, so there is nothing to structure. Present for shape parity with the Google-backed surface.", "additionalProperties": true }, "job_max_salary": { "type": "number", "example": 200000, "nullable": true, "description": "Upper salary bound in the units of job_salary_period. Null when unstated or when only a lower bound was given." }, "job_min_salary": { "type": "number", "example": 175000, "nullable": true, "description": "Lower salary bound in the units of job_salary_period. Null when unstated or when only an upper bound was given." }, "job_description": { "type": "string", "nullable": true, "description": "Full plain-text job description, returned in the SEARCH response. See job_description_html for the markup." }, "job_google_link": { "type": "string", "nullable": true, "description": "Always null. Google-for-Jobs specific and not applicable to an Indeed-sourced posting." }, "employer_reviews": { "type": "array", "items": { "type": "object" }, "nullable": true, "description": "Always null here. Indeed publishes its company rating and review count on the /cmp company surface. GET /company-reviews returns them with the full review list, the category ratings and the 1-5 star distribution, at one request per 20 reviews. Pass job_indeed_company_page_url from any job here as the company parameter." }, "employer_website": { "type": "string", "example": "https://www.americanexpress.com", "nullable": true, "description": "Employer's corporate website (72% of 600 measured jobs)." }, "job_onet_job_zone": { "type": "string", "nullable": true, "description": "Always null. See job_onet_soc." }, "job_salary_period": { "enum": [ "YEAR", "MONTH", "WEEK", "DAY", "HOUR", null ], "type": "string", "example": "YEAR", "nullable": true, "description": "Unit the salary bounds are expressed in: YEAR, MONTH, WEEK, DAY or HOUR. Salary values keep the unit the employer stated." }, "job_salary_string": { "type": "string", "example": "$175,000 - $200,000 a year", "nullable": true, "description": "Salary exactly as Indeed renders it, e.g. \"$152,000 - $221,000 a year\" (60% of measured jobs)." }, "job_indeed_expired": { "type": "boolean", "example": false, "description": "True when Indeed has marked the posting expired." }, "job_indeed_ref_num": { "type": "string", "example": "c4058bd0-55f3-49fd-a3de-994b4d2bb39e", "nullable": true, "description": "The employer's own requisition id, e.g. \"JR2025219\". 100% coverage." }, "job_apply_is_direct": { "type": "boolean", "example": true, "description": "True when job_apply_link points at the employer/ATS rather than at another job board." }, "job_employment_type": { "enum": [ "FULLTIME", "CONTRACTOR", "PARTTIME", "INTERN", null ], "type": "string", "example": "FULLTIME", "nullable": true, "description": "Primary employment type. One of FULLTIME, CONTRACTOR, PARTTIME, INTERN. Null when Indeed tagged none of them." }, "job_indeed_language": { "type": "string", "example": "en", "nullable": true, "description": "ISO 639-1 language of the posting as detected by Indeed." }, "job_benefits_strings": { "type": "array", "items": { "type": "string" }, "example": [ "Health insurance", "401(k)" ], "nullable": true, "description": "Benefit labels as Indeed states them, e.g. \"401(k)\", \"Health insurance\", \"Paid time off\". Null when the posting lists none." }, "job_description_html": { "type": "string", "nullable": true, "description": "The job description with Indeed's original HTML markup preserved." }, "job_employment_types": { "type": "array", "items": { "type": "string" }, "example": [ "FULLTIME" ], "nullable": true, "description": "All employment types tagged on the posting, in the enum order FULLTIME, CONTRACTOR, PARTTIME, INTERN. Empty array when Indeed tagged none. Indeed also uses Temporary and Seasonal tags, which have no JSearch enum member and are exposed only in job_indeed_attributes rather than being folded into CONTRACTOR." }, "job_indeed_is_hybrid": { "type": "boolean", "example": true, "description": "True when the posting carries Indeed's \"Hybrid work\" attribute." }, "job_indeed_attributes": { "type": "array", "items": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_7bc4ac4354ea1318_ref3" }, "nullable": true, "description": "Every attribute Indeed tagged on the posting - 27 to 66 per job, mixing skills, employment type, seniority, benefits and work arrangement. The SUIDs here are the same tokens the employment_types / experience_level / work_from_home filters use upstream." }, "job_indeed_occupations": { "type": "array", "items": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_7bc4ac4354ea1318_ref3" }, "nullable": true, "description": "Indeed's occupation taxonomy for the posting." }, "job_indeed_postal_code": { "type": "string", "example": "10040", "nullable": true, "description": "Postal code (51% coverage)." }, "job_indeed_employer_key": { "type": "string", "example": "fda3f19471b1c223", "nullable": true, "description": "Indeed's stable company identifier (96% coverage). Also the encodedFccId used by the /cmp company pages." }, "job_posted_at_timestamp": { "type": "integer", "example": 1788222664, "nullable": true, "description": "Unix timestamp (seconds) of when the posting appeared on Indeed. 100% coverage." }, "job_indeed_is_urgent_hire": { "type": "boolean", "example": false, "description": "True when Indeed flags the posting as urgently hiring." }, "job_indeed_street_address": { "type": "string", "example": "World Financial Center", "nullable": true, "description": "Street address (41% coverage)." }, "job_posted_at_datetime_utc": { "type": "string", "format": "date-time", "example": "2026-09-01T00:31:04.000Z", "nullable": true, "description": "ISO 8601 UTC form of job_posted_at_timestamp." }, "job_published_at_timestamp": { "type": "integer", "example": 1788152400, "nullable": true, "description": "Unix timestamp (seconds) of the employer's own publish date. Distinct from job_posted_at_timestamp, which is when the posting reached Indeed." }, "job_indeed_company_page_url": { "type": "string", "example": "https://www.indeed.com/cmp/Haq-Bpo-Solutions", "nullable": true, "description": "Absolute URL of the employer's Indeed company page, e.g. \"https://www.indeed.com/cmp/Capgemini\"." }, "job_indeed_normalized_title": { "type": "string", "example": "full stack developer", "nullable": true, "description": "Indeed's normalized job title, e.g. \"devops engineer\"." }, "job_indeed_employer_industry": { "type": "string", "nullable": true, "description": "Industry from the Indeed company dossier (13% coverage)." }, "job_indeed_experience_levels": { "type": "array", "items": { "type": "string" }, "example": [ "MID_LEVEL" ], "nullable": true, "description": "Seniority tags on the posting: ENTRY_LEVEL, MID_LEVEL, SENIOR_LEVEL and/or NO_EXPERIENCE. Empty array when Indeed tagged none." }, "job_published_at_datetime_utc": { "type": "string", "format": "date-time", "example": "2026-08-31T05:00:00.000Z", "nullable": true, "description": "ISO 8601 UTC form of job_published_at_timestamp." }, "job_indeed_source_employer_name": { "type": "string", "example": "PactFi", "nullable": true, "description": "Employer name as it appeared on the source feed, before Indeed matched it to a company record." }, "job_indeed_employer_header_image": { "type": "string", "example": "https://d2q79iu7y748jz.cloudfront.net/s/_headerimage/1960x400/aae57269f3888005ede005b80239171b", "nullable": true, "description": "Employer banner image from the Indeed company dossier (54% coverage)." }, "job_indeed_is_high_volume_hiring": { "type": "boolean", "example": false, "description": "True when Indeed flags the posting as high-volume hiring." } }, "description": "A job posting. A superset of the 35-key JSearch `/search` contract: all 35 keys are\nalways present (null / [] / {} where Indeed cannot fill them), followed by 20+\nIndeed-specific keys.\n" }, "sds_L_Fsr74jXxRwFrRFUiukT_7bc4ac4354ea1318_ref2": { "type": "object", "required": [ "publisher", "apply_link", "is_direct" ], "properties": { "is_direct": { "type": "boolean", "description": "True when the link goes to the employer/ATS rather than another job board." }, "publisher": { "type": "string", "example": "Workday", "description": "Who serves the application - the employer/ATS host, mapped to a friendly name where known." }, "apply_link": { "type": "string", "description": "The application URL." } }, "description": "A single route to apply for the job." }, "sds_L_Fsr74jXxRwFrRFUiukT_7bc4ac4354ea1318_ref3": { "type": "object", "required": [ "key", "label" ], "properties": { "key": { "type": "string", "example": "CF3CP", "description": "Indeed's stable SUID for the term." }, "label": { "type": "string", "example": "Full-time", "description": "Human-readable label, localised to the requested language." } }, "description": "An Indeed taxonomy entry - a stable SUID plus its human label in the requested language." }, "sds_L_Fsr74jXxRwFrRFUiukT_7bc4ac4354ea1318_ref4": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_7bc4ac4354ea1318_ref5" } } }, "description": "Invalid or missing parameter." }, "sds_L_Fsr74jXxRwFrRFUiukT_7bc4ac4354ea1318_ref5": { "type": "object", "required": [ "status", "request_id", "error" ], "properties": { "error": { "type": "object", "required": [ "message", "code" ], "properties": { "code": { "type": "integer" }, "message": { "type": "string" } } }, "status": { "enum": [ "ERROR" ], "type": "string" }, "request_id": { "type": "string" } } }, "sds_L_Fsr74jXxRwFrRFUiukT_7bc4ac4354ea1318_ref6": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_7bc4ac4354ea1318_ref5" } } }, "description": "Missing or invalid credentials." }, "sds_L_Fsr74jXxRwFrRFUiukT_7bc4ac4354ea1318_ref7": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_7bc4ac4354ea1318_ref5" } } }, "description": "Not subscribed to this API." }, "sds_L_Fsr74jXxRwFrRFUiukT_7bc4ac4354ea1318_ref8": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_7bc4ac4354ea1318_ref5" } } }, "description": "Quota exhausted." }, "sds_L_Fsr74jXxRwFrRFUiukT_7bc4ac4354ea1318_ref9": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_7bc4ac4354ea1318_ref5" } } }, "description": "Unexpected error." }, "sds_L_Fsr74jXxRwFrRFUiukT_7bc4ac4354ea1318_ref10": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_7bc4ac4354ea1318_ref5" } } }, "description": "The upstream source was temporarily unreachable after the proxy ladder was exhausted.\nSafe to retry.\n" }, "sds_L_Fsr74jXxRwFrRFUiukT_bc35adccd8b7b722_ref0": { "type": "object", "required": [ "page", "num_pages", "company_ids_resolved" ], "properties": { "page": { "type": "integer", "example": 1 }, "query": { "type": "string", "example": "software engineer" }, "fields": { "type": "string", "example": "job_title,employer_name" }, "geo_id": { "type": "string", "example": "102571732" }, "radius": { "type": "integer", "example": 40 }, "company": { "type": "string", "example": "microsoft", "description": "The `company` slugs/URLs exactly as sent." }, "country": { "type": "string", "example": "us" }, "sort_by": { "type": "string", "example": "date" }, "location": { "type": "string", "example": "New York, United States" }, "num_pages": { "type": "integer", "example": 1 }, "company_id": { "type": "string", "example": "1035,1441" }, "date_posted": { "type": "string", "example": "week" }, "include_details": { "type": "string", "example": "false" }, "employment_types": { "type": "string", "example": "FULLTIME" }, "remote_jobs_only": { "type": "string", "example": "true" }, "seniority_levels": { "type": "string", "example": "Mid-Senior level" }, "company_ids_resolved": { "type": "string", "example": "1035,1441", "description": "The comma-separated numeric company ids the search actually ran with — `company_id` as sent, unioned with every id resolved from `company`. A slug lookup is never invisible." } }, "description": "Echo of the parameters as the caller sent them, before any internal transformation, plus `company_ids_resolved`. Only the parameters actually supplied are present — `query` is absent when none was sent." }, "sds_L_Fsr74jXxRwFrRFUiukT_bc35adccd8b7b722_ref1": { "type": "object", "required": [ "job_id", "job_title", "employer_name", "employer_logo", "employer_website", "job_publisher", "job_employment_type", "job_employment_types", "job_apply_link", "job_apply_is_direct", "apply_options", "job_description", "job_is_remote", "job_posted_at", "job_posted_at_timestamp", "job_posted_at_datetime_utc", "job_location", "job_city", "job_state", "job_country", "job_latitude", "job_longitude", "job_benefits", "job_benefits_strings", "job_google_link", "job_salary", "job_salary_string", "job_min_salary", "job_max_salary", "job_salary_period", "job_highlights", "job_onet_soc", "job_onet_job_zone", "employer_reviews", "job_uid", "employer_linkedin_url", "job_linkedin_company_id", "job_seniority_level", "job_function", "job_industries", "job_applicants_count", "job_applicants_label", "job_salary_currency", "job_posted_at_date", "job_posted_at_linkedin_label", "job_linkedin_badges", "job_position" ], "properties": { "job_id": { "type": "string", "example": "bGlua2VkaW46NDQ1MzY3MDk3Mw", "description": "Opaque public id: `base64url(\"linkedin:\" + )`. Pass it back to `/job-details`. Stable for the life of the posting." }, "job_uid": { "type": "string", "example": "4453670973", "description": "The raw numeric LinkedIn posting id. Permanent, and accepted directly by `/job-details`." }, "job_city": { "type": "string", "example": "New York", "nullable": true }, "job_state": { "type": "string", "example": "New York", "nullable": true, "description": "US 2-letter codes are expanded to the full state name, matching JSearch." }, "job_title": { "type": "string", "example": "Software Engineer III (Java/AWS)" }, "job_salary": { "type": "number", "example": null, "nullable": true, "description": "Set only when a posting states a single figure rather than a range; a range populates `job_min_salary` / `job_max_salary` instead." }, "job_country": { "type": "string", "example": "US", "nullable": true, "description": "2-letter code derived from the posting's own location where it names a country or a US state, falling back to the requested `country`. A US state code always wins over the requested market." }, "job_benefits": { "type": "array", "items": { "type": "string" }, "example": null, "nullable": true, "description": "Always `null`; LinkedIn does not publish a normalized benefits list." }, "job_function": { "type": "string", "example": "Engineering and Information Technology", "nullable": true, "description": "LinkedIn's job-function label. Detail surface only." }, "job_latitude": { "type": "number", "format": "float", "example": null, "nullable": true, "description": "Always `null`; not published on this surface." }, "job_location": { "type": "string", "example": "New York, NY", "nullable": true, "description": "LinkedIn's location string, verbatim. Three shapes occur: `\"New York, NY\"` (US, no country suffix), `\"London, England, United Kingdom\"` (international) and `\"New York City Metropolitan Area\"` (metro, no comma)." }, "job_onet_soc": { "type": "string", "example": null, "nullable": true, "description": "Always `null`; not published." }, "job_position": { "type": "integer", "example": 0, "nullable": true, "description": "Absolute 0-based rank within the result set, continuing across pages (page 2 starts at 10). **Search surface only** — always `null` on `/job-details`." }, "apply_options": { "type": "array", "items": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_bc35adccd8b7b722_ref2" } }, "employer_logo": { "type": "string", "format": "uri", "example": "https://media.licdn.com/dms/image/v2/D4E0BAQGxpntCyRgsuA/company-logo_100_100/0/1718711710850/jpmorganchase_logo", "nullable": true, "description": "LinkedIn CDN company logo. 50/50 on the measured sample." }, "employer_name": { "type": "string", "example": "JPMorganChase" }, "job_is_remote": { "type": "boolean", "example": null, "nullable": true, "description": "`true` or `null`, **never `false`**. LinkedIn's logged-out payload has no workplace-type field, so `true` is emitted only when an explicit textual remote marker is present and `null` means \"LinkedIn did not say\", not \"not remote\". 0/50 on the measured sample." }, "job_longitude": { "type": "number", "format": "float", "example": null, "nullable": true, "description": "Always `null`; not published on this surface." }, "job_posted_at": { "type": "string", "example": "8 days ago", "nullable": true, "description": "Relative posting age in JSearch's vocabulary: `today`, `1 day ago`, `N days ago` up to 30, then `N month(s) ago`. LinkedIn's own badge (\"1 week ago\", \"Just now\") is never emitted here — it is preserved verbatim as `job_posted_at_linkedin_label`." }, "job_publisher": { "enum": [ "LinkedIn" ], "type": "string", "example": "LinkedIn", "description": "Always `LinkedIn` — the guest surface never names the originating job board." }, "job_apply_link": { "type": "string", "format": "uri", "example": "https://www.linkedin.com/jobs/view/software-engineer-iii-java-aws-at-jpmorganchase-4453670973", "nullable": true, "description": "The public LinkedIn posting URL, with LinkedIn's per-render tracking parameters stripped. **Not** the employer's ATS URL — that is behind a login wall and is not present in the guest payload. International postings use a country subdomain (`uk.linkedin.com`)." }, "job_highlights": { "type": "object", "example": {}, "description": "Always `{}`. LinkedIn ships one prose blob with no qualifications / responsibilities / benefits split.", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "job_industries": { "type": "array", "items": { "type": "string" }, "example": [ "Financial Services" ], "nullable": true, "description": "LinkedIn's industry labels, comma-split. Individual labels can themselves contain \"and\" (\"IT Services and IT Consulting\") and are not split further. Detail surface only." }, "job_max_salary": { "type": "number", "example": 185000, "nullable": true }, "job_min_salary": { "type": "number", "example": 137750, "nullable": true }, "job_description": { "type": "string", "nullable": true, "description": "Full posting text, HTML stripped to plain text with paragraph breaks preserved. Typically 5 000–10 000 characters. Detail surface only — `null` when `include_details=false`." }, "job_google_link": { "type": "string", "format": "uri", "example": null, "nullable": true, "description": "Always `null`; Google-specific." }, "employer_reviews": { "type": "array", "items": { "type": "object" }, "example": null, "nullable": true, "description": "Always `null`; not published." }, "employer_website": { "type": "string", "format": "uri", "example": null, "nullable": true, "description": "Always `null`. LinkedIn only ever exposes the employer's LinkedIn company page, which is returned as `employer_linkedin_url` instead of being passed off as a website." }, "job_onet_job_zone": { "type": "string", "example": null, "nullable": true, "description": "Always `null`; not published." }, "job_salary_period": { "enum": [ "HOUR", "DAY", "WEEK", "MONTH", "YEAR", null ], "type": "string", "example": "YEAR", "nullable": true }, "job_salary_string": { "type": "string", "example": "$137,750.00/yr - $185,000.00/yr", "nullable": true, "description": "LinkedIn's compensation string, verbatim. Present on ~24% of postings (12/50 measured); detail surface only." }, "job_posted_at_date": { "type": "string", "format": "date", "example": "2026-09-03", "nullable": true, "description": "The exact `datetime` attribute LinkedIn publishes on a search card. **Search surface only** — always `null` on `/job-details`, which carries no date element." }, "job_apply_is_direct": { "enum": [ false ], "type": "boolean", "example": false, "description": "Always `false`; the employer's own application destination is not visible." }, "job_employment_type": { "type": "string", "example": "Full-time", "nullable": true, "description": "LinkedIn's own label (\"Full-time\"). Detail surface only — `null` when `include_details=false`." }, "job_linkedin_badges": { "type": "array", "items": { "type": "string" }, "example": [ "Actively Hiring" ], "nullable": true, "description": "LinkedIn engagement badges (\"Actively Hiring\", \"Be an early applicant\"). Search surface only; 37/50 on the measured sample." }, "job_salary_currency": { "type": "string", "example": "USD", "nullable": true, "description": "ISO 4217 code inferred from the salary string's symbol or code." }, "job_seniority_level": { "enum": [ "Internship", "Entry level", "Associate", "Mid-Senior level", "Director", "Executive", "Not Applicable", null ], "type": "string", "example": "Not Applicable", "nullable": true, "description": "LinkedIn's own seniority vocabulary. Detail surface only." }, "job_applicants_count": { "type": "integer", "example": 193, "nullable": true, "description": "Applicant count as an integer. Present on ~52% of postings (26/50 measured). When LinkedIn caps the figure (\"Over 200 applicants\") this is the capped number and `job_applicants_label` carries the exact wording. Detail surface only." }, "job_applicants_label": { "type": "string", "example": "193 applicants", "nullable": true, "description": "LinkedIn's applicant caption, verbatim." }, "job_benefits_strings": { "type": "array", "items": { "type": "string" }, "example": null, "nullable": true, "description": "Always `null`. LinkedIn's only chips are engagement badges (\"Actively Hiring\"), which are not benefits; they are returned as `job_linkedin_badges` instead." }, "job_employment_types": { "type": "array", "items": { "enum": [ "FULLTIME", "PARTTIME", "CONTRACTOR", "INTERN", "VOLUNTEER", "OTHER" ], "type": "string" }, "example": [ "FULLTIME" ], "description": "Normalized enum form of `job_employment_type`. Empty when `include_details=false`." }, "employer_linkedin_url": { "type": "string", "format": "uri", "example": "https://www.linkedin.com/company/jpmorganchase", "nullable": true, "description": "The employer's LinkedIn company page, tracking parameters stripped." }, "job_linkedin_company_id": { "type": "string", "example": "1068", "nullable": true, "description": "The employer's numeric LinkedIn company id. Feed it back as `company_id` on `/search` to get more jobs at the same company. Detail surface only." }, "job_posted_at_timestamp": { "type": "integer", "example": 1788393600, "nullable": true, "description": "Unix epoch seconds at **midnight UTC of the posting date**. LinkedIn publishes a date, not a time. On `/job-details` this is derived from the relative label and can be off by a few days; `/search` carries the exact date." }, "job_posted_at_datetime_utc": { "type": "string", "format": "date-time", "example": "2026-09-03T00:00:00.000Z", "nullable": true }, "job_posted_at_linkedin_label": { "type": "string", "example": "1 week ago", "nullable": true, "description": "LinkedIn's own relative badge, verbatim." } }, "description": "A superset of the 35-key JSearch `/search` job object. All 35 keys are always present, as are the 12 LinkedIn-only extras; a field LinkedIn cannot supply is `null`, `[]` or `{}`." }, "sds_L_Fsr74jXxRwFrRFUiukT_bc35adccd8b7b722_ref2": { "type": "object", "required": [ "apply_link", "is_direct", "publisher" ], "properties": { "is_direct": { "enum": [ false ], "type": "boolean", "example": false }, "publisher": { "enum": [ "LinkedIn" ], "type": "string", "example": "LinkedIn" }, "apply_link": { "type": "string", "format": "uri", "example": "https://www.linkedin.com/jobs/view/software-engineer-iii-java-aws-at-jpmorganchase-4453670973" } }, "description": "Always exactly one entry on this source, describing the LinkedIn posting page. LinkedIn's logged-out surface does not expose the employer's own application destination, so there is never a second option and `is_direct` is never `true`." }, "sds_L_Fsr74jXxRwFrRFUiukT_bc35adccd8b7b722_ref3": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_bc35adccd8b7b722_ref4" } } }, "description": "Invalid request parameters" }, "sds_L_Fsr74jXxRwFrRFUiukT_bc35adccd8b7b722_ref4": { "type": "object", "required": [ "status", "request_id", "error" ], "properties": { "error": { "type": "object", "required": [ "message", "code" ], "properties": { "code": { "type": "integer" }, "message": { "type": "string" } } }, "status": { "enum": [ "ERROR" ], "type": "string" }, "request_id": { "type": "string" } } }, "sds_L_Fsr74jXxRwFrRFUiukT_bc35adccd8b7b722_ref5": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_bc35adccd8b7b722_ref4" } } }, "description": "Authentication error" }, "sds_L_Fsr74jXxRwFrRFUiukT_cc9abe91a2846790_ref0": { "type": "object", "required": [ "job_id" ], "properties": { "fields": { "type": "string" }, "job_id": { "type": "string", "example": "bGlua2VkaW46NDQ1MzY3MDk3Mw" }, "country": { "type": "string", "example": "us" } } }, "sds_L_Fsr74jXxRwFrRFUiukT_cc9abe91a2846790_ref1": { "type": "object", "required": [ "job_id", "job_title", "employer_name", "employer_logo", "employer_website", "job_publisher", "job_employment_type", "job_employment_types", "job_apply_link", "job_apply_is_direct", "apply_options", "job_description", "job_is_remote", "job_posted_at", "job_posted_at_timestamp", "job_posted_at_datetime_utc", "job_location", "job_city", "job_state", "job_country", "job_latitude", "job_longitude", "job_benefits", "job_benefits_strings", "job_google_link", "job_salary", "job_salary_string", "job_min_salary", "job_max_salary", "job_salary_period", "job_highlights", "job_onet_soc", "job_onet_job_zone", "employer_reviews", "job_uid", "employer_linkedin_url", "job_linkedin_company_id", "job_seniority_level", "job_function", "job_industries", "job_applicants_count", "job_applicants_label", "job_salary_currency", "job_posted_at_date", "job_posted_at_linkedin_label", "job_linkedin_badges", "job_position" ], "properties": { "job_id": { "type": "string", "example": "bGlua2VkaW46NDQ1MzY3MDk3Mw", "description": "Opaque public id: `base64url(\"linkedin:\" + )`. Pass it back to `/job-details`. Stable for the life of the posting." }, "job_uid": { "type": "string", "example": "4453670973", "description": "The raw numeric LinkedIn posting id. Permanent, and accepted directly by `/job-details`." }, "job_city": { "type": "string", "example": "New York", "nullable": true }, "job_state": { "type": "string", "example": "New York", "nullable": true, "description": "US 2-letter codes are expanded to the full state name, matching JSearch." }, "job_title": { "type": "string", "example": "Software Engineer III (Java/AWS)" }, "job_salary": { "type": "number", "example": null, "nullable": true, "description": "Set only when a posting states a single figure rather than a range; a range populates `job_min_salary` / `job_max_salary` instead." }, "job_country": { "type": "string", "example": "US", "nullable": true, "description": "2-letter code derived from the posting's own location where it names a country or a US state, falling back to the requested `country`. A US state code always wins over the requested market." }, "job_benefits": { "type": "array", "items": { "type": "string" }, "example": null, "nullable": true, "description": "Always `null`; LinkedIn does not publish a normalized benefits list." }, "job_function": { "type": "string", "example": "Engineering and Information Technology", "nullable": true, "description": "LinkedIn's job-function label. Detail surface only." }, "job_latitude": { "type": "number", "format": "float", "example": null, "nullable": true, "description": "Always `null`; not published on this surface." }, "job_location": { "type": "string", "example": "New York, NY", "nullable": true, "description": "LinkedIn's location string, verbatim. Three shapes occur: `\"New York, NY\"` (US, no country suffix), `\"London, England, United Kingdom\"` (international) and `\"New York City Metropolitan Area\"` (metro, no comma)." }, "job_onet_soc": { "type": "string", "example": null, "nullable": true, "description": "Always `null`; not published." }, "job_position": { "type": "integer", "example": 0, "nullable": true, "description": "Absolute 0-based rank within the result set, continuing across pages (page 2 starts at 10). **Search surface only** — always `null` on `/job-details`." }, "apply_options": { "type": "array", "items": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_cc9abe91a2846790_ref2" } }, "employer_logo": { "type": "string", "format": "uri", "example": "https://media.licdn.com/dms/image/v2/D4E0BAQGxpntCyRgsuA/company-logo_100_100/0/1718711710850/jpmorganchase_logo", "nullable": true, "description": "LinkedIn CDN company logo. 50/50 on the measured sample." }, "employer_name": { "type": "string", "example": "JPMorganChase" }, "job_is_remote": { "type": "boolean", "example": null, "nullable": true, "description": "`true` or `null`, **never `false`**. LinkedIn's logged-out payload has no workplace-type field, so `true` is emitted only when an explicit textual remote marker is present and `null` means \"LinkedIn did not say\", not \"not remote\". 0/50 on the measured sample." }, "job_longitude": { "type": "number", "format": "float", "example": null, "nullable": true, "description": "Always `null`; not published on this surface." }, "job_posted_at": { "type": "string", "example": "8 days ago", "nullable": true, "description": "Relative posting age in JSearch's vocabulary: `today`, `1 day ago`, `N days ago` up to 30, then `N month(s) ago`. LinkedIn's own badge (\"1 week ago\", \"Just now\") is never emitted here — it is preserved verbatim as `job_posted_at_linkedin_label`." }, "job_publisher": { "enum": [ "LinkedIn" ], "type": "string", "example": "LinkedIn", "description": "Always `LinkedIn` — the guest surface never names the originating job board." }, "job_apply_link": { "type": "string", "format": "uri", "example": "https://www.linkedin.com/jobs/view/software-engineer-iii-java-aws-at-jpmorganchase-4453670973", "nullable": true, "description": "The public LinkedIn posting URL, with LinkedIn's per-render tracking parameters stripped. **Not** the employer's ATS URL — that is behind a login wall and is not present in the guest payload. International postings use a country subdomain (`uk.linkedin.com`)." }, "job_highlights": { "type": "object", "example": {}, "description": "Always `{}`. LinkedIn ships one prose blob with no qualifications / responsibilities / benefits split.", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "job_industries": { "type": "array", "items": { "type": "string" }, "example": [ "Financial Services" ], "nullable": true, "description": "LinkedIn's industry labels, comma-split. Individual labels can themselves contain \"and\" (\"IT Services and IT Consulting\") and are not split further. Detail surface only." }, "job_max_salary": { "type": "number", "example": 185000, "nullable": true }, "job_min_salary": { "type": "number", "example": 137750, "nullable": true }, "job_description": { "type": "string", "nullable": true, "description": "Full posting text, HTML stripped to plain text with paragraph breaks preserved. Typically 5 000–10 000 characters. Detail surface only — `null` when `include_details=false`." }, "job_google_link": { "type": "string", "format": "uri", "example": null, "nullable": true, "description": "Always `null`; Google-specific." }, "employer_reviews": { "type": "array", "items": { "type": "object" }, "example": null, "nullable": true, "description": "Always `null`; not published." }, "employer_website": { "type": "string", "format": "uri", "example": null, "nullable": true, "description": "Always `null`. LinkedIn only ever exposes the employer's LinkedIn company page, which is returned as `employer_linkedin_url` instead of being passed off as a website." }, "job_onet_job_zone": { "type": "string", "example": null, "nullable": true, "description": "Always `null`; not published." }, "job_salary_period": { "enum": [ "HOUR", "DAY", "WEEK", "MONTH", "YEAR", null ], "type": "string", "example": "YEAR", "nullable": true }, "job_salary_string": { "type": "string", "example": "$137,750.00/yr - $185,000.00/yr", "nullable": true, "description": "LinkedIn's compensation string, verbatim. Present on ~24% of postings (12/50 measured); detail surface only." }, "job_posted_at_date": { "type": "string", "format": "date", "example": "2026-09-03", "nullable": true, "description": "The exact `datetime` attribute LinkedIn publishes on a search card. **Search surface only** — always `null` on `/job-details`, which carries no date element." }, "job_apply_is_direct": { "enum": [ false ], "type": "boolean", "example": false, "description": "Always `false`; the employer's own application destination is not visible." }, "job_employment_type": { "type": "string", "example": "Full-time", "nullable": true, "description": "LinkedIn's own label (\"Full-time\"). Detail surface only — `null` when `include_details=false`." }, "job_linkedin_badges": { "type": "array", "items": { "type": "string" }, "example": [ "Actively Hiring" ], "nullable": true, "description": "LinkedIn engagement badges (\"Actively Hiring\", \"Be an early applicant\"). Search surface only; 37/50 on the measured sample." }, "job_salary_currency": { "type": "string", "example": "USD", "nullable": true, "description": "ISO 4217 code inferred from the salary string's symbol or code." }, "job_seniority_level": { "enum": [ "Internship", "Entry level", "Associate", "Mid-Senior level", "Director", "Executive", "Not Applicable", null ], "type": "string", "example": "Not Applicable", "nullable": true, "description": "LinkedIn's own seniority vocabulary. Detail surface only." }, "job_applicants_count": { "type": "integer", "example": 193, "nullable": true, "description": "Applicant count as an integer. Present on ~52% of postings (26/50 measured). When LinkedIn caps the figure (\"Over 200 applicants\") this is the capped number and `job_applicants_label` carries the exact wording. Detail surface only." }, "job_applicants_label": { "type": "string", "example": "193 applicants", "nullable": true, "description": "LinkedIn's applicant caption, verbatim." }, "job_benefits_strings": { "type": "array", "items": { "type": "string" }, "example": null, "nullable": true, "description": "Always `null`. LinkedIn's only chips are engagement badges (\"Actively Hiring\"), which are not benefits; they are returned as `job_linkedin_badges` instead." }, "job_employment_types": { "type": "array", "items": { "enum": [ "FULLTIME", "PARTTIME", "CONTRACTOR", "INTERN", "VOLUNTEER", "OTHER" ], "type": "string" }, "example": [ "FULLTIME" ], "description": "Normalized enum form of `job_employment_type`. Empty when `include_details=false`." }, "employer_linkedin_url": { "type": "string", "format": "uri", "example": "https://www.linkedin.com/company/jpmorganchase", "nullable": true, "description": "The employer's LinkedIn company page, tracking parameters stripped." }, "job_linkedin_company_id": { "type": "string", "example": "1068", "nullable": true, "description": "The employer's numeric LinkedIn company id. Feed it back as `company_id` on `/search` to get more jobs at the same company. Detail surface only." }, "job_posted_at_timestamp": { "type": "integer", "example": 1788393600, "nullable": true, "description": "Unix epoch seconds at **midnight UTC of the posting date**. LinkedIn publishes a date, not a time. On `/job-details` this is derived from the relative label and can be off by a few days; `/search` carries the exact date." }, "job_posted_at_datetime_utc": { "type": "string", "format": "date-time", "example": "2026-09-03T00:00:00.000Z", "nullable": true }, "job_posted_at_linkedin_label": { "type": "string", "example": "1 week ago", "nullable": true, "description": "LinkedIn's own relative badge, verbatim." } }, "description": "A superset of the 35-key JSearch `/search` job object. All 35 keys are always present, as are the 12 LinkedIn-only extras; a field LinkedIn cannot supply is `null`, `[]` or `{}`." }, "sds_L_Fsr74jXxRwFrRFUiukT_cc9abe91a2846790_ref2": { "type": "object", "required": [ "apply_link", "is_direct", "publisher" ], "properties": { "is_direct": { "enum": [ false ], "type": "boolean", "example": false }, "publisher": { "enum": [ "LinkedIn" ], "type": "string", "example": "LinkedIn" }, "apply_link": { "type": "string", "format": "uri", "example": "https://www.linkedin.com/jobs/view/software-engineer-iii-java-aws-at-jpmorganchase-4453670973" } }, "description": "Always exactly one entry on this source, describing the LinkedIn posting page. LinkedIn's logged-out surface does not expose the employer's own application destination, so there is never a second option and `is_direct` is never `true`." }, "sds_L_Fsr74jXxRwFrRFUiukT_cc9abe91a2846790_ref3": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_cc9abe91a2846790_ref4" } } }, "description": "Invalid request parameters" }, "sds_L_Fsr74jXxRwFrRFUiukT_cc9abe91a2846790_ref4": { "type": "object", "required": [ "status", "request_id", "error" ], "properties": { "error": { "type": "object", "required": [ "message", "code" ], "properties": { "code": { "type": "integer" }, "message": { "type": "string" } } }, "status": { "enum": [ "ERROR" ], "type": "string" }, "request_id": { "type": "string" } } }, "sds_L_Fsr74jXxRwFrRFUiukT_cc9abe91a2846790_ref5": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_cc9abe91a2846790_ref4" } } }, "description": "Authentication error" }, "sds_L_Fsr74jXxRwFrRFUiukT_cc9abe91a2846790_ref6": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_cc9abe91a2846790_ref4" } } }, "description": "Resource not found" }, "sds_L_Fsr74jXxRwFrRFUiukT_dd1e400b60677987_ref0": { "type": "object", "required": [ "query", "page", "num_pages" ], "properties": { "page": { "type": "integer", "example": 1 }, "query": { "type": "string", "example": "software engineer" }, "fields": { "type": "string", "example": "job_title,employer_name" }, "geo_id": { "type": "string", "example": "102571732" }, "radius": { "type": "integer", "example": 40 }, "country": { "type": "string", "example": "us" }, "sort_by": { "type": "string", "example": "date" }, "location": { "type": "string", "example": "New York, United States" }, "num_pages": { "type": "integer", "example": 1 }, "company_id": { "type": "string", "example": "1441" }, "date_posted": { "type": "string", "example": "week" }, "include_details": { "type": "string", "example": "false" }, "employment_types": { "type": "string", "example": "FULLTIME" }, "remote_jobs_only": { "type": "string", "example": "true" }, "seniority_levels": { "type": "string", "example": "Mid-Senior level" } }, "description": "Echo of the parameters as the caller sent them, before any internal transformation. Only the parameters actually supplied are present." }, "sds_L_Fsr74jXxRwFrRFUiukT_dd1e400b60677987_ref1": { "type": "object", "required": [ "job_id", "job_title", "employer_name", "employer_logo", "employer_website", "job_publisher", "job_employment_type", "job_employment_types", "job_apply_link", "job_apply_is_direct", "apply_options", "job_description", "job_is_remote", "job_posted_at", "job_posted_at_timestamp", "job_posted_at_datetime_utc", "job_location", "job_city", "job_state", "job_country", "job_latitude", "job_longitude", "job_benefits", "job_benefits_strings", "job_google_link", "job_salary", "job_salary_string", "job_min_salary", "job_max_salary", "job_salary_period", "job_highlights", "job_onet_soc", "job_onet_job_zone", "employer_reviews", "job_uid", "employer_linkedin_url", "job_linkedin_company_id", "job_seniority_level", "job_function", "job_industries", "job_applicants_count", "job_applicants_label", "job_salary_currency", "job_posted_at_date", "job_posted_at_linkedin_label", "job_linkedin_badges", "job_position" ], "properties": { "job_id": { "type": "string", "example": "bGlua2VkaW46NDQ1MzY3MDk3Mw", "description": "Opaque public id: `base64url(\"linkedin:\" + )`. Pass it back to `/job-details`. Stable for the life of the posting." }, "job_uid": { "type": "string", "example": "4453670973", "description": "The raw numeric LinkedIn posting id. Permanent, and accepted directly by `/job-details`." }, "job_city": { "type": "string", "example": "New York", "nullable": true }, "job_state": { "type": "string", "example": "New York", "nullable": true, "description": "US 2-letter codes are expanded to the full state name, matching JSearch." }, "job_title": { "type": "string", "example": "Software Engineer III (Java/AWS)" }, "job_salary": { "type": "number", "example": null, "nullable": true, "description": "Set only when a posting states a single figure rather than a range; a range populates `job_min_salary` / `job_max_salary` instead." }, "job_country": { "type": "string", "example": "US", "nullable": true, "description": "2-letter code derived from the posting's own location where it names a country or a US state, falling back to the requested `country`. A US state code always wins over the requested market." }, "job_benefits": { "type": "array", "items": { "type": "string" }, "example": null, "nullable": true, "description": "Always `null`; LinkedIn does not publish a normalized benefits list." }, "job_function": { "type": "string", "example": "Engineering and Information Technology", "nullable": true, "description": "LinkedIn's job-function label. Detail surface only." }, "job_latitude": { "type": "number", "format": "float", "example": null, "nullable": true, "description": "Always `null`; not published on this surface." }, "job_location": { "type": "string", "example": "New York, NY", "nullable": true, "description": "LinkedIn's location string, verbatim. Three shapes occur: `\"New York, NY\"` (US, no country suffix), `\"London, England, United Kingdom\"` (international) and `\"New York City Metropolitan Area\"` (metro, no comma)." }, "job_onet_soc": { "type": "string", "example": null, "nullable": true, "description": "Always `null`; not published." }, "job_position": { "type": "integer", "example": 0, "nullable": true, "description": "Absolute 0-based rank within the result set, continuing across pages (page 2 starts at 10). **Search surface only** — always `null` on `/job-details`." }, "apply_options": { "type": "array", "items": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_dd1e400b60677987_ref2" } }, "employer_logo": { "type": "string", "format": "uri", "example": "https://media.licdn.com/dms/image/v2/D4E0BAQGxpntCyRgsuA/company-logo_100_100/0/1718711710850/jpmorganchase_logo", "nullable": true, "description": "LinkedIn CDN company logo. 50/50 on the measured sample." }, "employer_name": { "type": "string", "example": "JPMorganChase" }, "job_is_remote": { "type": "boolean", "example": null, "nullable": true, "description": "`true` or `null`, **never `false`**. LinkedIn's logged-out payload has no workplace-type field, so `true` is emitted only when an explicit textual remote marker is present and `null` means \"LinkedIn did not say\", not \"not remote\". 0/50 on the measured sample." }, "job_longitude": { "type": "number", "format": "float", "example": null, "nullable": true, "description": "Always `null`; not published on this surface." }, "job_posted_at": { "type": "string", "example": "8 days ago", "nullable": true, "description": "Relative posting age in JSearch's vocabulary: `today`, `1 day ago`, `N days ago` up to 30, then `N month(s) ago`. LinkedIn's own badge (\"1 week ago\", \"Just now\") is never emitted here — it is preserved verbatim as `job_posted_at_linkedin_label`." }, "job_publisher": { "enum": [ "LinkedIn" ], "type": "string", "example": "LinkedIn", "description": "Always `LinkedIn` — the guest surface never names the originating job board." }, "job_apply_link": { "type": "string", "format": "uri", "example": "https://www.linkedin.com/jobs/view/software-engineer-iii-java-aws-at-jpmorganchase-4453670973", "nullable": true, "description": "The public LinkedIn posting URL, with LinkedIn's per-render tracking parameters stripped. **Not** the employer's ATS URL — that is behind a login wall and is not present in the guest payload. International postings use a country subdomain (`uk.linkedin.com`)." }, "job_highlights": { "type": "object", "example": {}, "description": "Always `{}`. LinkedIn ships one prose blob with no qualifications / responsibilities / benefits split.", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "job_industries": { "type": "array", "items": { "type": "string" }, "example": [ "Financial Services" ], "nullable": true, "description": "LinkedIn's industry labels, comma-split. Individual labels can themselves contain \"and\" (\"IT Services and IT Consulting\") and are not split further. Detail surface only." }, "job_max_salary": { "type": "number", "example": 185000, "nullable": true }, "job_min_salary": { "type": "number", "example": 137750, "nullable": true }, "job_description": { "type": "string", "nullable": true, "description": "Full posting text, HTML stripped to plain text with paragraph breaks preserved. Typically 5 000–10 000 characters. Detail surface only — `null` when `include_details=false`." }, "job_google_link": { "type": "string", "format": "uri", "example": null, "nullable": true, "description": "Always `null`; Google-specific." }, "employer_reviews": { "type": "array", "items": { "type": "object" }, "example": null, "nullable": true, "description": "Always `null`; not published." }, "employer_website": { "type": "string", "format": "uri", "example": null, "nullable": true, "description": "Always `null`. LinkedIn only ever exposes the employer's LinkedIn company page, which is returned as `employer_linkedin_url` instead of being passed off as a website." }, "job_onet_job_zone": { "type": "string", "example": null, "nullable": true, "description": "Always `null`; not published." }, "job_salary_period": { "enum": [ "HOUR", "DAY", "WEEK", "MONTH", "YEAR", null ], "type": "string", "example": "YEAR", "nullable": true }, "job_salary_string": { "type": "string", "example": "$137,750.00/yr - $185,000.00/yr", "nullable": true, "description": "LinkedIn's compensation string, verbatim. Present on ~24% of postings (12/50 measured); detail surface only." }, "job_posted_at_date": { "type": "string", "format": "date", "example": "2026-09-03", "nullable": true, "description": "The exact `datetime` attribute LinkedIn publishes on a search card. **Search surface only** — always `null` on `/job-details`, which carries no date element." }, "job_apply_is_direct": { "enum": [ false ], "type": "boolean", "example": false, "description": "Always `false`; the employer's own application destination is not visible." }, "job_employment_type": { "type": "string", "example": "Full-time", "nullable": true, "description": "LinkedIn's own label (\"Full-time\"). Detail surface only — `null` when `include_details=false`." }, "job_linkedin_badges": { "type": "array", "items": { "type": "string" }, "example": [ "Actively Hiring" ], "nullable": true, "description": "LinkedIn engagement badges (\"Actively Hiring\", \"Be an early applicant\"). Search surface only; 37/50 on the measured sample." }, "job_salary_currency": { "type": "string", "example": "USD", "nullable": true, "description": "ISO 4217 code inferred from the salary string's symbol or code." }, "job_seniority_level": { "enum": [ "Internship", "Entry level", "Associate", "Mid-Senior level", "Director", "Executive", "Not Applicable", null ], "type": "string", "example": "Not Applicable", "nullable": true, "description": "LinkedIn's own seniority vocabulary. Detail surface only." }, "job_applicants_count": { "type": "integer", "example": 193, "nullable": true, "description": "Applicant count as an integer. Present on ~52% of postings (26/50 measured). When LinkedIn caps the figure (\"Over 200 applicants\") this is the capped number and `job_applicants_label` carries the exact wording. Detail surface only." }, "job_applicants_label": { "type": "string", "example": "193 applicants", "nullable": true, "description": "LinkedIn's applicant caption, verbatim." }, "job_benefits_strings": { "type": "array", "items": { "type": "string" }, "example": null, "nullable": true, "description": "Always `null`. LinkedIn's only chips are engagement badges (\"Actively Hiring\"), which are not benefits; they are returned as `job_linkedin_badges` instead." }, "job_employment_types": { "type": "array", "items": { "enum": [ "FULLTIME", "PARTTIME", "CONTRACTOR", "INTERN", "VOLUNTEER", "OTHER" ], "type": "string" }, "example": [ "FULLTIME" ], "description": "Normalized enum form of `job_employment_type`. Empty when `include_details=false`." }, "employer_linkedin_url": { "type": "string", "format": "uri", "example": "https://www.linkedin.com/company/jpmorganchase", "nullable": true, "description": "The employer's LinkedIn company page, tracking parameters stripped." }, "job_linkedin_company_id": { "type": "string", "example": "1068", "nullable": true, "description": "The employer's numeric LinkedIn company id. Feed it back as `company_id` on `/search` to get more jobs at the same company. Detail surface only." }, "job_posted_at_timestamp": { "type": "integer", "example": 1788393600, "nullable": true, "description": "Unix epoch seconds at **midnight UTC of the posting date**. LinkedIn publishes a date, not a time. On `/job-details` this is derived from the relative label and can be off by a few days; `/search` carries the exact date." }, "job_posted_at_datetime_utc": { "type": "string", "format": "date-time", "example": "2026-09-03T00:00:00.000Z", "nullable": true }, "job_posted_at_linkedin_label": { "type": "string", "example": "1 week ago", "nullable": true, "description": "LinkedIn's own relative badge, verbatim." } }, "description": "A superset of the 35-key JSearch `/search` job object. All 35 keys are always present, as are the 12 LinkedIn-only extras; a field LinkedIn cannot supply is `null`, `[]` or `{}`." }, "sds_L_Fsr74jXxRwFrRFUiukT_dd1e400b60677987_ref2": { "type": "object", "required": [ "apply_link", "is_direct", "publisher" ], "properties": { "is_direct": { "enum": [ false ], "type": "boolean", "example": false }, "publisher": { "enum": [ "LinkedIn" ], "type": "string", "example": "LinkedIn" }, "apply_link": { "type": "string", "format": "uri", "example": "https://www.linkedin.com/jobs/view/software-engineer-iii-java-aws-at-jpmorganchase-4453670973" } }, "description": "Always exactly one entry on this source, describing the LinkedIn posting page. LinkedIn's logged-out surface does not expose the employer's own application destination, so there is never a second option and `is_direct` is never `true`." }, "sds_L_Fsr74jXxRwFrRFUiukT_dd1e400b60677987_ref3": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_dd1e400b60677987_ref4" } } }, "description": "Invalid request parameters" }, "sds_L_Fsr74jXxRwFrRFUiukT_dd1e400b60677987_ref4": { "type": "object", "required": [ "status", "request_id", "error" ], "properties": { "error": { "type": "object", "required": [ "message", "code" ], "properties": { "code": { "type": "integer" }, "message": { "type": "string" } } }, "status": { "enum": [ "ERROR" ], "type": "string" }, "request_id": { "type": "string" } } }, "sds_L_Fsr74jXxRwFrRFUiukT_dd1e400b60677987_ref5": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_dd1e400b60677987_ref4" } } }, "description": "Authentication error" }, "sds_L_Fsr74jXxRwFrRFUiukT_dd1e400b60677987_ref6": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_dd1e400b60677987_ref4" } } }, "description": "Resource not found" }, "sds_L_Fsr74jXxRwFrRFUiukT_59a9ba9486dc2473_ref0": { "type": "object", "required": [ "company", "page", "num_pages" ], "properties": { "page": { "type": "integer", "description": "The page the response starts at. Always present, defaulting to 1." }, "query": { "type": "string", "description": "The keyword filter as sent. Absent when the employer was the only constraint." }, "fields": { "type": "string", "description": "The projection exactly as sent." }, "radius": { "type": "integer", "description": "The radius in kilometres, as sent." }, "company": { "type": "string", "description": "The employer display names exactly as sent, trimmed." }, "country": { "type": "string", "description": "The country code as sent, lowercased. Absent when it defaulted to `us`." }, "location": { "type": "string", "description": "The location exactly as sent. Absent when the search was country-wide." }, "num_pages": { "type": "integer", "description": "How many pages were fetched. Always present, defaulting to 1." }, "date_posted": { "type": "string", "description": "The freshness window exactly as sent, `all` included." }, "employment_types": { "type": "string", "description": "The employment types exactly as sent, before uppercasing and splitting." } }, "description": "Echo of the parameters as the caller sent them. `query` is absent when none was sent, since it is optional on this endpoint. `page` and `num_pages` are always echoed with the value actually used." }, "sds_L_Fsr74jXxRwFrRFUiukT_59a9ba9486dc2473_ref1": { "type": "object", "required": [ "job_id", "job_title", "employer_name", "employer_logo", "employer_website", "job_publisher", "job_employment_type", "job_employment_types", "job_apply_link", "job_apply_is_direct", "apply_options", "job_description", "job_is_remote", "job_posted_at", "job_posted_at_timestamp", "job_posted_at_datetime_utc", "job_location", "job_city", "job_state", "job_country", "job_latitude", "job_longitude", "job_benefits", "job_benefits_strings", "job_google_link", "job_salary", "job_salary_string", "job_min_salary", "job_max_salary", "job_salary_period", "job_highlights", "job_onet_soc", "job_onet_job_zone", "employer_reviews", "job_uid", "job_seo_id", "job_canonical_url", "job_apply_type", "job_skills", "job_industry", "job_occupational_category", "job_location_type", "job_status", "job_valid_through", "job_provider", "employer_description", "employer_founding_date", "employer_size", "employer_address", "job_posted_at_date", "job_salary_currency", "job_publisher_recency_label", "job_position" ], "properties": { "job_id": { "type": "string", "example": "bW9uc3RlcjplNzc2MTJmNS1iYjNiLTQ2NWUtYTk2NS00MzlhZjk0MDk0YmQ", "description": "Opaque public id for the posting, `base64url(\"monster:\" + )`. Pass it back to `/job-details`. Stable for the life of the posting." }, "job_uid": { "type": "string", "example": "e77612f5-bb3b-465e-a965-439af94094bd", "description": "Monster's own job id, a permanent UUIDv4. Accepted directly by `/job-details` and the right key for a downstream cache." }, "job_city": { "type": "string", "example": "DFW Airport", "nullable": true, "description": "City. `null` on a country-level or region-only posting." }, "job_state": { "type": "string", "example": "Texas", "nullable": true, "description": "The full state or province NAME, matching JSearch. The code appears inside `job_location`." }, "job_title": { "type": "string", "example": "Warehouse Associate - $26/hr +", "nullable": true, "description": "The job title as Monster publishes it." }, "job_salary": { "type": "number", "example": null, "nullable": true, "description": "Set only when a posting states ONE figure rather than a range, in the unit given by `job_salary_period`. A range populates `job_min_salary` / `job_max_salary` instead." }, "job_seo_id": { "type": "string", "example": "warehouse-associate-26-hr-dallas-tx--e77612f5-bb3b-465e-a965-439af94094bd", "nullable": true, "description": "The slugged id from the public posting URL, `----`. Accepted by `/job-details` in place of the uuid, so a caller holding only a scraped URL can round-trip with it." }, "job_skills": { "type": "array", "items": { "type": "string" }, "example": [ "Order Picking/Packing", "Product Packaging", "Warehousing" ], "nullable": true, "description": "Monster's knowledge-base skill tags for the posting, deduplicated and capped at 40. These are short tags, one concept each." }, "job_status": { "type": "string", "example": "ACTIVE", "nullable": true, "description": "The posting's lifecycle status. `ACTIVE` on every posting measured, and the field that reports the change when Monster pulls a posting." }, "job_country": { "type": "string", "example": "US", "nullable": true, "description": "Uppercase ISO 3166-1 alpha-2 country code, taken from the posting's own address where it names one and falling back to the requested `country`." }, "job_benefits": { "type": "array", "items": { "type": "string" }, "example": [ "401k", "medical_dental_vision", "paid_time_off" ], "nullable": true, "description": "Monster's normalized benefit enum, lowercased to snake_case so the shape matches JSearch's own keys. Rare: most Monster postings are syndicated feeds with no benefits block. `null` when none are stated." }, "job_industry": { "type": "string", "example": "Business Services - Other", "nullable": true, "description": "The industry Monster assigns to the posting. Present on a minority of postings." }, "job_latitude": { "type": "number", "format": "float", "example": 32.895623, "nullable": true, "description": "Latitude of the job location, as Monster publishes it." }, "job_location": { "type": "string", "example": "DFW Airport, TX", "nullable": true, "description": "Display location, `\"City, ST\"` for US postings and `\"City, ST, CC\"` elsewhere. Falls back to the country code alone on a posting with no city or region." }, "job_onet_soc": { "type": "string", "example": "43508103", "nullable": true, "description": "The O*NET-SOC occupation code as an 8-digit string with no punctuation, matching the rest of the fleet. The human title is published separately as `job_occupational_category`." }, "job_position": { "type": "integer", "example": 1, "nullable": true, "description": "0-based rank of the job within the upstream page it came from. Rank restarts at 0 on each page, so it orders one page at a time. Always `null` on `/job-details`, which has no result set to rank within." }, "job_provider": { "type": "string", "example": "Uline USA", "nullable": true, "description": "The upstream feed that delivered this posting to Monster, for example JobTarget, Jobot or Appcast. Provenance only; `job_publisher` is always `Monster`." }, "apply_options": { "type": "array", "items": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_59a9ba9486dc2473_ref2" }, "description": "Ways to apply, most authoritative first. One entry on most postings, two when Monster also exposes the destination its apply URL redirects to. Empty only when Monster publishes no usable URL at all." }, "employer_logo": { "type": "string", "format": "uri", "example": "https://media.newjobs.com/clu/xuli/xulinex/branding/138/Uline-logo-637798567972909562.png", "nullable": true, "description": "The employer's logo. Monster's own CDN supplies it on about 30% of postings; for most of the rest it is resolved from the employer's own domain." }, "employer_name": { "type": "string", "example": "Uline", "nullable": true, "description": "The hiring employer's name. This is the string `/company-jobs` matches on." }, "employer_size": { "type": "string", "example": "5,000 to 9,999 employees", "nullable": true, "description": "Employee headcount band from the employer's branding block." }, "job_is_remote": { "type": "boolean", "example": null, "nullable": true, "description": "Whether the job can be done remotely. A real tri-state: `true` when Monster marks the posting `REMOTE` or `ONSITE_AND_REMOTE`, `false` only when it explicitly says `ONSITE`, and `null` when Monster did not say, which is the common case." }, "job_longitude": { "type": "number", "format": "float", "example": -97.036731, "nullable": true, "description": "Longitude of the job location, as Monster publishes it." }, "job_posted_at": { "type": "string", "example": "1 day ago", "nullable": true, "description": "Relative posting age in JSearch's vocabulary: `today`, `1 day ago`, `N days ago` up to 30, then `N month(s) ago`. Derived from the posting timestamp. Monster's own badge is published separately as `job_publisher_recency_label`." }, "job_publisher": { "enum": [ "Monster" ], "type": "string", "example": "Monster", "description": "Always `Monster`. The upstream feed that delivered the posting is published separately as `job_provider`." }, "job_apply_link": { "type": "string", "format": "uri", "example": "https://uline.wd1.myworkdayjobs.com/Uline_Careers/job/Irving-TX/Warehouse-Associate----26-hr--_R267224-1/apply", "nullable": true, "description": "The application URL Monster publishes, with tracking parameters stripped. Falls back to the canonical Monster posting page when Monster publishes no application URL." }, "job_apply_type": { "type": "string", "example": "INTEGRATED", "nullable": true, "description": "Monster's own apply classification, and the raw basis for `job_apply_is_direct`. Values seen: `OFFSITE` (the apply link leaves Monster), `INTEGRATED` and `ONSITE`." }, "job_highlights": { "type": "object", "example": { "Qualifications": [ "High school diploma or equivalent." ], "Responsibilities": [ "Pick customer order items and package them for same day shipping." ] }, "properties": { "Benefits": { "type": "array", "items": { "type": "string" }, "example": [ "Medical, dental and vision from day one" ], "description": "Perks the employer listed under a benefits/perks heading." }, "Qualifications": { "type": "array", "items": { "type": "string" }, "example": [ "2+ years of warehouse experience", "Able to lift 50 lbs" ], "description": "Requirements the employer listed under a qualifications/requirements heading." }, "Responsibilities": { "type": "array", "items": { "type": "string" }, "example": [ "Pick customer order items and package them for same day shipping." ], "description": "Duties the employer listed under a responsibilities/duties heading." } }, "description": "Description bullets grouped by section, keyed `Qualifications`, `Responsibilities` and `Benefits`. Extracted from the employer's own headed lists in the posting HTML. `{}` when nothing was recovered, so it is always safe to enumerate. Up to 25 items per section.", "additionalProperties": { "type": "array", "items": { "type": "string" }, "description": "Any further section, keyed by the heading the employer used." } }, "job_max_salary": { "type": "number", "example": 32, "nullable": true, "description": "Upper bound of the stated range, in the `job_salary_period` unit." }, "job_min_salary": { "type": "number", "example": 26, "nullable": true, "description": "Lower bound of the stated range, in the `job_salary_period` unit. A one-sided range is mirrored, so `job_min_salary` equals `job_max_salary`. Populated once the period resolves." }, "job_description": { "type": "string", "example": "Warehouse Associate\nPay from $26 to $32 per hour with significant growth and earning potential!", "nullable": true, "description": "The full posting text, Monster's HTML rendered to plain text with paragraph and list breaks preserved. Present on search results as well as details, and typically over 1,000 characters." }, "job_google_link": { "type": "string", "format": "uri", "example": null, "nullable": true, "description": "Always `null`. This is a Google for Jobs permalink built around a Google docid, and Monster has none; constructing one would produce a link that resolves to nothing." }, "employer_address": { "type": "string", "example": "Pleasant Prairie, Wisconsin, US", "nullable": true, "description": "The employer's own address, joined into one string. This is the employer's headquarters; the job's own location is in `job_location`, `job_city` and `job_state`." }, "employer_reviews": { "type": "array", "items": { "type": "object" }, "example": null, "nullable": true, "description": "Always `null`. Monster publishes no employer ratings or review counts." }, "employer_website": { "type": "string", "format": "uri", "example": "https://www.uline.jobs/", "nullable": true, "description": "The employer's own website, from the posting's hiring-organization block. Present on a minority of postings." }, "job_canonical_url": { "type": "string", "format": "uri", "example": "https://www.monster.com/job-openings/warehouse-associate-26-hr-dallas-tx--e77612f5-bb3b-465e-a965-439af94094bd", "nullable": true, "description": "The public Monster posting page. Always a monster.com URL." }, "job_location_type": { "type": "string", "example": "REMOTE", "nullable": true, "description": "Monster's own workplace type, verbatim, and the source `job_is_remote` is derived from. Values measured, commonest first: `ONSITE`, `ON_THE_ROAD` (driving and field roles, and commoner than the two remote values combined), `REMOTE`, `ONSITE_AND_REMOTE`. `null` where Monster says `UNKNOWN` or says nothing, which is the common case. The value is passed through as Monster publishes it, so treat an unrecognised one as a new Monster category." }, "job_onet_job_zone": { "type": "string", "example": null, "nullable": true, "description": "Always `null`. The O*NET Job Zone is a separate O*NET attribute, and Monster publishes only the SOC code, which is in `job_onet_soc`." }, "job_salary_period": { "enum": [ "HOUR", "DAY", "WEEK", "MONTH", "YEAR", null ], "type": "string", "example": "HOUR", "nullable": true, "description": "The period the salary figures are expressed in." }, "job_salary_string": { "type": "string", "example": "$26 - $32 per hour", "nullable": true, "description": "The salary rendered for display, composed from Monster's own figures and currency." }, "job_valid_through": { "type": "string", "example": "2027-09-12T19:02:15.673Z", "nullable": true, "description": "When the posting expires, as Monster states it. ISO 8601, and the precision varies with what Monster published." }, "job_posted_at_date": { "type": "string", "format": "date", "example": "2026-09-12", "nullable": true, "description": "The date-only form of `job_posted_at_datetime_utc`." }, "job_apply_is_direct": { "type": "boolean", "example": false, "description": "`true` only when Monster's apply type is `OFFSITE`, meaning the link leaves Monster for the destination the employer published. `false` for `INTEGRATED` and `ONSITE` apply flows and whenever the link fell back to the canonical Monster page." }, "job_employment_type": { "enum": [ "FULLTIME", "PARTTIME", "CONTRACTOR", "INTERN", "VOLUNTEER", "OTHER", null ], "type": "string", "example": "FULLTIME", "nullable": true, "description": "The first entry of `job_employment_types`, for JSearch compatibility. `null` when Monster states no employment type, which is the common case on an unfiltered search." }, "job_salary_currency": { "type": "string", "example": "USD", "nullable": true, "description": "ISO 4217 currency code for the salary figures, uppercased. Present whenever Monster publishes a salary block, including on postings whose figures cannot be resolved." }, "employer_description": { "type": "string", "example": "In 1980, Liz and Dick Uihlein recognized a local need for a shipping supply distributor and started Uline from their basement.", "nullable": true, "description": "The employer's own \"about us\" text from Monster's branding block, HTML stripped to plain text. Present on a minority of postings." }, "job_benefits_strings": { "type": "array", "items": { "type": "string" }, "example": [ "Paid Sick Days", "Tuition Reimbursement", "401K" ], "nullable": true, "description": "Monster's human-readable benefit chips from the employer's branding block, verbatim. Rare, and `null` when none are stated." }, "job_employment_types": { "type": "array", "items": { "enum": [ "FULLTIME", "PARTTIME", "CONTRACTOR", "INTERN", "VOLUNTEER", "OTHER" ], "type": "string" }, "example": [ "FULLTIME" ], "description": "Every employment type stated on the posting, normalized to JSearch's vocabulary. An empty array when Monster states none. Monster populates this field mainly on postings returned BECAUSE of an `employment_types` filter, so an unfiltered search leaves it empty on most rows." }, "employer_founding_date": { "type": "string", "example": "1980", "nullable": true, "description": "The employer's founding date as Monster states it, usually a bare year. Passed through verbatim, so it can be a placeholder such as `0` where the employer supplied one." }, "job_posted_at_timestamp": { "type": "integer", "example": 1789239735, "nullable": true, "description": "Unix epoch seconds of the posting date. Monster usually publishes a full timestamp, so this normally carries a time of day; it is midnight UTC only where Monster published a bare date." }, "job_occupational_category": { "type": "string", "example": "43-5081.03: Stock Clerks- Stockroom, Warehouse, or Storage Yard", "nullable": true, "description": "The human O*NET occupation title behind `job_onet_soc`, in O*NET's own punctuation." }, "job_posted_at_datetime_utc": { "type": "string", "format": "date-time", "example": "2026-09-12T19:02:15.000Z", "nullable": true, "description": "ISO 8601 UTC form of `job_posted_at_timestamp`." }, "job_publisher_recency_label": { "type": "string", "example": "2 days ago", "nullable": true, "description": "Monster's own relative badge, verbatim, for example `Today`, `12 days ago` or `30+ days ago`. Kept separate from `job_posted_at` because the two use different vocabularies AND because the badge disagrees with the posting date on about 9% of rows. `job_posted_at_timestamp` is the authoritative field." } }, "description": "The Monster job object: the same keys in a fixed order, every one of them present on every endpoint. A field Monster cannot supply is `null`, `[]` or `{}`. The `fields` parameter is what narrows this object." }, "sds_L_Fsr74jXxRwFrRFUiukT_59a9ba9486dc2473_ref2": { "type": "object", "required": [ "publisher", "apply_link", "is_direct" ], "properties": { "is_direct": { "type": "boolean", "example": false, "description": "Whether applying leaves Monster for the destination the employer published. Always `true` on a resolved redirect destination." }, "publisher": { "type": "string", "example": "Monster", "description": "`Monster` for the published application URL. For the resolved redirect destination it is that destination's hostname." }, "apply_link": { "type": "string", "format": "uri", "example": "https://uline.wd1.myworkdayjobs.com/Uline_Careers/job/Irving-TX/Warehouse-Associate----26-hr--_R267224-1/apply", "description": "The URL to apply at, with tracking parameters stripped." } }, "description": "One way to apply to this job. The first entry is always Monster's published application URL. A second entry is added only when Monster also exposes the destination that URL redirects to and it is genuinely a different address, which is the employer's own application page and survives the redirector going down." }, "sds_L_Fsr74jXxRwFrRFUiukT_59a9ba9486dc2473_ref3": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_59a9ba9486dc2473_ref4" } } }, "description": "Invalid or missing parameter." }, "sds_L_Fsr74jXxRwFrRFUiukT_59a9ba9486dc2473_ref4": { "type": "object", "required": [ "status", "request_id", "error" ], "properties": { "error": { "type": "object", "required": [ "message", "code" ], "properties": { "code": { "type": "integer", "example": 400, "description": "The HTTP status code, repeated in the body." }, "message": { "type": "string", "example": "The 'query' parameter is required.", "description": "Human-readable description of what was wrong with the request." } } }, "status": { "enum": [ "ERROR" ], "type": "string", "example": "ERROR", "description": "Always `ERROR` on a failed request." }, "request_id": { "type": "string", "example": "c1f0b6a2-6a3f-4f77-9a0a-6f7f9c2f0f11", "description": "Unique id for this request, for tracing and support." } } }, "sds_L_Fsr74jXxRwFrRFUiukT_59a9ba9486dc2473_ref5": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_59a9ba9486dc2473_ref4" } } }, "description": "Missing or invalid API key." }, "sds_L_Fsr74jXxRwFrRFUiukT_59a9ba9486dc2473_ref6": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_59a9ba9486dc2473_ref4" } } }, "description": "Not subscribed to this API." }, "sds_L_Fsr74jXxRwFrRFUiukT_59a9ba9486dc2473_ref7": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_59a9ba9486dc2473_ref4" } } }, "description": "Unknown route." }, "sds_L_Fsr74jXxRwFrRFUiukT_59a9ba9486dc2473_ref8": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_59a9ba9486dc2473_ref4" } } }, "description": "Quota exhausted." }, "sds_L_Fsr74jXxRwFrRFUiukT_59a9ba9486dc2473_ref9": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_59a9ba9486dc2473_ref4" } } }, "description": "Unexpected error." }, "sds_L_Fsr74jXxRwFrRFUiukT_7edaea634ecba4a7_ref0": { "type": "object", "required": [ "job_id" ], "properties": { "fields": { "type": "string", "description": "The projection exactly as sent." }, "job_id": { "type": "string", "description": "The comma-separated id list exactly as sent, before deduplication." }, "country": { "type": "string", "description": "The country code as sent, lowercased. Absent when it defaulted to `us`." } }, "description": "Echo of the parameters as the caller sent them. Keys the caller did not send are absent." }, "sds_L_Fsr74jXxRwFrRFUiukT_7edaea634ecba4a7_ref1": { "type": "object", "required": [ "job_id", "job_title", "employer_name", "employer_logo", "employer_website", "job_publisher", "job_employment_type", "job_employment_types", "job_apply_link", "job_apply_is_direct", "apply_options", "job_description", "job_is_remote", "job_posted_at", "job_posted_at_timestamp", "job_posted_at_datetime_utc", "job_location", "job_city", "job_state", "job_country", "job_latitude", "job_longitude", "job_benefits", "job_benefits_strings", "job_google_link", "job_salary", "job_salary_string", "job_min_salary", "job_max_salary", "job_salary_period", "job_highlights", "job_onet_soc", "job_onet_job_zone", "employer_reviews", "job_uid", "job_seo_id", "job_canonical_url", "job_apply_type", "job_skills", "job_industry", "job_occupational_category", "job_location_type", "job_status", "job_valid_through", "job_provider", "employer_description", "employer_founding_date", "employer_size", "employer_address", "job_posted_at_date", "job_salary_currency", "job_publisher_recency_label", "job_position" ], "properties": { "job_id": { "type": "string", "example": "bW9uc3RlcjplNzc2MTJmNS1iYjNiLTQ2NWUtYTk2NS00MzlhZjk0MDk0YmQ", "description": "Opaque public id for the posting, `base64url(\"monster:\" + )`. Pass it back to `/job-details`. Stable for the life of the posting." }, "job_uid": { "type": "string", "example": "e77612f5-bb3b-465e-a965-439af94094bd", "description": "Monster's own job id, a permanent UUIDv4. Accepted directly by `/job-details` and the right key for a downstream cache." }, "job_city": { "type": "string", "example": "DFW Airport", "nullable": true, "description": "City. `null` on a country-level or region-only posting." }, "job_state": { "type": "string", "example": "Texas", "nullable": true, "description": "The full state or province NAME, matching JSearch. The code appears inside `job_location`." }, "job_title": { "type": "string", "example": "Warehouse Associate - $26/hr +", "nullable": true, "description": "The job title as Monster publishes it." }, "job_salary": { "type": "number", "example": null, "nullable": true, "description": "Set only when a posting states ONE figure rather than a range, in the unit given by `job_salary_period`. A range populates `job_min_salary` / `job_max_salary` instead." }, "job_seo_id": { "type": "string", "example": "warehouse-associate-26-hr-dallas-tx--e77612f5-bb3b-465e-a965-439af94094bd", "nullable": true, "description": "The slugged id from the public posting URL, `----`. Accepted by `/job-details` in place of the uuid, so a caller holding only a scraped URL can round-trip with it." }, "job_skills": { "type": "array", "items": { "type": "string" }, "example": [ "Order Picking/Packing", "Product Packaging", "Warehousing" ], "nullable": true, "description": "Monster's knowledge-base skill tags for the posting, deduplicated and capped at 40. These are short tags, one concept each." }, "job_status": { "type": "string", "example": "ACTIVE", "nullable": true, "description": "The posting's lifecycle status. `ACTIVE` on every posting measured, and the field that reports the change when Monster pulls a posting." }, "job_country": { "type": "string", "example": "US", "nullable": true, "description": "Uppercase ISO 3166-1 alpha-2 country code, taken from the posting's own address where it names one and falling back to the requested `country`." }, "job_benefits": { "type": "array", "items": { "type": "string" }, "example": [ "401k", "medical_dental_vision", "paid_time_off" ], "nullable": true, "description": "Monster's normalized benefit enum, lowercased to snake_case so the shape matches JSearch's own keys. Rare: most Monster postings are syndicated feeds with no benefits block. `null` when none are stated." }, "job_industry": { "type": "string", "example": "Business Services - Other", "nullable": true, "description": "The industry Monster assigns to the posting. Present on a minority of postings." }, "job_latitude": { "type": "number", "format": "float", "example": 32.895623, "nullable": true, "description": "Latitude of the job location, as Monster publishes it." }, "job_location": { "type": "string", "example": "DFW Airport, TX", "nullable": true, "description": "Display location, `\"City, ST\"` for US postings and `\"City, ST, CC\"` elsewhere. Falls back to the country code alone on a posting with no city or region." }, "job_onet_soc": { "type": "string", "example": "43508103", "nullable": true, "description": "The O*NET-SOC occupation code as an 8-digit string with no punctuation, matching the rest of the fleet. The human title is published separately as `job_occupational_category`." }, "job_position": { "type": "integer", "example": 1, "nullable": true, "description": "0-based rank of the job within the upstream page it came from. Rank restarts at 0 on each page, so it orders one page at a time. Always `null` on `/job-details`, which has no result set to rank within." }, "job_provider": { "type": "string", "example": "Uline USA", "nullable": true, "description": "The upstream feed that delivered this posting to Monster, for example JobTarget, Jobot or Appcast. Provenance only; `job_publisher` is always `Monster`." }, "apply_options": { "type": "array", "items": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_7edaea634ecba4a7_ref2" }, "description": "Ways to apply, most authoritative first. One entry on most postings, two when Monster also exposes the destination its apply URL redirects to. Empty only when Monster publishes no usable URL at all." }, "employer_logo": { "type": "string", "format": "uri", "example": "https://media.newjobs.com/clu/xuli/xulinex/branding/138/Uline-logo-637798567972909562.png", "nullable": true, "description": "The employer's logo. Monster's own CDN supplies it on about 30% of postings; for most of the rest it is resolved from the employer's own domain." }, "employer_name": { "type": "string", "example": "Uline", "nullable": true, "description": "The hiring employer's name. This is the string `/company-jobs` matches on." }, "employer_size": { "type": "string", "example": "5,000 to 9,999 employees", "nullable": true, "description": "Employee headcount band from the employer's branding block." }, "job_is_remote": { "type": "boolean", "example": null, "nullable": true, "description": "Whether the job can be done remotely. A real tri-state: `true` when Monster marks the posting `REMOTE` or `ONSITE_AND_REMOTE`, `false` only when it explicitly says `ONSITE`, and `null` when Monster did not say, which is the common case." }, "job_longitude": { "type": "number", "format": "float", "example": -97.036731, "nullable": true, "description": "Longitude of the job location, as Monster publishes it." }, "job_posted_at": { "type": "string", "example": "1 day ago", "nullable": true, "description": "Relative posting age in JSearch's vocabulary: `today`, `1 day ago`, `N days ago` up to 30, then `N month(s) ago`. Derived from the posting timestamp. Monster's own badge is published separately as `job_publisher_recency_label`." }, "job_publisher": { "enum": [ "Monster" ], "type": "string", "example": "Monster", "description": "Always `Monster`. The upstream feed that delivered the posting is published separately as `job_provider`." }, "job_apply_link": { "type": "string", "format": "uri", "example": "https://uline.wd1.myworkdayjobs.com/Uline_Careers/job/Irving-TX/Warehouse-Associate----26-hr--_R267224-1/apply", "nullable": true, "description": "The application URL Monster publishes, with tracking parameters stripped. Falls back to the canonical Monster posting page when Monster publishes no application URL." }, "job_apply_type": { "type": "string", "example": "INTEGRATED", "nullable": true, "description": "Monster's own apply classification, and the raw basis for `job_apply_is_direct`. Values seen: `OFFSITE` (the apply link leaves Monster), `INTEGRATED` and `ONSITE`." }, "job_highlights": { "type": "object", "example": { "Qualifications": [ "High school diploma or equivalent." ], "Responsibilities": [ "Pick customer order items and package them for same day shipping." ] }, "properties": { "Benefits": { "type": "array", "items": { "type": "string" }, "example": [ "Medical, dental and vision from day one" ], "description": "Perks the employer listed under a benefits/perks heading." }, "Qualifications": { "type": "array", "items": { "type": "string" }, "example": [ "2+ years of warehouse experience", "Able to lift 50 lbs" ], "description": "Requirements the employer listed under a qualifications/requirements heading." }, "Responsibilities": { "type": "array", "items": { "type": "string" }, "example": [ "Pick customer order items and package them for same day shipping." ], "description": "Duties the employer listed under a responsibilities/duties heading." } }, "description": "Description bullets grouped by section, keyed `Qualifications`, `Responsibilities` and `Benefits`. Extracted from the employer's own headed lists in the posting HTML. `{}` when nothing was recovered, so it is always safe to enumerate. Up to 25 items per section.", "additionalProperties": { "type": "array", "items": { "type": "string" }, "description": "Any further section, keyed by the heading the employer used." } }, "job_max_salary": { "type": "number", "example": 32, "nullable": true, "description": "Upper bound of the stated range, in the `job_salary_period` unit." }, "job_min_salary": { "type": "number", "example": 26, "nullable": true, "description": "Lower bound of the stated range, in the `job_salary_period` unit. A one-sided range is mirrored, so `job_min_salary` equals `job_max_salary`. Populated once the period resolves." }, "job_description": { "type": "string", "example": "Warehouse Associate\nPay from $26 to $32 per hour with significant growth and earning potential!", "nullable": true, "description": "The full posting text, Monster's HTML rendered to plain text with paragraph and list breaks preserved. Present on search results as well as details, and typically over 1,000 characters." }, "job_google_link": { "type": "string", "format": "uri", "example": null, "nullable": true, "description": "Always `null`. This is a Google for Jobs permalink built around a Google docid, and Monster has none; constructing one would produce a link that resolves to nothing." }, "employer_address": { "type": "string", "example": "Pleasant Prairie, Wisconsin, US", "nullable": true, "description": "The employer's own address, joined into one string. This is the employer's headquarters; the job's own location is in `job_location`, `job_city` and `job_state`." }, "employer_reviews": { "type": "array", "items": { "type": "object" }, "example": null, "nullable": true, "description": "Always `null`. Monster publishes no employer ratings or review counts." }, "employer_website": { "type": "string", "format": "uri", "example": "https://www.uline.jobs/", "nullable": true, "description": "The employer's own website, from the posting's hiring-organization block. Present on a minority of postings." }, "job_canonical_url": { "type": "string", "format": "uri", "example": "https://www.monster.com/job-openings/warehouse-associate-26-hr-dallas-tx--e77612f5-bb3b-465e-a965-439af94094bd", "nullable": true, "description": "The public Monster posting page. Always a monster.com URL." }, "job_location_type": { "type": "string", "example": "REMOTE", "nullable": true, "description": "Monster's own workplace type, verbatim, and the source `job_is_remote` is derived from. Values measured, commonest first: `ONSITE`, `ON_THE_ROAD` (driving and field roles, and commoner than the two remote values combined), `REMOTE`, `ONSITE_AND_REMOTE`. `null` where Monster says `UNKNOWN` or says nothing, which is the common case. The value is passed through as Monster publishes it, so treat an unrecognised one as a new Monster category." }, "job_onet_job_zone": { "type": "string", "example": null, "nullable": true, "description": "Always `null`. The O*NET Job Zone is a separate O*NET attribute, and Monster publishes only the SOC code, which is in `job_onet_soc`." }, "job_salary_period": { "enum": [ "HOUR", "DAY", "WEEK", "MONTH", "YEAR", null ], "type": "string", "example": "HOUR", "nullable": true, "description": "The period the salary figures are expressed in." }, "job_salary_string": { "type": "string", "example": "$26 - $32 per hour", "nullable": true, "description": "The salary rendered for display, composed from Monster's own figures and currency." }, "job_valid_through": { "type": "string", "example": "2027-09-12T19:02:15.673Z", "nullable": true, "description": "When the posting expires, as Monster states it. ISO 8601, and the precision varies with what Monster published." }, "job_posted_at_date": { "type": "string", "format": "date", "example": "2026-09-12", "nullable": true, "description": "The date-only form of `job_posted_at_datetime_utc`." }, "job_apply_is_direct": { "type": "boolean", "example": false, "description": "`true` only when Monster's apply type is `OFFSITE`, meaning the link leaves Monster for the destination the employer published. `false` for `INTEGRATED` and `ONSITE` apply flows and whenever the link fell back to the canonical Monster page." }, "job_employment_type": { "enum": [ "FULLTIME", "PARTTIME", "CONTRACTOR", "INTERN", "VOLUNTEER", "OTHER", null ], "type": "string", "example": "FULLTIME", "nullable": true, "description": "The first entry of `job_employment_types`, for JSearch compatibility. `null` when Monster states no employment type, which is the common case on an unfiltered search." }, "job_salary_currency": { "type": "string", "example": "USD", "nullable": true, "description": "ISO 4217 currency code for the salary figures, uppercased. Present whenever Monster publishes a salary block, including on postings whose figures cannot be resolved." }, "employer_description": { "type": "string", "example": "In 1980, Liz and Dick Uihlein recognized a local need for a shipping supply distributor and started Uline from their basement.", "nullable": true, "description": "The employer's own \"about us\" text from Monster's branding block, HTML stripped to plain text. Present on a minority of postings." }, "job_benefits_strings": { "type": "array", "items": { "type": "string" }, "example": [ "Paid Sick Days", "Tuition Reimbursement", "401K" ], "nullable": true, "description": "Monster's human-readable benefit chips from the employer's branding block, verbatim. Rare, and `null` when none are stated." }, "job_employment_types": { "type": "array", "items": { "enum": [ "FULLTIME", "PARTTIME", "CONTRACTOR", "INTERN", "VOLUNTEER", "OTHER" ], "type": "string" }, "example": [ "FULLTIME" ], "description": "Every employment type stated on the posting, normalized to JSearch's vocabulary. An empty array when Monster states none. Monster populates this field mainly on postings returned BECAUSE of an `employment_types` filter, so an unfiltered search leaves it empty on most rows." }, "employer_founding_date": { "type": "string", "example": "1980", "nullable": true, "description": "The employer's founding date as Monster states it, usually a bare year. Passed through verbatim, so it can be a placeholder such as `0` where the employer supplied one." }, "job_posted_at_timestamp": { "type": "integer", "example": 1789239735, "nullable": true, "description": "Unix epoch seconds of the posting date. Monster usually publishes a full timestamp, so this normally carries a time of day; it is midnight UTC only where Monster published a bare date." }, "job_occupational_category": { "type": "string", "example": "43-5081.03: Stock Clerks- Stockroom, Warehouse, or Storage Yard", "nullable": true, "description": "The human O*NET occupation title behind `job_onet_soc`, in O*NET's own punctuation." }, "job_posted_at_datetime_utc": { "type": "string", "format": "date-time", "example": "2026-09-12T19:02:15.000Z", "nullable": true, "description": "ISO 8601 UTC form of `job_posted_at_timestamp`." }, "job_publisher_recency_label": { "type": "string", "example": "2 days ago", "nullable": true, "description": "Monster's own relative badge, verbatim, for example `Today`, `12 days ago` or `30+ days ago`. Kept separate from `job_posted_at` because the two use different vocabularies AND because the badge disagrees with the posting date on about 9% of rows. `job_posted_at_timestamp` is the authoritative field." } }, "description": "The Monster job object: the same keys in a fixed order, every one of them present on every endpoint. A field Monster cannot supply is `null`, `[]` or `{}`. The `fields` parameter is what narrows this object." }, "sds_L_Fsr74jXxRwFrRFUiukT_7edaea634ecba4a7_ref2": { "type": "object", "required": [ "publisher", "apply_link", "is_direct" ], "properties": { "is_direct": { "type": "boolean", "example": false, "description": "Whether applying leaves Monster for the destination the employer published. Always `true` on a resolved redirect destination." }, "publisher": { "type": "string", "example": "Monster", "description": "`Monster` for the published application URL. For the resolved redirect destination it is that destination's hostname." }, "apply_link": { "type": "string", "format": "uri", "example": "https://uline.wd1.myworkdayjobs.com/Uline_Careers/job/Irving-TX/Warehouse-Associate----26-hr--_R267224-1/apply", "description": "The URL to apply at, with tracking parameters stripped." } }, "description": "One way to apply to this job. The first entry is always Monster's published application URL. A second entry is added only when Monster also exposes the destination that URL redirects to and it is genuinely a different address, which is the employer's own application page and survives the redirector going down." }, "sds_L_Fsr74jXxRwFrRFUiukT_7edaea634ecba4a7_ref3": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_7edaea634ecba4a7_ref4" } } }, "description": "Invalid or missing parameter." }, "sds_L_Fsr74jXxRwFrRFUiukT_7edaea634ecba4a7_ref4": { "type": "object", "required": [ "status", "request_id", "error" ], "properties": { "error": { "type": "object", "required": [ "message", "code" ], "properties": { "code": { "type": "integer", "example": 400, "description": "The HTTP status code, repeated in the body." }, "message": { "type": "string", "example": "The 'query' parameter is required.", "description": "Human-readable description of what was wrong with the request." } } }, "status": { "enum": [ "ERROR" ], "type": "string", "example": "ERROR", "description": "Always `ERROR` on a failed request." }, "request_id": { "type": "string", "example": "c1f0b6a2-6a3f-4f77-9a0a-6f7f9c2f0f11", "description": "Unique id for this request, for tracing and support." } } }, "sds_L_Fsr74jXxRwFrRFUiukT_7edaea634ecba4a7_ref5": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_7edaea634ecba4a7_ref4" } } }, "description": "Missing or invalid API key." }, "sds_L_Fsr74jXxRwFrRFUiukT_7edaea634ecba4a7_ref6": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_7edaea634ecba4a7_ref4" } } }, "description": "Not subscribed to this API." }, "sds_L_Fsr74jXxRwFrRFUiukT_7edaea634ecba4a7_ref7": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_7edaea634ecba4a7_ref4" } } }, "description": "Unknown route." }, "sds_L_Fsr74jXxRwFrRFUiukT_7edaea634ecba4a7_ref8": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_7edaea634ecba4a7_ref4" } } }, "description": "Quota exhausted." }, "sds_L_Fsr74jXxRwFrRFUiukT_7edaea634ecba4a7_ref9": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_7edaea634ecba4a7_ref4" } } }, "description": "Unexpected error." }, "sds_L_Fsr74jXxRwFrRFUiukT_78715484d3239c04_ref0": { "type": "object", "required": [ "query", "page", "num_pages" ], "properties": { "page": { "type": "integer", "description": "The page the response starts at. Always present, defaulting to 1." }, "query": { "type": "string", "description": "The search query exactly as sent." }, "fields": { "type": "string", "description": "The projection exactly as sent." }, "radius": { "type": "integer", "description": "The radius in kilometres, as sent." }, "country": { "type": "string", "description": "The country code as sent, lowercased. Absent when it defaulted to `us`." }, "sort_by": { "type": "string", "description": "The sort order as sent, lowercased. Absent when none was sent." }, "language": { "type": "string", "description": "The language code exactly as sent. Absent when none was sent." }, "location": { "type": "string", "description": "The location exactly as sent. Absent when the search was country-wide." }, "num_pages": { "type": "integer", "description": "How many pages were fetched. Always present, defaulting to 1." }, "date_posted": { "type": "string", "description": "The freshness window exactly as sent, `all` included." }, "employment_types": { "type": "string", "description": "The employment types exactly as sent, before uppercasing and splitting." }, "remote_jobs_only": { "type": "string", "description": "Echoed as the raw string that was sent." } }, "description": "Echo of the parameters as the caller sent them, before any internal transformation. `date_posted: all` is echoed verbatim even though it is applied as \"no date filter\". Keys the caller did not send are absent, except `page` and `num_pages`, which are always echoed with the value actually used." }, "sds_L_Fsr74jXxRwFrRFUiukT_78715484d3239c04_ref1": { "type": "object", "required": [ "job_id", "job_title", "employer_name", "employer_logo", "employer_website", "job_publisher", "job_employment_type", "job_employment_types", "job_apply_link", "job_apply_is_direct", "apply_options", "job_description", "job_is_remote", "job_posted_at", "job_posted_at_timestamp", "job_posted_at_datetime_utc", "job_location", "job_city", "job_state", "job_country", "job_latitude", "job_longitude", "job_benefits", "job_benefits_strings", "job_google_link", "job_salary", "job_salary_string", "job_min_salary", "job_max_salary", "job_salary_period", "job_highlights", "job_onet_soc", "job_onet_job_zone", "employer_reviews", "job_uid", "job_seo_id", "job_canonical_url", "job_apply_type", "job_skills", "job_industry", "job_occupational_category", "job_location_type", "job_status", "job_valid_through", "job_provider", "employer_description", "employer_founding_date", "employer_size", "employer_address", "job_posted_at_date", "job_salary_currency", "job_publisher_recency_label", "job_position" ], "properties": { "job_id": { "type": "string", "example": "bW9uc3RlcjplNzc2MTJmNS1iYjNiLTQ2NWUtYTk2NS00MzlhZjk0MDk0YmQ", "description": "Opaque public id for the posting, `base64url(\"monster:\" + )`. Pass it back to `/job-details`. Stable for the life of the posting." }, "job_uid": { "type": "string", "example": "e77612f5-bb3b-465e-a965-439af94094bd", "description": "Monster's own job id, a permanent UUIDv4. Accepted directly by `/job-details` and the right key for a downstream cache." }, "job_city": { "type": "string", "example": "DFW Airport", "nullable": true, "description": "City. `null` on a country-level or region-only posting." }, "job_state": { "type": "string", "example": "Texas", "nullable": true, "description": "The full state or province NAME, matching JSearch. The code appears inside `job_location`." }, "job_title": { "type": "string", "example": "Warehouse Associate - $26/hr +", "nullable": true, "description": "The job title as Monster publishes it." }, "job_salary": { "type": "number", "example": null, "nullable": true, "description": "Set only when a posting states ONE figure rather than a range, in the unit given by `job_salary_period`. A range populates `job_min_salary` / `job_max_salary` instead." }, "job_seo_id": { "type": "string", "example": "warehouse-associate-26-hr-dallas-tx--e77612f5-bb3b-465e-a965-439af94094bd", "nullable": true, "description": "The slugged id from the public posting URL, `----`. Accepted by `/job-details` in place of the uuid, so a caller holding only a scraped URL can round-trip with it." }, "job_skills": { "type": "array", "items": { "type": "string" }, "example": [ "Order Picking/Packing", "Product Packaging", "Warehousing" ], "nullable": true, "description": "Monster's knowledge-base skill tags for the posting, deduplicated and capped at 40. These are short tags, one concept each." }, "job_status": { "type": "string", "example": "ACTIVE", "nullable": true, "description": "The posting's lifecycle status. `ACTIVE` on every posting measured, and the field that reports the change when Monster pulls a posting." }, "job_country": { "type": "string", "example": "US", "nullable": true, "description": "Uppercase ISO 3166-1 alpha-2 country code, taken from the posting's own address where it names one and falling back to the requested `country`." }, "job_benefits": { "type": "array", "items": { "type": "string" }, "example": [ "401k", "medical_dental_vision", "paid_time_off" ], "nullable": true, "description": "Monster's normalized benefit enum, lowercased to snake_case so the shape matches JSearch's own keys. Rare: most Monster postings are syndicated feeds with no benefits block. `null` when none are stated." }, "job_industry": { "type": "string", "example": "Business Services - Other", "nullable": true, "description": "The industry Monster assigns to the posting. Present on a minority of postings." }, "job_latitude": { "type": "number", "format": "float", "example": 32.895623, "nullable": true, "description": "Latitude of the job location, as Monster publishes it." }, "job_location": { "type": "string", "example": "DFW Airport, TX", "nullable": true, "description": "Display location, `\"City, ST\"` for US postings and `\"City, ST, CC\"` elsewhere. Falls back to the country code alone on a posting with no city or region." }, "job_onet_soc": { "type": "string", "example": "43508103", "nullable": true, "description": "The O*NET-SOC occupation code as an 8-digit string with no punctuation, matching the rest of the fleet. The human title is published separately as `job_occupational_category`." }, "job_position": { "type": "integer", "example": 1, "nullable": true, "description": "0-based rank of the job within the upstream page it came from. Rank restarts at 0 on each page, so it orders one page at a time. Always `null` on `/job-details`, which has no result set to rank within." }, "job_provider": { "type": "string", "example": "Uline USA", "nullable": true, "description": "The upstream feed that delivered this posting to Monster, for example JobTarget, Jobot or Appcast. Provenance only; `job_publisher` is always `Monster`." }, "apply_options": { "type": "array", "items": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_78715484d3239c04_ref2" }, "description": "Ways to apply, most authoritative first. One entry on most postings, two when Monster also exposes the destination its apply URL redirects to. Empty only when Monster publishes no usable URL at all." }, "employer_logo": { "type": "string", "format": "uri", "example": "https://media.newjobs.com/clu/xuli/xulinex/branding/138/Uline-logo-637798567972909562.png", "nullable": true, "description": "The employer's logo. Monster's own CDN supplies it on about 30% of postings; for most of the rest it is resolved from the employer's own domain." }, "employer_name": { "type": "string", "example": "Uline", "nullable": true, "description": "The hiring employer's name. This is the string `/company-jobs` matches on." }, "employer_size": { "type": "string", "example": "5,000 to 9,999 employees", "nullable": true, "description": "Employee headcount band from the employer's branding block." }, "job_is_remote": { "type": "boolean", "example": null, "nullable": true, "description": "Whether the job can be done remotely. A real tri-state: `true` when Monster marks the posting `REMOTE` or `ONSITE_AND_REMOTE`, `false` only when it explicitly says `ONSITE`, and `null` when Monster did not say, which is the common case." }, "job_longitude": { "type": "number", "format": "float", "example": -97.036731, "nullable": true, "description": "Longitude of the job location, as Monster publishes it." }, "job_posted_at": { "type": "string", "example": "1 day ago", "nullable": true, "description": "Relative posting age in JSearch's vocabulary: `today`, `1 day ago`, `N days ago` up to 30, then `N month(s) ago`. Derived from the posting timestamp. Monster's own badge is published separately as `job_publisher_recency_label`." }, "job_publisher": { "enum": [ "Monster" ], "type": "string", "example": "Monster", "description": "Always `Monster`. The upstream feed that delivered the posting is published separately as `job_provider`." }, "job_apply_link": { "type": "string", "format": "uri", "example": "https://uline.wd1.myworkdayjobs.com/Uline_Careers/job/Irving-TX/Warehouse-Associate----26-hr--_R267224-1/apply", "nullable": true, "description": "The application URL Monster publishes, with tracking parameters stripped. Falls back to the canonical Monster posting page when Monster publishes no application URL." }, "job_apply_type": { "type": "string", "example": "INTEGRATED", "nullable": true, "description": "Monster's own apply classification, and the raw basis for `job_apply_is_direct`. Values seen: `OFFSITE` (the apply link leaves Monster), `INTEGRATED` and `ONSITE`." }, "job_highlights": { "type": "object", "example": { "Qualifications": [ "High school diploma or equivalent." ], "Responsibilities": [ "Pick customer order items and package them for same day shipping." ] }, "properties": { "Benefits": { "type": "array", "items": { "type": "string" }, "example": [ "Medical, dental and vision from day one" ], "description": "Perks the employer listed under a benefits/perks heading." }, "Qualifications": { "type": "array", "items": { "type": "string" }, "example": [ "2+ years of warehouse experience", "Able to lift 50 lbs" ], "description": "Requirements the employer listed under a qualifications/requirements heading." }, "Responsibilities": { "type": "array", "items": { "type": "string" }, "example": [ "Pick customer order items and package them for same day shipping." ], "description": "Duties the employer listed under a responsibilities/duties heading." } }, "description": "Description bullets grouped by section, keyed `Qualifications`, `Responsibilities` and `Benefits`. Extracted from the employer's own headed lists in the posting HTML. `{}` when nothing was recovered, so it is always safe to enumerate. Up to 25 items per section.", "additionalProperties": { "type": "array", "items": { "type": "string" }, "description": "Any further section, keyed by the heading the employer used." } }, "job_max_salary": { "type": "number", "example": 32, "nullable": true, "description": "Upper bound of the stated range, in the `job_salary_period` unit." }, "job_min_salary": { "type": "number", "example": 26, "nullable": true, "description": "Lower bound of the stated range, in the `job_salary_period` unit. A one-sided range is mirrored, so `job_min_salary` equals `job_max_salary`. Populated once the period resolves." }, "job_description": { "type": "string", "example": "Warehouse Associate\nPay from $26 to $32 per hour with significant growth and earning potential!", "nullable": true, "description": "The full posting text, Monster's HTML rendered to plain text with paragraph and list breaks preserved. Present on search results as well as details, and typically over 1,000 characters." }, "job_google_link": { "type": "string", "format": "uri", "example": null, "nullable": true, "description": "Always `null`. This is a Google for Jobs permalink built around a Google docid, and Monster has none; constructing one would produce a link that resolves to nothing." }, "employer_address": { "type": "string", "example": "Pleasant Prairie, Wisconsin, US", "nullable": true, "description": "The employer's own address, joined into one string. This is the employer's headquarters; the job's own location is in `job_location`, `job_city` and `job_state`." }, "employer_reviews": { "type": "array", "items": { "type": "object" }, "example": null, "nullable": true, "description": "Always `null`. Monster publishes no employer ratings or review counts." }, "employer_website": { "type": "string", "format": "uri", "example": "https://www.uline.jobs/", "nullable": true, "description": "The employer's own website, from the posting's hiring-organization block. Present on a minority of postings." }, "job_canonical_url": { "type": "string", "format": "uri", "example": "https://www.monster.com/job-openings/warehouse-associate-26-hr-dallas-tx--e77612f5-bb3b-465e-a965-439af94094bd", "nullable": true, "description": "The public Monster posting page. Always a monster.com URL." }, "job_location_type": { "type": "string", "example": "REMOTE", "nullable": true, "description": "Monster's own workplace type, verbatim, and the source `job_is_remote` is derived from. Values measured, commonest first: `ONSITE`, `ON_THE_ROAD` (driving and field roles, and commoner than the two remote values combined), `REMOTE`, `ONSITE_AND_REMOTE`. `null` where Monster says `UNKNOWN` or says nothing, which is the common case. The value is passed through as Monster publishes it, so treat an unrecognised one as a new Monster category." }, "job_onet_job_zone": { "type": "string", "example": null, "nullable": true, "description": "Always `null`. The O*NET Job Zone is a separate O*NET attribute, and Monster publishes only the SOC code, which is in `job_onet_soc`." }, "job_salary_period": { "enum": [ "HOUR", "DAY", "WEEK", "MONTH", "YEAR", null ], "type": "string", "example": "HOUR", "nullable": true, "description": "The period the salary figures are expressed in." }, "job_salary_string": { "type": "string", "example": "$26 - $32 per hour", "nullable": true, "description": "The salary rendered for display, composed from Monster's own figures and currency." }, "job_valid_through": { "type": "string", "example": "2027-09-12T19:02:15.673Z", "nullable": true, "description": "When the posting expires, as Monster states it. ISO 8601, and the precision varies with what Monster published." }, "job_posted_at_date": { "type": "string", "format": "date", "example": "2026-09-12", "nullable": true, "description": "The date-only form of `job_posted_at_datetime_utc`." }, "job_apply_is_direct": { "type": "boolean", "example": false, "description": "`true` only when Monster's apply type is `OFFSITE`, meaning the link leaves Monster for the destination the employer published. `false` for `INTEGRATED` and `ONSITE` apply flows and whenever the link fell back to the canonical Monster page." }, "job_employment_type": { "enum": [ "FULLTIME", "PARTTIME", "CONTRACTOR", "INTERN", "VOLUNTEER", "OTHER", null ], "type": "string", "example": "FULLTIME", "nullable": true, "description": "The first entry of `job_employment_types`, for JSearch compatibility. `null` when Monster states no employment type, which is the common case on an unfiltered search." }, "job_salary_currency": { "type": "string", "example": "USD", "nullable": true, "description": "ISO 4217 currency code for the salary figures, uppercased. Present whenever Monster publishes a salary block, including on postings whose figures cannot be resolved." }, "employer_description": { "type": "string", "example": "In 1980, Liz and Dick Uihlein recognized a local need for a shipping supply distributor and started Uline from their basement.", "nullable": true, "description": "The employer's own \"about us\" text from Monster's branding block, HTML stripped to plain text. Present on a minority of postings." }, "job_benefits_strings": { "type": "array", "items": { "type": "string" }, "example": [ "Paid Sick Days", "Tuition Reimbursement", "401K" ], "nullable": true, "description": "Monster's human-readable benefit chips from the employer's branding block, verbatim. Rare, and `null` when none are stated." }, "job_employment_types": { "type": "array", "items": { "enum": [ "FULLTIME", "PARTTIME", "CONTRACTOR", "INTERN", "VOLUNTEER", "OTHER" ], "type": "string" }, "example": [ "FULLTIME" ], "description": "Every employment type stated on the posting, normalized to JSearch's vocabulary. An empty array when Monster states none. Monster populates this field mainly on postings returned BECAUSE of an `employment_types` filter, so an unfiltered search leaves it empty on most rows." }, "employer_founding_date": { "type": "string", "example": "1980", "nullable": true, "description": "The employer's founding date as Monster states it, usually a bare year. Passed through verbatim, so it can be a placeholder such as `0` where the employer supplied one." }, "job_posted_at_timestamp": { "type": "integer", "example": 1789239735, "nullable": true, "description": "Unix epoch seconds of the posting date. Monster usually publishes a full timestamp, so this normally carries a time of day; it is midnight UTC only where Monster published a bare date." }, "job_occupational_category": { "type": "string", "example": "43-5081.03: Stock Clerks- Stockroom, Warehouse, or Storage Yard", "nullable": true, "description": "The human O*NET occupation title behind `job_onet_soc`, in O*NET's own punctuation." }, "job_posted_at_datetime_utc": { "type": "string", "format": "date-time", "example": "2026-09-12T19:02:15.000Z", "nullable": true, "description": "ISO 8601 UTC form of `job_posted_at_timestamp`." }, "job_publisher_recency_label": { "type": "string", "example": "2 days ago", "nullable": true, "description": "Monster's own relative badge, verbatim, for example `Today`, `12 days ago` or `30+ days ago`. Kept separate from `job_posted_at` because the two use different vocabularies AND because the badge disagrees with the posting date on about 9% of rows. `job_posted_at_timestamp` is the authoritative field." } }, "description": "The Monster job object: the same keys in a fixed order, every one of them present on every endpoint. A field Monster cannot supply is `null`, `[]` or `{}`. The `fields` parameter is what narrows this object." }, "sds_L_Fsr74jXxRwFrRFUiukT_78715484d3239c04_ref2": { "type": "object", "required": [ "publisher", "apply_link", "is_direct" ], "properties": { "is_direct": { "type": "boolean", "example": false, "description": "Whether applying leaves Monster for the destination the employer published. Always `true` on a resolved redirect destination." }, "publisher": { "type": "string", "example": "Monster", "description": "`Monster` for the published application URL. For the resolved redirect destination it is that destination's hostname." }, "apply_link": { "type": "string", "format": "uri", "example": "https://uline.wd1.myworkdayjobs.com/Uline_Careers/job/Irving-TX/Warehouse-Associate----26-hr--_R267224-1/apply", "description": "The URL to apply at, with tracking parameters stripped." } }, "description": "One way to apply to this job. The first entry is always Monster's published application URL. A second entry is added only when Monster also exposes the destination that URL redirects to and it is genuinely a different address, which is the employer's own application page and survives the redirector going down." }, "sds_L_Fsr74jXxRwFrRFUiukT_78715484d3239c04_ref3": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_78715484d3239c04_ref4" } } }, "description": "Invalid or missing parameter." }, "sds_L_Fsr74jXxRwFrRFUiukT_78715484d3239c04_ref4": { "type": "object", "required": [ "status", "request_id", "error" ], "properties": { "error": { "type": "object", "required": [ "message", "code" ], "properties": { "code": { "type": "integer", "example": 400, "description": "The HTTP status code, repeated in the body." }, "message": { "type": "string", "example": "The 'query' parameter is required.", "description": "Human-readable description of what was wrong with the request." } } }, "status": { "enum": [ "ERROR" ], "type": "string", "example": "ERROR", "description": "Always `ERROR` on a failed request." }, "request_id": { "type": "string", "example": "c1f0b6a2-6a3f-4f77-9a0a-6f7f9c2f0f11", "description": "Unique id for this request, for tracing and support." } } }, "sds_L_Fsr74jXxRwFrRFUiukT_78715484d3239c04_ref5": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_78715484d3239c04_ref4" } } }, "description": "Missing or invalid API key." }, "sds_L_Fsr74jXxRwFrRFUiukT_78715484d3239c04_ref6": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_78715484d3239c04_ref4" } } }, "description": "Not subscribed to this API." }, "sds_L_Fsr74jXxRwFrRFUiukT_78715484d3239c04_ref7": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_78715484d3239c04_ref4" } } }, "description": "Unknown route." }, "sds_L_Fsr74jXxRwFrRFUiukT_78715484d3239c04_ref8": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_78715484d3239c04_ref4" } } }, "description": "Quota exhausted." }, "sds_L_Fsr74jXxRwFrRFUiukT_78715484d3239c04_ref9": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_78715484d3239c04_ref4" } } }, "description": "Unexpected error." }, "sds_L_Fsr74jXxRwFrRFUiukT_901e1a996e16938b_ref0": { "type": "object", "required": [ "job_title", "country" ], "properties": { "fields": { "type": "string", "example": "median_salary,salary_period", "description": "The projection exactly as sent. Absent when not supplied." }, "country": { "enum": [ "us", "ca" ], "type": "string", "example": "us", "description": "The resolved country market, lowercased." }, "location": { "type": "string", "example": "New York", "description": "The location exactly as sent, trimmed. Absent when no location was supplied." }, "job_title": { "type": "string", "example": "Registered Nurse", "description": "The job title exactly as sent, trimmed." } }, "description": "Echo of the parameters as the caller sent them, before any internal transformation. Only\nthe parameters actually supplied are present, except `country`, which always carries its\nresolved default." }, "sds_L_Fsr74jXxRwFrRFUiukT_901e1a996e16938b_ref1": { "type": "object", "required": [ "location", "job_title", "min_salary", "max_salary", "median_salary", "min_base_salary", "max_base_salary", "median_base_salary", "min_additional_pay", "max_additional_pay", "median_additional_pay", "salary_period", "salary_currency", "salary_count", "salaries_updated_at", "publisher_name", "publisher_link", "confidence", "ziprecruiter_average_salary", "ziprecruiter_national_average_salary", "ziprecruiter_p25_salary", "ziprecruiter_p75_salary", "ziprecruiter_pay_frequencies", "ziprecruiter_salary_histogram", "ziprecruiter_salaries_by_state", "ziprecruiter_top_paying_cities", "ziprecruiter_related_titles", "ziprecruiter_total_listings", "ziprecruiter_spread_level", "ziprecruiter_location_granularity", "ziprecruiter_preferred_pay_period", "ziprecruiter_job_title_searched", "ziprecruiter_salaries_updated_at_text", "ziprecruiter_summary", "ziprecruiter_faq", "ziprecruiter_json_ld_median" ], "properties": { "location": { "type": "string", "example": "United States", "nullable": true, "description": "The scope the figures describe: the state or province name on a state request, and the\ncountry name (`United States`, `Canada`) on a national one. Read from the page's own\nscope field." }, "job_title": { "type": "string", "example": "RN", "nullable": true, "description": "ZipRecruiter's canonical title for the page, which can differ from what was sent:\n`Registered Nurse` resolves to `RN`. What was sent is echoed in `parameters`, and the\npage's own raw title is `ziprecruiter_job_title_searched`." }, "confidence": { "type": "string", "example": null, "nullable": true, "description": "Always `null`. ZipRecruiter states no estimator confidence. `ziprecruiter_spread_level`\ndescribes how widely the top-city figures spread, which is a different thing." }, "max_salary": { "type": "number", "example": 131000, "nullable": true, "description": "90th percentile annual pay, the top of the middle 80%." }, "min_salary": { "type": "number", "example": 56000, "nullable": true, "description": "10th percentile annual pay, the bottom of the middle 80%." }, "salary_count": { "type": "integer", "example": null, "nullable": true, "description": "Always `null`. ZipRecruiter states no sample size for its estimate. The count of open\npostings behind the page is a different quantity and is published as\n`ziprecruiter_total_listings`." }, "median_salary": { "type": "number", "example": 82000, "nullable": true, "description": "The real annual median, parsed from the page's own data layer. The JSON-LD field\nlabelled `median` is the mean and reads up to 13.8% high; it is carried separately as\n`ziprecruiter_json_ld_median`." }, "salary_period": { "enum": [ "HOUR", "WEEK", "MONTH", "YEAR" ], "type": "string", "example": "YEAR", "nullable": true, "description": "Always `YEAR`. ZipRecruiter's own structured data is annual on every page measured,\nincluding titles the page leads with an hourly figure, so annual keeps titles\ncomparable. The other frequencies are in `ziprecruiter_pay_frequencies`." }, "publisher_link": { "type": "string", "format": "uri", "example": "https://www.ziprecruiter.com/Salaries/Registered-Nurse-Salary", "nullable": true, "description": "The ZipRecruiter salary page these figures were read from, so any number on the row can\nbe checked against its source." }, "publisher_name": { "type": "string", "example": "ZipRecruiter", "description": "Always `ZipRecruiter`. Constant by construction on this source." }, "max_base_salary": { "type": "number", "example": null, "nullable": true, "description": "Always `null`, for the same reason as `min_base_salary`." }, "min_base_salary": { "type": "number", "example": null, "nullable": true, "description": "Always `null`. ZipRecruiter publishes total pay only on this surface, with no\nbase-versus-additional split." }, "salary_currency": { "type": "string", "example": "USD", "nullable": true, "description": "ISO 4217 currency of every figure on the row, from the page's own country field. `USD`\nfor US pages, `CAD` for Canadian ones." }, "ziprecruiter_faq": { "type": "array", "items": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_901e1a996e16938b_ref8" }, "description": "ZipRecruiter's generated FAQ for this title and scope, typically 3 entries covering the\nheadline figure, the best-paying related titles and the top-paying cities. An empty\narray when the page carries none." }, "max_additional_pay": { "type": "number", "example": null, "nullable": true, "description": "Always `null`, for the same reason as `min_additional_pay`." }, "median_base_salary": { "type": "number", "example": null, "nullable": true, "description": "Always `null`, for the same reason as `min_base_salary`." }, "min_additional_pay": { "type": "number", "example": null, "nullable": true, "description": "Always `null`. ZipRecruiter states total pay only, with no bonus, commission or equity\ncomponent broken out." }, "salaries_updated_at": { "type": "string", "format": "date-time", "example": "2026-09-12T00:00:00.000Z", "nullable": true, "description": "ISO 8601 UTC timestamp of the date ZipRecruiter last refreshed the figures. The raw\ntext it prints is kept as `ziprecruiter_salaries_updated_at_text`." }, "ziprecruiter_summary": { "type": "string", "example": "The average annual pay for a registered nurse in the United States is $87,868 a year...", "nullable": true, "description": "ZipRecruiter's own prose summary of the figures, HTML stripped to plain text. Ready to\nshow to an end user without writing the sentence yourself." }, "median_additional_pay": { "type": "number", "example": null, "nullable": true, "description": "Always `null`, for the same reason as `min_additional_pay`." }, "ziprecruiter_p25_salary": { "type": "number", "example": 65500, "nullable": true, "description": "25th percentile annual pay. With p75 it gives the interquartile range." }, "ziprecruiter_p75_salary": { "type": "number", "example": 104000, "nullable": true, "description": "75th percentile annual pay." }, "ziprecruiter_spread_level": { "type": "string", "example": "large", "nullable": true, "description": "How widely the top-city figures spread: `large`, `medium` or `small`. ZipRecruiter's\nown label." }, "ziprecruiter_average_salary": { "type": "number", "example": 87868, "nullable": true, "description": "The annual MEAN, published under its real name. It differs from `median_salary` on\nevery title measured." }, "ziprecruiter_json_ld_median": { "type": "number", "example": 87868, "nullable": true, "description": "The figure ZipRecruiter's own JSON-LD labels `median`, carried so the discrepancy is\nauditable. It is the MEAN: byte-identical to the page average on 16 of 16 pages\nmeasured, and on Truck Driver it reads 56,348 against a true median of 49,500, 13.8%\nhigh. Compare it to `median_salary`." }, "ziprecruiter_related_titles": { "type": "array", "items": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_901e1a996e16938b_ref7" }, "description": "The 5 related titles ZipRecruiter lists, each with its pay delta against the searched\ntitle. Every one can be fed straight back into `job_title`." }, "ziprecruiter_total_listings": { "type": "integer", "example": 506, "nullable": true, "description": "How many open ZipRecruiter postings sit behind this page right now. A demand signal\nfor the title, separate from the estimate's sample size. `0` is a real answer." }, "ziprecruiter_pay_frequencies": { "type": "object", "nullable": true, "required": [ "year", "month", "week", "hour" ], "properties": { "hour": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_901e1a996e16938b_ref2" }, "week": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_901e1a996e16938b_ref2" }, "year": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_901e1a996e16938b_ref2" }, "month": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_901e1a996e16938b_ref2" } }, "description": "All four pay frequencies in one response, each with its own full distribution. Read\n`hour` for an hourly role without a second request and without dividing an annual\nfigure by an assumed number of hours." }, "ziprecruiter_salary_histogram": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_901e1a996e16938b_ref3" }, "ziprecruiter_salaries_by_state": { "type": "array", "items": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_901e1a996e16938b_ref5" }, "description": "Pay for this title in every US state and Canadian province ZipRecruiter has figures\nfor, 59 to 64 rows. National requests only: an empty array on a state request." }, "ziprecruiter_top_paying_cities": { "type": "array", "items": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_901e1a996e16938b_ref6" }, "description": "The 10 highest-paying cities for this title, across the country on a national request\nand within the state on a state request." }, "ziprecruiter_job_title_searched": { "type": "string", "example": "Registered Nurse", "nullable": true, "description": "The page's own raw title, before ZipRecruiter's canonicalisation. `Registered Nurse`\nwhere `job_title` reads `RN`." }, "ziprecruiter_location_granularity": { "enum": [ "NATIONAL", "STATE" ], "type": "string", "example": "NATIONAL", "nullable": true, "description": "Which page answered: `NATIONAL` or `STATE`. Read from the page's own scope field, so it\nis the ground truth for what `location` describes." }, "ziprecruiter_preferred_pay_period": { "enum": [ "HOUR", "WEEK", "MONTH", "YEAR" ], "type": "string", "example": "HOUR", "nullable": true, "description": "The frequency ZipRecruiter itself leads the page with: `HOUR` on 6 of 11 titles\nmeasured. An editorial signal about the role; `salary_period` stays annual so titles\nremain comparable." }, "ziprecruiter_national_average_salary": { "type": "number", "example": 87868, "nullable": true, "description": "The national annual mean for this title. Equal to `ziprecruiter_average_salary` on a\nnational request; the benchmark a state figure is above or below on a state request." }, "ziprecruiter_salaries_updated_at_text": { "type": "string", "example": "September 12 2026", "nullable": true, "description": "The refresh date exactly as ZipRecruiter prints it. The parsed form is\n`salaries_updated_at`." } }, "description": "A salary distribution for one job title and one scope. The 18 house `/estimated-salary`\ncontract keys come first, in contract order, followed by 18 `ziprecruiter_*` extras, for 36\nkeys in total. Every key is always present, `null` or `[]` where ZipRecruiter has no value,\nso a consumer gets the same set of keys on every row. The `fields` projection narrows it,\nreturning exactly the keys asked for plus `job_title` and `location`." }, "sds_L_Fsr74jXxRwFrRFUiukT_901e1a996e16938b_ref2": { "type": "object", "nullable": true, "required": [ "salary_period", "average_salary", "national_average_salary", "median_salary", "p10_salary", "p25_salary", "p75_salary", "p90_salary", "average_salary_delta" ], "properties": { "p10_salary": { "type": "number", "example": 56000, "nullable": true, "description": "10th percentile." }, "p25_salary": { "type": "number", "example": 65500, "nullable": true, "description": "25th percentile. ZipRecruiter names it \"average low\"; it equals the JSON-LD\n`percentile25` on every page measured, so it is published as what it is." }, "p75_salary": { "type": "number", "example": 104000, "nullable": true, "description": "75th percentile. ZipRecruiter names it \"average high\"; it equals the JSON-LD\n`percentile75` on every page measured." }, "p90_salary": { "type": "number", "example": 131000, "nullable": true, "description": "90th percentile." }, "median_salary": { "type": "number", "example": 82000, "nullable": true, "description": "The real median for this frequency, read from the page's own data layer." }, "salary_period": { "enum": [ "HOUR", "WEEK", "MONTH", "YEAR" ], "type": "string", "example": "YEAR", "description": "The period these figures are expressed in. ZipRecruiter publishes hourly, weekly,\nmonthly and annual figures, and those four are the values that appear." }, "average_salary": { "type": "number", "example": 87868, "nullable": true, "description": "The MEAN for this frequency. This is the number ZipRecruiter's JSON-LD mislabels as its\nmedian; it is published here under its real name." }, "average_salary_delta": { "type": "number", "example": 38500, "nullable": true, "description": "ZipRecruiter's own published spread figure for this frequency." }, "national_average_salary": { "type": "number", "example": 87868, "nullable": true, "description": "The national mean for this title and frequency. Equal to `average_salary` on a national\nrequest; the national benchmark to compare against on a state request." } }, "description": "One pay frequency, with the full distribution ZipRecruiter publishes for it. `null` when\nZipRecruiter carries no figure for that frequency. Every page measured carried all four." }, "sds_L_Fsr74jXxRwFrRFUiukT_901e1a996e16938b_ref3": { "type": "object", "nullable": true, "required": [ "bucket_count", "bucket_min_list", "bucket_probability_list", "buckets" ], "properties": { "buckets": { "type": "array", "items": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_901e1a996e16938b_ref4" }, "description": "The same data zipped into explicit bounded buckets, which is what most consumers want\nto chart." }, "bucket_count": { "type": "integer", "example": 11, "description": "Number of buckets. `11` on every page measured." }, "bucket_min_list": { "type": "array", "items": { "type": "number", "nullable": true }, "example": [ 15500, 27500, 40000 ], "description": "The raw lower bounds, in order, as ZipRecruiter publishes them." }, "bucket_probability_list": { "type": "array", "items": { "type": "number", "nullable": true }, "example": [ 0.0069, 0.0048, 0.0464 ], "description": "The raw probabilities, in the same order as `bucket_min_list`." } }, "description": "The 11-bucket annual salary distribution ZipRecruiter publishes for the title. A real\ndistribution: it shows where the mass actually sits. `null` on the rare page that carries\nno histogram." }, "sds_L_Fsr74jXxRwFrRFUiukT_901e1a996e16938b_ref4": { "type": "object", "required": [ "min_salary", "max_salary", "probability" ], "properties": { "max_salary": { "type": "number", "example": 76500, "nullable": true, "description": "Upper bound, exclusive. `null` on the last bucket, which is open-ended." }, "min_salary": { "type": "number", "example": 64000, "nullable": true, "description": "Lower bound of the bucket, in annual currency units." }, "probability": { "type": "number", "example": 0.196, "nullable": true, "description": "Share of postings in this bucket, as a fraction. The 11 probabilities sum to roughly\n1.0." } }, "description": "One bucket of the salary distribution. Bucket `i` spans `[min_salary, max_salary)`; the top\nbucket is open-ended, so its `max_salary` is `null`." }, "sds_L_Fsr74jXxRwFrRFUiukT_901e1a996e16938b_ref5": { "type": "object", "required": [ "state", "annual_salary", "monthly_pay", "weekly_pay", "hourly_wage", "difference_from_average", "difference_percent" ], "properties": { "state": { "type": "string", "example": "Washington", "nullable": true, "description": "The state or province name, spelled out. Usable directly as this endpoint's `location`.\nTwo rows use a display spelling that differs from the URL name (`Newfoundland`,\n`Yukon Territory`); both are accepted as `location` values." }, "weekly_pay": { "type": "number", "example": 1913, "nullable": true, "description": "The same figure expressed weekly." }, "hourly_wage": { "type": "number", "example": 47.85, "nullable": true, "description": "The same figure expressed hourly." }, "monthly_pay": { "type": "number", "example": 8293, "nullable": true, "description": "The same figure expressed monthly." }, "annual_salary": { "type": "number", "example": 99519, "nullable": true, "description": "Average annual pay for the title in this state or province." }, "difference_percent": { "type": "number", "example": 13.26, "nullable": true, "description": "`difference_from_average` as a percentage of the page's annual mean." }, "difference_from_average": { "type": "number", "example": 11651, "nullable": true, "description": "This row's annual figure minus the page's own annual mean. Computed for every row,\nbecause ZipRecruiter publishes the delta for only 3 or 4 of them." } }, "description": "One row of the state and province pay table: 59 to 64 rows covering the 50 US states, the\nDistrict of Columbia and the Canadian provinces and territories. National requests only;\nan empty array on a state request." }, "sds_L_Fsr74jXxRwFrRFUiukT_901e1a996e16938b_ref6": { "type": "object", "required": [ "city", "annual_salary", "monthly_pay", "weekly_pay", "hourly_wage", "difference_from_average", "difference_percent", "state" ], "properties": { "city": { "type": "string", "example": "San Mateo County, CA", "nullable": true, "description": "The city as ZipRecruiter names it, often including the state code. This endpoint's\n`location` takes a state, province or country name." }, "state": { "type": "string", "example": null, "nullable": true, "description": "The separate state column, which ZipRecruiter ships empty on both page types, so it is\n`null` on every row measured." }, "weekly_pay": { "type": "number", "example": 2487, "nullable": true, "description": "The same figure expressed weekly." }, "hourly_wage": { "type": "number", "example": 62.18, "nullable": true, "description": "The same figure expressed hourly." }, "monthly_pay": { "type": "number", "example": 10778, "nullable": true, "description": "The same figure expressed monthly." }, "annual_salary": { "type": "number", "example": 129338, "nullable": true, "description": "Average annual pay for the title in this city." }, "difference_percent": { "type": "number", "example": 47.2, "nullable": true, "description": "`difference_from_average` as a percentage of the page's annual mean." }, "difference_from_average": { "type": "number", "example": 41470, "nullable": true, "description": "This row's annual figure minus the page's own annual mean." } }, "description": "One of the 10 top-paying cities for the title: cities across the country on a national\nrequest, cities within the state on a state request." }, "sds_L_Fsr74jXxRwFrRFUiukT_901e1a996e16938b_ref7": { "type": "object", "required": [ "job_title", "annual_salary", "monthly_pay", "weekly_pay", "hourly_wage", "difference_from_average", "difference_percent" ], "properties": { "job_title": { "type": "string", "example": "Vice President Home Health Registered Nurse", "nullable": true, "description": "The related title, usable directly as this endpoint's `job_title`." }, "weekly_pay": { "type": "number", "example": 3180, "nullable": true, "description": "The same figure expressed weekly." }, "hourly_wage": { "type": "number", "example": 79.51, "nullable": true, "description": "The same figure expressed hourly." }, "monthly_pay": { "type": "number", "example": 13781, "nullable": true, "description": "The same figure expressed monthly." }, "annual_salary": { "type": "number", "example": 165372, "nullable": true, "description": "Average annual pay for the related title." }, "difference_percent": { "type": "number", "example": 88.21, "nullable": true, "description": "`difference_from_average` as a percentage of the searched title's annual mean." }, "difference_from_average": { "type": "number", "example": 77504, "nullable": true, "description": "This title's annual figure minus the searched title's annual mean. Computed for all 5\nrows; ZipRecruiter publishes only 4 of them." } }, "description": "One of the 5 related job titles ZipRecruiter lists for the searched title, with how much\nmore or less it pays. Each `job_title` can be fed straight back into this endpoint." }, "sds_L_Fsr74jXxRwFrRFUiukT_901e1a996e16938b_ref8": { "type": "object", "required": [ "question", "answer" ], "properties": { "answer": { "type": "string", "example": "The average annual pay for a registered nurse in the United States is $87,868 a year...", "nullable": true, "description": "The answer, HTML stripped to plain text." }, "question": { "type": "string", "example": "How much does a Registered Nurse make?", "nullable": true, "description": "The question, verbatim." } }, "description": "One entry of ZipRecruiter's generated salary FAQ for this title and scope. Answers that\nquote a table are flattened to text with cells separated by ` | `." }, "sds_L_Fsr74jXxRwFrRFUiukT_901e1a996e16938b_ref9": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_901e1a996e16938b_ref10" } } }, "description": "Invalid or missing parameter." }, "sds_L_Fsr74jXxRwFrRFUiukT_901e1a996e16938b_ref10": { "type": "object", "required": [ "status", "request_id", "error" ], "properties": { "error": { "type": "object", "required": [ "message", "code" ], "properties": { "code": { "type": "integer", "example": 400, "description": "HTTP status code, repeated in the body." }, "message": { "type": "string", "example": "The 'query' parameter is required.", "description": "Human-readable explanation, naming the parameter and the allowed values." } }, "description": "What went wrong." }, "status": { "enum": [ "ERROR" ], "type": "string", "description": "Always `ERROR` on a failed request." }, "request_id": { "type": "string", "example": "35dabdcd-b334-4600-afbc-d654b8af91cf", "description": "Unique id for this request, useful when contacting support." } } }, "sds_L_Fsr74jXxRwFrRFUiukT_901e1a996e16938b_ref11": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_901e1a996e16938b_ref10" } } }, "description": "Missing or invalid credentials." }, "sds_L_Fsr74jXxRwFrRFUiukT_901e1a996e16938b_ref12": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_901e1a996e16938b_ref10" } } }, "description": "Not subscribed to this API." }, "sds_L_Fsr74jXxRwFrRFUiukT_901e1a996e16938b_ref13": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_901e1a996e16938b_ref10" } } }, "description": "The requested resource does not exist. On `/search` this is an unrecognised `company_id`,\nand on `/estimated-salary` a job title, or a title and state pair, outside ZipRecruiter's\nsalary pages." }, "sds_L_Fsr74jXxRwFrRFUiukT_901e1a996e16938b_ref14": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_901e1a996e16938b_ref10" } } }, "description": "Quota exhausted or rate limit hit." }, "sds_L_Fsr74jXxRwFrRFUiukT_901e1a996e16938b_ref15": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_901e1a996e16938b_ref10" } } }, "description": "Unexpected error." }, "sds_L_Fsr74jXxRwFrRFUiukT_901e1a996e16938b_ref16": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_901e1a996e16938b_ref10" } } }, "description": "ZipRecruiter was temporarily unreachable after the full proxy ladder was exhausted. A 503\nmeans the page could not be read, where an empty result set means the search ran and\nmatched nothing. Safe to retry." }, "sds_L_Fsr74jXxRwFrRFUiukT_6a426ce028a594c8_ref0": { "type": "object", "required": [ "job_id", "country" ], "properties": { "fields": { "type": "string", "example": "job_title,employer_name", "description": "The projection exactly as sent. Absent when not supplied." }, "job_id": { "type": "string", "example": "emlwcmVjcnVpdGVyOjkzNjIxNWNiNTAzZDhiZTI", "description": "The id list exactly as sent, before splitting and deduplication." }, "country": { "enum": [ "us", "ca" ], "type": "string", "example": "us", "description": "The resolved country market, lowercased." } }, "description": "Echo of the parameters as the caller sent them." }, "sds_L_Fsr74jXxRwFrRFUiukT_6a426ce028a594c8_ref1": { "type": "object", "required": [ "job_id", "job_title", "employer_name", "employer_logo", "employer_website", "job_publisher", "job_employment_type", "job_employment_types", "job_apply_link", "job_apply_is_direct", "apply_options", "job_description", "job_is_remote", "job_posted_at", "job_posted_at_timestamp", "job_posted_at_datetime_utc", "job_location", "job_city", "job_state", "job_country", "job_latitude", "job_longitude", "job_benefits", "job_benefits_strings", "job_google_link", "job_salary", "job_salary_string", "job_min_salary", "job_max_salary", "job_salary_period", "job_highlights", "job_onet_soc", "job_onet_job_zone", "employer_reviews", "job_uid", "ziprecruiter_listing_key", "ziprecruiter_short_description", "ziprecruiter_description_html", "ziprecruiter_share_url", "ziprecruiter_canonical_job_url", "ziprecruiter_updated_at", "ziprecruiter_is_new", "ziprecruiter_apply_type", "ziprecruiter_apply_host", "ziprecruiter_salary_source", "ziprecruiter_salary_is_estimated", "ziprecruiter_location_type", "ziprecruiter_location_county", "ziprecruiter_location_postal_code", "ziprecruiter_location_id", "ziprecruiter_company_id", "ziprecruiter_company_slug", "ziprecruiter_company_size", "ziprecruiter_company_hq", "ziprecruiter_company_industries", "ziprecruiter_job_industry", "ziprecruiter_valid_through", "ziprecruiter_ats_identifier", "ziprecruiter_key_responsibilities", "ziprecruiter_employer_faq" ], "properties": { "job_id": { "type": "string", "example": "emlwcmVjcnVpdGVyOjkzNjIxNWNiNTAzZDhiZTI", "description": "Stable, opaque id for this posting. Pass it straight back to `/job-details`. Encodes\nZipRecruiter's own seat id, so it survives re-fetches and is the same on every surface." }, "job_uid": { "type": "string", "example": "936215cb503d8be2", "description": "ZipRecruiter's own raw seat id, 16 hex characters. Stable across surfaces and\nre-fetches, accepted directly by `/job-details`, and the right key for an enrichment\ncache." }, "job_city": { "type": "string", "example": "Manhattan", "nullable": true, "description": "City. `null` on a state-level or remote-only listing." }, "job_state": { "type": "string", "example": "New York", "nullable": true, "description": "The full state or province NAME, matching JSearch. The two-letter code appears inside\n`job_location`." }, "job_title": { "type": "string", "example": "Senior AI Engineer (AI Foundations)", "nullable": true, "description": "The job title as ZipRecruiter publishes it. 100% fill." }, "job_salary": { "type": "number", "example": 155750, "nullable": true, "description": "The headline salary figure: the midpoint when the posting states a range, the single\nbound otherwise, in the period given by `job_salary_period`. 69% fill. Populated only\nwhen ZipRecruiter itself displays the pay." }, "job_country": { "type": "string", "example": "US", "nullable": true, "description": "Uppercase ISO 3166-1 alpha-2 country code. `US` or `CA` on this source." }, "job_benefits": { "type": "array", "items": { "enum": [ "medical", "dental", "vision", "life_insurance", "paid_time_off", "retirement" ], "type": "string" }, "example": [ "medical", "dental", "vision", "paid_time_off", "retirement" ], "nullable": true, "description": "Normalised benefit tags ZipRecruiter states on the posting. 44% fill; `null` when none\nare stated." }, "job_latitude": { "type": "number", "format": "float", "example": null, "nullable": true, "description": "Always `null`. ZipRecruiter publishes coordinates on neither the card, the detail\npayload nor the JSON-LD." }, "job_location": { "type": "string", "example": "Manhattan, NY", "nullable": true, "description": "The location as ZipRecruiter displays it on the posting. 100% fill." }, "job_onet_soc": { "type": "string", "example": "15-1132.00", "nullable": true, "description": "The O*NET-SOC occupation code ZipRecruiter states, with the human title removed.\nDetail surface only, and capped at 73% because it comes from JSON-LD, which\nZipRecruiter ships on 73% of detail pages." }, "apply_options": { "type": "array", "items": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_6a426ce028a594c8_ref2" }, "description": "Ways to apply. ZipRecruiter exposes exactly one, its own posting page, so this is a\none-entry array, or empty on the rare job with no resolvable URL." }, "employer_logo": { "type": "string", "format": "uri", "example": "https://www.ziprecruiter.com/svc/fotomat/public-nosensitive-ziprecruiter-logos/company/60122984.png", "nullable": true, "description": "The employer's logo. 69% fill from ZipRecruiter itself; the remainder is lifted from\nthe employer's own domain where one is known." }, "employer_name": { "type": "string", "example": "Capital One", "nullable": true, "description": "The hiring company's name. 100% fill." }, "job_is_remote": { "type": "boolean", "example": false, "nullable": true, "description": "Whether the job can be done remotely. A real tri-state here: ZipRecruiter states a\nworkplace type on 100% of postings, so `false` is a supported answer.\nFully remote and remote-optional map to `true`; hybrid and in-person map to `false`." }, "job_longitude": { "type": "number", "format": "float", "example": null, "nullable": true, "description": "Always `null`, for the same reason as `job_latitude`." }, "job_posted_at": { "type": "string", "example": "4 days ago", "nullable": true, "description": "Relative publication age, for example `4 days ago` or `1 month ago`. Derived from\nZipRecruiter's own posted-at stamp. Its JSON-LD `datePosted` is a reindex stamp and\ndisagrees with reality on 58% of postings." }, "job_publisher": { "enum": [ "ZipRecruiter" ], "type": "string", "example": "ZipRecruiter", "description": "Always `ZipRecruiter`. Constant by construction on this source." }, "job_apply_link": { "type": "string", "format": "uri", "example": "https://www.ziprecruiter.com/c/Capital-One/Job/Senior-AI-Engineer-(AI-Foundations)/-in-Manhattan,NY?jid=936215cb503d8be2", "nullable": true, "description": "The canonical ZipRecruiter posting URL, with tracking parameters stripped. 100% fill,\nstable, and a page a human can apply from." }, "job_highlights": { "type": "object", "example": { "Qualifications": [ "At least 3 years of experience programming with Python, Go, Scala, or Java" ], "Responsibilities": [ "Design, develop, test, deploy, and support AI software components." ] }, "description": "Description bullets grouped by section, keyed `Qualifications`, `Responsibilities` and\n`Benefits`. Recovered from the posting's own headed lists, plus ZipRecruiter's extracted\nkey responsibilities where it provides them. Detail surface only, 72% fill; `{}` when\nnothing was recovered, so it is always safe to enumerate. Only headings that map to one\nof the three sections are kept.", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "job_max_salary": { "type": "number", "example": 177100, "nullable": true, "description": "Upper bound of the stated range, in the `job_salary_period` unit. 69% fill." }, "job_min_salary": { "type": "number", "example": 134400, "nullable": true, "description": "Lower bound of the stated range, in the `job_salary_period` unit. 69% fill." }, "job_description": { "type": "string", "example": "Senior AI Engineer (AI Foundations)\n\nOverview:\n\nAt Capital One, we are creating responsible and reliable AI systems, changing banking for good.", "nullable": true, "description": "The full posting text, HTML stripped to plain text with paragraph breaks preserved.\n**Detail surface only, and this is the field callers most often expect for free:** it\nis `null` on a `/search` response unless `include_details=true`, because a ZipRecruiter\nsearch card carries only a roughly 200-character teaser, published separately as\n`ziprecruiter_short_description`. 100% fill on the detail surface." }, "job_google_link": { "type": "string", "format": "uri", "example": null, "nullable": true, "description": "Always `null`. This link is a Google for Jobs construction built around a Google docid,\nwhich ZipRecruiter does not issue." }, "employer_reviews": { "type": "array", "items": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_6a426ce028a594c8_ref3" }, "nullable": true, "description": "Employer ratings published by Breakroom. Detail surface only, 14% fill; `null` when\nZipRecruiter shows no rating. Note the scale is 1 to 10, carried on the row as\n`max_score`." }, "employer_website": { "type": "string", "format": "uri", "example": "https://capitalone.com", "nullable": true, "description": "The employer's own website, from ZipRecruiter's company widget. Detail surface only,\n54% fill." }, "job_onet_job_zone": { "type": "string", "example": null, "nullable": true, "description": "Always `null`. The O*NET job zone is a Google enrichment; ZipRecruiter states the SOC\ncode only." }, "job_salary_period": { "enum": [ "HOUR", "DAY", "WEEK", "MONTH", "YEAR", null ], "type": "string", "example": "YEAR", "nullable": true, "description": "The period the salary figures are expressed in. 69% fill." }, "job_salary_string": { "type": "string", "example": "$134K - $177K/yr", "nullable": true, "description": "ZipRecruiter's own salary text, verbatim, exactly as shown on the page. 69% fill." }, "job_apply_is_direct": { "type": "boolean", "example": false, "description": "Always `false`. A ZipApply job is applied to on ZipRecruiter, and an external job goes\nthrough a redirect whose destination is an ad network relay more often than an employer\nATS. See `ziprecruiter_apply_type` for the apply signal." }, "job_employment_type": { "enum": [ "FULLTIME", "CONTRACTOR", "PARTTIME", "INTERN", "TEMPORARY", "OTHER", null ], "type": "string", "example": "FULLTIME", "nullable": true, "description": "The first entry of `job_employment_types`, for JSearch compatibility. `null` when\nZipRecruiter states no employment type. `INTERN` appears here as a reported value:\nZipRecruiter labels internships on the posting, while its search offers an\n`employment_types` filter without one." }, "ziprecruiter_is_new": { "type": "boolean", "example": null, "nullable": true, "description": "ZipRecruiter's own \"new\" badge on a search card. Search surface only, and `null` when\nthe payload carries no badge." }, "job_benefits_strings": { "type": "array", "items": { "type": "string" }, "example": [ "Medical", "Dental", "Vision", "Life", "Retirement", "PTO" ], "nullable": true, "description": "ZipRecruiter's own benefit labels, split out of its single comma-joined display string.\nSame 44% fill as `job_benefits`; `null` when none are stated." }, "job_employment_types": { "type": "array", "items": { "enum": [ "FULLTIME", "CONTRACTOR", "PARTTIME", "INTERN", "TEMPORARY", "OTHER" ], "type": "string" }, "example": [ "FULLTIME" ], "description": "Every employment type stated on the posting, in JSearch's documented order so two\nidentically tagged jobs always serialise the same way. An empty array when\nZipRecruiter states none. `INTERN` is a reported value here; ZipRecruiter's search\noffers an `employment_types` filter without one." }, "ziprecruiter_share_url": { "type": "string", "format": "uri", "example": "https://www.ziprecruiter.com/job-redirect/share?match_token=CqABChZubDRwVEpHZHBvb2lIeGYxVXE1WFJ3", "nullable": true, "description": "ZipRecruiter's own short share link for the posting." }, "job_posted_at_timestamp": { "type": "integer", "example": 1788992809, "nullable": true, "description": "Unix timestamp in seconds of the publication date. 100% fill." }, "ziprecruiter_apply_host": { "type": "string", "example": "dsp.prng.co", "nullable": true, "description": "The hostname behind ZipRecruiter's external apply redirect, decoded. Provenance only:\nit is frequently an ad network relay. Use `job_apply_link` to apply." }, "ziprecruiter_apply_type": { "enum": [ "OPEN_APPLY_FLOW", "OPEN_EXTERNAL", null ], "type": "string", "example": "OPEN_EXTERNAL", "nullable": true, "description": "How applying works. `OPEN_APPLY_FLOW` is ZipApply, applied on ZipRecruiter itself;\n`OPEN_EXTERNAL` leaves for a third-party destination. This is the apply signal to read." }, "ziprecruiter_company_hq": { "type": "string", "example": "McLean, VA, US", "nullable": true, "description": "The company's headquarters location from ZipRecruiter's company widget. Detail surface\nonly, 54% fill." }, "ziprecruiter_company_id": { "type": "string", "example": "LvOba8F2oEpGlw2IxG/RnmjRZMM=", "nullable": true, "description": "ZipRecruiter's internal company identifier, an opaque base64 blob, stringified like\nevery other id in this response." }, "ziprecruiter_updated_at": { "type": "string", "example": "2026-09-14T04:20:33.688364560Z", "nullable": true, "description": "When ZipRecruiter last refreshed the listing, distinct from the publication date. Search\nsurface only: `null` on `/job-details`. Nanosecond precision, as ZipRecruiter publishes\nit." }, "ziprecruiter_listing_key": { "type": "string", "example": "nl4pTJGdpooiHxf1Uq5XRw", "nullable": true, "description": "ZipRecruiter's internal listing key. Useful for diffing payloads, but NOT an identity:\nthe same job can carry different keys on different surfaces. Use `job_id` or `job_uid`." }, "ziprecruiter_location_id": { "type": "string", "example": "0a070499-f1f0-42d9-940e-76c39915e34a", "nullable": true, "description": "ZipRecruiter's internal identifier for the location." }, "ziprecruiter_company_size": { "type": "string", "example": "10000+ Employees", "nullable": true, "description": "Employee headcount band from ZipRecruiter's company widget, for example\n`1001 - 5000 Employees`. Detail surface only, 54% fill." }, "ziprecruiter_company_slug": { "type": "string", "example": "capital one", "nullable": true, "description": "ZipRecruiter's canonical display name for the company. A display label only: scope a\nsearch to this employer with `ziprecruiter_company_id`." }, "ziprecruiter_employer_faq": { "type": "array", "items": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_6a426ce028a594c8_ref4" }, "nullable": true, "description": "ZipRecruiter's generated FAQ for the posting. Detail surface only. Despite the contract\nname, most entries are about the ROLE; some are Breakroom survey findings about the\nemployer." }, "ziprecruiter_job_industry": { "type": "string", "example": "Technology", "nullable": true, "description": "The industry ZipRecruiter assigns to this JOB. From JSON-LD, so detail surface only and\ncapped at 73%." }, "job_posted_at_datetime_utc": { "type": "string", "format": "date-time", "example": "2026-09-09T22:26:49.000Z", "nullable": true, "description": "ISO 8601 UTC form of `job_posted_at_timestamp`." }, "ziprecruiter_location_type": { "enum": [ "LOCATION_TYPE_NAME_IN_PERSON", "LOCATION_TYPE_NAME_REMOTE", "LOCATION_TYPE_NAME_REMOTE_OPTIONAL", "LOCATION_TYPE_NAME_HYBRID", null ], "type": "string", "example": "LOCATION_TYPE_NAME_IN_PERSON", "nullable": true, "description": "ZipRecruiter's own workplace-type enum, passed through verbatim. 100% fill, and the\nsource `job_is_remote` is derived from." }, "ziprecruiter_salary_source": { "enum": [ "SOURCE_PROVIDED", "SOURCE_PARSED", "SOURCE_PREDICTED", "SOURCE_MISSING", null ], "type": "string", "example": "SOURCE_PREDICTED", "nullable": true, "description": "Where ZipRecruiter's pay figure came from. Always published, even when the salary\nfields are `null`, so a caller can see WHY a job has no salary: `SOURCE_MISSING` means\nthe employer stated no pay and ZipRecruiter modelled and then hid a figure, which this\nAPI suppresses." }, "ziprecruiter_valid_through": { "type": "string", "example": "2026-10-14", "nullable": true, "description": "The date the posting expires, as ZipRecruiter states it in JSON-LD. Detail surface\nonly, capped at 73%." }, "ziprecruiter_ats_identifier": { "type": "string", "example": "R1000242", "nullable": true, "description": "The employer's own requisition reference, from the posting's JSON-LD identifier. Detail\nsurface only, and present on 40 of the 43 measured pages that carry JSON-LD at all." }, "ziprecruiter_location_county": { "type": "string", "example": "New York", "nullable": true, "description": "County or equivalent administrative area for the job location." }, "ziprecruiter_description_html": { "type": "string", "example": "Senior AI Engineer (AI Foundations)

Overview:

At Capital One, we are creating responsible ...

", "nullable": true, "description": "The job description with ZipRecruiter's original HTML markup preserved, for callers who\nwant the formatting. Detail surface only, 100% fill there." }, "ziprecruiter_canonical_job_url": { "type": "string", "format": "uri", "example": "https://www.ziprecruiter.com/c/Capital-One/Job/Senior-AI-Engineer-(AI-Foundations)/-in-Manhattan,NY?jid=936215cb503d8be2", "nullable": true, "description": "The canonical ZipRecruiter posting URL. Identical to `job_apply_link`, exposed under\nits own name so the ZipRecruiter extras stand on their own." }, "ziprecruiter_short_description": { "type": "string", "example": "Senior AI Engineer (AI Foundations) Overview: At Capital One, we are creating responsible and reliable AI systems, changing banking for good.", "nullable": true, "description": "The roughly 200-character teaser a ZipRecruiter search card carries. Card surface\nonly: always `null` on `/job-details`, where the full `job_description` is present\ninstead. Passed through verbatim, so unlike `job_description` it can carry\nZipRecruiter's own `` search-highlight markup and undecoded HTML entities; strip or\ndecode it before display." }, "ziprecruiter_company_industries": { "type": "array", "items": { "type": "string" }, "example": [ "Funds, Trusts and Financial Programs", "Real Estate" ], "nullable": true, "description": "Industries ZipRecruiter assigns to the COMPANY, distinct from the job's own industry.\nDetail surface only; `null` when the widget lists none." }, "ziprecruiter_salary_is_estimated": { "type": "boolean", "example": true, "nullable": true, "description": "Whether ZipRecruiter labels the displayed pay as an estimate. `null` when there is no\ndisplayed pay to label." }, "ziprecruiter_key_responsibilities": { "type": "array", "items": { "type": "string" }, "example": null, "nullable": true, "description": "ZipRecruiter's machine-extracted responsibility summaries, rewritten from the posting.\nDetail surface only, present on roughly a third of detail pages; also merged into\n`job_highlights.Responsibilities`." }, "ziprecruiter_location_postal_code": { "type": "string", "example": "10012", "nullable": true, "description": "Postal or ZIP code, as a string so leading zeros survive." } }, "description": "A ZipRecruiter job posting. A superset of the 35-key JSearch `/search` contract, whose keys\ncome first in contract order, followed by 25 `ziprecruiter_*` extras, for 60 keys in total.\nEvery key is always present, `null` / `[]` / `{}` where ZipRecruiter has no value, so a\nconsumer gets the same set of keys on every job. The `fields` projection narrows it,\nreturning exactly the keys asked for plus `job_id` and `job_title`.\n\nFields marked \"detail surface only\" are `null` on a `/search` response unless\n`include_details=true`, and are filled on `/job-details`." }, "sds_L_Fsr74jXxRwFrRFUiukT_6a426ce028a594c8_ref2": { "type": "object", "required": [ "publisher", "apply_link", "is_direct" ], "properties": { "is_direct": { "type": "boolean", "example": false, "description": "Always `false`. The destination is ZipRecruiter itself or an ad network relay." }, "publisher": { "type": "string", "example": "ZipRecruiter", "description": "Always `ZipRecruiter`; every row on this surface is a ZipRecruiter listing." }, "apply_link": { "type": "string", "format": "uri", "example": "https://www.ziprecruiter.com/c/Capital-One/Job/Senior-AI-Engineer-(AI-Foundations)/-in-Manhattan,NY?jid=936215cb503d8be2", "description": "The canonical ZipRecruiter posting URL, identical to `job_apply_link`." } }, "description": "One way to apply to this job. ZipRecruiter exposes exactly one, its own posting page, so\nthis array has either one entry or none." }, "sds_L_Fsr74jXxRwFrRFUiukT_6a426ce028a594c8_ref3": { "type": "object", "required": [ "publisher", "employer_name", "score", "num_stars", "review_count", "max_score", "reviews_link" ], "properties": { "score": { "type": "number", "example": 7.76, "description": "The rating, on the `max_score` scale, rounded to 2 decimals." }, "max_score": { "type": "integer", "example": 10, "description": "The top of the scale. `10` for Breakroom." }, "num_stars": { "type": "integer", "example": 8, "description": "`score` rounded to the nearest whole number, on the same scale as `max_score`." }, "publisher": { "type": "string", "example": "Breakroom", "description": "Who published the rating. `Breakroom` on every sample measured." }, "review_count": { "type": "integer", "example": 148, "nullable": true, "description": "How many responses the rating is based on." }, "reviews_link": { "type": "string", "format": "uri", "example": "https://breakroom.cc/companies/capital-one", "nullable": true, "description": "The Breakroom company page the rating comes from." }, "employer_name": { "type": "string", "example": "Capital One", "nullable": true, "description": "The employer the rating is about, as the rating source names it." } }, "description": "One employer rating, published by Breakroom. Note the scale: `max_score` is 10, and the\nscore is carried on that scale unchanged." }, "sds_L_Fsr74jXxRwFrRFUiukT_6a426ce028a594c8_ref4": { "type": "object", "required": [ "question", "answer" ], "properties": { "answer": { "type": "string", "example": "Key technical skills include expertise in programming languages such as Java, Python, or C++.", "nullable": true, "description": "The answer, verbatim. May contain inline HTML where ZipRecruiter published it." }, "question": { "type": "string", "example": "What skills or qualities help someone succeed as a Senior Software Engineer?", "nullable": true, "description": "The question, verbatim." } }, "description": "One generated FAQ entry. ZipRecruiter writes these about the ROLE, so most answers\ndescribe the occupation; a few are Breakroom survey findings about the employer." }, "sds_L_Fsr74jXxRwFrRFUiukT_6a426ce028a594c8_ref5": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_6a426ce028a594c8_ref6" } } }, "description": "Invalid or missing parameter." }, "sds_L_Fsr74jXxRwFrRFUiukT_6a426ce028a594c8_ref6": { "type": "object", "required": [ "status", "request_id", "error" ], "properties": { "error": { "type": "object", "required": [ "message", "code" ], "properties": { "code": { "type": "integer", "example": 400, "description": "HTTP status code, repeated in the body." }, "message": { "type": "string", "example": "The 'query' parameter is required.", "description": "Human-readable explanation, naming the parameter and the allowed values." } }, "description": "What went wrong." }, "status": { "enum": [ "ERROR" ], "type": "string", "description": "Always `ERROR` on a failed request." }, "request_id": { "type": "string", "example": "35dabdcd-b334-4600-afbc-d654b8af91cf", "description": "Unique id for this request, useful when contacting support." } } }, "sds_L_Fsr74jXxRwFrRFUiukT_6a426ce028a594c8_ref7": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_6a426ce028a594c8_ref6" } } }, "description": "Missing or invalid credentials." }, "sds_L_Fsr74jXxRwFrRFUiukT_6a426ce028a594c8_ref8": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_6a426ce028a594c8_ref6" } } }, "description": "Not subscribed to this API." }, "sds_L_Fsr74jXxRwFrRFUiukT_6a426ce028a594c8_ref9": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_6a426ce028a594c8_ref6" } } }, "description": "The requested resource does not exist. On `/search` this is an unrecognised `company_id`,\nand on `/estimated-salary` a job title, or a title and state pair, outside ZipRecruiter's\nsalary pages." }, "sds_L_Fsr74jXxRwFrRFUiukT_6a426ce028a594c8_ref10": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_6a426ce028a594c8_ref6" } } }, "description": "Quota exhausted or rate limit hit." }, "sds_L_Fsr74jXxRwFrRFUiukT_6a426ce028a594c8_ref11": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_6a426ce028a594c8_ref6" } } }, "description": "Unexpected error." }, "sds_L_Fsr74jXxRwFrRFUiukT_6a426ce028a594c8_ref12": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_6a426ce028a594c8_ref6" } } }, "description": "ZipRecruiter was temporarily unreachable after the full proxy ladder was exhausted. A 503\nmeans the page could not be read, where an empty result set means the search ran and\nmatched nothing. Safe to retry." }, "sds_L_Fsr74jXxRwFrRFUiukT_24e03882eaa99c44_ref0": { "type": "object", "required": [ "query", "page", "num_pages", "country", "date_posted", "remote_jobs_only", "zipapply_only", "include_details" ], "properties": { "page": { "type": "integer", "example": 1, "description": "The first page fetched." }, "query": { "type": "string", "example": "software engineer", "description": "The search query, trimmed." }, "fields": { "type": "string", "example": "job_title,employer_name", "description": "The projection exactly as sent. Absent when not supplied." }, "radius": { "type": "integer", "example": 40, "description": "The radius in KILOMETRES as sent, before conversion to miles." }, "country": { "enum": [ "us", "ca" ], "type": "string", "example": "us", "description": "The resolved country market, lowercased." }, "location": { "type": "string", "example": "New York, NY", "description": "The location as sent, trimmed. Absent when no location was supplied." }, "num_pages": { "type": "integer", "example": 1, "description": "How many consecutive pages were requested." }, "company_id": { "type": "string", "example": "veWDjg7imzXye0FSbif3ZyRHsGc=", "description": "The company id exactly as sent, trimmed. Absent when not supplied." }, "salary_max": { "type": "integer", "example": 150000, "description": "The maximum annual salary as an integer. Absent when not supplied." }, "salary_min": { "type": "integer", "example": 80000, "description": "The minimum annual salary as an integer. Absent when not supplied." }, "date_posted": { "enum": [ "all", "today", "3days", "week", "month" ], "type": "string", "example": "all", "description": "The resolved date window, lowercased." }, "zipapply_only": { "example": false, "description": "The boolean `false` when the parameter was not supplied, otherwise the raw string\nexactly as the caller sent it." }, "include_details": { "example": "true", "description": "The boolean `false` when the parameter was not supplied, otherwise the raw string\nexactly as the caller sent it." }, "employment_types": { "type": "string", "example": "FULLTIME,CONTRACTOR", "description": "The employment type list exactly as sent. Absent when not supplied." }, "experience_level": { "type": "string", "example": "senior", "description": "The experience level exactly as sent. Absent when not supplied." }, "remote_jobs_only": { "example": false, "description": "The boolean `false` when the parameter was not supplied, otherwise the raw string\nexactly as the caller sent it." } }, "description": "Echo of the parameters as the caller sent them, before any internal transformation.\n`date_posted` is echoed as its resolved default `all`, and `radius` is echoed in\nkilometres, the unit the caller sends. Only the parameters\nactually supplied are present, except the four that always carry their resolved default.\n`remote_jobs_only`, `zipapply_only` and `include_details` echo the boolean `false` when the\ncaller omitted them and the caller's raw string when the caller supplied them." }, "sds_L_Fsr74jXxRwFrRFUiukT_24e03882eaa99c44_ref1": { "type": "object", "required": [ "job_id", "job_title", "employer_name", "employer_logo", "employer_website", "job_publisher", "job_employment_type", "job_employment_types", "job_apply_link", "job_apply_is_direct", "apply_options", "job_description", "job_is_remote", "job_posted_at", "job_posted_at_timestamp", "job_posted_at_datetime_utc", "job_location", "job_city", "job_state", "job_country", "job_latitude", "job_longitude", "job_benefits", "job_benefits_strings", "job_google_link", "job_salary", "job_salary_string", "job_min_salary", "job_max_salary", "job_salary_period", "job_highlights", "job_onet_soc", "job_onet_job_zone", "employer_reviews", "job_uid", "ziprecruiter_listing_key", "ziprecruiter_short_description", "ziprecruiter_description_html", "ziprecruiter_share_url", "ziprecruiter_canonical_job_url", "ziprecruiter_updated_at", "ziprecruiter_is_new", "ziprecruiter_apply_type", "ziprecruiter_apply_host", "ziprecruiter_salary_source", "ziprecruiter_salary_is_estimated", "ziprecruiter_location_type", "ziprecruiter_location_county", "ziprecruiter_location_postal_code", "ziprecruiter_location_id", "ziprecruiter_company_id", "ziprecruiter_company_slug", "ziprecruiter_company_size", "ziprecruiter_company_hq", "ziprecruiter_company_industries", "ziprecruiter_job_industry", "ziprecruiter_valid_through", "ziprecruiter_ats_identifier", "ziprecruiter_key_responsibilities", "ziprecruiter_employer_faq" ], "properties": { "job_id": { "type": "string", "example": "emlwcmVjcnVpdGVyOjkzNjIxNWNiNTAzZDhiZTI", "description": "Stable, opaque id for this posting. Pass it straight back to `/job-details`. Encodes\nZipRecruiter's own seat id, so it survives re-fetches and is the same on every surface." }, "job_uid": { "type": "string", "example": "936215cb503d8be2", "description": "ZipRecruiter's own raw seat id, 16 hex characters. Stable across surfaces and\nre-fetches, accepted directly by `/job-details`, and the right key for an enrichment\ncache." }, "job_city": { "type": "string", "example": "Manhattan", "nullable": true, "description": "City. `null` on a state-level or remote-only listing." }, "job_state": { "type": "string", "example": "New York", "nullable": true, "description": "The full state or province NAME, matching JSearch. The two-letter code appears inside\n`job_location`." }, "job_title": { "type": "string", "example": "Senior AI Engineer (AI Foundations)", "nullable": true, "description": "The job title as ZipRecruiter publishes it. 100% fill." }, "job_salary": { "type": "number", "example": 155750, "nullable": true, "description": "The headline salary figure: the midpoint when the posting states a range, the single\nbound otherwise, in the period given by `job_salary_period`. 69% fill. Populated only\nwhen ZipRecruiter itself displays the pay." }, "job_country": { "type": "string", "example": "US", "nullable": true, "description": "Uppercase ISO 3166-1 alpha-2 country code. `US` or `CA` on this source." }, "job_benefits": { "type": "array", "items": { "enum": [ "medical", "dental", "vision", "life_insurance", "paid_time_off", "retirement" ], "type": "string" }, "example": [ "medical", "dental", "vision", "paid_time_off", "retirement" ], "nullable": true, "description": "Normalised benefit tags ZipRecruiter states on the posting. 44% fill; `null` when none\nare stated." }, "job_latitude": { "type": "number", "format": "float", "example": null, "nullable": true, "description": "Always `null`. ZipRecruiter publishes coordinates on neither the card, the detail\npayload nor the JSON-LD." }, "job_location": { "type": "string", "example": "Manhattan, NY", "nullable": true, "description": "The location as ZipRecruiter displays it on the posting. 100% fill." }, "job_onet_soc": { "type": "string", "example": "15-1132.00", "nullable": true, "description": "The O*NET-SOC occupation code ZipRecruiter states, with the human title removed.\nDetail surface only, and capped at 73% because it comes from JSON-LD, which\nZipRecruiter ships on 73% of detail pages." }, "apply_options": { "type": "array", "items": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_24e03882eaa99c44_ref2" }, "description": "Ways to apply. ZipRecruiter exposes exactly one, its own posting page, so this is a\none-entry array, or empty on the rare job with no resolvable URL." }, "employer_logo": { "type": "string", "format": "uri", "example": "https://www.ziprecruiter.com/svc/fotomat/public-nosensitive-ziprecruiter-logos/company/60122984.png", "nullable": true, "description": "The employer's logo. 69% fill from ZipRecruiter itself; the remainder is lifted from\nthe employer's own domain where one is known." }, "employer_name": { "type": "string", "example": "Capital One", "nullable": true, "description": "The hiring company's name. 100% fill." }, "job_is_remote": { "type": "boolean", "example": false, "nullable": true, "description": "Whether the job can be done remotely. A real tri-state here: ZipRecruiter states a\nworkplace type on 100% of postings, so `false` is a supported answer.\nFully remote and remote-optional map to `true`; hybrid and in-person map to `false`." }, "job_longitude": { "type": "number", "format": "float", "example": null, "nullable": true, "description": "Always `null`, for the same reason as `job_latitude`." }, "job_posted_at": { "type": "string", "example": "4 days ago", "nullable": true, "description": "Relative publication age, for example `4 days ago` or `1 month ago`. Derived from\nZipRecruiter's own posted-at stamp. Its JSON-LD `datePosted` is a reindex stamp and\ndisagrees with reality on 58% of postings." }, "job_publisher": { "enum": [ "ZipRecruiter" ], "type": "string", "example": "ZipRecruiter", "description": "Always `ZipRecruiter`. Constant by construction on this source." }, "job_apply_link": { "type": "string", "format": "uri", "example": "https://www.ziprecruiter.com/c/Capital-One/Job/Senior-AI-Engineer-(AI-Foundations)/-in-Manhattan,NY?jid=936215cb503d8be2", "nullable": true, "description": "The canonical ZipRecruiter posting URL, with tracking parameters stripped. 100% fill,\nstable, and a page a human can apply from." }, "job_highlights": { "type": "object", "example": { "Qualifications": [ "At least 3 years of experience programming with Python, Go, Scala, or Java" ], "Responsibilities": [ "Design, develop, test, deploy, and support AI software components." ] }, "description": "Description bullets grouped by section, keyed `Qualifications`, `Responsibilities` and\n`Benefits`. Recovered from the posting's own headed lists, plus ZipRecruiter's extracted\nkey responsibilities where it provides them. Detail surface only, 72% fill; `{}` when\nnothing was recovered, so it is always safe to enumerate. Only headings that map to one\nof the three sections are kept.", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "job_max_salary": { "type": "number", "example": 177100, "nullable": true, "description": "Upper bound of the stated range, in the `job_salary_period` unit. 69% fill." }, "job_min_salary": { "type": "number", "example": 134400, "nullable": true, "description": "Lower bound of the stated range, in the `job_salary_period` unit. 69% fill." }, "job_description": { "type": "string", "example": "Senior AI Engineer (AI Foundations)\n\nOverview:\n\nAt Capital One, we are creating responsible and reliable AI systems, changing banking for good.", "nullable": true, "description": "The full posting text, HTML stripped to plain text with paragraph breaks preserved.\n**Detail surface only, and this is the field callers most often expect for free:** it\nis `null` on a `/search` response unless `include_details=true`, because a ZipRecruiter\nsearch card carries only a roughly 200-character teaser, published separately as\n`ziprecruiter_short_description`. 100% fill on the detail surface." }, "job_google_link": { "type": "string", "format": "uri", "example": null, "nullable": true, "description": "Always `null`. This link is a Google for Jobs construction built around a Google docid,\nwhich ZipRecruiter does not issue." }, "employer_reviews": { "type": "array", "items": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_24e03882eaa99c44_ref3" }, "nullable": true, "description": "Employer ratings published by Breakroom. Detail surface only, 14% fill; `null` when\nZipRecruiter shows no rating. Note the scale is 1 to 10, carried on the row as\n`max_score`." }, "employer_website": { "type": "string", "format": "uri", "example": "https://capitalone.com", "nullable": true, "description": "The employer's own website, from ZipRecruiter's company widget. Detail surface only,\n54% fill." }, "job_onet_job_zone": { "type": "string", "example": null, "nullable": true, "description": "Always `null`. The O*NET job zone is a Google enrichment; ZipRecruiter states the SOC\ncode only." }, "job_salary_period": { "enum": [ "HOUR", "DAY", "WEEK", "MONTH", "YEAR", null ], "type": "string", "example": "YEAR", "nullable": true, "description": "The period the salary figures are expressed in. 69% fill." }, "job_salary_string": { "type": "string", "example": "$134K - $177K/yr", "nullable": true, "description": "ZipRecruiter's own salary text, verbatim, exactly as shown on the page. 69% fill." }, "job_apply_is_direct": { "type": "boolean", "example": false, "description": "Always `false`. A ZipApply job is applied to on ZipRecruiter, and an external job goes\nthrough a redirect whose destination is an ad network relay more often than an employer\nATS. See `ziprecruiter_apply_type` for the apply signal." }, "job_employment_type": { "enum": [ "FULLTIME", "CONTRACTOR", "PARTTIME", "INTERN", "TEMPORARY", "OTHER", null ], "type": "string", "example": "FULLTIME", "nullable": true, "description": "The first entry of `job_employment_types`, for JSearch compatibility. `null` when\nZipRecruiter states no employment type. `INTERN` appears here as a reported value:\nZipRecruiter labels internships on the posting, while its search offers an\n`employment_types` filter without one." }, "ziprecruiter_is_new": { "type": "boolean", "example": null, "nullable": true, "description": "ZipRecruiter's own \"new\" badge on a search card. Search surface only, and `null` when\nthe payload carries no badge." }, "job_benefits_strings": { "type": "array", "items": { "type": "string" }, "example": [ "Medical", "Dental", "Vision", "Life", "Retirement", "PTO" ], "nullable": true, "description": "ZipRecruiter's own benefit labels, split out of its single comma-joined display string.\nSame 44% fill as `job_benefits`; `null` when none are stated." }, "job_employment_types": { "type": "array", "items": { "enum": [ "FULLTIME", "CONTRACTOR", "PARTTIME", "INTERN", "TEMPORARY", "OTHER" ], "type": "string" }, "example": [ "FULLTIME" ], "description": "Every employment type stated on the posting, in JSearch's documented order so two\nidentically tagged jobs always serialise the same way. An empty array when\nZipRecruiter states none. `INTERN` is a reported value here; ZipRecruiter's search\noffers an `employment_types` filter without one." }, "ziprecruiter_share_url": { "type": "string", "format": "uri", "example": "https://www.ziprecruiter.com/job-redirect/share?match_token=CqABChZubDRwVEpHZHBvb2lIeGYxVXE1WFJ3", "nullable": true, "description": "ZipRecruiter's own short share link for the posting." }, "job_posted_at_timestamp": { "type": "integer", "example": 1788992809, "nullable": true, "description": "Unix timestamp in seconds of the publication date. 100% fill." }, "ziprecruiter_apply_host": { "type": "string", "example": "dsp.prng.co", "nullable": true, "description": "The hostname behind ZipRecruiter's external apply redirect, decoded. Provenance only:\nit is frequently an ad network relay. Use `job_apply_link` to apply." }, "ziprecruiter_apply_type": { "enum": [ "OPEN_APPLY_FLOW", "OPEN_EXTERNAL", null ], "type": "string", "example": "OPEN_EXTERNAL", "nullable": true, "description": "How applying works. `OPEN_APPLY_FLOW` is ZipApply, applied on ZipRecruiter itself;\n`OPEN_EXTERNAL` leaves for a third-party destination. This is the apply signal to read." }, "ziprecruiter_company_hq": { "type": "string", "example": "McLean, VA, US", "nullable": true, "description": "The company's headquarters location from ZipRecruiter's company widget. Detail surface\nonly, 54% fill." }, "ziprecruiter_company_id": { "type": "string", "example": "LvOba8F2oEpGlw2IxG/RnmjRZMM=", "nullable": true, "description": "ZipRecruiter's internal company identifier, an opaque base64 blob, stringified like\nevery other id in this response." }, "ziprecruiter_updated_at": { "type": "string", "example": "2026-09-14T04:20:33.688364560Z", "nullable": true, "description": "When ZipRecruiter last refreshed the listing, distinct from the publication date. Search\nsurface only: `null` on `/job-details`. Nanosecond precision, as ZipRecruiter publishes\nit." }, "ziprecruiter_listing_key": { "type": "string", "example": "nl4pTJGdpooiHxf1Uq5XRw", "nullable": true, "description": "ZipRecruiter's internal listing key. Useful for diffing payloads, but NOT an identity:\nthe same job can carry different keys on different surfaces. Use `job_id` or `job_uid`." }, "ziprecruiter_location_id": { "type": "string", "example": "0a070499-f1f0-42d9-940e-76c39915e34a", "nullable": true, "description": "ZipRecruiter's internal identifier for the location." }, "ziprecruiter_company_size": { "type": "string", "example": "10000+ Employees", "nullable": true, "description": "Employee headcount band from ZipRecruiter's company widget, for example\n`1001 - 5000 Employees`. Detail surface only, 54% fill." }, "ziprecruiter_company_slug": { "type": "string", "example": "capital one", "nullable": true, "description": "ZipRecruiter's canonical display name for the company. A display label only: scope a\nsearch to this employer with `ziprecruiter_company_id`." }, "ziprecruiter_employer_faq": { "type": "array", "items": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_24e03882eaa99c44_ref4" }, "nullable": true, "description": "ZipRecruiter's generated FAQ for the posting. Detail surface only. Despite the contract\nname, most entries are about the ROLE; some are Breakroom survey findings about the\nemployer." }, "ziprecruiter_job_industry": { "type": "string", "example": "Technology", "nullable": true, "description": "The industry ZipRecruiter assigns to this JOB. From JSON-LD, so detail surface only and\ncapped at 73%." }, "job_posted_at_datetime_utc": { "type": "string", "format": "date-time", "example": "2026-09-09T22:26:49.000Z", "nullable": true, "description": "ISO 8601 UTC form of `job_posted_at_timestamp`." }, "ziprecruiter_location_type": { "enum": [ "LOCATION_TYPE_NAME_IN_PERSON", "LOCATION_TYPE_NAME_REMOTE", "LOCATION_TYPE_NAME_REMOTE_OPTIONAL", "LOCATION_TYPE_NAME_HYBRID", null ], "type": "string", "example": "LOCATION_TYPE_NAME_IN_PERSON", "nullable": true, "description": "ZipRecruiter's own workplace-type enum, passed through verbatim. 100% fill, and the\nsource `job_is_remote` is derived from." }, "ziprecruiter_salary_source": { "enum": [ "SOURCE_PROVIDED", "SOURCE_PARSED", "SOURCE_PREDICTED", "SOURCE_MISSING", null ], "type": "string", "example": "SOURCE_PREDICTED", "nullable": true, "description": "Where ZipRecruiter's pay figure came from. Always published, even when the salary\nfields are `null`, so a caller can see WHY a job has no salary: `SOURCE_MISSING` means\nthe employer stated no pay and ZipRecruiter modelled and then hid a figure, which this\nAPI suppresses." }, "ziprecruiter_valid_through": { "type": "string", "example": "2026-10-14", "nullable": true, "description": "The date the posting expires, as ZipRecruiter states it in JSON-LD. Detail surface\nonly, capped at 73%." }, "ziprecruiter_ats_identifier": { "type": "string", "example": "R1000242", "nullable": true, "description": "The employer's own requisition reference, from the posting's JSON-LD identifier. Detail\nsurface only, and present on 40 of the 43 measured pages that carry JSON-LD at all." }, "ziprecruiter_location_county": { "type": "string", "example": "New York", "nullable": true, "description": "County or equivalent administrative area for the job location." }, "ziprecruiter_description_html": { "type": "string", "example": "Senior AI Engineer (AI Foundations)

Overview:

At Capital One, we are creating responsible ...

", "nullable": true, "description": "The job description with ZipRecruiter's original HTML markup preserved, for callers who\nwant the formatting. Detail surface only, 100% fill there." }, "ziprecruiter_canonical_job_url": { "type": "string", "format": "uri", "example": "https://www.ziprecruiter.com/c/Capital-One/Job/Senior-AI-Engineer-(AI-Foundations)/-in-Manhattan,NY?jid=936215cb503d8be2", "nullable": true, "description": "The canonical ZipRecruiter posting URL. Identical to `job_apply_link`, exposed under\nits own name so the ZipRecruiter extras stand on their own." }, "ziprecruiter_short_description": { "type": "string", "example": "Senior AI Engineer (AI Foundations) Overview: At Capital One, we are creating responsible and reliable AI systems, changing banking for good.", "nullable": true, "description": "The roughly 200-character teaser a ZipRecruiter search card carries. Card surface\nonly: always `null` on `/job-details`, where the full `job_description` is present\ninstead. Passed through verbatim, so unlike `job_description` it can carry\nZipRecruiter's own `` search-highlight markup and undecoded HTML entities; strip or\ndecode it before display." }, "ziprecruiter_company_industries": { "type": "array", "items": { "type": "string" }, "example": [ "Funds, Trusts and Financial Programs", "Real Estate" ], "nullable": true, "description": "Industries ZipRecruiter assigns to the COMPANY, distinct from the job's own industry.\nDetail surface only; `null` when the widget lists none." }, "ziprecruiter_salary_is_estimated": { "type": "boolean", "example": true, "nullable": true, "description": "Whether ZipRecruiter labels the displayed pay as an estimate. `null` when there is no\ndisplayed pay to label." }, "ziprecruiter_key_responsibilities": { "type": "array", "items": { "type": "string" }, "example": null, "nullable": true, "description": "ZipRecruiter's machine-extracted responsibility summaries, rewritten from the posting.\nDetail surface only, present on roughly a third of detail pages; also merged into\n`job_highlights.Responsibilities`." }, "ziprecruiter_location_postal_code": { "type": "string", "example": "10012", "nullable": true, "description": "Postal or ZIP code, as a string so leading zeros survive." } }, "description": "A ZipRecruiter job posting. A superset of the 35-key JSearch `/search` contract, whose keys\ncome first in contract order, followed by 25 `ziprecruiter_*` extras, for 60 keys in total.\nEvery key is always present, `null` / `[]` / `{}` where ZipRecruiter has no value, so a\nconsumer gets the same set of keys on every job. The `fields` projection narrows it,\nreturning exactly the keys asked for plus `job_id` and `job_title`.\n\nFields marked \"detail surface only\" are `null` on a `/search` response unless\n`include_details=true`, and are filled on `/job-details`." }, "sds_L_Fsr74jXxRwFrRFUiukT_24e03882eaa99c44_ref2": { "type": "object", "required": [ "publisher", "apply_link", "is_direct" ], "properties": { "is_direct": { "type": "boolean", "example": false, "description": "Always `false`. The destination is ZipRecruiter itself or an ad network relay." }, "publisher": { "type": "string", "example": "ZipRecruiter", "description": "Always `ZipRecruiter`; every row on this surface is a ZipRecruiter listing." }, "apply_link": { "type": "string", "format": "uri", "example": "https://www.ziprecruiter.com/c/Capital-One/Job/Senior-AI-Engineer-(AI-Foundations)/-in-Manhattan,NY?jid=936215cb503d8be2", "description": "The canonical ZipRecruiter posting URL, identical to `job_apply_link`." } }, "description": "One way to apply to this job. ZipRecruiter exposes exactly one, its own posting page, so\nthis array has either one entry or none." }, "sds_L_Fsr74jXxRwFrRFUiukT_24e03882eaa99c44_ref3": { "type": "object", "required": [ "publisher", "employer_name", "score", "num_stars", "review_count", "max_score", "reviews_link" ], "properties": { "score": { "type": "number", "example": 7.76, "description": "The rating, on the `max_score` scale, rounded to 2 decimals." }, "max_score": { "type": "integer", "example": 10, "description": "The top of the scale. `10` for Breakroom." }, "num_stars": { "type": "integer", "example": 8, "description": "`score` rounded to the nearest whole number, on the same scale as `max_score`." }, "publisher": { "type": "string", "example": "Breakroom", "description": "Who published the rating. `Breakroom` on every sample measured." }, "review_count": { "type": "integer", "example": 148, "nullable": true, "description": "How many responses the rating is based on." }, "reviews_link": { "type": "string", "format": "uri", "example": "https://breakroom.cc/companies/capital-one", "nullable": true, "description": "The Breakroom company page the rating comes from." }, "employer_name": { "type": "string", "example": "Capital One", "nullable": true, "description": "The employer the rating is about, as the rating source names it." } }, "description": "One employer rating, published by Breakroom. Note the scale: `max_score` is 10, and the\nscore is carried on that scale unchanged." }, "sds_L_Fsr74jXxRwFrRFUiukT_24e03882eaa99c44_ref4": { "type": "object", "required": [ "question", "answer" ], "properties": { "answer": { "type": "string", "example": "Key technical skills include expertise in programming languages such as Java, Python, or C++.", "nullable": true, "description": "The answer, verbatim. May contain inline HTML where ZipRecruiter published it." }, "question": { "type": "string", "example": "What skills or qualities help someone succeed as a Senior Software Engineer?", "nullable": true, "description": "The question, verbatim." } }, "description": "One generated FAQ entry. ZipRecruiter writes these about the ROLE, so most answers\ndescribe the occupation; a few are Breakroom survey findings about the employer." }, "sds_L_Fsr74jXxRwFrRFUiukT_24e03882eaa99c44_ref5": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_24e03882eaa99c44_ref6" } } }, "description": "Invalid or missing parameter." }, "sds_L_Fsr74jXxRwFrRFUiukT_24e03882eaa99c44_ref6": { "type": "object", "required": [ "status", "request_id", "error" ], "properties": { "error": { "type": "object", "required": [ "message", "code" ], "properties": { "code": { "type": "integer", "example": 400, "description": "HTTP status code, repeated in the body." }, "message": { "type": "string", "example": "The 'query' parameter is required.", "description": "Human-readable explanation, naming the parameter and the allowed values." } }, "description": "What went wrong." }, "status": { "enum": [ "ERROR" ], "type": "string", "description": "Always `ERROR` on a failed request." }, "request_id": { "type": "string", "example": "35dabdcd-b334-4600-afbc-d654b8af91cf", "description": "Unique id for this request, useful when contacting support." } } }, "sds_L_Fsr74jXxRwFrRFUiukT_24e03882eaa99c44_ref7": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_24e03882eaa99c44_ref6" } } }, "description": "Missing or invalid credentials." }, "sds_L_Fsr74jXxRwFrRFUiukT_24e03882eaa99c44_ref8": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_24e03882eaa99c44_ref6" } } }, "description": "Not subscribed to this API." }, "sds_L_Fsr74jXxRwFrRFUiukT_24e03882eaa99c44_ref9": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_24e03882eaa99c44_ref6" } } }, "description": "The requested resource does not exist. On `/search` this is an unrecognised `company_id`,\nand on `/estimated-salary` a job title, or a title and state pair, outside ZipRecruiter's\nsalary pages." }, "sds_L_Fsr74jXxRwFrRFUiukT_24e03882eaa99c44_ref10": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_24e03882eaa99c44_ref6" } } }, "description": "Quota exhausted or rate limit hit." }, "sds_L_Fsr74jXxRwFrRFUiukT_24e03882eaa99c44_ref11": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_24e03882eaa99c44_ref6" } } }, "description": "Unexpected error." }, "sds_L_Fsr74jXxRwFrRFUiukT_24e03882eaa99c44_ref12": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_24e03882eaa99c44_ref6" } } }, "description": "ZipRecruiter was temporarily unreachable after the full proxy ladder was exhausted. A 503\nmeans the page could not be read, where an empty result set means the search ran and\nmatched nothing. Safe to retry." } } }, "paths": { "/ai-overviews/ai-overviews": { "get": { "summary": "AI Overviews", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "search_returned_ai_overviews": { "type": "boolean", "description": "Indicates if AI Overviews were returned in the search results" } } }, "status": { "type": "string", "description": "The status of the API response" }, "request_id": { "type": "string", "description": "A unique identifier for the API request" } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "q", "schema": { "type": "string" }, "example": "How to approach solving a hard math problem?", "required": true, "description": "Search query." }, { "in": "query", "name": "location", "schema": { "type": "string" }, "description": "Where you want the search to originate from. \n It is recommended to specify location at the city level in order to simulate a real user’s search (e.g. London, England, United Kingdom)." }, { "in": "query", "name": "gl", "schema": { "type": "string", "default": "us" }, "description": "The country / region for which to make the query. 2-letter country code, see ISO 3166-1 alpha-2." }, { "in": "query", "name": "hl", "schema": { "type": "string", "default": "en" }, "description": "The language to use for the search (Google's hl parameter). 2-letter country code, see ISO 639-1 alpha-2." } ], "description": "Get Google Search AI Overviews, including text parts (paragraphs and lists) and reference links. Pulled in real-time from Google Search.", "operationId": "ai_overviews__get__ai_overviews", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_t1I2lol_F5DgGpe13n3Xt", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_OBuPoRSMenxSJ1CM3zwbN" } ], "x-zeroclick-services": [ "ai-overviews" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "ai-overviews", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "ai-overviews", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/chatgpt/chat": { "post": { "summary": "Chat", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "request_id", "data" ], "properties": { "data": { "type": "object", "properties": { "html": { "type": "string", "nullable": true, "description": "The raw HTML of the ChatGPT page with the answer, without any parsing (only with return_raw_html=true)." }, "reply_text": { "type": "string", "description": "The ChatGPT reply, formatted as markdown when markdown=true (default), otherwise plain text." }, "html_length": { "type": "integer", "nullable": true, "description": "Length of html in characters (only with return_raw_html=true)." }, "content_references": { "type": "object", "properties": { "videos": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Video platform ID (e.g. YouTube video id)." }, "title": { "type": "string", "description": "Title of the video." }, "source": { "type": "string", "description": "Source platform of the video (e.g. youtube)." }, "end_idx": { "type": "integer", "description": "End character offset of the reference inside reply_text." }, "start_idx": { "type": "integer", "description": "Start character offset of the reference inside reply_text." }, "video_url": { "type": "string", "description": "Canonical URL of the video." }, "thumbnail_url": { "type": "string", "nullable": true, "description": "URL of the video thumbnail image." } } }, "description": "Videos referenced in the reply." }, "sources": { "type": "array", "items": { "type": "object", "properties": { "end_idx": { "type": "integer", "description": "End character offset of the reference inside reply_text." }, "sources": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string", "description": "Canonical URL of the source." }, "title": { "type": "string", "description": "Title of the source." }, "source": { "type": "string", "description": "Source/publisher name." }, "snippet": { "type": "string", "nullable": true, "description": "Short excerpt from the source, when available." }, "pub_date": { "type": "string", "nullable": true, "description": "Publication date of the source (ISO 8601), when known." } } }, "description": "Individual sources in this aggregation." }, "start_idx": { "type": "integer", "description": "Start character offset of the reference inside reply_text." } } }, "description": "Aggregated source citations referenced in the reply." }, "link_groups": { "type": "array", "items": { "type": "object", "properties": { "links": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string", "description": "Canonical URL of the linked page." }, "title": { "type": "string", "description": "Title of the linked page." }, "source": { "type": "string", "description": "Source/publisher name of the linked page." }, "snippet": { "type": "string", "nullable": true, "description": "Short excerpt from the linked page." }, "pub_date": { "type": "string", "nullable": true, "description": "Publication date of the linked source (ISO 8601), when known." } } }, "description": "Links in this group." }, "end_idx": { "type": "integer", "description": "End character offset of the reference inside reply_text." }, "start_idx": { "type": "integer", "description": "Start character offset of the reference inside reply_text." } } }, "description": "Groups of links referenced inline in the reply." }, "link_titles": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string", "description": "Canonical URL of the link." }, "title": { "type": "string", "description": "Display title of the link." }, "end_idx": { "type": "integer", "description": "End character offset of the reference inside reply_text." }, "start_idx": { "type": "integer", "description": "Start character offset of the reference inside reply_text." } } }, "description": "Standalone titled links referenced in the reply." }, "image_groups": { "type": "array", "items": { "type": "object", "properties": { "title": { "type": "string", "nullable": true, "description": "Title of the image group." }, "images": { "type": "array", "items": { "type": "object", "properties": { "image_url": { "type": "string", "description": "Direct URL to the image." }, "source_url": { "type": "string", "description": "URL of the page where the image originates." }, "thumbnail_url": { "type": "string", "description": "URL to the image thumbnail." } } }, "description": "Individual images in the group." }, "layout": { "type": "string", "description": "Recommended display layout. Values: carousel, grid." }, "end_idx": { "type": "integer", "description": "End character offset of the reference inside reply_text." }, "start_idx": { "type": "integer", "description": "Start character offset of the reference inside reply_text." }, "image_size": { "type": "string", "nullable": true, "description": "Reported image size (e.g. 'small', 'large')." }, "aspect_ratio": { "type": "string", "description": "Aspect ratio of the images in the group." }, "thumbnail_size": { "type": "string", "nullable": true, "description": "Reported thumbnail size." }, "thumbnail_crop_info": { "type": "object", "nullable": true, "description": "Crop metadata for the thumbnail, when provided upstream." } } }, "description": "Groups of images referenced in the reply." } }, "description": "Structured content references (videos, images, links, sources) cited inline in reply_text. Each entry includes start_idx/end_idx pointing back into the text." } }, "description": "With return_raw_html=true, data holds only html_length and html. Otherwise it holds the parsed answer." }, "status": { "type": "string", "description": "The status of the API response." }, "request_id": { "type": "string", "description": "A unique ID to trace the API request." } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "description": "Chat with OpenAI ChatGPT with support for continuous conversation and markdown/plain-text.", "operationId": "chatgpt__post__chat", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "query": { "type": "string" }, "message": { "type": "string", "example": "Hello", "description": "Message to send to ChatGPT." }, "markdown": { "type": "boolean", "default": true, "description": "Whether to return the ChatGPT response message in markdown format. By default, the bot reply is in markdown format.\n" }, "web_search": { "type": "boolean", "default": false, "description": "Whether to enable ChatGPT Web Search, so the answer is grounded in live web results with citations (false by default)." }, "return_raw_html": { "type": "boolean", "default": false, "description": "Whether to return the raw HTML of the ChatGPT page with the answer, without any parsing, as data.html with its length in data.html_length (false by default). The response data then holds only those two fields." } } }, "example": { "message": "Hello", "markdown": true, "web_search": false, "return_raw_html": false } } } }, "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing request body schema details" ], "pages": [ 1 ], "sourceId": "sds_0prF_Y5BkmqQXtEQyheXN", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/required" ], "revisionId": "sdrn_Z5rvTt1qYfVU6DSLLxPnI" }, { "gaps": [ "Missing request body details" ], "pages": [ 1 ], "sourceId": "sds_1IfgtOxqP1q4cHvJ7VyPY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/required" ], "revisionId": "sdrn_mb4oPKVX4C1sgk5EHzdxz" }, { "gaps": [ "Missing request body schema details." ], "pages": [], "sourceId": "sds_2Dc9eyhO3NLPUm0GEbTiV", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/required" ], "revisionId": "sdrn_Z1eLurdzog7OgIWS9gcdZ" }, { "gaps": [ "Missing request body schema properties and response schema details." ], "pages": [], "sourceId": "sds_2EOeqrIsWKjYBjoNIGwV0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/required" ], "revisionId": "sdrn_ds2DI_Xad11MCFdnoGvH0" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_5hlhZJYspBPaHxKN7OhqJ", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/required" ], "revisionId": "sdrn_3lrPg3Nc0kbMzAAAdVFHe" }, { "gaps": [ "Missing parameter details for message" ], "pages": [ 1 ], "sourceId": "sds_AF8bRESy69frdnjtCAF2z", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/required" ], "revisionId": "sdrn_nUAt1Ad8MTY5qaVlNUqO9" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_BowKpX7oIEvSZAa5G-8Cj", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description" ], "revisionId": "sdrn_AlkJCvRexbLp1t3wre1uD" }, { "gaps": [ "Missing request body schema and response schema" ], "pages": [ 1 ], "sourceId": "sds_bygUmn2K86zcEr8uYnytH", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/required" ], "revisionId": "sdrn_lRwIurwEjFC6EgANnKCbC" }, { "gaps": [ "Missing request parameters schema details" ], "pages": [ 1 ], "sourceId": "sds_FK2maa1cDe4qcElj5U3zU", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/required" ], "revisionId": "sdrn_gZ-rMsS0AnYbgxe2iW2Nm" }, { "gaps": [ "Missing request body schema and response schema" ], "pages": [ 1 ], "sourceId": "sds_fZv-ITvZDV87-KqyW2hgn", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/required" ], "revisionId": "sdrn_aohUeFTorAhUkoXJ0nrWa" }, { "gaps": [ "Missing request body schema and response schema" ], "pages": [ 1 ], "sourceId": "sds_jRl0O0t2JNWjX4MjQ_kC5", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/required" ], "revisionId": "sdrn_0KHmU6zKJBn3JfGQhhbYP" }, { "gaps": [ "Missing request body schema and response schema" ], "pages": [ 1 ], "sourceId": "sds_MAxJPNBPJFwSKQLj1M1dr", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/required" ], "revisionId": "sdrn_QFW9HQumx231aOJCusPx0" }, { "gaps": [ "Missing explicit request body schema in documentation" ], "pages": [], "sourceId": "sds_MV8gWtP36-RZn0HelHkbq", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/required" ], "revisionId": "sdrn_zsd2yxhBG769IpVFIUWRc" }, { "gaps": [ "Missing full request body schema" ], "pages": [ 1 ], "sourceId": "sds_QIFfeTcLDOFoTiC9diV0b", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/required", "/requestBody/required" ], "revisionId": "sdrn_1pOKvi_ZPvz0xrF_bUbDr" }, { "gaps": [ "Missing response schema details" ], "pages": [ 1 ], "sourceId": "sds_soxpzUWt2CLoTKLGBZfNb", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/required" ], "revisionId": "sdrn_3H-1br_3SJ3ASZfGOL5Yr" }, { "gaps": [ "Missing parameters, request body schema details, and response schema details." ], "pages": [], "sourceId": "sds_SWPCFBdhQTXC3OrJ98RML", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/required" ], "revisionId": "sdrn_bk6BUY0JsF4ImDRAT3nR8" }, { "gaps": [ "Missing schema details" ], "pages": [ 1 ], "sourceId": "sds_t1I2lol_F5DgGpe13n3Xt", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/required" ], "revisionId": "sdrn_OBuPoRSMenxSJ1CM3zwbN" }, { "gaps": [ "Missing schema definition for response body" ], "pages": [ 1 ], "sourceId": "sds_vaNNaw5q29aKLh-qRSfR0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/required" ], "revisionId": "sdrn_SrJ_OL_N_pZ70W8niC6g0" }, { "gaps": [ "Missing request body schema" ], "pages": [], "sourceId": "sds_vdxxiVsx4OKV5vH7hrhwb", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_46RDkwnCaOF5IxAFfXTW0" }, { "gaps": [ "Missing request body fields and response schema details." ], "pages": [], "sourceId": "sds_x7ttfFTcDVeDC-z6q5Fme", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/required", "/requestBody/required" ], "revisionId": "sdrn_CYVDOGPj9Fd8EmU6tGOk8" }, { "gaps": [ "Missing request body schema" ], "pages": [ 1 ], "sourceId": "sds_ZS-xdAQ0s8auc1LcI7Ooo", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_7knEBvR-UUuEvVL1C_QLq" } ], "x-zeroclick-services": [ "chatgpt" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.050000" }, "rates": [ { "service": "chatgpt", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.050000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "chatgpt", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/copilot/copilot": { "post": { "summary": "Copilot", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "request_id", "data" ], "properties": { "data": { "type": "object", "required": [ "message", "citations", "conversation_id" ], "properties": { "message": { "type": "string", "description": "The Copilot reply text." }, "citations": { "type": "array", "items": { "type": "object", "required": [ "title", "url", "publisher" ], "properties": { "url": { "type": "string", "description": "Canonical URL of the cited source." }, "title": { "type": "string", "description": "Title of the cited source." }, "icon_url": { "type": "string", "nullable": true, "description": "Relative URL for the publisher icon." }, "publisher": { "type": "string", "description": "Publisher name of the cited source." } } }, "description": "Source citations referenced in the reply." }, "conversation_id": { "type": "string", "description": "ID used to continue the conversation in a follow-up request." } } }, "status": { "type": "string", "description": "The status of the API response." }, "request_id": { "type": "string", "description": "A unique ID to trace the API request." } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "description": "Chat with Copilot with web access and continuous conversation support. Answers are localized to the requested country (country parameter, default us).", "operationId": "copilot__post__copilot", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "mode": { "type": "string", "example": "CHAT", "description": "Use normal chat mode (i.e. CHAT), reasoning mode (i.e. REASONING), or smart mode with OpenAI's latest model (SMART)." }, "query": { "type": "string" }, "country": { "type": "string", "example": "us", "description": "Country to answer from, as a 2-letter ISO 3166-1 alpha-2 code (e.g. us, gb, de). Copilot localizes its answer (local businesses, prices, regulations) to this country. Default: us." }, "message": { "type": "string", "example": "Hello", "description": "Message to send to Copilot." }, "markdown": { "type": "boolean", "example": true, "description": "Whether to return the Copilot response message in markdown format. By default, the bot reply is in plain text." }, "conversation_id": { "type": "string", "example": "BEo5jhxYmas6nphKeTbyL", "description": "Conversation id. In case not supplied, a new conversation will be created and conversation_id will be returned by the endpoint." } } }, "example": { "mode": "CHAT", "country": "us", "message": "Hello", "markdown": true, "conversation_id": "BEo5jhxYmas6nphKeTbyL" } } } }, "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing request body schema details" ], "pages": [ 1 ], "sourceId": "sds_0prF_Y5BkmqQXtEQyheXN", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/required" ], "revisionId": "sdrn_Z5rvTt1qYfVU6DSLLxPnI" }, { "gaps": [ "Missing request body details" ], "pages": [ 1 ], "sourceId": "sds_1IfgtOxqP1q4cHvJ7VyPY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/required", "/requestBody/required" ], "revisionId": "sdrn_mb4oPKVX4C1sgk5EHzdxz" }, { "gaps": [ "Missing request body schema details." ], "pages": [], "sourceId": "sds_2Dc9eyhO3NLPUm0GEbTiV", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/required" ], "revisionId": "sdrn_Z1eLurdzog7OgIWS9gcdZ" }, { "gaps": [ "Missing request body schema properties and response schema details." ], "pages": [], "sourceId": "sds_2EOeqrIsWKjYBjoNIGwV0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/required" ], "revisionId": "sdrn_ds2DI_Xad11MCFdnoGvH0" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_5hlhZJYspBPaHxKN7OhqJ", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/required", "/requestBody/required" ], "revisionId": "sdrn_3lrPg3Nc0kbMzAAAdVFHe" }, { "gaps": [ "Missing parameter details for message" ], "pages": [ 1 ], "sourceId": "sds_AF8bRESy69frdnjtCAF2z", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/required", "/requestBody/required" ], "revisionId": "sdrn_nUAt1Ad8MTY5qaVlNUqO9" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_BowKpX7oIEvSZAa5G-8Cj", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description" ], "revisionId": "sdrn_AlkJCvRexbLp1t3wre1uD" }, { "gaps": [ "Missing request body schema and response schema" ], "pages": [ 1 ], "sourceId": "sds_bygUmn2K86zcEr8uYnytH", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/required" ], "revisionId": "sdrn_lRwIurwEjFC6EgANnKCbC" }, { "gaps": [ "Missing request parameters schema details" ], "pages": [ 1 ], "sourceId": "sds_FK2maa1cDe4qcElj5U3zU", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/required", "/requestBody/required" ], "revisionId": "sdrn_gZ-rMsS0AnYbgxe2iW2Nm" }, { "gaps": [ "Missing request body schema and response schema" ], "pages": [ 1 ], "sourceId": "sds_fZv-ITvZDV87-KqyW2hgn", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/required" ], "revisionId": "sdrn_aohUeFTorAhUkoXJ0nrWa" }, { "gaps": [ "Missing request body schema and response schema" ], "pages": [ 1 ], "sourceId": "sds_jRl0O0t2JNWjX4MjQ_kC5", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/required" ], "revisionId": "sdrn_0KHmU6zKJBn3JfGQhhbYP" }, { "gaps": [ "Missing request body schema and response schema" ], "pages": [ 1 ], "sourceId": "sds_MAxJPNBPJFwSKQLj1M1dr", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/required" ], "revisionId": "sdrn_QFW9HQumx231aOJCusPx0" }, { "gaps": [ "Missing full request body schema" ], "pages": [ 1 ], "sourceId": "sds_QIFfeTcLDOFoTiC9diV0b", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/required", "/requestBody/required" ], "revisionId": "sdrn_1pOKvi_ZPvz0xrF_bUbDr" }, { "gaps": [ "Missing response schema details" ], "pages": [ 1 ], "sourceId": "sds_soxpzUWt2CLoTKLGBZfNb", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/required", "/requestBody/required" ], "revisionId": "sdrn_3H-1br_3SJ3ASZfGOL5Yr" }, { "gaps": [ "Missing parameters, request body schema details, and response schema details." ], "pages": [], "sourceId": "sds_SWPCFBdhQTXC3OrJ98RML", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/required" ], "revisionId": "sdrn_bk6BUY0JsF4ImDRAT3nR8" }, { "gaps": [ "Missing schema details" ], "pages": [ 1 ], "sourceId": "sds_t1I2lol_F5DgGpe13n3Xt", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/required", "/requestBody/required" ], "revisionId": "sdrn_OBuPoRSMenxSJ1CM3zwbN" }, { "gaps": [ "Missing schema definition for response body" ], "pages": [ 1 ], "sourceId": "sds_vaNNaw5q29aKLh-qRSfR0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/required", "/requestBody/required" ], "revisionId": "sdrn_SrJ_OL_N_pZ70W8niC6g0" }, { "gaps": [ "Missing request body schema" ], "pages": [], "sourceId": "sds_vdxxiVsx4OKV5vH7hrhwb", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_46RDkwnCaOF5IxAFfXTW0" }, { "gaps": [ "Missing request body schema" ], "pages": [ 1 ], "sourceId": "sds_ZS-xdAQ0s8auc1LcI7Ooo", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_7knEBvR-UUuEvVL1C_QLq" } ], "x-zeroclick-services": [ "copilot" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.050000" }, "rates": [ { "service": "copilot", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.050000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "copilot", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/driving-directions/get-directions": { "get": { "summary": "Get Directions", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "origin": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the origin location" }, "address": { "type": "string", "description": "Short address of the origin" }, "latitude": { "type": "number", "description": "Latitude coordinate of the origin" }, "google_id": { "type": "string", "description": "Google Places ID for the origin" }, "longitude": { "type": "number", "description": "Longitude coordinate of the origin" }, "full_address": { "type": "string", "description": "Complete address of the origin" } } }, "best_routes": { "type": "array", "items": { "type": "object", "properties": { "route_name": { "type": "string", "description": "Name or identifier of the route" }, "route_parts": { "type": "array", "items": { "type": "object", "properties": { "summary": { "type": "string", "description": "Brief description of the route part" }, "instructions": { "type": "array", "items": { "type": "object", "properties": { "photo_url": { "type": "string", "description": "URL of an instructional photo" } } } }, "distance_label": { "type": "string", "description": "Human-readable distance for this part" }, "duration_label": { "type": "string", "description": "Human-readable duration for this part" }, "distance_meters": { "type": "integer", "description": "Distance of this route part in meters" }, "duration_seconds": { "type": "integer", "description": "Duration of this route part in seconds" } } } }, "distance_label": { "type": "string", "description": "Human-readable distance description" }, "duration_label": { "type": "string", "description": "Human-readable duration description" }, "distance_meters": { "type": "integer", "description": "Total route distance in meters" }, "duration_seconds": { "type": "integer", "description": "Estimated travel time in seconds" }, "arrival_timestamp": { "type": "integer", "description": "Arrival time as Unix timestamp" }, "departure_timestamp": { "type": "integer", "description": "Departure time as Unix timestamp" }, "arrival_datetime_utc": { "type": "string", "description": "Arrival time in UTC ISO format" }, "max_duration_seconds": { "type": "integer", "description": "Maximum expected travel time in seconds" }, "min_duration_seconds": { "type": "integer", "description": "Minimum expected travel time in seconds" }, "departure_datetime_utc": { "type": "string", "description": "Departure time in UTC ISO format" } } } }, "destination": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the destination location" }, "address": { "type": "string", "description": "Short address of the destination" }, "latitude": { "type": "number", "description": "Latitude coordinate of the destination" }, "google_id": { "type": "string", "description": "Google Places ID for the destination" }, "longitude": { "type": "number", "description": "Longitude coordinate of the destination" }, "full_address": { "type": "string", "description": "Complete address of the destination" } } }, "directions_link": { "type": "string", "description": "URL to view directions on maps" } } }, "status": { "type": "string", "description": "The status of the API response" }, "request_id": { "type": "string", "description": "Unique identifier for the API request" } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "origin", "schema": { "type": "string" }, "example": "Church St & 29th St, San-Francisco, CA, USA", "required": true, "description": "Directions origin / starting point - specified as free-text location query or latitude, longitude pair. \n\n **Examples:** \n `Church St & 29th St, San-Francisco, CA, USA` \n `37.743292, -122.420437`" }, { "in": "query", "name": "destination", "schema": { "type": "string" }, "example": "Sunnyvale, CA, USA", "required": true, "description": "Directions destination - specified as free-text location query or latitude, longitude pair. \n\n **Examples:** \n `145 5th Ave, New York, NY, USA` \n `40.649238, -73.974229`" }, { "in": "query", "name": "departure_time", "schema": { "type": "number", "default": 0 }, "description": "Departure time - specified as a Unix-Timestamp in origin local time. \n\n **Example:** `1665785617`" }, { "in": "query", "name": "arrival_time", "schema": { "type": "number", "default": 0 }, "description": "Arrival time - specified as a Unix-Timestamp in destination local time. \n\n **Example:** `1665752460`" }, { "in": "query", "name": "distance_units", "schema": { "enum": [ "auto", "km", "mi" ], "type": "string", "default": "auto" }, "description": "Set the distance units in the response to Kilometers or Miles. \n The default auto value will use the common distance units used in origin/destination (e.g. Miles in the US, Kilometers in Germany)." }, { "in": "query", "name": "avoid_routes", "schema": { "type": "string" }, "description": "Route types to avoid - specified as a comma delimited list of the following values: `tolls`, `highways`, `ferries`. \n\n **Examples:** \n `ferries,tolls` \n `highways`" }, { "in": "query", "name": "country", "schema": { "type": "string", "default": "US" }, "description": "The country/region to use for the query, specified as a 2-letter country code - see `ISO 3166-1 alpha-2`." }, { "in": "query", "name": "language", "schema": { "type": "string", "default": "EN" }, "description": "The language to use for the query, specified as a 2-letter language code - see `ISO 639-1 alpha-2`." } ], "description": "Get driving directions from an origin to a destination.", "operationId": "driving_directions__get__get_directions", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_t1I2lol_F5DgGpe13n3Xt", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_OBuPoRSMenxSJ1CM3zwbN" } ], "x-zeroclick-services": [ "driving-directions" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "driving-directions", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "driving-directions", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/email-search/search-emails": { "get": { "summary": "Search Emails", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "string" }, "description": "A list of string values returned in the response." }, "status": { "type": "string", "description": "The status of the response." }, "request_id": { "type": "string", "description": "A unique identifier for the request." } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "query", "schema": { "type": "string" }, "example": "Car Dealer California USA", "required": true, "description": "Search query. \n\n **Examples:** \n `Steve Smith San Francisco CA USA` \n `Facebook CEO` \n `Jack blogger New York` \n `Car dealer California USA` " }, { "in": "query", "name": "email_domain", "schema": { "type": "string" }, "example": "gmail.com", "required": true, "description": "Email domain - typically a company domain (e.g. `wsgr.com`) or an email provider domain (e.g. `gmail.com`)." }, { "in": "query", "name": "limit", "schema": { "type": "number", "default": 5000 }, "description": "Maximum number of emails to return.\n \n **Allowed values:** `1-5000`" }, { "in": "query", "name": "domain", "schema": { "type": "string" }, "required": false } ], "description": "Search the web for emails using a query and email domain and get up to 5,000 email addresses.", "operationId": "email_search__get__search_emails", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing explicit parameter definitions in documentation text; inferred from description." ], "pages": [ 1 ], "sourceId": "sds_1IfgtOxqP1q4cHvJ7VyPY", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_mb4oPKVX4C1sgk5EHzdxz" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_t1I2lol_F5DgGpe13n3Xt", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_OBuPoRSMenxSJ1CM3zwbN" } ], "x-zeroclick-services": [ "email-search" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "email-search", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "email-search", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/ev-charge-finder/search-by-coordinates-point": { "get": { "summary": "Search by Coordinates Point", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "required": [ "id", "name", "connectors", "formatted_address", "latitude", "longitude" ], "properties": { "id": { "type": "string", "description": "Unique identifier of the charging station." }, "name": { "type": "string", "description": "Name of the charging station." }, "photo": { "type": "string", "nullable": true, "description": "URL of a representative photo of the station, when available." }, "rating": { "type": "number", "nullable": true, "description": "Average user rating (0–5)." }, "website": { "type": "string", "nullable": true, "description": "Station operator website URL, when known." }, "latitude": { "type": "number", "description": "Latitude of the station in decimal degrees." }, "longitude": { "type": "number", "description": "Longitude of the station in decimal degrees." }, "connectors": { "type": "array", "items": { "type": "object", "required": [ "type", "total", "kw", "speed" ], "properties": { "kw": { "type": "number", "description": "Power output of the connector in kilowatts." }, "type": { "type": "string", "description": "Connector type. Values include: CHAdeMO, CCS, J1772, Tesla, Unknown plug." }, "speed": { "type": "string", "description": "Charging speed category. Values: Very fast, Fast, Medium, Slow." }, "total": { "type": "integer", "description": "Total number of connectors of this type at the station." }, "available": { "type": "integer", "nullable": true, "description": "Number of connectors of this type currently available. Null when live availability is unknown." } } }, "description": "Connectors available at the station with counts, power, and live availability." }, "google_cid": { "type": "string", "nullable": true, "description": "Google customer ID (CID) of the station." }, "place_link": { "type": "string", "nullable": true, "description": "Google Maps link to the station." }, "phone_number": { "type": "string", "nullable": true, "description": "Station phone number in E.164 format, when available." }, "review_count": { "type": "integer", "nullable": true, "description": "Number of user reviews." }, "opening_hours": { "type": "object", "nullable": true, "description": "Opening hours per day of the week. Each value is an array of human-readable hour ranges.", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "google_place_id": { "type": "string", "nullable": true, "description": "Google Place ID of the station." }, "formatted_address": { "type": "string", "description": "Human-readable street address of the station." }, "address_components": { "type": "object", "properties": { "city": { "type": "string", "description": "City name." }, "state": { "type": "string", "description": "State or region." }, "country": { "type": "string", "description": "ISO 3166-1 alpha-2 country code." }, "zipcode": { "type": "string", "description": "Postal/ZIP code." }, "district": { "type": "string", "nullable": true, "description": "District or borough." }, "street_address": { "type": "string", "description": "Street and number." } }, "description": "Parsed components of the station address." } } }, "description": "An array of EV charging stations near the supplied coordinates." }, "status": { "type": "string", "description": "The status of the response" }, "request_id": { "type": "string", "description": "A unique identifier for the request" } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "lat", "schema": { "type": "number" }, "example": "37.359428", "required": true, "description": "Latitude of the geographic coordinates point to search near by." }, { "in": "query", "name": "lng", "schema": { "type": "number" }, "example": "-121.925337", "required": true, "description": "Longitude of the geographic coordinates point to search near by." }, { "in": "query", "name": "type", "schema": { "type": "string" }, "description": "Return EV charging stations with connectors of one or more types, specified as a comma (,) delimited list of connector types to match. \n\n **Examples:** \n `CHAdeMO` \n `J1772,CCS` " }, { "in": "query", "name": "available", "schema": { "type": "string" }, "description": "Find EV charging stations with an available connector." }, { "in": "query", "name": "min_kw", "schema": { "type": "number" }, "description": "Restrict the result to the availability for connectors with a specific minimal value of power in kilowatts (closed interval - with that value)." }, { "in": "query", "name": "max_kw", "schema": { "type": "number" }, "description": "Restrict the result to the availability for connectors with a specific maximum value of power in kilowatts (closed interval - with that value)." }, { "in": "query", "name": "limit", "schema": { "type": "number", "default": 20 }, "description": "Maximum number of results to return.\n \n **Allowed values:** `1-500`" }, { "in": "query", "name": "query", "schema": { "type": "string" }, "description": "Return EV charging stations matching a specific query or keyword. \n\n **Examples:** \n `evgo` \n `tesla` \n `chargepoint` " } ], "description": "Search for EV charging stations near specific geographic coordinates point.", "operationId": "ev_charge_finder__get__search_by_coordinates_point", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_t1I2lol_F5DgGpe13n3Xt", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_OBuPoRSMenxSJ1CM3zwbN" } ], "x-zeroclick-services": [ "ev-charge-finder" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.050000" }, "rates": [ { "service": "ev-charge-finder", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.050000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "ev-charge-finder", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/ev-charge-finder/search-by-location": { "get": { "summary": "Search by Location", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "required": [ "id", "name", "connectors", "formatted_address", "latitude", "longitude" ], "properties": { "id": { "type": "string", "description": "Unique identifier of the charging station." }, "name": { "type": "string", "description": "Name of the charging station." }, "photo": { "type": "string", "nullable": true, "description": "URL of a representative photo of the station, when available." }, "rating": { "type": "number", "nullable": true, "description": "Average user rating (0–5)." }, "website": { "type": "string", "nullable": true, "description": "Station operator website URL, when known." }, "latitude": { "type": "number", "description": "Latitude of the station in decimal degrees." }, "longitude": { "type": "number", "description": "Longitude of the station in decimal degrees." }, "connectors": { "type": "array", "items": { "type": "object", "required": [ "type", "total", "kw", "speed" ], "properties": { "kw": { "type": "number", "description": "Power output of the connector in kilowatts." }, "type": { "type": "string", "description": "Connector type. Values include: CHAdeMO, CCS, J1772, Tesla, Unknown plug." }, "speed": { "type": "string", "description": "Charging speed category. Values: Very fast, Fast, Medium, Slow." }, "total": { "type": "integer", "description": "Total number of connectors of this type at the station." }, "available": { "type": "integer", "nullable": true, "description": "Number of connectors of this type currently available. Null when live availability is unknown." } } }, "description": "Connectors available at the station with counts, power, and live availability." }, "google_cid": { "type": "string", "description": "Google customer ID (CID) of the station." }, "place_link": { "type": "string", "description": "Google Maps link to the station." }, "phone_number": { "type": "string", "nullable": true, "description": "Station phone number in E.164 format, when available." }, "review_count": { "type": "integer", "nullable": true, "description": "Number of user reviews." }, "opening_hours": { "type": "object", "nullable": true, "description": "Opening hours per day of the week. Each value is an array of human-readable hour ranges.", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "google_place_id": { "type": "string", "description": "Google Place ID of the station." }, "formatted_address": { "type": "string", "description": "Human-readable street address of the station." }, "address_components": { "type": "object", "properties": { "city": { "type": "string", "description": "City name." }, "state": { "type": "string", "description": "State or region." }, "country": { "type": "string", "description": "ISO 3166-1 alpha-2 country code." }, "zipcode": { "type": "string", "description": "Postal/ZIP code." }, "district": { "type": "string", "nullable": true, "description": "District or borough." }, "street_address": { "type": "string", "description": "Street and number." } }, "description": "Parsed components of the station address." } } }, "description": "An array of EV charging stations matching the query." }, "status": { "type": "string", "description": "The status of the response" }, "request_id": { "type": "string", "description": "A unique identifier for the request" } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "near", "schema": { "type": "string" }, "example": "San Francisco, CA, USA", "required": true, "description": "Free-form location query to search near by. \n\n **Example:** `San Francisco, CA, USA`" }, { "in": "query", "name": "type", "schema": { "type": "string" }, "description": "Return EV charging stations with connectors of one or more types, specified as a comma (,) delimited list of connector types to match. \n\n **Examples:** \n `CHAdeMO` \n `J1772,CCS` " }, { "in": "query", "name": "available", "schema": { "type": "boolean" }, "description": "If `true`, only returns EV charging stations with at least one available connector. \n Omit this parameter to include all stations regardless of availability." }, { "in": "query", "name": "min_kw", "schema": { "type": "number", "default": 0 }, "description": "Restrict the result to the availability for connectors with a specific minimal value of power in kilowatts (closed interval - with that value)." }, { "in": "query", "name": "max_kw", "schema": { "type": "number", "default": 0 }, "description": "Restrict the result to the availability for connectors with a specific maximum value of power in kilowatts (closed interval - with that value)." }, { "in": "query", "name": "limit", "schema": { "type": "number", "default": 20 }, "description": "Maximum number of results to return.\n \n **Allowed values:** `1-500`" }, { "in": "query", "name": "query", "schema": { "type": "string" }, "description": "Return EV charging stations matching a specific query or keyword. \n\n **Examples:** \n `evgo` \n `tesla` \n `chargepoint` " } ], "description": "Search for EV charging stations near a specific location specified as a free-form location query (e.g. `San Francisco, CA, USA`).", "operationId": "ev_charge_finder__get__search_by_location", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_t1I2lol_F5DgGpe13n3Xt", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_OBuPoRSMenxSJ1CM3zwbN" } ], "x-zeroclick-services": [ "ev-charge-finder" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.050000" }, "rates": [ { "service": "ev-charge-finder", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.050000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "ev-charge-finder", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/gemini/chat": { "post": { "summary": "Chat", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "request_id", "data" ], "properties": { "data": { "type": "object", "required": [ "reply_text", "reference_links", "conversation_id" ], "properties": { "reply_text": { "type": "string", "description": "The Gemini reply text. Returned as markdown when the markdown parameter is true, otherwise as plain text." }, "conversation_id": { "type": "string", "description": "ID used to continue the conversation in a follow-up request." }, "reference_links": { "type": "array", "items": { "type": "object", "properties": { "link": { "type": "string", "description": "URL of the source page." }, "title": { "type": "string", "nullable": true, "description": "Title of the source page." }, "source": { "type": "string", "nullable": true, "description": "Name of the publisher, when Gemini provides one." }, "favicon": { "type": "string", "nullable": true, "description": "URL of the source's favicon." }, "snippet": { "type": "string", "nullable": true, "description": "Excerpt of the source content Gemini cited." } } }, "description": "Web sources Gemini grounded the reply on. Empty when the reply was answered without a web search.\n" } } }, "status": { "type": "string", "description": "The status of the API response." }, "request_id": { "type": "string", "description": "A unique ID to trace the API request." } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "description": "Chat with Google Gemini with web access and continuous conversation support.", "operationId": "gemini__post__chat", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "message" ], "properties": { "query": { "type": "string" }, "message": { "type": "string", "example": "Hello", "description": "Message to send to Google Gemini." }, "markdown": { "type": "boolean", "default": true, "description": "Whether to return the Google Gemini response message in markdown format. By default, the bot reply is in plain text.\n" }, "conversation_id": { "type": "string", "example": null, "description": "Conversation Id. In case not supplied, a new conversation will be created and conversation_id will be returned by the endpoint.\n" } } }, "example": { "message": "Hello", "markdown": true } } } }, "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing request body schema details" ], "pages": [ 1 ], "sourceId": "sds_0prF_Y5BkmqQXtEQyheXN", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/required" ], "revisionId": "sdrn_Z5rvTt1qYfVU6DSLLxPnI" }, { "gaps": [ "Missing request body details" ], "pages": [ 1 ], "sourceId": "sds_1IfgtOxqP1q4cHvJ7VyPY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/required" ], "revisionId": "sdrn_mb4oPKVX4C1sgk5EHzdxz" }, { "gaps": [ "Missing request body schema details." ], "pages": [], "sourceId": "sds_2Dc9eyhO3NLPUm0GEbTiV", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/required" ], "revisionId": "sdrn_Z1eLurdzog7OgIWS9gcdZ" }, { "gaps": [ "Missing request body schema properties and response schema details." ], "pages": [], "sourceId": "sds_2EOeqrIsWKjYBjoNIGwV0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/required" ], "revisionId": "sdrn_ds2DI_Xad11MCFdnoGvH0" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_5hlhZJYspBPaHxKN7OhqJ", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/required" ], "revisionId": "sdrn_3lrPg3Nc0kbMzAAAdVFHe" }, { "gaps": [ "Missing parameter details for message" ], "pages": [ 1 ], "sourceId": "sds_AF8bRESy69frdnjtCAF2z", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/required" ], "revisionId": "sdrn_nUAt1Ad8MTY5qaVlNUqO9" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_BowKpX7oIEvSZAa5G-8Cj", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description" ], "revisionId": "sdrn_AlkJCvRexbLp1t3wre1uD" }, { "gaps": [ "Missing request body schema and response schema" ], "pages": [ 1 ], "sourceId": "sds_bygUmn2K86zcEr8uYnytH", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/required" ], "revisionId": "sdrn_lRwIurwEjFC6EgANnKCbC" }, { "gaps": [ "Missing request parameters schema details" ], "pages": [ 1 ], "sourceId": "sds_FK2maa1cDe4qcElj5U3zU", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/required" ], "revisionId": "sdrn_gZ-rMsS0AnYbgxe2iW2Nm" }, { "gaps": [ "Missing request body schema and response schema" ], "pages": [ 1 ], "sourceId": "sds_fZv-ITvZDV87-KqyW2hgn", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/required" ], "revisionId": "sdrn_aohUeFTorAhUkoXJ0nrWa" }, { "gaps": [ "Missing request body schema and response schema" ], "pages": [ 1 ], "sourceId": "sds_jRl0O0t2JNWjX4MjQ_kC5", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/required" ], "revisionId": "sdrn_0KHmU6zKJBn3JfGQhhbYP" }, { "gaps": [ "Missing request body schema and response schema" ], "pages": [ 1 ], "sourceId": "sds_MAxJPNBPJFwSKQLj1M1dr", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/required" ], "revisionId": "sdrn_QFW9HQumx231aOJCusPx0" }, { "gaps": [ "Missing full request body schema" ], "pages": [ 1 ], "sourceId": "sds_QIFfeTcLDOFoTiC9diV0b", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/required", "/requestBody/required" ], "revisionId": "sdrn_1pOKvi_ZPvz0xrF_bUbDr" }, { "gaps": [ "Missing response schema details" ], "pages": [ 1 ], "sourceId": "sds_soxpzUWt2CLoTKLGBZfNb", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/required" ], "revisionId": "sdrn_3H-1br_3SJ3ASZfGOL5Yr" }, { "gaps": [ "Missing parameters, request body schema details, and response schema details." ], "pages": [], "sourceId": "sds_SWPCFBdhQTXC3OrJ98RML", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/required" ], "revisionId": "sdrn_bk6BUY0JsF4ImDRAT3nR8" }, { "gaps": [ "Missing schema details" ], "pages": [ 1 ], "sourceId": "sds_t1I2lol_F5DgGpe13n3Xt", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/required" ], "revisionId": "sdrn_OBuPoRSMenxSJ1CM3zwbN" }, { "gaps": [ "Missing schema definition for response body" ], "pages": [ 1 ], "sourceId": "sds_vaNNaw5q29aKLh-qRSfR0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/required" ], "revisionId": "sdrn_SrJ_OL_N_pZ70W8niC6g0" }, { "gaps": [ "Missing request body schema" ], "pages": [], "sourceId": "sds_vdxxiVsx4OKV5vH7hrhwb", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_46RDkwnCaOF5IxAFfXTW0" }, { "gaps": [ "Missing request body schema" ], "pages": [ 1 ], "sourceId": "sds_ZS-xdAQ0s8auc1LcI7Ooo", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_7knEBvR-UUuEvVL1C_QLq" } ], "x-zeroclick-services": [ "gemini" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.050000" }, "rates": [ { "service": "gemini", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.050000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "gemini", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/google-ai-mode/ai-mode": { "get": { "summary": "AI Mode", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "raw_html": { "type": "string", "description": "Raw HTML, returned instead of the parsed results (the only data field) when return_raw_html=true. With prompt: the AI Mode answer fragment as streamed by Google. With url: the full rendered AI Mode page with the sources panel expanded." }, "session_token": { "type": "string", "description": "Token used to maintain session context for follow-up interactions" } } }, "status": { "type": "string", "description": "The status of the API response" }, "parameters": { "type": "object", "properties": { "gl": { "type": "string", "description": "Geolocation/country code used for localization" }, "hl": { "type": "string", "description": "Language code used for localization" }, "url": { "type": "string", "description": "The AI Mode URL as received (only for url requests)" }, "uule": { "type": "string", "nullable": true, "description": "Google uule location string as received (only when explicitly passed)." }, "prompt": { "type": "string", "description": "The input prompt provided by the user" }, "location": { "type": "string", "nullable": true, "description": "Search origin location as received (only when explicitly passed)." }, "return_raw_html": { "type": "boolean", "description": "Present (true) when return_raw_html=true was passed" } } }, "request_id": { "type": "string", "description": "A unique identifier for the API request" } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "prompt", "schema": { "type": "string" }, "example": "How to make a pizza step by step?", "required": true, "description": "AI Mode prompt. Required unless url is specified." }, { "in": "query", "name": "session_token", "schema": { "type": "string" }, "description": "Specify a session token from previous AI Mode response to continue the chat from the same point (preserving history in context for continuous conversation)." }, { "in": "query", "name": "location", "schema": { "type": "string" }, "description": "Where the AI Mode search originates from, for location-dependent prompts such as local businesses, weather or events. Recommended to specify at city level to simulate a real user's search (e.g. London, England, United Kingdom). See https://openwebninja.s3.us-east-1.amazonaws.com/locations.json for the list of supported locations. Cannot be combined with uule." }, { "in": "query", "name": "uule", "schema": { "type": "string" }, "description": "Google's own encoded location string (e.g. w+CAIQICIgU2VhdHRsZSxXYXNoaW5ndG9uLFVuaXRlZCBTdGF0ZXM=), passed to Google as is. Use it instead of location when you already generate uule values. Cannot be combined with location." }, { "in": "query", "name": "gl", "schema": { "type": "string", "default": "us" }, "description": "The country / region for which to make the query. 2-letter country code, see ISO 3166-1 alpha-2." }, { "in": "query", "name": "hl", "schema": { "type": "string", "default": "en" }, "description": "The language to use for the search (Google's hl parameter). 2-letter country code, see ISO 639-1 alpha-2." }, { "in": "query", "name": "attachments", "schema": { "type": "string" }, "description": "Optional JSON array of document URLs (PDF) to attach to the prompt, passed as a string, e.g. [\"https://example.com/file.pdf\"]. Up to 5 files, 10 MB each. Images are not supported. Attaching one or more documents is charged a flat 1 extra request credit. For multiple or long URLs use the POST method (no URL length limit)." }, { "in": "query", "name": "url", "schema": { "type": "string" }, "description": "A full Google AI Mode URL to fetch instead of a prompt, e.g. https://www.google.com/search?q=coffee&udm=50. Must be a Google /search URL (google.com or a Google country domain) with udm=50 and a non-empty q. The page is loaded as is, so other Google parameters in it (e.g. uule) apply, and its own gl and hl take precedence over the gl and hl parameters. Cannot be combined with prompt, session_token, location, uule or attachments. A url request is charged 2 request credits. URL-encode it when sent in the query string." }, { "in": "query", "name": "return_raw_html", "schema": { "type": "boolean", "default": false }, "description": "Return the raw HTML (in data.raw_html) instead of the parsed results. With prompt, the HTML of the AI Mode answer. With url, the full rendered AI Mode page, with the sources panel expanded." } ], "description": "Send a prompt/query and get structured results and reference links from Google AI Mode.", "operationId": "google_ai_mode__get__ai_mode", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_t1I2lol_F5DgGpe13n3Xt", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_OBuPoRSMenxSJ1CM3zwbN" } ], "x-zeroclick-services": [ "google-ai-mode" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.050000" }, "rates": [ { "service": "google-ai-mode", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.050000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "google-ai-mode", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] }, "post": { "summary": "AI Mode", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "raw_html": { "type": "string", "description": "Raw HTML, returned instead of the parsed results (the only data field) when return_raw_html=true. With prompt: the AI Mode answer fragment as streamed by Google. With url: the full rendered AI Mode page with the sources panel expanded." }, "session_token": { "type": "string", "description": "Token used to maintain session context for follow-up interactions" } } }, "status": { "type": "string", "description": "The status of the API response" }, "parameters": { "type": "object", "properties": { "gl": { "type": "string", "description": "Geolocation/country code used for localization" }, "hl": { "type": "string", "description": "Language code used for localization" }, "url": { "type": "string", "description": "The AI Mode URL as received (only for url requests)" }, "uule": { "type": "string", "nullable": true, "description": "Google uule location string as received (only when explicitly passed)." }, "prompt": { "type": "string", "description": "The input prompt provided by the user" }, "location": { "type": "string", "nullable": true, "description": "Search origin location as received (only when explicitly passed)." }, "return_raw_html": { "type": "boolean", "description": "Present (true) when return_raw_html=true was passed" } } }, "request_id": { "type": "string", "description": "A unique identifier for the API request" } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "description": "Send a prompt/query and get structured results and reference links from Google AI Mode. POST variant of the AI Mode endpoint - accepts the same parameters in a JSON request body, with no URL length limit (recommended for long prompts).", "operationId": "google_ai_mode__post__ai_mode", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "prompt" ], "properties": { "gl": { "type": "string", "default": "us", "example": "us", "description": "The country / region for which to make the query. 2-letter country code, see ISO 3166-1 alpha-2." }, "hl": { "type": "string", "default": "en", "example": "en", "description": "The language to use for the search (Google's hl parameter). 2-letter country code, see ISO 639-1 alpha-2." }, "tbs": { "type": "string", "nullable": true, "description": "This parameter defines advanced search parameters that aren't available using regular query parameters (to be searched)." }, "url": { "type": "string", "nullable": true, "description": "A full Google AI Mode URL to fetch instead of a prompt, e.g. https://www.google.com/search?q=coffee&udm=50. Must be a Google /search URL (google.com or a Google country domain) with udm=50 and a non-empty q. The page is loaded as is, so other Google parameters in it (e.g. uule) apply, and its own gl and hl take precedence over the gl and hl parameters. Cannot be combined with prompt, session_token, location, uule or attachments. A url request is charged 2 request credits." }, "uule": { "type": "string", "nullable": true, "description": "Google's own encoded location string (e.g. w+CAIQICIgU2VhdHRsZSxXYXNoaW5ndG9uLFVuaXRlZCBTdGF0ZXM=), passed to Google as is. Use it instead of location when you already generate uule values. Cannot be combined with location." }, "query": { "type": "string" }, "prompt": { "type": "string", "example": "How to make a pizza step by step?", "description": "AI Mode prompt." }, "message": { "type": "string" }, "location": { "type": "string", "nullable": true, "description": "Where the AI Mode search originates from, for location-dependent prompts such as local businesses, weather or events. Recommended to specify at city level to simulate a real user's search (e.g. London, England, United Kingdom). See https://openwebninja.s3.us-east-1.amazonaws.com/locations.json for the list of supported locations. Cannot be combined with uule." }, "attachments": { "type": "array", "items": { "type": "string" }, "example": [ "https://pdfobject.com/pdf/sample.pdf" ], "nullable": true, "description": "Optional list of document URLs (PDF) to attach to the prompt, as plain URL strings. Up to 5 files, 10 MB each. Images are not supported. Attaching one or more documents is charged a flat 1 extra request credit." }, "session_token": { "type": "string", "nullable": true, "description": "Specify a session token from previous AI Mode response to continue the chat from the same point (preserving history in context for continuous conversation)." }, "return_raw_html": { "type": "boolean", "default": false, "description": "Return the raw HTML (in data.raw_html) instead of the parsed results. With prompt, the HTML of the AI Mode answer. With url, the full rendered AI Mode page, with the sources panel expanded." } } }, "example": { "gl": "us", "hl": "en", "tbs": null, "uule": null, "prompt": "Summarize the attached document and give its title.", "attachments": [ "https://pdfobject.com/pdf/sample.pdf" ], "session_token": null } } }, "required": true }, "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing request body schema details" ], "pages": [ 1 ], "sourceId": "sds_0prF_Y5BkmqQXtEQyheXN", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/required" ], "revisionId": "sdrn_Z5rvTt1qYfVU6DSLLxPnI" }, { "gaps": [ "Missing request body details" ], "pages": [ 1 ], "sourceId": "sds_1IfgtOxqP1q4cHvJ7VyPY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/required" ], "revisionId": "sdrn_mb4oPKVX4C1sgk5EHzdxz" }, { "gaps": [ "Missing request body schema details." ], "pages": [], "sourceId": "sds_2Dc9eyhO3NLPUm0GEbTiV", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/required" ], "revisionId": "sdrn_Z1eLurdzog7OgIWS9gcdZ" }, { "gaps": [ "Missing request body schema properties and response schema details." ], "pages": [], "sourceId": "sds_2EOeqrIsWKjYBjoNIGwV0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_ds2DI_Xad11MCFdnoGvH0" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_5hlhZJYspBPaHxKN7OhqJ", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/required" ], "revisionId": "sdrn_3lrPg3Nc0kbMzAAAdVFHe" }, { "gaps": [ "Missing parameter details for query" ], "pages": [ 1 ], "sourceId": "sds_AF8bRESy69frdnjtCAF2z", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/required" ], "revisionId": "sdrn_nUAt1Ad8MTY5qaVlNUqO9" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_BowKpX7oIEvSZAa5G-8Cj", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description" ], "revisionId": "sdrn_AlkJCvRexbLp1t3wre1uD" }, { "gaps": [ "Missing request body schema and response schema" ], "pages": [ 1 ], "sourceId": "sds_bygUmn2K86zcEr8uYnytH", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_lRwIurwEjFC6EgANnKCbC" }, { "gaps": [ "Missing request parameters schema details" ], "pages": [ 1 ], "sourceId": "sds_FK2maa1cDe4qcElj5U3zU", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/required" ], "revisionId": "sdrn_gZ-rMsS0AnYbgxe2iW2Nm" }, { "gaps": [ "Missing request body schema and response schema" ], "pages": [ 1 ], "sourceId": "sds_fZv-ITvZDV87-KqyW2hgn", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_aohUeFTorAhUkoXJ0nrWa" }, { "gaps": [ "Missing request body schema and response schema" ], "pages": [ 1 ], "sourceId": "sds_MAxJPNBPJFwSKQLj1M1dr", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/required" ], "revisionId": "sdrn_QFW9HQumx231aOJCusPx0" }, { "gaps": [ "Missing full request body schema" ], "pages": [ 1 ], "sourceId": "sds_QIFfeTcLDOFoTiC9diV0b", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/required" ], "revisionId": "sdrn_1pOKvi_ZPvz0xrF_bUbDr" }, { "gaps": [ "Missing response schema details" ], "pages": [ 1 ], "sourceId": "sds_soxpzUWt2CLoTKLGBZfNb", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/required" ], "revisionId": "sdrn_3H-1br_3SJ3ASZfGOL5Yr" }, { "gaps": [ "Missing parameters, request body schema details, and response schema details." ], "pages": [], "sourceId": "sds_SWPCFBdhQTXC3OrJ98RML", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/required" ], "revisionId": "sdrn_bk6BUY0JsF4ImDRAT3nR8" }, { "gaps": [ "Missing schema details" ], "pages": [ 1 ], "sourceId": "sds_t1I2lol_F5DgGpe13n3Xt", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/required" ], "revisionId": "sdrn_OBuPoRSMenxSJ1CM3zwbN" }, { "gaps": [ "Missing schema definition for response body" ], "pages": [ 1 ], "sourceId": "sds_vaNNaw5q29aKLh-qRSfR0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/required" ], "revisionId": "sdrn_SrJ_OL_N_pZ70W8niC6g0" }, { "gaps": [ "Missing request body schema" ], "pages": [], "sourceId": "sds_vdxxiVsx4OKV5vH7hrhwb", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_46RDkwnCaOF5IxAFfXTW0" }, { "gaps": [ "Missing request body schema" ], "pages": [ 1 ], "sourceId": "sds_ZS-xdAQ0s8auc1LcI7Ooo", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_7knEBvR-UUuEvVL1C_QLq" } ], "x-zeroclick-services": [ "google-ai-mode" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.050000" }, "rates": [ { "service": "google-ai-mode", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.050000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "google-ai-mode", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/google-maps-traffic-alerts/traffic-alerts": { "get": { "summary": "Traffic Alerts", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "request_id", "parameters", "data" ], "properties": { "data": { "type": "object", "required": [ "count", "alerts" ], "properties": { "count": { "type": "integer", "description": "Number of traffic alerts found within the requested area (the length of the alerts array)." }, "alerts": { "type": "array", "items": { "type": "object", "required": [ "type", "latitude", "longitude" ], "properties": { "type": { "type": "string", "description": "Incident type. Values: road_closed, construction, accident, incident (generic incident when a more specific type cannot be determined)." }, "latitude": { "type": "number", "description": "Latitude of the incident location." }, "longitude": { "type": "number", "description": "Longitude of the incident location." } } }, "description": "The traffic incidents detected within the requested area." } }, "description": "The traffic alerts found within the requested area." }, "status": { "type": "string", "description": "The status of the API response." }, "parameters": { "type": "object", "required": [ "zoom" ], "properties": { "zoom": { "type": "integer", "description": "Google Maps zoom level used for the scan." }, "top_right": { "type": "string", "description": "Top-right (north-east) corner of the scanned area, as received." }, "bottom_left": { "type": "string", "description": "Bottom-left (south-west) corner of the scanned area, as received." } }, "description": "The parameters the API received and used for this request, echoed back." }, "request_id": { "type": "string", "description": "A unique ID to trace the API request." } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "bottom_left", "schema": { "type": "string" }, "example": "40.63,-74.10", "required": true, "description": "Bottom-left (south-west) corner of the area to scan, as `latitude,longitude`. The total box area is capped per `zoom` level (see the `zoom` parameter).\n\n **Example:** `40.63,-74.10`" }, { "in": "query", "name": "top_right", "schema": { "type": "string" }, "example": "40.81,-73.87", "required": true, "description": "Top-right (north-east) corner of the area to scan, as `latitude,longitude`. The total box area is capped per `zoom` level (see the `zoom` parameter).\n\n **Example:** `40.81,-73.87`" }, { "in": "query", "name": "zoom", "schema": { "type": "integer", "default": 13, "maximum": 16, "minimum": 11 }, "description": "Google Maps zoom level for the scan - the same zoom value Google Maps uses (higher is more zoomed in, returning finer detail over a smaller maximum area). Each zoom level has a maximum bounding-box area; to cover a larger area, use a lower zoom level.\n\n **Allowed values:** `11-16`\n\n **Maximum area per zoom:**\n\n - zoom 11: 8000 km²\n - zoom 12: 2000 km²\n - zoom 13: 500 km² (default)\n - zoom 14: 125 km²\n - zoom 15: 30 km²\n - zoom 16: 8 km²\n\n **Default:** `13`" } ], "description": "Returns live traffic incidents (accidents, construction zones, road closures, and other slowdowns) within the bounding box defined by two corner coordinates. Each alert includes its incident type and precise latitude/longitude.\n\nThe bounding box area is capped per `zoom` level (higher zoom returns finer detail over a smaller maximum area). To scan a larger area, use a lower zoom level.", "operationId": "google_maps_traffic_alerts__get__traffic_alerts", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_t1I2lol_F5DgGpe13n3Xt", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_OBuPoRSMenxSJ1CM3zwbN" } ], "x-zeroclick-services": [ "google-maps-traffic-alerts" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "google-maps-traffic-alerts", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "google-maps-traffic-alerts", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/job-salary-data/company-job-salary": { "get": { "summary": "Company Job Salary", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "company": { "type": "string", "description": "The name of the company offering the job" }, "location": { "type": "string", "description": "The location of the job" }, "job_title": { "type": "string", "description": "The title of the job position" }, "confidence": { "type": "string", "description": "The confidence level of the salary estimate" }, "max_salary": { "type": "number", "description": "The maximum salary for the job" }, "min_salary": { "type": "number", "description": "The minimum salary for the job" }, "salary_count": { "type": "integer", "description": "The number of salary data points used for estimation" }, "median_salary": { "type": "number", "description": "The median salary for the job" }, "salary_period": { "type": "string", "description": "The period for which the salary is calculated" }, "max_base_salary": { "type": "number", "description": "The maximum base salary for the job" }, "min_base_salary": { "type": "number", "description": "The minimum base salary for the job" }, "salary_currency": { "type": "string", "description": "The currency in which the salary is paid" }, "max_additional_pay": { "type": "number", "description": "The maximum additional pay such as bonuses" }, "median_base_salary": { "type": "number", "description": "The median base salary for the job" }, "min_additional_pay": { "type": "number", "description": "The minimum additional pay such as bonuses" }, "median_additional_pay": { "type": "number", "description": "The median additional pay such as bonuses" } } } }, "status": { "type": "string", "description": "The status of the response" }, "request_id": { "type": "string", "description": "A unique identifier for the request" } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "company", "schema": { "type": "string" }, "example": "Amazon", "required": true, "description": "The company name for which to get salary information (e.g. Amazon)." }, { "in": "query", "name": "job_title", "schema": { "type": "string" }, "example": "software developer", "required": true, "description": "Job title for which to get salary estimation." }, { "in": "query", "name": "location", "schema": { "type": "string" }, "description": "Free-text location/area in which to get salary estimation." }, { "in": "query", "name": "location_type", "schema": { "enum": [ "ANY", "CITY", "STATE", "COUNTRY" ], "type": "string", "default": "ANY" }, "description": "Specify the type of the location you are looking to get salary estimation for additional accuracy." }, { "in": "query", "name": "years_of_experience", "schema": { "enum": [ "ALL", "LESS_THAN_ONE", "ONE_TO_THREE", "FOUR_TO_SIX", "SEVEN_TO_NINE", "TEN_TO_FOURTEEN", "ABOVE_FIFTEEN" ], "type": "string", "default": "ALL" }, "description": "Get job estimation for a specific experience level range (years)." } ], "description": "Get estimated job salaries/pay in a specific company by job title and optionally a location and experience level in years.", "operationId": "job_salary_data__get__company_job_salary", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" } ], "x-zeroclick-services": [ "job-salary-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "job-salary-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "job-salary-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/job-salary-data/job-salary": { "get": { "summary": "Job Salary", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "location": { "type": "string", "description": "The job location" }, "job_title": { "type": "string", "description": "The title of the job" }, "confidence": { "type": "string", "description": "The confidence level of the salary estimate" }, "max_salary": { "type": "number", "description": "The maximum salary for the job" }, "min_salary": { "type": "number", "description": "The minimum salary for the job" }, "median_salary": { "type": "integer", "description": "The median salary for the job" }, "salary_period": { "type": "string", "description": "The period for which the salary is paid" }, "publisher_link": { "type": "string", "description": "A link to the salary data publisher" }, "publisher_name": { "type": "string", "description": "The name of the salary data publisher" }, "salary_currency": { "type": "string", "description": "The currency of the salary" } } } }, "status": { "type": "string", "description": "The status of the response" }, "request_id": { "type": "string", "description": "A unique identifier for the request" } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "job_title", "schema": { "type": "string" }, "example": "nodejs developer", "required": true, "description": "Job title for which to get salary estimation." }, { "in": "query", "name": "location", "schema": { "type": "string" }, "example": "New York", "required": true, "description": "Free-text location/area in which to get salary estimation." }, { "in": "query", "name": "location_type", "schema": { "enum": [ "ANY", "CITY", "STATE", "COUNTRY" ], "type": "string", "default": "ANY" }, "description": "Specify the type of the location you are looking to get salary estimation for additional accuracy." }, { "in": "query", "name": "years_of_experience", "schema": { "enum": [ "ALL", "LESS_THAN_ONE", "ONE_TO_THREE", "FOUR_TO_SIX", "SEVEN_TO_NINE", "TEN_TO_FOURTEEN", "ABOVE_FIFTEEN" ], "type": "string", "default": "ALL" }, "description": "Get job estimation for a specific experience level range (years)." } ], "description": "Get estimated job salaries/pay by job title and location.", "operationId": "job_salary_data__get__job_salary", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" } ], "x-zeroclick-services": [ "job-salary-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "job-salary-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "job-salary-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/jsearch/company-job-salary": { "get": { "summary": "Company Job Salary", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "request_id", "data" ], "properties": { "data": { "type": "array", "items": { "type": "object", "required": [ "company", "job_title", "salary_period", "salary_currency" ], "properties": { "company": { "type": "string", "description": "Company name the salary estimate applies to." }, "location": { "type": "string", "nullable": true, "description": "Location the salary estimate applies to." }, "job_title": { "type": "string", "description": "Job title the salary estimate applies to." }, "confidence": { "type": "string", "nullable": true, "description": "Confidence level of the estimate. Values: CONFIDENT, NOT_CONFIDENT." }, "max_salary": { "type": "number", "nullable": true, "description": "Maximum total salary reported for this job." }, "min_salary": { "type": "number", "nullable": true, "description": "Minimum total salary reported for this job." }, "salary_count": { "type": "integer", "nullable": true, "description": "Number of underlying salary data points used to compute the estimate." }, "median_salary": { "type": "number", "nullable": true, "description": "Median total salary reported for this job." }, "salary_period": { "type": "string", "description": "Period of the salary. Values: HOUR, DAY, WEEK, MONTH, YEAR." }, "max_base_salary": { "type": "number", "nullable": true, "description": "Maximum base salary portion of the total compensation." }, "min_base_salary": { "type": "number", "nullable": true, "description": "Minimum base salary portion of the total compensation." }, "salary_currency": { "type": "string", "description": "ISO 4217 currency code of the salary." }, "max_additional_pay": { "type": "number", "nullable": true, "description": "Maximum additional pay reported (bonuses, stock, etc.)." }, "median_base_salary": { "type": "number", "nullable": true, "description": "Median base salary for the job title." }, "min_additional_pay": { "type": "number", "nullable": true, "description": "Minimum additional pay reported (bonuses, stock, etc.)." }, "median_additional_pay": { "type": "number", "nullable": true, "description": "Median additional pay for the job title." } } }, "description": "Array of salary estimate entries for the requested company and job title (empty if no data is available)." }, "status": { "type": "string", "description": "The status of the API response." }, "request_id": { "type": "string", "description": "A unique ID to trace the API request." } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "company", "schema": { "type": "string", "example": "Amazon" }, "example": "Amazon", "required": true, "description": "The company name for which to get salary information (e.g. Amazon)." }, { "in": "query", "name": "job_title", "schema": { "type": "string", "example": "software developer" }, "example": "software developer", "required": true, "description": "Job title for which to get salary estimation." }, { "in": "query", "name": "location", "schema": { "type": "string" }, "description": "Free-text location/area in which to get salary estimation." }, { "in": "query", "name": "location_type", "schema": { "enum": [ "ANY", "CITY", "STATE", "COUNTRY" ], "type": "string", "default": "ANY" }, "description": "Specify the type of the location you are looking to get salary estimation for additional accuracy." }, { "in": "query", "name": "years_of_experience", "schema": { "enum": [ "ALL", "LESS_THAN_ONE", "ONE_TO_THREE", "FOUR_TO_SIX", "SEVEN_TO_NINE", "TEN_TO_FOURTEEN", "ABOVE_FIFTEEN" ], "type": "string", "default": "ALL" }, "description": "Get job estimation for a specific experience level range (years)." } ], "description": "Get estimated job salaries/pay in a specific company by job title and optionally a location and experience level in years.", "operationId": "jsearch__get__company_job_salary", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" } ], "x-zeroclick-services": [ "jsearch" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "jsearch", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "jsearch", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/jsearch/estimated-salary": { "get": { "summary": "Job Salary", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "request_id", "parameters", "data" ], "properties": { "data": { "type": "array", "items": { "type": "object", "required": [ "location", "job_title", "salary_period", "salary_currency" ], "properties": { "location": { "type": "string", "description": "The location the salary estimate applies to." }, "job_title": { "type": "string", "description": "The job title the salary estimate applies to." }, "confidence": { "type": "string", "nullable": true, "description": "Confidence level of the estimate. Values: CONFIDENT, NOT_CONFIDENT." }, "max_salary": { "type": "number", "nullable": true, "description": "The maximum total salary reported." }, "min_salary": { "type": "number", "nullable": true, "description": "The minimum total salary reported." }, "salary_count": { "type": "integer", "nullable": true, "description": "Number of underlying salary data points used to compute the estimate." }, "median_salary": { "type": "number", "nullable": true, "description": "The median total salary reported." }, "salary_period": { "type": "string", "description": "Period of the salary. Values: HOUR, DAY, WEEK, MONTH, YEAR." }, "publisher_link": { "type": "string", "nullable": true, "description": "URL to the salary data on the publisher." }, "publisher_name": { "type": "string", "description": "Name of the salary data publisher (e.g. Glassdoor)." }, "max_base_salary": { "type": "number", "nullable": true, "description": "The maximum base salary reported." }, "min_base_salary": { "type": "number", "nullable": true, "description": "The minimum base salary reported." }, "salary_currency": { "type": "string", "description": "ISO 4217 currency code of the salary." }, "max_additional_pay": { "type": "number", "nullable": true, "description": "The maximum additional compensation reported (bonuses, stock, etc.)." }, "median_base_salary": { "type": "number", "nullable": true, "description": "The median base salary reported." }, "min_additional_pay": { "type": "number", "nullable": true, "description": "The minimum additional compensation reported (bonuses, stock, etc.)." }, "salaries_updated_at": { "type": "string", "nullable": true, "description": "ISO 8601 UTC datetime of when the underlying salary data was last refreshed." }, "median_additional_pay": { "type": "number", "nullable": true, "description": "The median additional compensation reported (bonuses, stock, etc.)." } } }, "description": "Array of salary estimate entries (one per matched location/publisher)." }, "status": { "type": "string", "description": "The status of the API response." }, "parameters": { "type": "object", "properties": { "location": { "type": "string", "description": "The location as received." }, "job_title": { "type": "string", "description": "The job title as received." }, "location_type": { "type": "string", "description": "Location type as received. Values: ANY, CITY, STATE, COUNTRY." }, "years_of_experience": { "type": "string", "nullable": true, "description": "Years-of-experience filter as received. Values: ALL, LESS_THAN_ONE, ONE_TO_THREE, FOUR_TO_SIX, SEVEN_TO_NINE, TEN_TO_FOURTEEN, ABOVE_FIFTEEN." } }, "description": "The parameters the API received and used for this request, echoed back." }, "request_id": { "type": "string", "description": "A unique ID to trace the API request." } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "job_title", "schema": { "type": "string", "example": "nodejs developer" }, "example": "nodejs developer", "required": true, "description": "Job title for which to get salary estimation." }, { "in": "query", "name": "location", "schema": { "type": "string", "example": "new york" }, "example": "new york", "required": true, "description": "Location in which to get salary estimation." }, { "in": "query", "name": "location_type", "schema": { "enum": [ "ANY", "CITY", "STATE", "COUNTRY" ], "type": "string", "default": "ANY" }, "description": "Specify the type of the location you are looking to get salary estimation for additional accuracy." }, { "in": "query", "name": "years_of_experience", "schema": { "enum": [ "ALL", "LESS_THAN_ONE", "ONE_TO_THREE", "FOUR_TO_SIX", "SEVEN_TO_NINE", "TEN_TO_FOURTEEN", "ABOVE_FIFTEEN" ], "type": "string", "default": "ALL" }, "description": "Get job estimation for a specific experience level range (years)." }, { "in": "query", "name": "fields", "schema": { "type": "string" }, "description": "A comma separated list of job salary fields to include in the response (field projection). \n By default all fields are returned." } ], "description": "Get estimated salaries / pay for a jobs around a location by job title and location. \n The salary estimation is returned for several periods, depending on data availability / relevance, and includes: hourly, daily, weekly, monthly, or yearly.", "operationId": "jsearch__get__estimated_salary", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" } ], "x-zeroclick-services": [ "jsearch" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "jsearch", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "jsearch", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/jsearch/job-details": { "get": { "summary": "Job Details", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "request_id", "parameters", "data" ], "properties": { "data": { "type": "array", "items": { "type": "object", "required": [ "job_id", "job_title", "employer_name", "job_publisher", "job_apply_link" ], "properties": { "job_id": { "type": "string", "description": "The unique identifier of the job listing." }, "industry": { "type": "string", "nullable": true, "description": "Industry or domain of the employer, extracted via AI enrichment (?enrich=true)." }, "job_city": { "type": "string", "nullable": true, "description": "City where the job is located." }, "job_state": { "type": "string", "nullable": true, "description": "State or province of the job location." }, "job_title": { "type": "string", "description": "The title or position name of the job." }, "job_salary": { "type": "string", "nullable": true, "description": "Free-form salary description string as published." }, "start_date": { "type": "string", "nullable": true, "description": "Expected start date if specified, extracted via AI enrichment (?enrich=true)." }, "job_country": { "type": "string", "nullable": true, "description": "ISO 3166-1 alpha-2 country code of the job location." }, "soft_skills": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "Soft skills mentioned in the job posting, extracted via AI enrichment (?enrich=true)." }, "job_benefits": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "Normalized benefit codes detected in the listing (e.g. health_insurance, dental_coverage, paid_time_off, retirement_savings)." }, "job_function": { "type": "string", "nullable": true, "description": "Technical function category of the role, extracted via AI enrichment (?enrich=true). Values: backend, frontend, full-stack, mobile, devops, data-engineering, ml-ai, systems, qa, security, other." }, "job_latitude": { "type": "number", "nullable": true, "description": "Latitude of the job location." }, "job_location": { "type": "string", "nullable": true, "description": "Full location string of the job (e.g. 'San Francisco, CA')." }, "job_onet_soc": { "type": "string", "nullable": true, "description": "The O*NET SOC code for the job occupation." }, "apply_options": { "type": "array", "items": { "type": "object", "required": [ "apply_link", "publisher" ], "properties": { "is_direct": { "type": "boolean", "description": "True if the apply link goes directly to the employer's careers site." }, "publisher": { "type": "string", "description": "Name of the publisher hosting this apply link." }, "apply_link": { "type": "string", "description": "Apply URL on this publisher." } } }, "description": "Alternative apply links from other publishers." }, "employer_logo": { "type": "string", "nullable": true, "description": "The URL of the employer's logo image." }, "employer_name": { "type": "string", "description": "The name of the company posting the job." }, "job_is_remote": { "type": "boolean", "nullable": true, "description": "True if the job is fully remote." }, "job_longitude": { "type": "number", "nullable": true, "description": "Longitude of the job location." }, "job_posted_at": { "type": "string", "nullable": true, "description": "Relative posting time (e.g. '3 days ago')." }, "job_publisher": { "type": "string", "description": "The platform or site that published the job." }, "methodologies": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "Development methodologies mentioned, extracted via AI enrichment (?enrich=true)." }, "ai_ml_involved": { "type": "boolean", "nullable": true, "description": "Whether the role involves AI/ML work, extracted via AI enrichment (?enrich=true)." }, "job_apply_link": { "type": "string", "description": "The primary link to apply for the job." }, "job_highlights": { "type": "object", "description": "Bulleted highlights extracted from the listing. Keys typically include 'Qualifications', 'Responsibilities', 'Benefits'. Each value is an array of bullet strings.", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "job_max_salary": { "type": "number", "nullable": true, "description": "Maximum salary parsed from the listing." }, "job_min_salary": { "type": "number", "nullable": true, "description": "Minimum salary parsed from the listing." }, "job_description": { "type": "string", "nullable": true, "description": "A detailed description of the job posting." }, "job_google_link": { "type": "string", "nullable": true, "description": "A link to the job's Google for Jobs detail panel." }, "seniority_level": { "type": "string", "nullable": true, "description": "Seniority level extracted via AI enrichment (?enrich=true). Values: entry, mid, senior, principal, lead, manager." }, "employer_reviews": { "type": "array", "items": { "type": "object", "properties": { "score": { "type": "number", "description": "Average review score on this publisher." }, "max_score": { "type": "number", "description": "Maximum score on the publisher's scale." }, "num_stars": { "type": "number", "description": "Star rating (typically 0-5, possibly fractional)." }, "publisher": { "type": "string", "description": "Name of the review publisher (e.g. Indeed, Glassdoor)." }, "review_count": { "type": "integer", "description": "Total number of reviews on this publisher." }, "reviews_link": { "type": "string", "description": "URL to the publisher's reviews page for this employer." }, "employer_name": { "type": "string", "description": "Employer name as it appears on the publisher." } } }, "nullable": true, "description": "Aggregated employer review summaries from third-party publishers. Present when available." }, "employer_website": { "type": "string", "nullable": true, "description": "The official website of the employer." }, "visa_sponsorship": { "type": "boolean", "nullable": true, "description": "Whether visa sponsorship is offered, extracted via AI enrichment (?enrich=true)." }, "work_arrangement": { "type": "string", "nullable": true, "description": "Work arrangement extracted via AI enrichment (?enrich=true). Values: onsite, remote, hybrid." }, "benefits_extended": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "Extended benefits list extracted from job description via AI enrichment (?enrich=true)." }, "contract_duration": { "type": "string", "nullable": true, "description": "Duration of contract for contract roles, extracted via AI enrichment (?enrich=true)." }, "job_onet_job_zone": { "type": "string", "nullable": true, "description": "The O*NET job zone classification (1-5) indicating preparation level required." }, "job_salary_period": { "type": "string", "nullable": true, "description": "Period of the salary. Values: HOUR, DAY, WEEK, MONTH, YEAR." }, "education_required": { "type": "object", "nullable": true, "properties": { "field": { "type": "string", "nullable": true, "description": "Required field of study." }, "level": { "type": "string", "nullable": true, "description": "Required degree level (e.g. bachelor, master, phd)." } }, "description": "Required education level and field, extracted via AI enrichment (?enrich=true)." }, "job_apply_is_direct": { "type": "boolean", "description": "Indicates if the application is submitted directly to the employer." }, "job_employment_type": { "type": "string", "nullable": true, "description": "Employment type label (e.g. Full-time, Part-time, Contractor)." }, "relocation_required": { "type": "boolean", "nullable": true, "description": "Whether relocation is required, extracted via AI enrichment (?enrich=true)." }, "job_benefits_strings": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "Raw benefit strings detected in the listing (when available)." }, "job_employment_types": { "type": "array", "items": { "type": "string" }, "description": "Normalized employment type codes. Values: FULLTIME, CONTRACTOR, PARTTIME, INTERN." }, "relocation_assistance": { "type": "boolean", "nullable": true, "description": "Whether relocation assistance is provided, extracted via AI enrichment (?enrich=true)." }, "required_technologies": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "Required technologies and tools, extracted via AI enrichment (?enrich=true)." }, "preferred_technologies": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "Preferred/nice-to-have technologies, extracted via AI enrichment (?enrich=true)." }, "job_posted_at_timestamp": { "type": "integer", "nullable": true, "description": "Unix timestamp (seconds) of when the job was posted." }, "required_experience_years": { "type": "integer", "nullable": true, "description": "Minimum years of experience required, extracted via AI enrichment (?enrich=true)." }, "job_posted_at_datetime_utc": { "type": "string", "nullable": true, "description": "ISO 8601 UTC datetime of when the job was posted." }, "has_management_responsibilities": { "type": "boolean", "nullable": true, "description": "Whether the role involves managing or mentoring others, extracted via AI enrichment (?enrich=true)." } } }, "description": "Array of job detail objects (one per requested job_id, batched up to 20)." }, "status": { "type": "string", "description": "The status of the API response." }, "parameters": { "type": "object", "properties": { "job_id": { "type": "string", "description": "The job identifier provided in the request." }, "country": { "type": "string", "description": "ISO 3166-1 alpha-2 country code used for the lookup." }, "language": { "type": "string", "description": "ISO 639 language code used for the lookup." } }, "description": "The parameters the API received and used for this request, echoed back." }, "request_id": { "type": "string", "description": "A unique ID to trace the API request." } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "job_id", "schema": { "type": "string", "example": "20N57zBfi3eT9BdpAAAAAA==" }, "example": "20N57zBfi3eT9BdpAAAAAA==", "required": true, "description": "Job Id of the job for which to get details. \n Batching of up to 20 Job Ids is supported by separating multiple Job Ids by comma (,). \n Note that each Job Id in a batch request is counted as a request for quota calculation." }, { "in": "query", "name": "country", "schema": { "type": "string", "default": "us" }, "description": "Country code of the country from which to return job posting. \n\n **Allowed values:** See *https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2*" }, { "in": "query", "name": "language", "schema": { "type": "string" }, "description": "Language code in which to return job postings. \n Leave empty to use the primary language in the specified country (country parameter). \n \n **Allowed values:** See *https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes*" }, { "in": "query", "name": "fields", "schema": { "type": "string" }, "description": "A comma separated list of job fields to include in the response (field projection). \n By default all fields are returned. " } ], "description": "Get all job details, including additional information such as: application options / links, employer reviews and estimated salaries for similar jobs.", "operationId": "jsearch__get__job_details", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" } ], "x-zeroclick-services": [ "jsearch" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "jsearch", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "jsearch", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/jsearch/search-v2": { "get": { "summary": "Job Search", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "request_id", "parameters", "data" ], "properties": { "data": { "type": "object", "required": [ "jobs" ], "properties": { "jobs": { "type": "array", "items": { "type": "object", "required": [ "job_id", "job_title", "employer_name", "job_publisher", "job_apply_link" ], "properties": { "job_id": { "type": "string", "description": "Unique identifier of the job posting. Use as input to /job-details." }, "job_city": { "type": "string", "nullable": true, "description": "City where the job is located." }, "job_state": { "type": "string", "nullable": true, "description": "State or province where the job is located." }, "job_title": { "type": "string", "description": "Title of the job posting." }, "job_salary": { "type": "string", "nullable": true, "description": "Salary description as published by the source (free-form)." }, "job_country": { "type": "string", "nullable": true, "description": "ISO 3166-1 alpha-2 country code of the job location." }, "job_benefits": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "Normalized benefit codes detected in the listing (e.g. health_insurance, dental_coverage, paid_time_off, retirement_savings)." }, "job_latitude": { "type": "number", "nullable": true, "description": "Latitude of the job location." }, "job_location": { "type": "string", "nullable": true, "description": "Full location string (e.g. 'Chicago, IL')." }, "job_onet_soc": { "type": "string", "nullable": true, "description": "O*NET SOC occupation code for the job." }, "apply_options": { "type": "array", "items": { "type": "object", "required": [ "apply_link", "publisher" ], "properties": { "is_direct": { "type": "boolean", "description": "True if the apply link goes directly to the employer's careers site." }, "publisher": { "type": "string", "description": "Name of the publisher hosting this apply link." }, "apply_link": { "type": "string", "description": "Apply URL on this publisher." } } }, "description": "Alternative apply links from other publishers." }, "employer_logo": { "type": "string", "nullable": true, "description": "URL of the employer's logo image." }, "employer_name": { "type": "string", "description": "Name of the employer / company." }, "job_is_remote": { "type": "boolean", "nullable": true, "description": "True if the job is fully remote." }, "job_longitude": { "type": "number", "nullable": true, "description": "Longitude of the job location." }, "job_posted_at": { "type": "string", "nullable": true, "description": "Human-readable posting time (e.g. '2 days ago')." }, "job_publisher": { "type": "string", "description": "Name of the site that published this listing." }, "job_apply_link": { "type": "string", "description": "Primary URL to apply for the job." }, "job_highlights": { "type": "object", "description": "Bulleted highlights extracted from the listing. Keys typically include 'Qualifications', 'Responsibilities', 'Benefits'. Each value is an array of bullet strings.", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "job_max_salary": { "type": "number", "nullable": true, "description": "Maximum salary parsed from the listing." }, "job_min_salary": { "type": "number", "nullable": true, "description": "Minimum salary parsed from the listing." }, "job_description": { "type": "string", "nullable": true, "description": "Full text of the job description as posted." }, "job_google_link": { "type": "string", "nullable": true, "description": "Link to the job's Google for Jobs detail panel." }, "employer_reviews": { "type": "array", "items": { "type": "object", "properties": { "score": { "type": "number", "description": "Average review score on this publisher." }, "max_score": { "type": "number", "description": "Maximum score on the publisher's scale." }, "num_stars": { "type": "number", "description": "Star rating (typically 0-5, possibly fractional)." }, "publisher": { "type": "string", "description": "Name of the review publisher (e.g. Indeed, Glassdoor)." }, "review_count": { "type": "integer", "description": "Total number of reviews on this publisher." }, "reviews_link": { "type": "string", "description": "URL to the publisher's reviews page for this employer." }, "employer_name": { "type": "string", "description": "Employer name as it appears on the publisher." } } }, "nullable": true, "description": "Aggregated employer review summaries from third-party publishers. Present when available." }, "employer_website": { "type": "string", "nullable": true, "description": "Employer's official website URL." }, "job_onet_job_zone": { "type": "string", "nullable": true, "description": "O*NET job zone classification (1-5) indicating preparation level required." }, "job_salary_period": { "type": "string", "nullable": true, "description": "Period of the salary. Values: HOUR, DAY, WEEK, MONTH, YEAR." }, "job_salary_string": { "type": "string", "nullable": true, "description": "Raw salary string as extracted from the listing (free-form)." }, "job_apply_is_direct": { "type": "boolean", "description": "True if the apply link goes directly to the employer's careers site (not via an aggregator)." }, "job_employment_type": { "type": "string", "nullable": true, "description": "Employment type label (e.g. Full-time, Part-time, Contractor)." }, "job_benefits_strings": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "Raw benefit strings detected in the listing (when available)." }, "job_employment_types": { "type": "array", "items": { "type": "string" }, "description": "Normalized employment type codes. Values: FULLTIME, CONTRACTOR, PARTTIME, INTERN." }, "job_posted_at_timestamp": { "type": "integer", "nullable": true, "description": "Unix timestamp (seconds) of when the job was posted." }, "job_posted_at_datetime_utc": { "type": "string", "nullable": true, "description": "ISO 8601 UTC datetime of when the job was posted." } } }, "description": "Array of job postings matching the search." }, "cursor": { "type": "string", "nullable": true, "description": "Cursor for fetching the next page. Pass as the `cursor` query parameter on the next request. Null when there are no more pages." } } }, "status": { "type": "string", "description": "The status of the API response." }, "parameters": { "type": "object", "properties": { "query": { "type": "string", "description": "The search query string as received." }, "cursor": { "type": "string", "nullable": true, "description": "The cursor value as received (empty/absent on the first page)." }, "country": { "type": "string", "description": "ISO 3166-1 alpha-2 country code used for the search." }, "language": { "type": "string", "description": "ISO 639 language code used for the search." }, "num_pages": { "type": "integer", "description": "Number of pages requested." }, "date_posted": { "type": "string", "description": "Date posted filter as received. Values: all, today, 3days, week, month." } }, "description": "The parameters the API received and used for this request, echoed back." }, "request_id": { "type": "string", "description": "A unique ID to trace the API request." } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "query", "schema": { "type": "string", "example": "developer jobs in chicago" }, "example": "developer jobs in chicago", "required": true, "description": "Free-form jobs search query. \n It is highly recommended to include job title and location as part of the query, see query examples below. \n \n **Examples:** \n `web development jobs in chicago` \n `marketing manager in new york via linkedin` " }, { "in": "query", "name": "cursor", "schema": { "type": "string" }, "description": "Cursor for paginating results. \n Pass the value of `data.cursor` returned by the previous response to fetch the next page. \n Leave empty (or omit) to start from the first page." }, { "in": "query", "name": "num_pages", "schema": { "type": "integer", "default": 1 }, "description": "Number of pages to return, starting from page. \n\n **Allowed values:** `1-20` \n \n **Note**: Each page (containing up to 10 results) returned by the API consumes one request credit." }, { "in": "query", "name": "country", "schema": { "type": "string", "default": "us" }, "description": "Country code of the country from which to return job postings. \n Please note that this parameter must be set in order to get jobs in a specific country, for example, to query for software developer jobs in Berlin, \none should add *country=de* to the request - *e.g. query=software+developers+in +berlin&country=de*. \n For the list of supported values see *https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2" }, { "in": "query", "name": "language", "schema": { "type": "string" }, "description": "Language code in which to return job postings. Leave empty to use the primary language in the specified country (country parameter).\n In case a language not supported by the specified country is used, it is likely that no results will be returned. \n For the list of supported values see https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes" }, { "in": "query", "name": "date_posted", "schema": { "enum": [ "all", "today", "3days", "week", "month" ], "type": "string", "default": "all" }, "description": "Find jobs posted within the time you specify." }, { "in": "query", "name": "work_from_home", "schema": { "type": "boolean", "default": false }, "description": "Only return work from home / remote jobs." }, { "in": "query", "name": "employment_types", "schema": { "enum": [ "FULLTIME", "CONTRACTOR", "PARTTIME", "INTERN" ], "type": "string" }, "description": "Find jobs of particular employment types, specified as a comma delimited list of the following values:" }, { "in": "query", "name": "job_requirements", "schema": { "enum": [ "under_3_years_experience", "more_than_3_years_experience", "no_experience", "no_degree" ], "type": "string" }, "description": "Find jobs with specific requirements, specified as a comma delimited list of the following values:" }, { "in": "query", "name": "radius", "schema": { "type": "number" }, "description": "Return jobs within a certain distance from location as specified as part of the query (in km). \n This internally sent as the Google \"lrad\" parameter and although it might affect the results, it is not strictly followed by Google for Jobs." }, { "in": "query", "name": "exclude_job_publishers", "schema": { "type": "string" }, "description": "Exclude jobs published by specific publishers, specified as a comma (,) separated list of publishers to exclude. " }, { "in": "query", "name": "fields", "schema": { "type": "string" }, "description": "A comma separated list of job fields to include in the response (field projection). \n By default all fields are returned." } ], "description": "Search for jobs posted on any public job site across the web on the largest job aggregate in the world (Google for Jobs). \n Extensive filtering support and most options available on Google for Jobs. \n \n Use cursor-based pagination: pass `data.cursor` from the previous response as the `cursor` query parameter on the next request.", "operationId": "jsearch__get__search_v2", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" } ], "x-zeroclick-services": [ "jsearch" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "jsearch", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "jsearch", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/local-business-data/area-search-by-bounding-box": { "get": { "summary": "Area Search (Bounding Box)", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "request_id", "parameters", "data" ], "properties": { "data": { "type": "array", "items": { "type": "object", "required": [ "business_id", "google_id", "name", "business_status" ], "properties": { "cid": { "type": "string", "nullable": true, "description": "Google CID (Customer ID) of the business." }, "tld": { "type": "string", "nullable": true, "description": "Top-level domain of the business website." }, "city": { "type": "string", "nullable": true, "description": "City of the business location." }, "name": { "type": "string", "description": "Display name of the business." }, "type": { "type": "string", "nullable": true, "description": "Primary business category as labelled by Google Maps." }, "about": { "type": "object", "nullable": true, "properties": { "details": { "type": "object", "nullable": true, "description": "Map of attribute groups (e.g. Amenities, Crowd, Service options) to attribute name -> boolean.", "additionalProperties": { "type": "object", "additionalProperties": { "type": "boolean" } } }, "summary": { "type": "string", "nullable": true, "description": "Free-text description of the business." } }, "description": "Free-form summary and a structured details map of business attributes." }, "state": { "type": "string", "nullable": true, "description": "State / region of the business location." }, "rating": { "type": "number", "nullable": true, "description": "Average review rating (1-5) on Google Maps." }, "address": { "type": "string", "nullable": true, "description": "Street address line of the business." }, "country": { "type": "string", "nullable": true, "description": "ISO 3166-1 alpha-2 country code of the business location." }, "website": { "type": "string", "nullable": true, "description": "Business website URL." }, "zipcode": { "type": "string", "nullable": true, "description": "ZIP / postal code of the business location." }, "district": { "type": "string", "nullable": true, "description": "District or neighbourhood of the business location." }, "latitude": { "type": "number", "description": "Latitude of the business location." }, "owner_id": { "type": "string", "nullable": true, "description": "ID of the Google Maps contributor account that owns this listing." }, "place_id": { "type": "string", "description": "Google Maps Place ID." }, "subtypes": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "List of additional business categories." }, "timezone": { "type": "string", "nullable": true, "description": "IANA timezone of the business location." }, "verified": { "type": "boolean", "description": "Whether the business is verified by Google." }, "directory": { "type": "array", "items": { "type": "object", "additionalProperties": true }, "nullable": true, "description": "List of businesses located in the same building / directory (e.g. mall, plaza). Conditional." }, "google_id": { "type": "string", "description": "Google's internal hexadecimal ID of the business." }, "longitude": { "type": "number", "description": "Longitude of the business location." }, "menu_link": { "type": "string", "nullable": true, "description": "URL of the business menu (when published)." }, "google_mid": { "type": "string", "nullable": true, "description": "Google Knowledge Graph machine ID." }, "located_in": { "type": "object", "nullable": true, "properties": { "name": { "type": "string", "description": "Name of the parent place." }, "google_id": { "type": "string", "description": "Google ID of the parent place." } }, "description": "Parent place this business is located in (e.g. mall) when applicable." }, "order_link": { "type": "string", "nullable": true, "description": "URL to place an order (when published)." }, "owner_link": { "type": "string", "nullable": true, "description": "Link to the owner profile on Google Maps." }, "owner_name": { "type": "string", "nullable": true, "description": "Display name of the owner profile." }, "place_link": { "type": "string", "description": "Google Maps URL for the business." }, "posts_link": { "type": "string", "nullable": true, "description": "URL to the full list of owner posts on Google Maps." }, "share_link": { "type": "string", "nullable": true, "description": "Shortened Google Maps share URL for the business. Returned when extract_share_link=true." }, "business_id": { "type": "string", "description": "Unique Google identifier of the business. Same value as google_id." }, "hotel_stars": { "type": "integer", "nullable": true, "description": "Hotel-only: star rating (1-5). Present only for hotels." }, "photo_count": { "type": "integer", "nullable": true, "description": "Total number of photos available for the business." }, "price_level": { "type": "string", "nullable": true, "description": "Price level as shown on Google Maps (e.g. '$', '$$')." }, "booking_link": { "type": "string", "nullable": true, "description": "URL to book a service or appointment." }, "full_address": { "type": "string", "description": "Full formatted address including business name." }, "opening_date": { "type": "string", "nullable": true, "description": "Date the business opened (when published by Google)." }, "phone_number": { "type": "string", "nullable": true, "description": "Business phone number in E.164 format when available." }, "posts_sample": { "type": "array", "items": { "type": "object", "properties": { "post_id": { "type": "string", "description": "Unique Google identifier of the owner post." }, "post_link": { "type": "string", "nullable": true, "description": "Direct URL to the post on Google." }, "post_text": { "type": "string", "nullable": true, "description": "Text content of the post." }, "post_links": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string", "description": "Target URL of the link." }, "caption": { "type": "string", "nullable": true, "description": "Caption of the link as shown on the post." } } }, "nullable": true, "description": "Outbound links attached to the post." }, "post_photos": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "URLs of photos attached to the post." }, "post_timestamp": { "type": "integer", "nullable": true, "description": "Unix epoch seconds matching post_datetime_utc." }, "post_datetime_utc": { "type": "string", "nullable": true, "description": "ISO 8601 UTC datetime when the post was published." } } }, "nullable": true, "description": "Sample of the most recent owner posts. Present in /business-details and /business-details-plus." }, "review_count": { "type": "integer", "nullable": true, "description": "Total number of Google Maps reviews on the business." }, "reviews_link": { "type": "string", "nullable": true, "description": "URL to view reviews on Google Maps." }, "photos_sample": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "Media type. Values: photo, video, street_view." }, "latitude": { "type": "number", "nullable": true, "description": "Latitude where the photo was taken (when known)." }, "photo_id": { "type": "string", "description": "Google Maps photo ID." }, "longitude": { "type": "number", "nullable": true, "description": "Longitude where the photo was taken (when known)." }, "photo_url": { "type": "string", "description": "URL of the photo (lower-resolution)." }, "photo_timestamp": { "type": "integer", "nullable": true, "description": "Unix epoch seconds matching photo_datetime_utc." }, "photo_url_large": { "type": "string", "nullable": true, "description": "URL of the photo at a larger resolution." }, "photo_datetime_utc": { "type": "string", "nullable": true, "description": "Original publication datetime of the photo in ISO 8601 UTC." }, "video_thumbnail_url": { "type": "string", "nullable": true, "description": "Thumbnail URL when the media is a video; null for still photos." } } }, "nullable": true, "description": "Up to ~10 representative photos for the business." }, "subtype_gcids": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "Internal Google category IDs corresponding to the primary type and subtypes." }, "working_hours": { "type": "object", "nullable": true, "description": "Working hours map keyed by day of the week. Each value is an array of time-range strings; empty object when not published.", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "opening_status": { "type": "string", "nullable": true, "description": "Current opening status string as shown on Google Maps (e.g. 'Open', 'Closed', 'Open 24 hours')." }, "reviews_sample": { "type": "array", "items": { "type": "object", "properties": { "rating": { "type": "integer", "description": "Star rating given in the review (1-5)." }, "author_id": { "type": "string", "nullable": true, "description": "Google Maps contributor ID of the review author." }, "review_id": { "type": "string", "description": "Unique Google identifier of the review." }, "like_count": { "type": "integer", "nullable": true, "description": "Number of likes the review received." }, "author_link": { "type": "string", "nullable": true, "description": "URL to the author's Google Maps profile." }, "author_name": { "type": "string", "nullable": true, "description": "Display name of the review author." }, "review_form": { "type": "object", "nullable": true, "description": "Structured questions the author answered (e.g. 'What kind of trip was it?').", "additionalProperties": { "type": "string" } }, "review_link": { "type": "string", "nullable": true, "description": "Direct Google Maps URL to the review." }, "review_text": { "type": "string", "nullable": true, "description": "Full text content of the review." }, "review_photos": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "URLs of photos attached to the review." }, "review_source": { "type": "string", "nullable": true, "description": "Platform the review originates from (e.g. 'Google', 'Tripadvisor')." }, "review_language": { "type": "string", "nullable": true, "description": "ISO 639 language code of the review text." }, "service_quality": { "type": "string", "nullable": true, "description": "Optional service-quality tag the author selected." }, "author_photo_url": { "type": "string", "nullable": true, "description": "URL of the author's profile photo." }, "review_timestamp": { "type": "integer", "nullable": true, "description": "Unix epoch seconds matching review_datetime_utc." }, "author_review_count": { "type": "integer", "nullable": true, "description": "Number of reviews this author has posted." }, "author_reviews_link": { "type": "string", "nullable": true, "description": "URL to all reviews by this author." }, "owner_response_text": { "type": "string", "nullable": true, "description": "Text of the business owner's response." }, "review_datetime_utc": { "type": "string", "nullable": true, "description": "ISO 8601 UTC datetime when the review was posted." }, "hotel_rating_breakdown": { "type": "object", "nullable": true, "description": "Hotel-only: per-aspect ratings (Rooms, Service, Location, etc.).", "additionalProperties": { "type": "integer" } }, "owner_response_language": { "type": "string", "nullable": true, "description": "ISO 639 language code of the owner response." }, "author_local_guide_level": { "type": "integer", "nullable": true, "description": "Google Local Guide level (1-10) of the author." }, "owner_response_timestamp": { "type": "integer", "nullable": true, "description": "Unix epoch seconds matching owner_response_datetime_utc." }, "owner_response_datetime_utc": { "type": "string", "nullable": true, "description": "ISO 8601 UTC datetime when the business owner responded." } } }, "nullable": true, "description": "Sample of recent reviews. Present in /business-details and /business-details-plus." }, "street_address": { "type": "string", "nullable": true, "description": "Street name and number portion of the address." }, "business_status": { "type": "string", "description": "Operational status. Values: OPEN, CLOSED_TEMPORARILY, CLOSED_PERMANENTLY." }, "hotel_amenities": { "type": "object", "nullable": true, "description": "Hotel-only: map of amenity name to availability (true/false). Present only for hotels.", "additionalProperties": { "type": "boolean" } }, "global_plus_code": { "type": "string", "nullable": true, "description": "Global Open Location Code (Plus Code) for the business location." }, "business_services": { "type": "object", "nullable": true, "description": "Map of service category -> list of services offered (when published by the owner).", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "reservations_link": { "type": "string", "nullable": true, "description": "URL to make a reservation." }, "compound_plus_code": { "type": "string", "nullable": true, "description": "Compound (short) Plus Code with a nearby locality." }, "reviews_per_rating": { "type": "object", "nullable": true, "properties": { "1": { "type": "integer", "description": "Number of 1-star reviews." }, "2": { "type": "integer", "description": "Number of 2-star reviews." }, "3": { "type": "integer", "description": "Number of 3-star reviews." }, "4": { "type": "integer", "description": "Number of 4-star reviews." }, "5": { "type": "integer", "description": "Number of 5-star reviews." } }, "description": "Counts of reviews per integer rating from 1 to 5." }, "emails_and_contacts": { "type": "object", "nullable": true, "properties": { "yelp": { "type": "string", "nullable": true, "description": "Yelp listing URL." }, "emails": { "type": "array", "items": { "type": "string" }, "description": "Email addresses found on the business website." }, "github": { "type": "string", "nullable": true, "description": "GitHub profile URL." }, "tiktok": { "type": "string", "nullable": true, "description": "TikTok profile URL." }, "twitter": { "type": "string", "nullable": true, "description": "Twitter/X profile URL." }, "youtube": { "type": "string", "nullable": true, "description": "YouTube channel URL." }, "facebook": { "type": "string", "nullable": true, "description": "Facebook profile URL." }, "linkedin": { "type": "string", "nullable": true, "description": "LinkedIn profile URL." }, "snapchat": { "type": "string", "nullable": true, "description": "Snapchat profile URL." }, "instagram": { "type": "string", "nullable": true, "description": "Instagram profile URL." }, "pinterest": { "type": "string", "nullable": true, "description": "Pinterest profile URL." }, "phone_numbers": { "type": "array", "items": { "type": "string" }, "description": "Phone numbers found on the business website." } }, "description": "Emails and social-network profiles extracted from the business website. Populated when extract_emails_and_contacts=true (the default for /business-details)." }, "hotel_review_summary": { "type": "object", "nullable": true, "description": "Hotel-only: AI-generated review summary. Present only for hotels.", "additionalProperties": true }, "hotel_booking_options": { "type": "array", "items": { "type": "object", "additionalProperties": true }, "nullable": true, "description": "Hotel-only: array of booking options (provider, price, link). Present only for hotels with live rates." }, "hotel_location_rating": { "type": "object", "nullable": true, "description": "Hotel-only: location rating breakdown when the business is a hotel.", "additionalProperties": true }, "hotel_price_for_dates": { "type": "string", "nullable": true, "description": "Hotel-only: nightly price string when Google has live rates." }, "requested_business_id": { "type": "string", "description": "The exact business_id from the request, echoed back. Useful when batching multiple IDs." }, "hotel_results_from_web": { "type": "array", "items": { "type": "object", "additionalProperties": true }, "nullable": true, "description": "Hotel-only: additional web-sourced results / reviews shown alongside the Google listing." }, "keywords_mentioned_in_reviews": { "type": "array", "items": { "type": "object", "required": [ "keyword", "review_count" ], "properties": { "keyword": { "type": "string", "description": "The keyword extracted from reviews." }, "review_count": { "type": "integer", "description": "Number of reviews mentioning this keyword." } } }, "nullable": true, "description": "Keywords most frequently mentioned in reviews, with counts. Returned by /business-details-plus only (AI-enriched, ?extended_details=true)." } } }, "description": "List of businesses returned." }, "status": { "type": "string", "description": "The status of the API response." }, "parameters": { "type": "object", "properties": { "lat": { "type": "number", "description": "Latitude bias center used for the search." }, "lng": { "type": "number", "description": "Longitude bias center used for the search." }, "zoom": { "type": "integer", "description": "Map zoom level used for the search." }, "limit": { "type": "integer", "description": "Maximum number of results requested." }, "query": { "type": "string", "description": "The search query as received." }, "offset": { "type": "integer", "description": "Number of results skipped (for pagination)." }, "region": { "type": "string", "description": "The region/country code used for the search." }, "language": { "type": "string", "description": "The language code used for the search." }, "extract_emails_and_contacts": { "type": "boolean", "description": "Whether email/contact extraction was requested for each business." } }, "description": "The parameters the API received and used for this request, echoed back." }, "request_id": { "type": "string", "description": "A unique ID to trace the API request." } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "query", "schema": { "type": "string", "example": "pizza" }, "example": "pizza", "required": true, "description": "Search query / keyword" }, { "in": "query", "name": "bottom_left", "schema": { "type": "string", "example": "40.606540,-74.013580" }, "example": "40.606540,-74.013580", "required": true, "description": "The bottom-left (south-west) corner of the bounding box to search in, as a \"lat,lng\" string." }, { "in": "query", "name": "top_right", "schema": { "type": "string", "example": "40.812151,-73.910522" }, "example": "40.812151,-73.910522", "required": true, "description": "The top-right (north-east) corner of the bounding box to search in, as a \"lat,lng\" string." }, { "in": "query", "name": "limit", "schema": { "type": "string", "default": 20 }, "description": "Maximum number of businesses to return. \n\n **Allowed values:** `1-500`" }, { "in": "query", "name": "language", "schema": { "type": "string", "default": "en" }, "description": "Set the language of the results. \n For a list of supported language codes see *https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes*." }, { "in": "query", "name": "region", "schema": { "type": "string", "default": "us" }, "description": "Query Google Maps from a particular region or country. \n For a list of supported region/country codes see *https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes (Alpha-2 code)*." }, { "in": "query", "name": "subtypes", "schema": { "type": "string" }, "description": "Find businesses with specific subtypes, specified as a comma separated list of types (business categories). \n For the complete list of types, see *https://daltonluka.com/blog/google-my-business-categories*. \n \n **Examples:** \n `Plumber,Carpenter,Electrician` \n `Night club,Dance club,Bar,Pub` " }, { "in": "query", "name": "extract_emails_and_contacts", "schema": { "type": "boolean", "default": false }, "description": "Extract emails, contacts and social profiles for each business in the response. \n In case true, businesses will be enriched with a emails_and_contacts field with emails, phones, Facebook, LinkedIn, Instagram and other social profiles.\n \n **Note:** in case `true`, the endpoint will scrape emails and contacts from the business website (in case non-empty). \n For each such business, the API will charge an additional credit." }, { "in": "query", "name": "fields", "schema": { "type": "string" }, "description": "A comma separated list of business fields to include in the response (field projection). \n By default all fields are returned." } ], "description": "Search businesses within a rectangular area defined by its bottom-left (south-west) and top-right (north-east) corner coordinates.", "operationId": "local_business_data__get__area_search_by_bounding_box", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" } ], "x-zeroclick-services": [ "local-business-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "local-business-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "local-business-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/local-business-data/area-search-by-radius": { "get": { "summary": "Area Search (Radius)", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "request_id", "parameters", "data" ], "properties": { "data": { "type": "array", "items": { "type": "object", "required": [ "business_id", "google_id", "name", "business_status" ], "properties": { "cid": { "type": "string", "nullable": true, "description": "Google CID (Customer ID) of the business." }, "tld": { "type": "string", "nullable": true, "description": "Top-level domain of the business website." }, "city": { "type": "string", "nullable": true, "description": "City of the business location." }, "name": { "type": "string", "description": "Display name of the business." }, "type": { "type": "string", "nullable": true, "description": "Primary business category as labelled by Google Maps." }, "about": { "type": "object", "nullable": true, "properties": { "details": { "type": "object", "nullable": true, "description": "Map of attribute groups (e.g. Amenities, Crowd, Service options) to attribute name -> boolean.", "additionalProperties": { "type": "object", "additionalProperties": { "type": "boolean" } } }, "summary": { "type": "string", "nullable": true, "description": "Free-text description of the business." } }, "description": "Free-form summary and a structured details map of business attributes." }, "state": { "type": "string", "nullable": true, "description": "State / region of the business location." }, "rating": { "type": "number", "nullable": true, "description": "Average review rating (1-5) on Google Maps." }, "address": { "type": "string", "nullable": true, "description": "Street address line of the business." }, "country": { "type": "string", "nullable": true, "description": "ISO 3166-1 alpha-2 country code of the business location." }, "website": { "type": "string", "nullable": true, "description": "Business website URL." }, "zipcode": { "type": "string", "nullable": true, "description": "ZIP / postal code of the business location." }, "district": { "type": "string", "nullable": true, "description": "District or neighbourhood of the business location." }, "latitude": { "type": "number", "description": "Latitude of the business location." }, "owner_id": { "type": "string", "nullable": true, "description": "ID of the Google Maps contributor account that owns this listing." }, "place_id": { "type": "string", "description": "Google Maps Place ID." }, "subtypes": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "List of additional business categories." }, "timezone": { "type": "string", "nullable": true, "description": "IANA timezone of the business location." }, "verified": { "type": "boolean", "description": "Whether the business is verified by Google." }, "directory": { "type": "array", "items": { "type": "object", "additionalProperties": true }, "nullable": true, "description": "List of businesses located in the same building / directory (e.g. mall, plaza). Conditional." }, "google_id": { "type": "string", "description": "Google's internal hexadecimal ID of the business." }, "longitude": { "type": "number", "description": "Longitude of the business location." }, "menu_link": { "type": "string", "nullable": true, "description": "URL of the business menu (when published)." }, "google_mid": { "type": "string", "nullable": true, "description": "Google Knowledge Graph machine ID." }, "located_in": { "type": "object", "nullable": true, "properties": { "name": { "type": "string", "description": "Name of the parent place." }, "google_id": { "type": "string", "description": "Google ID of the parent place." } }, "description": "Parent place this business is located in (e.g. mall) when applicable." }, "order_link": { "type": "string", "nullable": true, "description": "URL to place an order (when published)." }, "owner_link": { "type": "string", "nullable": true, "description": "Link to the owner profile on Google Maps." }, "owner_name": { "type": "string", "nullable": true, "description": "Display name of the owner profile." }, "place_link": { "type": "string", "description": "Google Maps URL for the business." }, "posts_link": { "type": "string", "nullable": true, "description": "URL to the full list of owner posts on Google Maps." }, "share_link": { "type": "string", "nullable": true, "description": "Shortened Google Maps share URL for the business. Returned when extract_share_link=true." }, "business_id": { "type": "string", "description": "Unique Google identifier of the business. Same value as google_id." }, "hotel_stars": { "type": "integer", "nullable": true, "description": "Hotel-only: star rating (1-5). Present only for hotels." }, "photo_count": { "type": "integer", "nullable": true, "description": "Total number of photos available for the business." }, "price_level": { "type": "string", "nullable": true, "description": "Price level as shown on Google Maps (e.g. '$', '$$')." }, "booking_link": { "type": "string", "nullable": true, "description": "URL to book a service or appointment." }, "full_address": { "type": "string", "description": "Full formatted address including business name." }, "opening_date": { "type": "string", "nullable": true, "description": "Date the business opened (when published by Google)." }, "phone_number": { "type": "string", "nullable": true, "description": "Business phone number in E.164 format when available." }, "posts_sample": { "type": "array", "items": { "type": "object", "properties": { "post_id": { "type": "string", "description": "Unique Google identifier of the owner post." }, "post_link": { "type": "string", "nullable": true, "description": "Direct URL to the post on Google." }, "post_text": { "type": "string", "nullable": true, "description": "Text content of the post." }, "post_links": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string", "description": "Target URL of the link." }, "caption": { "type": "string", "nullable": true, "description": "Caption of the link as shown on the post." } } }, "nullable": true, "description": "Outbound links attached to the post." }, "post_photos": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "URLs of photos attached to the post." }, "post_timestamp": { "type": "integer", "nullable": true, "description": "Unix epoch seconds matching post_datetime_utc." }, "post_datetime_utc": { "type": "string", "nullable": true, "description": "ISO 8601 UTC datetime when the post was published." } } }, "nullable": true, "description": "Sample of the most recent owner posts. Present in /business-details and /business-details-plus." }, "review_count": { "type": "integer", "nullable": true, "description": "Total number of Google Maps reviews on the business." }, "reviews_link": { "type": "string", "nullable": true, "description": "URL to view reviews on Google Maps." }, "photos_sample": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "Media type. Values: photo, video, street_view." }, "latitude": { "type": "number", "nullable": true, "description": "Latitude where the photo was taken (when known)." }, "photo_id": { "type": "string", "description": "Google Maps photo ID." }, "longitude": { "type": "number", "nullable": true, "description": "Longitude where the photo was taken (when known)." }, "photo_url": { "type": "string", "description": "URL of the photo (lower-resolution)." }, "photo_timestamp": { "type": "integer", "nullable": true, "description": "Unix epoch seconds matching photo_datetime_utc." }, "photo_url_large": { "type": "string", "nullable": true, "description": "URL of the photo at a larger resolution." }, "photo_datetime_utc": { "type": "string", "nullable": true, "description": "Original publication datetime of the photo in ISO 8601 UTC." }, "video_thumbnail_url": { "type": "string", "nullable": true, "description": "Thumbnail URL when the media is a video; null for still photos." } } }, "nullable": true, "description": "Up to ~10 representative photos for the business." }, "subtype_gcids": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "Internal Google category IDs corresponding to the primary type and subtypes." }, "working_hours": { "type": "object", "nullable": true, "description": "Working hours map keyed by day of the week. Each value is an array of time-range strings; empty object when not published.", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "opening_status": { "type": "string", "nullable": true, "description": "Current opening status string as shown on Google Maps (e.g. 'Open', 'Closed', 'Open 24 hours')." }, "reviews_sample": { "type": "array", "items": { "type": "object", "properties": { "rating": { "type": "integer", "description": "Star rating given in the review (1-5)." }, "author_id": { "type": "string", "nullable": true, "description": "Google Maps contributor ID of the review author." }, "review_id": { "type": "string", "description": "Unique Google identifier of the review." }, "like_count": { "type": "integer", "nullable": true, "description": "Number of likes the review received." }, "author_link": { "type": "string", "nullable": true, "description": "URL to the author's Google Maps profile." }, "author_name": { "type": "string", "nullable": true, "description": "Display name of the review author." }, "review_form": { "type": "object", "nullable": true, "description": "Structured questions the author answered (e.g. 'What kind of trip was it?').", "additionalProperties": { "type": "string" } }, "review_link": { "type": "string", "nullable": true, "description": "Direct Google Maps URL to the review." }, "review_text": { "type": "string", "nullable": true, "description": "Full text content of the review." }, "review_photos": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "URLs of photos attached to the review." }, "review_source": { "type": "string", "nullable": true, "description": "Platform the review originates from (e.g. 'Google', 'Tripadvisor')." }, "review_language": { "type": "string", "nullable": true, "description": "ISO 639 language code of the review text." }, "service_quality": { "type": "string", "nullable": true, "description": "Optional service-quality tag the author selected." }, "author_photo_url": { "type": "string", "nullable": true, "description": "URL of the author's profile photo." }, "review_timestamp": { "type": "integer", "nullable": true, "description": "Unix epoch seconds matching review_datetime_utc." }, "author_review_count": { "type": "integer", "nullable": true, "description": "Number of reviews this author has posted." }, "author_reviews_link": { "type": "string", "nullable": true, "description": "URL to all reviews by this author." }, "owner_response_text": { "type": "string", "nullable": true, "description": "Text of the business owner's response." }, "review_datetime_utc": { "type": "string", "nullable": true, "description": "ISO 8601 UTC datetime when the review was posted." }, "hotel_rating_breakdown": { "type": "object", "nullable": true, "description": "Hotel-only: per-aspect ratings (Rooms, Service, Location, etc.).", "additionalProperties": { "type": "integer" } }, "owner_response_language": { "type": "string", "nullable": true, "description": "ISO 639 language code of the owner response." }, "author_local_guide_level": { "type": "integer", "nullable": true, "description": "Google Local Guide level (1-10) of the author." }, "owner_response_timestamp": { "type": "integer", "nullable": true, "description": "Unix epoch seconds matching owner_response_datetime_utc." }, "owner_response_datetime_utc": { "type": "string", "nullable": true, "description": "ISO 8601 UTC datetime when the business owner responded." } } }, "nullable": true, "description": "Sample of recent reviews. Present in /business-details and /business-details-plus." }, "street_address": { "type": "string", "nullable": true, "description": "Street name and number portion of the address." }, "business_status": { "type": "string", "description": "Operational status. Values: OPEN, CLOSED_TEMPORARILY, CLOSED_PERMANENTLY." }, "hotel_amenities": { "type": "object", "nullable": true, "description": "Hotel-only: map of amenity name to availability (true/false). Present only for hotels.", "additionalProperties": { "type": "boolean" } }, "global_plus_code": { "type": "string", "nullable": true, "description": "Global Open Location Code (Plus Code) for the business location." }, "business_services": { "type": "object", "nullable": true, "description": "Map of service category -> list of services offered (when published by the owner).", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "reservations_link": { "type": "string", "nullable": true, "description": "URL to make a reservation." }, "compound_plus_code": { "type": "string", "nullable": true, "description": "Compound (short) Plus Code with a nearby locality." }, "reviews_per_rating": { "type": "object", "nullable": true, "properties": { "1": { "type": "integer", "description": "Number of 1-star reviews." }, "2": { "type": "integer", "description": "Number of 2-star reviews." }, "3": { "type": "integer", "description": "Number of 3-star reviews." }, "4": { "type": "integer", "description": "Number of 4-star reviews." }, "5": { "type": "integer", "description": "Number of 5-star reviews." } }, "description": "Counts of reviews per integer rating from 1 to 5." }, "emails_and_contacts": { "type": "object", "nullable": true, "properties": { "yelp": { "type": "string", "nullable": true, "description": "Yelp listing URL." }, "emails": { "type": "array", "items": { "type": "string" }, "description": "Email addresses found on the business website." }, "github": { "type": "string", "nullable": true, "description": "GitHub profile URL." }, "tiktok": { "type": "string", "nullable": true, "description": "TikTok profile URL." }, "twitter": { "type": "string", "nullable": true, "description": "Twitter/X profile URL." }, "youtube": { "type": "string", "nullable": true, "description": "YouTube channel URL." }, "facebook": { "type": "string", "nullable": true, "description": "Facebook profile URL." }, "linkedin": { "type": "string", "nullable": true, "description": "LinkedIn profile URL." }, "snapchat": { "type": "string", "nullable": true, "description": "Snapchat profile URL." }, "instagram": { "type": "string", "nullable": true, "description": "Instagram profile URL." }, "pinterest": { "type": "string", "nullable": true, "description": "Pinterest profile URL." }, "phone_numbers": { "type": "array", "items": { "type": "string" }, "description": "Phone numbers found on the business website." } }, "description": "Emails and social-network profiles extracted from the business website. Populated when extract_emails_and_contacts=true (the default for /business-details)." }, "hotel_review_summary": { "type": "object", "nullable": true, "description": "Hotel-only: AI-generated review summary. Present only for hotels.", "additionalProperties": true }, "hotel_booking_options": { "type": "array", "items": { "type": "object", "additionalProperties": true }, "nullable": true, "description": "Hotel-only: array of booking options (provider, price, link). Present only for hotels with live rates." }, "hotel_location_rating": { "type": "object", "nullable": true, "description": "Hotel-only: location rating breakdown when the business is a hotel.", "additionalProperties": true }, "hotel_price_for_dates": { "type": "string", "nullable": true, "description": "Hotel-only: nightly price string when Google has live rates." }, "requested_business_id": { "type": "string", "description": "The exact business_id from the request, echoed back. Useful when batching multiple IDs." }, "hotel_results_from_web": { "type": "array", "items": { "type": "object", "additionalProperties": true }, "nullable": true, "description": "Hotel-only: additional web-sourced results / reviews shown alongside the Google listing." }, "keywords_mentioned_in_reviews": { "type": "array", "items": { "type": "object", "required": [ "keyword", "review_count" ], "properties": { "keyword": { "type": "string", "description": "The keyword extracted from reviews." }, "review_count": { "type": "integer", "description": "Number of reviews mentioning this keyword." } } }, "nullable": true, "description": "Keywords most frequently mentioned in reviews, with counts. Returned by /business-details-plus only (AI-enriched, ?extended_details=true)." } } }, "description": "List of businesses returned." }, "status": { "type": "string", "description": "The status of the API response." }, "parameters": { "type": "object", "properties": { "lat": { "type": "number", "description": "Latitude bias center used for the search." }, "lng": { "type": "number", "description": "Longitude bias center used for the search." }, "zoom": { "type": "integer", "description": "Map zoom level used for the search." }, "limit": { "type": "integer", "description": "Maximum number of results requested." }, "query": { "type": "string", "description": "The search query as received." }, "offset": { "type": "integer", "description": "Number of results skipped (for pagination)." }, "region": { "type": "string", "description": "The region/country code used for the search." }, "language": { "type": "string", "description": "The language code used for the search." }, "extract_emails_and_contacts": { "type": "boolean", "description": "Whether email/contact extraction was requested for each business." } }, "description": "The parameters the API received and used for this request, echoed back." }, "request_id": { "type": "string", "description": "A unique ID to trace the API request." } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "query", "schema": { "type": "string", "example": "pizza" }, "example": "pizza", "required": true, "description": "Search query / keyword" }, { "in": "query", "name": "lat", "schema": { "type": "string", "default": 37.359428, "example": "37.359428" }, "example": "37.359428", "required": true, "description": "Latitude of the center coordinate point of the area to search in." }, { "in": "query", "name": "lng", "schema": { "type": "string", "default": -121.925337, "example": "-121.925337" }, "example": "-121.925337", "required": true, "description": "Longitude of the center coordinate point of the area to search in." }, { "in": "query", "name": "radius", "schema": { "type": "string", "example": "5000" }, "example": "5000", "required": true, "description": "The radius (in meters) of the circular search area around the center coordinate point (lat, lng). Allowed values: 1-50000." }, { "in": "query", "name": "limit", "schema": { "type": "string", "default": 20 }, "description": "Maximum number of businesses to return. \n\n **Allowed values:** `1-500`" }, { "in": "query", "name": "language", "schema": { "type": "string", "default": "en" }, "description": "Set the language of the results. \n For a list of supported language codes see *https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes*." }, { "in": "query", "name": "region", "schema": { "type": "string", "default": "us" }, "description": "Query Google Maps from a particular region or country. \n For a list of supported region/country codes see *https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes (Alpha-2 code)*." }, { "in": "query", "name": "subtypes", "schema": { "type": "string" }, "description": "Find businesses with specific subtypes, specified as a comma separated list of types (business categories). \n For the complete list of types, see *https://daltonluka.com/blog/google-my-business-categories*. \n \n **Examples:** \n `Plumber,Carpenter,Electrician` \n `Night club,Dance club,Bar,Pub` " }, { "in": "query", "name": "extract_emails_and_contacts", "schema": { "type": "boolean", "default": false }, "description": "Extract emails, contacts and social profiles for each business in the response. \n In case true, businesses will be enriched with a emails_and_contacts field with emails, phones, Facebook, LinkedIn, Instagram and other social profiles.\n \n **Note:** in case `true`, the endpoint will scrape emails and contacts from the business website (in case non-empty). \n For each such business, the API will charge an additional credit." }, { "in": "query", "name": "fields", "schema": { "type": "string" }, "description": "A comma separated list of business fields to include in the response (field projection). \n By default all fields are returned." } ], "description": "Search businesses within a circular area defined by a center coordinate point (lat, lng) and a radius in meters.", "operationId": "local_business_data__get__area_search_by_radius", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" } ], "x-zeroclick-services": [ "local-business-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "local-business-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "local-business-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/local-business-data/autocomplete": { "get": { "summary": "Autocomplete", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "request_id", "parameters", "data" ], "properties": { "data": { "type": "array", "items": { "type": "object", "required": [ "type", "description", "main_text" ], "properties": { "type": { "type": "string", "description": "Type of prediction. Values: place, query." }, "country": { "type": "string", "nullable": true, "description": "ISO 3166-1 alpha-2 country code of the predicted place; null for query predictions." }, "latitude": { "type": "number", "nullable": true, "description": "Latitude of the predicted place; null for query predictions." }, "place_id": { "type": "string", "nullable": true, "description": "Google Maps Place ID when the prediction is a place; null for query predictions." }, "google_id": { "type": "string", "nullable": true, "description": "Google identifier when the prediction is a place; null for query predictions." }, "longitude": { "type": "number", "nullable": true, "description": "Longitude of the predicted place; null for query predictions." }, "main_text": { "type": "string", "description": "Primary (left-hand) portion of the prediction text." }, "description": { "type": "string", "description": "Full prediction text suitable for display in the suggestion list." }, "secondary_text": { "type": "string", "nullable": true, "description": "Secondary (right-hand) portion of the prediction text (e.g. city / region)." }, "main_text_highlights": { "type": "array", "items": { "type": "object", "properties": { "length": { "type": "integer", "description": "Length of the highlighted span in characters." }, "offset": { "type": "integer", "description": "0-based character offset of the highlighted span." } } }, "nullable": true, "description": "Substring highlights inside main_text (each {offset, length})." }, "secondary_text_highlights": { "type": "array", "items": { "type": "object", "properties": { "length": { "type": "integer", "description": "Length of the highlighted span in characters." }, "offset": { "type": "integer", "description": "0-based character offset of the highlighted span." } } }, "nullable": true, "description": "Substring highlights inside secondary_text." } } }, "description": "List of prediction objects." }, "status": { "type": "string", "description": "The status of the API response." }, "parameters": { "type": "object", "properties": { "query": { "type": "string", "description": "The query as received." }, "region": { "type": "string", "description": "Region code used for the response." }, "language": { "type": "string", "description": "Language code used for the response." }, "coordinates": { "type": "string", "nullable": true, "description": "Geographic bias coordinates used (lat,lng)." } }, "description": "The parameters the API received and used for this request, echoed back." }, "request_id": { "type": "string", "description": "A unique ID to trace the API request." } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "query", "schema": { "type": "string", "example": "new y" }, "example": "new y", "required": true, "description": "Search query" }, { "in": "query", "name": "region", "schema": { "type": "string", "default": "us" }, "description": "Return results based to a particular region. \n For a list of supported region/country codes see *https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes (Alpha-2 code)*." }, { "in": "query", "name": "language", "schema": { "type": "string", "default": "en" }, "description": "Set the language of the results. \n For a list of supported language codes see *https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2*." }, { "in": "query", "name": "coordinates", "schema": { "type": "string" }, "description": "Geographic coordinates of the location from which the query is applied - recommended to use so that results are biased towards this location. \n Defaults to some central location in the region (see the region parameter)." } ], "description": "Returns place/address, business and query predictions for text-based geographic queries.", "operationId": "local_business_data__get__autocomplete", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" } ], "x-zeroclick-services": [ "local-business-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "local-business-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "local-business-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/local-business-database/area-search-by-bounding-box": { "get": { "summary": "Area Search By Bounding Box", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "request_id", "parameters", "data" ], "properties": { "data": { "type": "object", "required": [ "businesses", "match_count", "limit" ], "properties": { "limit": { "type": "number", "description": "Maximum number of results requested for this page (the limit parameter, or its default)." }, "businesses": { "type": "array", "items": { "type": "object", "required": [ "business_id" ], "properties": { "cid": { "type": "string", "description": "Google CID (Customer ID) of the business." }, "lat": { "type": "number", "description": "Latitude of the business location." }, "lng": { "type": "number", "description": "Longitude of the business location." }, "tld": { "type": "string", "description": "Domain of the business website." }, "city": { "type": "string", "description": "City of the business location." }, "name": { "type": "string", "description": "Display name of the business." }, "about": { "type": "object", "required": [ "summary", "details" ], "properties": { "details": { "type": "object", "nullable": true, "description": "Structured attribute map, grouped by attribute category (e.g. accessibility, amenities), each mapping an attribute identifier to a boolean.", "additionalProperties": { "type": "object", "additionalProperties": { "type": "boolean" } } }, "summary": { "type": "string", "nullable": true, "description": "Free-text description of the business." } }, "description": "Free-form summary and a structured details map of business attributes.", "additionalProperties": false }, "phone": { "type": "string", "description": "Business phone number in E.164 format when available." }, "state": { "type": "string", "description": "State / region of the business location." }, "rating": { "type": "number", "description": "Average review rating (1-5) on Google Maps." }, "status": { "enum": [ "operational", "closed", "temporarily_closed" ], "type": "string", "description": "Operational status of the business. Values: operational, closed, temporarily_closed." }, "address": { "type": "string", "description": "Full formatted address, including the business name." }, "country": { "type": "string", "description": "ISO 3166-1 alpha-2 country code of the business location: the country of its Google address or, when that address names none, the country of the map area the business was found in. Absent when neither is known." }, "website": { "type": "string", "description": "Business website URL." }, "zipcode": { "type": "string", "description": "ZIP / postal code of the business location." }, "district": { "type": "string", "description": "District or neighbourhood of the business location." }, "owner_id": { "type": "string", "description": "ID of the Google Maps contributor account that owns this listing." }, "place_id": { "type": "string", "description": "Google Maps Place ID." }, "timezone": { "type": "string", "description": "IANA timezone of the business location." }, "verified": { "type": "boolean", "description": "Whether the business is verified by Google." }, "last_seen": { "type": "string", "description": "ISO 8601 UTC datetime the listing was last collected." }, "open_24_7": { "type": "boolean", "description": "Whether the business is open 24 hours a day, every day of the week." }, "categories": { "type": "array", "items": { "type": "string" }, "description": "List of business categories as labelled by Google Maps." }, "closed_dow": { "type": "array", "items": { "type": "number" }, "description": "Days of the week the business is closed, as ISO-8601 day numbers (1 = Monday, 7 = Sunday)." }, "first_seen": { "type": "string", "description": "ISO 8601 UTC datetime the listing was first collected." }, "google_mid": { "type": "string", "description": "Google Knowledge Graph machine ID." }, "located_in": { "type": "object", "required": [ "google_id", "name" ], "properties": { "name": { "type": "string", "description": "Name of the parent place." }, "google_id": { "type": "string", "description": "Google ID of the parent place." } }, "description": "Parent place this business is located in (e.g. mall) when applicable.", "additionalProperties": false }, "order_link": { "type": "string", "description": "URL to place an order (when published)." }, "owner_link": { "type": "string", "description": "Link to the owner profile on Google Maps." }, "owner_name": { "type": "string", "description": "Display name of the owner profile." }, "place_link": { "type": "string", "description": "Google Maps URL for the business." }, "business_id": { "type": "string", "description": "Unique Google identifier of the business." }, "hotel_stars": { "type": "number", "description": "Hotel-only: star rating (1-5). Present only for hotels." }, "photo_count": { "type": "number", "description": "Total number of photos available for the business." }, "price_level": { "type": "string", "description": "Price level as shown on Google Maps (e.g. '$10-20')." }, "booking_link": { "type": "string", "description": "URL to book a service or appointment (when published)." }, "category_ids": { "type": "array", "items": { "type": "string" }, "description": "Google's internal entity-type IDs for the business. Broader than categories, and usually several per business. The IDs are gcids (Google Maps category IDs). For a list of gcids see *https://www.openwebninja.com/blog/all-google-maps-categories*." }, "last_changed": { "type": "string", "description": "ISO 8601 UTC datetime the listing data last changed." }, "opening_date": { "type": "string", "description": "Date the business opened (when published by Google)." }, "review_count": { "type": "number", "description": "Total number of Google Maps reviews on the business." }, "reviews_link": { "type": "string", "description": "URL to view reviews on Google Maps." }, "address_short": { "type": "string", "description": "Formatted address without the business name." }, "main_category": { "type": "string", "description": "Primary business category as labelled by Google Maps." }, "photos_sample": { "type": "array", "items": { "type": "object", "required": [ "photo_id", "photo_url", "photo_url_large", "video_thumbnail_url", "latitude", "longitude", "type", "photo_datetime_utc", "photo_timestamp" ], "properties": { "type": { "enum": [ "photo", "street_view", "video" ], "type": "string", "description": "Media type. Values: photo, video, street_view." }, "latitude": { "type": "number", "nullable": true, "description": "Latitude where the photo was taken (when known)." }, "photo_id": { "type": "string", "description": "Unique Google identifier of the photo." }, "longitude": { "type": "number", "nullable": true, "description": "Longitude where the photo was taken (when known)." }, "photo_url": { "type": "string", "nullable": true, "description": "URL of the photo (default resolution)." }, "photo_timestamp": { "type": "number", "nullable": true, "description": "Unix epoch seconds matching photo_datetime_utc." }, "photo_url_large": { "type": "string", "nullable": true, "description": "URL of the photo at a larger resolution." }, "photo_datetime_utc": { "type": "string", "nullable": true, "description": "Original publication datetime of the photo in ISO 8601 UTC." }, "video_thumbnail_url": { "type": "string", "nullable": true, "description": "Thumbnail URL when the media is a video; null for still photos." } }, "additionalProperties": false }, "description": "Sample of representative photos for the business." }, "working_hours": { "type": "object", "description": "Working hours map keyed by day of the week. Each value is an array of time-range strings; absent when not published.", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "opening_status": { "type": "string", "description": "Current opening status string as shown on Google Maps (e.g. 'Open', 'Closed', 'Open 24 hours')." }, "street_address": { "type": "string", "description": "Street name and number portion of the address." }, "hotel_amenities": { "type": "object", "description": "Hotel-only: map of amenity name to availability (true/false). Present only for hotels.", "additionalProperties": { "type": "boolean" } }, "main_category_id": { "type": "string", "description": "Google's internal ID of the primary category. The ID is a gcid (Google Maps category ID). For a list of gcids see *https://www.openwebninja.com/blog/all-google-maps-categories*." }, "reservations_link": { "type": "string", "description": "URL to make a reservation (when published)." }, "reviews_per_rating": { "type": "object", "required": [ "1", "2", "3", "4", "5" ], "properties": { "1": { "type": "number", "description": "Number of 1-star reviews." }, "2": { "type": "number", "description": "Number of 2-star reviews." }, "3": { "type": "number", "description": "Number of 3-star reviews." }, "4": { "type": "number", "description": "Number of 4-star reviews." }, "5": { "type": "number", "description": "Number of 5-star reviews." } }, "description": "Counts of reviews per integer rating from 1 to 5.", "additionalProperties": false }, "hotel_review_summary": { "type": "object", "description": "Hotel-only: AI-generated review summary. Present only for hotels.", "additionalProperties": { "type": "object", "required": [ "score", "summary" ], "properties": { "score": { "type": "number", "nullable": true }, "summary": { "type": "string", "nullable": true } }, "additionalProperties": false } }, "hotel_booking_options": { "type": "array", "items": { "type": "object", "required": [ "source", "price", "link", "source_favicon" ], "properties": { "link": { "type": "string", "nullable": true, "description": "URL to book with the provider." }, "price": { "type": "string", "nullable": true, "description": "Nightly price as shown by the provider." }, "rooms": { "type": "array", "items": { "type": "object", "required": [ "room_type", "link", "price" ], "properties": { "link": { "type": "string", "nullable": true, "description": "URL to book this room type." }, "price": { "type": "string", "nullable": true, "description": "Price of this room type as shown by the provider." }, "room_type": { "type": "string", "nullable": true, "description": "Name of the room type." } }, "additionalProperties": false }, "description": "Room types offered by this provider." }, "source": { "type": "string", "nullable": true, "description": "Booking provider the option comes from." }, "source_favicon": { "type": "string", "nullable": true, "description": "URL of the provider favicon." } }, "additionalProperties": false }, "description": "Hotel-only: booking options (provider, price, link). Present only for hotels with live rates." }, "hotel_location_rating": { "type": "object", "required": [ "Overall", "Things to do", "Transit", "Airports" ], "properties": { "Overall": { "type": "number", "nullable": true, "description": "Hotel-only: overall location rating." }, "Transit": { "type": "number", "nullable": true, "description": "Hotel-only: location rating for transit access." }, "Airports": { "type": "number", "nullable": true, "description": "Hotel-only: location rating for airport access." }, "Things to do": { "type": "number", "nullable": true, "description": "Hotel-only: location rating for things to do nearby." } }, "description": "Hotel-only: location rating breakdown when the business is a hotel.", "additionalProperties": false }, "hotel_results_from_web": { "type": "array", "items": { "type": "object", "required": [ "source", "link", "source_favicon" ], "properties": { "link": { "type": "string", "nullable": true, "description": "URL of the result." }, "source": { "type": "string", "nullable": true, "description": "Website the result comes from." }, "source_favicon": { "type": "string", "nullable": true, "description": "URL of the source favicon." } }, "additionalProperties": false }, "description": "Hotel-only: additional web-sourced results shown alongside the Google listing." } }, "additionalProperties": false }, "description": "List of businesses returned." }, "match_count": { "type": "number", "description": "Total number of businesses matching the query, across all pages. It is counted on the first page and repeated on every later page, so it can differ from a fresh count if listings change while you page." } }, "description": "Businesses matching the query inside the bounding box, with the total match count and the page size applied." }, "cursor": { "type": "string", "description": "Pagination cursor for the next page of results. Pass it back as the `cursor` parameter together with the same query. Absent on the last page." }, "status": { "type": "string", "description": "The status of the API response." }, "parameters": { "type": "object", "description": "The parameters the API received and used for this request, echoed back.", "additionalProperties": true }, "request_id": { "type": "string", "description": "A unique ID to trace the API request." } } } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "request_id", "error" ], "properties": { "error": { "type": "object", "required": [ "message", "code" ], "properties": { "code": { "type": "integer", "description": "The HTTP status of this response, repeated." }, "message": { "type": "string", "description": "What went wrong, in English. Where a code names the fault, it ends this message in parentheses." } }, "description": "What went wrong." }, "status": { "type": "string", "description": "`ERROR` on every error response." }, "request_id": { "type": "string", "description": "A unique ID to trace the failed request." } } } } }, "description": "The request was refused.\n\n`error.message` ends with its code in parentheses, as in `(UNKNOWN_FIELD)`; a message that ends in none is `VALIDATION_ERROR`. Branch on the code rather than on the English before it:\n\n`VALIDATION_ERROR` - A parameter this operation accepts was sent in a form it does not, a required parameter is missing, or the request's path and method are not one this API serves. Correct the request: `message` names the offending parameter and the accepted form.\n\n`UNKNOWN_FIELD` - A parameter name this operation does not accept, or a name in `fields` it does not return. It is a spelling fix.\n\n`INVALID_CURSOR` - The page token is not one this API issued for this request, or it can no longer be resumed. Start again from the first page.\n\n`CURSOR_EXPIRED` - The page token was issued for this request, but the walk took longer than its lifetime. Start again from the first page." }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." }, "429": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "request_id", "error" ], "properties": { "error": { "type": "object", "required": [ "message", "code" ], "properties": { "code": { "type": "integer", "description": "The HTTP status of this response, repeated." }, "message": { "type": "string", "description": "What went wrong, in English. Where a code names the fault, it ends this message in parentheses." } }, "description": "What went wrong." }, "status": { "type": "string", "description": "`ERROR` on every error response." }, "request_id": { "type": "string", "description": "A unique ID to trace the failed request." } } } } }, "description": "The plan behind this API key has no requests left for this API. `error.message` carries no code. Retrying does not help until the plan allows further requests." }, "500": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "request_id", "error" ], "properties": { "error": { "type": "object", "required": [ "message", "code" ], "properties": { "code": { "type": "integer", "description": "The HTTP status of this response, repeated." }, "message": { "type": "string", "description": "What went wrong, in English. Where a code names the fault, it ends this message in parentheses." } }, "description": "What went wrong." }, "status": { "type": "string", "description": "`ERROR` on every error response." }, "request_id": { "type": "string", "description": "A unique ID to trace the failed request." } } } } }, "description": "The request failed on this API's side.\n\n`error.message` ends with its code in parentheses, as in `(INTERNAL_ERROR)`. Branch on the code rather than on the English before it:\n\n`INTERNAL_ERROR` - An unexpected failure on this service's side, not a fault in the request; no further detail is echoed. Retry later, with backoff.\n\n**Note:** a 500 whose message ends in no code carries no further detail about its cause. Retry later, with backoff." }, "502": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "request_id", "error" ], "properties": { "error": { "type": "object", "required": [ "message", "code" ], "properties": { "code": { "type": "integer", "description": "The HTTP status of this response, repeated." }, "message": { "type": "string", "description": "What went wrong, in English. Where a code names the fault, it ends this message in parentheses." } }, "description": "What went wrong." }, "status": { "type": "string", "description": "`ERROR` on every error response." }, "request_id": { "type": "string", "description": "A unique ID to trace the failed request." } } } } }, "description": "A service this API depends on did not complete the request.\n\n`error.message` ends with its code in parentheses, as in `(UPSTREAM_ERROR)`. Branch on the code rather than on the English before it:\n\n`UPSTREAM_ERROR` - The search backend rejected the query. Narrow the query rather than retrying it unchanged.\n\n**Note:** a 502 whose message ends in no code carries no further detail about its cause. Retry later, with backoff." }, "503": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "request_id", "error" ], "properties": { "error": { "type": "object", "required": [ "message", "code" ], "properties": { "code": { "type": "integer", "description": "The HTTP status of this response, repeated." }, "message": { "type": "string", "description": "What went wrong, in English. Where a code names the fault, it ends this message in parentheses." } }, "description": "What went wrong." }, "status": { "type": "string", "description": "`ERROR` on every error response." }, "request_id": { "type": "string", "description": "A unique ID to trace the failed request." } } } } }, "description": "This API is temporarily unable to serve the request.\n\n`error.message` ends with its code in parentheses, as in `(SEARCH_BUSY)`. Branch on the code rather than on the English before it:\n\n`SEARCH_BUSY` - The search backend is temporarily over capacity, which is not a fault in the request. Retry the same request after a few seconds, with backoff." }, "504": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "request_id", "error" ], "properties": { "error": { "type": "object", "required": [ "message", "code" ], "properties": { "code": { "type": "integer", "description": "The HTTP status of this response, repeated." }, "message": { "type": "string", "description": "What went wrong, in English. Where a code names the fault, it ends this message in parentheses." } }, "description": "What went wrong." }, "status": { "type": "string", "description": "`ERROR` on every error response." }, "request_id": { "type": "string", "description": "A unique ID to trace the failed request." } } } } }, "description": "The request did not complete within the time this API allows. `error.message` carries no code. Retry later, with backoff." } }, "parameters": [ { "in": "query", "name": "country", "schema": { "type": "string", "maxLength": 256 }, "example": "US", "required": true, "description": "Find businesses in a specific country, as one ISO 3166-1 alpha-2 code. It is required.\n\nSend one code per request. A list of codes, comma separated or as the parameter sent more than once, and an unknown code are rejected with a 400 error.\n\nFor a list of supported country codes see *https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2*.\n\n**Examples:**\n\n`US`" }, { "in": "query", "name": "top_right", "schema": { "type": "string" }, "example": "41.89,-87.62", "required": true, "description": "The top-right (north-east) corner of the bounding box to search in, as a \"lat,lng\" string.\n\nRequired together with bottom_left.\n\n**Examples:**\n\n`41.9,-87.6`" }, { "in": "query", "name": "bottom_left", "schema": { "type": "string" }, "example": "41.87,-87.64", "required": true, "description": "The bottom-left (south-west) corner of the bounding box to search in, as a \"lat,lng\" string.\n\nRequired together with top_right.\n\n**Examples:**\n\n`41.8,-87.7`" }, { "in": "query", "name": "limit", "schema": { "type": "integer" }, "example": 10, "required": false, "description": "Maximum number of businesses to return.\n\n**Allowed values:** `1-500`" }, { "in": "query", "name": "cursor", "schema": { "type": "string", "maxLength": 1024 }, "required": false, "description": "Pagination cursor for fetching the next page. Pass the `cursor` value returned in the previous response. Omit it on the first request.\n\n**Note:** a cursor is only valid for the exact query that produced it, and it expires. Do not build or edit one." }, { "in": "query", "name": "business_category", "schema": { "oneOf": [ { "type": "string", "pattern": "^[^,]{0,256}(,[^,]{0,256}){0,19}$" }, { "type": "array", "items": { "type": "string", "maxLength": 256 }, "maxItems": 20 } ] }, "examples": { "single": { "value": "restaurant" }, "multiple": { "value": "restaurant,bank,photography studio", "description": "The same values as repeated occurrences: `business_category=restaurant&business_category=bank&business_category=photography studio`." } }, "required": false, "description": "Find businesses carrying a specific category. Accepts a comma separated list (e.g., `restaurant`, `bank`) or multiple `business_category` parameters (e.g., `business_category=restaurant&business_category=bank`) of up to 20 values.\n\n**Examples:**\n\n`restaurant`\n\n`restaurant,bank,photography studio`" }, { "in": "query", "name": "state", "schema": { "oneOf": [ { "type": "string", "pattern": "^[^,]{0,256}(,[^,]{0,256}){0,19}$" }, { "type": "array", "items": { "type": "string", "maxLength": 256 }, "maxItems": 20 } ] }, "examples": { "codes": { "value": "IL,FL" }, "single": { "value": "Illinois" }, "multiple": { "value": "Illinois,Florida,Ontario", "description": "The same values as repeated occurrences: `state=Illinois&state=Florida&state=Ontario`." } }, "required": false, "description": "Find businesses in a specific state or province. Accepts a comma separated list (e.g., `Illinois`, `Florida`) or multiple `state` parameters (e.g., `state=Illinois&state=Florida`) of up to 20 values.\n\nUS states match either way they are sent, by full name or by two-letter code.\n\n**Examples:**\n\n`Illinois`\n\n`Illinois,Florida,Ontario`\n\n`IL,FL`" }, { "in": "query", "name": "city", "schema": { "oneOf": [ { "type": "string", "maxLength": 256 }, { "type": "array", "items": { "type": "string", "maxLength": 256 }, "maxItems": 20 } ] }, "example": "Chicago", "required": false, "description": "Find businesses in a specific city.\n\nAccepts multiple `city` parameters (e.g., `city=value1&city=value2`) of up to 20 values.\n\nValues cannot be comma separated here, as a comma can be part of the value. In the POST form, send an array instead.\n\n**Examples:**\n\n`Chicago`" }, { "in": "query", "name": "zipcode", "schema": { "oneOf": [ { "type": "string", "pattern": "^[^,]{0,256}(,[^,]{0,256}){0,19}$" }, { "type": "array", "items": { "type": "string", "maxLength": 256 }, "maxItems": 20 } ] }, "examples": { "single": { "value": "60602" }, "multiple": { "value": "60602,98112,33186", "description": "The same values as repeated occurrences: `zipcode=60602&zipcode=98112&zipcode=33186`." } }, "required": false, "description": "Find businesses in a specific ZIP / postal code. Accepts a comma separated list (e.g., `60602`, `98112`) or multiple `zipcode` parameters (e.g., `zipcode=60602&zipcode=98112`) of up to 20 values.\n\n**Examples:**\n\n`60602`\n\n`60602,98112,33186`" }, { "in": "query", "name": "district", "schema": { "oneOf": [ { "type": "string", "maxLength": 256 }, { "type": "array", "items": { "type": "string", "maxLength": 256 }, "maxItems": 20 } ] }, "example": "Chicago Loop", "required": false, "description": "Find businesses in a specific district or neighbourhood, when the listing carries one.\n\nAccepts multiple `district` parameters (e.g., `district=value1&district=value2`) of up to 20 values.\n\nValues cannot be comma separated here, as a comma can be part of the value. In the POST form, send an array instead.\n\n**Examples:**\n\n`Chicago Loop`" }, { "in": "query", "name": "name", "schema": { "type": "string", "maxLength": 256 }, "examples": { "miami": { "value": "Truist" }, "chicago": { "value": "Office of City Treasurer" }, "seattle": { "value": "Avante Catering" } }, "required": false, "description": "Find businesses by their display name.\n\n**Examples:**\n\n`Office of City Treasurer`\n\n`Avante Catering`\n\n`Truist`" }, { "in": "query", "name": "main_business_category", "schema": { "oneOf": [ { "type": "string", "pattern": "^[^,]{0,256}(,[^,]{0,256}){0,19}$" }, { "type": "array", "items": { "type": "string", "maxLength": 256 }, "maxItems": 20 } ] }, "examples": { "single": { "value": "Coffee shop" }, "multiple": { "value": "Coffee shop,Hotel,Bakery", "description": "The same values as repeated occurrences: `main_business_category=Coffee shop&main_business_category=Hotel&main_business_category=Bakery`." } }, "required": false, "description": "Find businesses whose primary category matches. Same value space as the business_category parameter. Accepts a comma separated list (e.g., `Coffee shop`, `Hotel`) or multiple `main_business_category` parameters (e.g., `main_business_category=Coffee shop&main_business_category=Hotel`) of up to 20 values.\n\n**Examples:**\n\n`Coffee shop`\n\n`Coffee shop,Hotel,Bakery`" }, { "in": "query", "name": "business_category_id", "schema": { "oneOf": [ { "type": "string", "pattern": "^[^,]{0,256}(,[^,]{0,256}){0,19}$" }, { "type": "array", "items": { "type": "string", "maxLength": 256 }, "maxItems": 20 } ] }, "examples": { "single": { "value": "bakery" }, "multiple": { "value": "bakery,catholic_church,psychotherapist", "description": "The same values as repeated occurrences: `business_category_id=bakery&business_category_id=catholic_church&business_category_id=psychotherapist`." } }, "required": false, "description": "Find businesses by Google's internal entity-type IDs. Accepts a comma separated list (e.g., `bakery`, `catholic_church`) or multiple `business_category_id` parameters (e.g., `business_category_id=bakery&business_category_id=catholic_church`) of up to 20 values.\n\nThese are entity types rather than the listing's categories: the values are broad and a listing usually carries several of them, so this is a wide filter.\n\nThe IDs are gcids (Google Maps category IDs). For a list of gcids see *https://www.openwebninja.com/blog/all-google-maps-categories*.\n\n**Examples:**\n\n`bakery`\n\n`bakery,catholic_church,psychotherapist`" }, { "in": "query", "name": "main_business_category_id", "schema": { "oneOf": [ { "type": "string", "pattern": "^[^,]{0,256}(,[^,]{0,256}){0,19}$" }, { "type": "array", "items": { "type": "string", "maxLength": 256 }, "maxItems": 20 } ] }, "examples": { "single": { "value": "restaurant" }, "multiple": { "value": "restaurant,hotel,dentist", "description": "The same values as repeated occurrences: `main_business_category_id=restaurant&main_business_category_id=hotel&main_business_category_id=dentist`." } }, "required": false, "description": "Find businesses by Google's internal ID of the primary category. Accepts a comma separated list (e.g., `restaurant`, `hotel`) or multiple `main_business_category_id` parameters (e.g., `main_business_category_id=restaurant&main_business_category_id=hotel`) of up to 20 values.\n\nThis is the machine ID, not the display label the main_business_category parameter matches, and the two can name different primaries.\n\nThe IDs are gcids (Google Maps category IDs). For a list of gcids see *https://www.openwebninja.com/blog/all-google-maps-categories*.\n\n**Examples:**\n\n`restaurant`\n\n`restaurant,hotel,dentist`" }, { "in": "query", "name": "phone_number", "schema": { "oneOf": [ { "type": "string", "pattern": "^[^,]{0,256}(,[^,]{0,256}){0,19}$" }, { "type": "array", "items": { "type": "string", "maxLength": 256 }, "maxItems": 20 } ] }, "examples": { "single": { "value": "+13127443356" }, "multiple": { "value": "+13127443356,+12063248900,+13053784725", "description": "The same values as repeated occurrences: `phone_number=+13127443356&phone_number=+12063248900`." } }, "required": false, "description": "Find businesses by phone number. Accepts a comma separated list (e.g., `+13127443356`, `+12063248900`) or multiple `phone_number` parameters (e.g., `phone_number=%2B13127443356&phone_number=%2B12063248900`) of up to 20 values.\n\nSend the number with its country code, either in E.164 *(`+14325551234`, URL-encoded as `%2B14325551234`)* or in a decorated form such as `1-432-555-1234`, `(432) 555-1234` or `0014325551234`.\n\n**Examples:**\n\n`+13127443356`\n\n`+13127443356,+12063248900,+13053784725`" }, { "in": "query", "name": "address", "schema": { "type": "string", "maxLength": 256 }, "examples": { "miami": { "value": "Truist, 12390 SW 120th St, Miami, FL 33186" }, "chicago": { "value": "Office of City Treasurer, 121 N LaSalle St #106, Chicago, IL 60602" }, "seattle": { "value": "Avante Catering, 5600 Delridge Wy SW, Seattle, WA 98106" } }, "required": false, "description": "Find businesses by their full formatted address, including the business name.\n\n**Examples:**\n\n`Office of City Treasurer, 121 N LaSalle St #106, Chicago, IL 60602`\n\n`Avante Catering, 5600 Delridge Wy SW, Seattle, WA 98106`\n\n`Truist, 12390 SW 120th St, Miami, FL 33186`" }, { "in": "query", "name": "street_address", "schema": { "oneOf": [ { "type": "string", "maxLength": 256 }, { "type": "array", "items": { "type": "string", "maxLength": 256 }, "maxItems": 20 } ] }, "example": "121 N LaSalle St #106", "required": false, "description": "Find businesses by the street line of their address on its own.\n\nA single value is matched loosely, which also finds spelling and abbreviation variants. Several values are matched exactly instead, which narrows the result.\n\nAccepts multiple `street_address` parameters (e.g., `street_address=value1&street_address=value2`) of up to 20 values.\n\nValues cannot be comma separated here, as a comma can be part of the value. In the POST form, send an array instead.\n\n**Examples:**\n\n`121 N LaSalle St #106`" }, { "in": "query", "name": "business_id", "schema": { "oneOf": [ { "type": "string", "pattern": "^[^,]{0,256}(,[^,]{0,256}){0,19}$" }, { "type": "array", "items": { "type": "string", "maxLength": 256 }, "maxItems": 20 } ] }, "examples": { "single": { "value": "0x102b644d009e013:0xea49e9ee285fa7bf" }, "multiple": { "value": "0x102b644d009e013:0xea49e9ee285fa7bf,0x1792d85c519234b:0x91eebb9c864b198d,0x1138baa323ef021:0x7c312666da760370", "description": "The same values as repeated occurrences: `business_id=id1&business_id=id2&business_id=id3`." } }, "required": false, "description": "Find businesses by their unique Business Id, matched exactly. Accepts a comma separated list (e.g., `0x102b644d009e013:0xea49e9ee285fa7bf`, `0x1792d85c519234b:0x91eebb9c864b198d`) or multiple `business_id` parameters (e.g., `business_id=0x102b644d009e013:0xea49e9ee285fa7bf&business_id=0x1792d85c519234b:0x91eebb9c864b198d`) of up to 20 values.\n\n**Examples:**\n\n`0x102b644d009e013:0xea49e9ee285fa7bf`\n\n`0x102b644d009e013:0xea49e9ee285fa7bf,0x1792d85c519234b:0x91eebb9c864b198d`" }, { "in": "query", "name": "owner_name", "schema": { "oneOf": [ { "type": "string", "maxLength": 256 }, { "type": "array", "items": { "type": "string", "maxLength": 256 }, "maxItems": 20 } ] }, "example": "Office of City Treasurer", "required": false, "description": "Find businesses by the name on the owner profile.\n\nAccepts multiple `owner_name` parameters (e.g., `owner_name=value1&owner_name=value2`) of up to 20 values.\n\nValues cannot be comma separated here, as a comma can be part of the value. In the POST form, send an array instead.\n\n**Examples:**\n\n`Office of City Treasurer`" }, { "in": "query", "name": "verified", "schema": { "type": "boolean" }, "example": true, "required": false, "description": "Find businesses by whether their Google listing is claimed by the owner: `true` for claimed listings, `false` for unclaimed ones.\n\nA business whose claim status is unknown, with no `verified` in its record, matches neither value, so `verified=false` never returns it. Claim status fills in as listings are refreshed, so coverage grows over the first month after release.\n\n**Examples:**\n\n`true`" }, { "in": "query", "name": "fields", "schema": { "type": "string", "pattern": "^\\s*$|^\\s*(business_id|name|address|lat|lng|categories|main_category|phone|website|tld|status|rating|review_count|place_id|google_mid|cid|place_link|timezone|owner_id|owner_name|owner_link|address_short|district|street_address|city|zipcode|state|country|photo_count|photos_sample|verified|opening_status|working_hours|opening_date|reviews_per_rating|price_level|reviews_link|booking_link|order_link|reservations_link|category_ids|main_category_id|about|closed_dow|open_24_7|located_in|hotel_stars|hotel_amenities|hotel_location_rating|hotel_review_summary|hotel_booking_options|hotel_results_from_web|first_seen|last_seen|last_changed)(\\s*,\\s*(business_id|name|address|lat|lng|categories|main_category|phone|website|tld|status|rating|review_count|place_id|google_mid|cid|place_link|timezone|owner_id|owner_name|owner_link|address_short|district|street_address|city|zipcode|state|country|photo_count|photos_sample|verified|opening_status|working_hours|opening_date|reviews_per_rating|price_level|reviews_link|booking_link|order_link|reservations_link|category_ids|main_category_id|about|closed_dow|open_24_7|located_in|hotel_stars|hotel_amenities|hotel_location_rating|hotel_review_summary|hotel_booking_options|hotel_results_from_web|first_seen|last_seen|last_changed)){0,54}\\s*$" }, "required": false, "description": "A comma separated list of business fields to include in the response (field projection).\n\nBy default all fields are returned. `business_id` is always included.\n\n**Allowed values:** `business_id`, `name`, `address`, `lat`, `lng`, `categories`, `main_category`, `phone`, `website`, `tld`, `status`, `rating`, `review_count`, `place_id`, `google_mid`, `cid`, `place_link`, `timezone`, `owner_id`, `owner_name`, `owner_link`, `address_short`, `district`, `street_address`, `city`, `zipcode`, `state`, `country`, `photo_count`, `photos_sample`, `verified`, `opening_status`, `working_hours`, `opening_date`, `reviews_per_rating`, `price_level`, `reviews_link`, `booking_link`, `order_link`, `reservations_link`, `category_ids`, `main_category_id`, `about`, `closed_dow`, `open_24_7`, `located_in`, `hotel_stars`, `hotel_amenities`, `hotel_location_rating`, `hotel_review_summary`, `hotel_booking_options`, `hotel_results_from_web`, `first_seen`, `last_seen`, `last_changed`\n\n**Note:** field projection trims the response body only. It does not change how the request is billed." } ], "description": "Search business listings within a rectangular area defined by its bottom-left (south-west) and top-right (north-east) corner coordinates.\n\nBoth corners are required, and any field parameter of the Search endpoint can be combined with them.\n\nOne country is searched per request, and `country` is required.\n\n**Note:** `match_count` is the total number of matching businesses, not the number returned on this page. A `cursor` is returned while further pages are available and omitted on the last page.\n\n**Note:** a query that matches nothing is not an error. The response is a `200` with an empty `businesses` array.", "operationId": "near_realtime_business_data__Area_Search_By_Bounding_Box", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing detailed response schema" ], "pages": [ 1 ], "sourceId": "sds_y_pAgcC-xJrVMI2TjrXI0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/min_lat", "/parameters/query/max_lat", "/parameters/query/min_lng", "/parameters/query/max_lng", "/description", "/operationId" ], "revisionId": "sdrn_58jSAkKvEcC3bWRtd9F4t" } ], "x-zeroclick-services": [ "local-business-database" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "local-business-database", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "local-business-database", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/local-business-database/area-search-by-radius": { "get": { "summary": "Area Search By Radius", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "request_id", "parameters", "data" ], "properties": { "data": { "type": "object", "required": [ "businesses", "match_count", "limit" ], "properties": { "limit": { "type": "number", "description": "Maximum number of results requested for this page (the limit parameter, or its default)." }, "businesses": { "type": "array", "items": { "type": "object", "required": [ "business_id" ], "properties": { "cid": { "type": "string", "description": "Google CID (Customer ID) of the business." }, "lat": { "type": "number", "description": "Latitude of the business location." }, "lng": { "type": "number", "description": "Longitude of the business location." }, "tld": { "type": "string", "description": "Domain of the business website." }, "city": { "type": "string", "description": "City of the business location." }, "name": { "type": "string", "description": "Display name of the business." }, "about": { "type": "object", "required": [ "summary", "details" ], "properties": { "details": { "type": "object", "nullable": true, "description": "Structured attribute map, grouped by attribute category (e.g. accessibility, amenities), each mapping an attribute identifier to a boolean.", "additionalProperties": { "type": "object", "additionalProperties": { "type": "boolean" } } }, "summary": { "type": "string", "nullable": true, "description": "Free-text description of the business." } }, "description": "Free-form summary and a structured details map of business attributes.", "additionalProperties": false }, "phone": { "type": "string", "description": "Business phone number in E.164 format when available." }, "state": { "type": "string", "description": "State / region of the business location." }, "rating": { "type": "number", "description": "Average review rating (1-5) on Google Maps." }, "status": { "enum": [ "operational", "closed", "temporarily_closed" ], "type": "string", "description": "Operational status of the business. Values: operational, closed, temporarily_closed." }, "address": { "type": "string", "description": "Full formatted address, including the business name." }, "country": { "type": "string", "description": "ISO 3166-1 alpha-2 country code of the business location: the country of its Google address or, when that address names none, the country of the map area the business was found in. Absent when neither is known." }, "website": { "type": "string", "description": "Business website URL." }, "zipcode": { "type": "string", "description": "ZIP / postal code of the business location." }, "district": { "type": "string", "description": "District or neighbourhood of the business location." }, "owner_id": { "type": "string", "description": "ID of the Google Maps contributor account that owns this listing." }, "place_id": { "type": "string", "description": "Google Maps Place ID." }, "timezone": { "type": "string", "description": "IANA timezone of the business location." }, "verified": { "type": "boolean", "description": "Whether the business is verified by Google." }, "last_seen": { "type": "string", "description": "ISO 8601 UTC datetime the listing was last collected." }, "open_24_7": { "type": "boolean", "description": "Whether the business is open 24 hours a day, every day of the week." }, "categories": { "type": "array", "items": { "type": "string" }, "description": "List of business categories as labelled by Google Maps." }, "closed_dow": { "type": "array", "items": { "type": "number" }, "description": "Days of the week the business is closed, as ISO-8601 day numbers (1 = Monday, 7 = Sunday)." }, "first_seen": { "type": "string", "description": "ISO 8601 UTC datetime the listing was first collected." }, "google_mid": { "type": "string", "description": "Google Knowledge Graph machine ID." }, "located_in": { "type": "object", "required": [ "google_id", "name" ], "properties": { "name": { "type": "string", "description": "Name of the parent place." }, "google_id": { "type": "string", "description": "Google ID of the parent place." } }, "description": "Parent place this business is located in (e.g. mall) when applicable.", "additionalProperties": false }, "order_link": { "type": "string", "description": "URL to place an order (when published)." }, "owner_link": { "type": "string", "description": "Link to the owner profile on Google Maps." }, "owner_name": { "type": "string", "description": "Display name of the owner profile." }, "place_link": { "type": "string", "description": "Google Maps URL for the business." }, "business_id": { "type": "string", "description": "Unique Google identifier of the business." }, "hotel_stars": { "type": "number", "description": "Hotel-only: star rating (1-5). Present only for hotels." }, "photo_count": { "type": "number", "description": "Total number of photos available for the business." }, "price_level": { "type": "string", "description": "Price level as shown on Google Maps (e.g. '$10-20')." }, "booking_link": { "type": "string", "description": "URL to book a service or appointment (when published)." }, "category_ids": { "type": "array", "items": { "type": "string" }, "description": "Google's internal entity-type IDs for the business. Broader than categories, and usually several per business. The IDs are gcids (Google Maps category IDs). For a list of gcids see *https://www.openwebninja.com/blog/all-google-maps-categories*." }, "last_changed": { "type": "string", "description": "ISO 8601 UTC datetime the listing data last changed." }, "opening_date": { "type": "string", "description": "Date the business opened (when published by Google)." }, "review_count": { "type": "number", "description": "Total number of Google Maps reviews on the business." }, "reviews_link": { "type": "string", "description": "URL to view reviews on Google Maps." }, "address_short": { "type": "string", "description": "Formatted address without the business name." }, "main_category": { "type": "string", "description": "Primary business category as labelled by Google Maps." }, "photos_sample": { "type": "array", "items": { "type": "object", "required": [ "photo_id", "photo_url", "photo_url_large", "video_thumbnail_url", "latitude", "longitude", "type", "photo_datetime_utc", "photo_timestamp" ], "properties": { "type": { "enum": [ "photo", "street_view", "video" ], "type": "string", "description": "Media type. Values: photo, video, street_view." }, "latitude": { "type": "number", "nullable": true, "description": "Latitude where the photo was taken (when known)." }, "photo_id": { "type": "string", "description": "Unique Google identifier of the photo." }, "longitude": { "type": "number", "nullable": true, "description": "Longitude where the photo was taken (when known)." }, "photo_url": { "type": "string", "nullable": true, "description": "URL of the photo (default resolution)." }, "photo_timestamp": { "type": "number", "nullable": true, "description": "Unix epoch seconds matching photo_datetime_utc." }, "photo_url_large": { "type": "string", "nullable": true, "description": "URL of the photo at a larger resolution." }, "photo_datetime_utc": { "type": "string", "nullable": true, "description": "Original publication datetime of the photo in ISO 8601 UTC." }, "video_thumbnail_url": { "type": "string", "nullable": true, "description": "Thumbnail URL when the media is a video; null for still photos." } }, "additionalProperties": false }, "description": "Sample of representative photos for the business." }, "working_hours": { "type": "object", "description": "Working hours map keyed by day of the week. Each value is an array of time-range strings; absent when not published.", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "opening_status": { "type": "string", "description": "Current opening status string as shown on Google Maps (e.g. 'Open', 'Closed', 'Open 24 hours')." }, "street_address": { "type": "string", "description": "Street name and number portion of the address." }, "hotel_amenities": { "type": "object", "description": "Hotel-only: map of amenity name to availability (true/false). Present only for hotels.", "additionalProperties": { "type": "boolean" } }, "main_category_id": { "type": "string", "description": "Google's internal ID of the primary category. The ID is a gcid (Google Maps category ID). For a list of gcids see *https://www.openwebninja.com/blog/all-google-maps-categories*." }, "reservations_link": { "type": "string", "description": "URL to make a reservation (when published)." }, "reviews_per_rating": { "type": "object", "required": [ "1", "2", "3", "4", "5" ], "properties": { "1": { "type": "number", "description": "Number of 1-star reviews." }, "2": { "type": "number", "description": "Number of 2-star reviews." }, "3": { "type": "number", "description": "Number of 3-star reviews." }, "4": { "type": "number", "description": "Number of 4-star reviews." }, "5": { "type": "number", "description": "Number of 5-star reviews." } }, "description": "Counts of reviews per integer rating from 1 to 5.", "additionalProperties": false }, "hotel_review_summary": { "type": "object", "description": "Hotel-only: AI-generated review summary. Present only for hotels.", "additionalProperties": { "type": "object", "required": [ "score", "summary" ], "properties": { "score": { "type": "number", "nullable": true }, "summary": { "type": "string", "nullable": true } }, "additionalProperties": false } }, "hotel_booking_options": { "type": "array", "items": { "type": "object", "required": [ "source", "price", "link", "source_favicon" ], "properties": { "link": { "type": "string", "nullable": true, "description": "URL to book with the provider." }, "price": { "type": "string", "nullable": true, "description": "Nightly price as shown by the provider." }, "rooms": { "type": "array", "items": { "type": "object", "required": [ "room_type", "link", "price" ], "properties": { "link": { "type": "string", "nullable": true, "description": "URL to book this room type." }, "price": { "type": "string", "nullable": true, "description": "Price of this room type as shown by the provider." }, "room_type": { "type": "string", "nullable": true, "description": "Name of the room type." } }, "additionalProperties": false }, "description": "Room types offered by this provider." }, "source": { "type": "string", "nullable": true, "description": "Booking provider the option comes from." }, "source_favicon": { "type": "string", "nullable": true, "description": "URL of the provider favicon." } }, "additionalProperties": false }, "description": "Hotel-only: booking options (provider, price, link). Present only for hotels with live rates." }, "hotel_location_rating": { "type": "object", "required": [ "Overall", "Things to do", "Transit", "Airports" ], "properties": { "Overall": { "type": "number", "nullable": true, "description": "Hotel-only: overall location rating." }, "Transit": { "type": "number", "nullable": true, "description": "Hotel-only: location rating for transit access." }, "Airports": { "type": "number", "nullable": true, "description": "Hotel-only: location rating for airport access." }, "Things to do": { "type": "number", "nullable": true, "description": "Hotel-only: location rating for things to do nearby." } }, "description": "Hotel-only: location rating breakdown when the business is a hotel.", "additionalProperties": false }, "hotel_results_from_web": { "type": "array", "items": { "type": "object", "required": [ "source", "link", "source_favicon" ], "properties": { "link": { "type": "string", "nullable": true, "description": "URL of the result." }, "source": { "type": "string", "nullable": true, "description": "Website the result comes from." }, "source_favicon": { "type": "string", "nullable": true, "description": "URL of the source favicon." } }, "additionalProperties": false }, "description": "Hotel-only: additional web-sourced results shown alongside the Google listing." } }, "additionalProperties": false }, "description": "List of businesses returned." }, "match_count": { "type": "number", "description": "Total number of businesses matching the query, across all pages. It is counted on the first page and repeated on every later page, so it can differ from a fresh count if listings change while you page." } }, "description": "Businesses matching the query inside the radius, with the total match count and the page size applied." }, "cursor": { "type": "string", "description": "Pagination cursor for the next page of results. Pass it back as the `cursor` parameter together with the same query. Absent on the last page." }, "status": { "type": "string", "description": "The status of the API response." }, "parameters": { "type": "object", "description": "The parameters the API received and used for this request, echoed back.", "additionalProperties": true }, "request_id": { "type": "string", "description": "A unique ID to trace the API request." } } } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "request_id", "error" ], "properties": { "error": { "type": "object", "required": [ "message", "code" ], "properties": { "code": { "type": "integer", "description": "The HTTP status of this response, repeated." }, "message": { "type": "string", "description": "What went wrong, in English. Where a code names the fault, it ends this message in parentheses." } }, "description": "What went wrong." }, "status": { "type": "string", "description": "`ERROR` on every error response." }, "request_id": { "type": "string", "description": "A unique ID to trace the failed request." } } } } }, "description": "The request was refused.\n\n`error.message` ends with its code in parentheses, as in `(UNKNOWN_FIELD)`; a message that ends in none is `VALIDATION_ERROR`. Branch on the code rather than on the English before it:\n\n`VALIDATION_ERROR` - A parameter this operation accepts was sent in a form it does not, a required parameter is missing, or the request's path and method are not one this API serves. Correct the request: `message` names the offending parameter and the accepted form.\n\n`UNKNOWN_FIELD` - A parameter name this operation does not accept, or a name in `fields` it does not return. It is a spelling fix.\n\n`INVALID_CURSOR` - The page token is not one this API issued for this request, or it can no longer be resumed. Start again from the first page.\n\n`CURSOR_EXPIRED` - The page token was issued for this request, but the walk took longer than its lifetime. Start again from the first page." }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." }, "429": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "request_id", "error" ], "properties": { "error": { "type": "object", "required": [ "message", "code" ], "properties": { "code": { "type": "integer", "description": "The HTTP status of this response, repeated." }, "message": { "type": "string", "description": "What went wrong, in English. Where a code names the fault, it ends this message in parentheses." } }, "description": "What went wrong." }, "status": { "type": "string", "description": "`ERROR` on every error response." }, "request_id": { "type": "string", "description": "A unique ID to trace the failed request." } } } } }, "description": "The plan behind this API key has no requests left for this API. `error.message` carries no code. Retrying does not help until the plan allows further requests." }, "500": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "request_id", "error" ], "properties": { "error": { "type": "object", "required": [ "message", "code" ], "properties": { "code": { "type": "integer", "description": "The HTTP status of this response, repeated." }, "message": { "type": "string", "description": "What went wrong, in English. Where a code names the fault, it ends this message in parentheses." } }, "description": "What went wrong." }, "status": { "type": "string", "description": "`ERROR` on every error response." }, "request_id": { "type": "string", "description": "A unique ID to trace the failed request." } } } } }, "description": "The request failed on this API's side.\n\n`error.message` ends with its code in parentheses, as in `(INTERNAL_ERROR)`. Branch on the code rather than on the English before it:\n\n`INTERNAL_ERROR` - An unexpected failure on this service's side, not a fault in the request; no further detail is echoed. Retry later, with backoff.\n\n**Note:** a 500 whose message ends in no code carries no further detail about its cause. Retry later, with backoff." }, "502": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "request_id", "error" ], "properties": { "error": { "type": "object", "required": [ "message", "code" ], "properties": { "code": { "type": "integer", "description": "The HTTP status of this response, repeated." }, "message": { "type": "string", "description": "What went wrong, in English. Where a code names the fault, it ends this message in parentheses." } }, "description": "What went wrong." }, "status": { "type": "string", "description": "`ERROR` on every error response." }, "request_id": { "type": "string", "description": "A unique ID to trace the failed request." } } } } }, "description": "A service this API depends on did not complete the request.\n\n`error.message` ends with its code in parentheses, as in `(UPSTREAM_ERROR)`. Branch on the code rather than on the English before it:\n\n`UPSTREAM_ERROR` - The search backend rejected the query. Narrow the query rather than retrying it unchanged.\n\n**Note:** a 502 whose message ends in no code carries no further detail about its cause. Retry later, with backoff." }, "503": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "request_id", "error" ], "properties": { "error": { "type": "object", "required": [ "message", "code" ], "properties": { "code": { "type": "integer", "description": "The HTTP status of this response, repeated." }, "message": { "type": "string", "description": "What went wrong, in English. Where a code names the fault, it ends this message in parentheses." } }, "description": "What went wrong." }, "status": { "type": "string", "description": "`ERROR` on every error response." }, "request_id": { "type": "string", "description": "A unique ID to trace the failed request." } } } } }, "description": "This API is temporarily unable to serve the request.\n\n`error.message` ends with its code in parentheses, as in `(SEARCH_BUSY)`. Branch on the code rather than on the English before it:\n\n`SEARCH_BUSY` - The search backend is temporarily over capacity, which is not a fault in the request. Retry the same request after a few seconds, with backoff." }, "504": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "request_id", "error" ], "properties": { "error": { "type": "object", "required": [ "message", "code" ], "properties": { "code": { "type": "integer", "description": "The HTTP status of this response, repeated." }, "message": { "type": "string", "description": "What went wrong, in English. Where a code names the fault, it ends this message in parentheses." } }, "description": "What went wrong." }, "status": { "type": "string", "description": "`ERROR` on every error response." }, "request_id": { "type": "string", "description": "A unique ID to trace the failed request." } } } } }, "description": "The request did not complete within the time this API allows. `error.message` carries no code. Retry later, with backoff." } }, "parameters": [ { "in": "query", "name": "country", "schema": { "type": "string", "maxLength": 256 }, "example": "US", "required": true, "description": "Find businesses in a specific country, as one ISO 3166-1 alpha-2 code. It is required.\n\nSend one code per request. A list of codes, comma separated or as the parameter sent more than once, and an unknown code are rejected with a 400 error.\n\nFor a list of supported country codes see *https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2*.\n\n**Examples:**\n\n`US`" }, { "in": "query", "name": "lat", "schema": { "type": "number", "maximum": 90, "minimum": -90 }, "example": 41.8827, "required": true, "description": "Latitude of the center coordinate point of the area to search in.\n\nRequired together with lng and radius." }, { "in": "query", "name": "lng", "schema": { "type": "number", "maximum": 180, "minimum": -180 }, "example": -87.6233, "required": true, "description": "Longitude of the center coordinate point of the area to search in.\n\nRequired together with lat and radius." }, { "in": "query", "name": "radius", "schema": { "type": "number", "maximum": 100000, "minimum": 0, "exclusiveMinimum": true }, "example": 1000, "required": true, "description": "Radius of the area to search in, in meters.\n\n**Allowed values:** `1-100000`" }, { "in": "query", "name": "limit", "schema": { "type": "integer" }, "example": 10, "required": false, "description": "Maximum number of businesses to return.\n\n**Allowed values:** `1-500`" }, { "in": "query", "name": "cursor", "schema": { "type": "string", "maxLength": 1024 }, "required": false, "description": "Pagination cursor for fetching the next page. Pass the `cursor` value returned in the previous response. Omit it on the first request.\n\n**Note:** a cursor is only valid for the exact query that produced it, and it expires. Do not build or edit one." }, { "in": "query", "name": "business_category", "schema": { "oneOf": [ { "type": "string", "pattern": "^[^,]{0,256}(,[^,]{0,256}){0,19}$" }, { "type": "array", "items": { "type": "string", "maxLength": 256 }, "maxItems": 20 } ] }, "examples": { "single": { "value": "restaurant" }, "multiple": { "value": "restaurant,bank,photography studio", "description": "The same values as repeated occurrences: `business_category=restaurant&business_category=bank&business_category=photography studio`." } }, "required": false, "description": "Find businesses carrying a specific category. Accepts a comma separated list (e.g., `restaurant`, `bank`) or multiple `business_category` parameters (e.g., `business_category=restaurant&business_category=bank`) of up to 20 values.\n\n**Examples:**\n\n`restaurant`\n\n`restaurant,bank,photography studio`" }, { "in": "query", "name": "state", "schema": { "oneOf": [ { "type": "string", "pattern": "^[^,]{0,256}(,[^,]{0,256}){0,19}$" }, { "type": "array", "items": { "type": "string", "maxLength": 256 }, "maxItems": 20 } ] }, "examples": { "codes": { "value": "IL,FL" }, "single": { "value": "Illinois" }, "multiple": { "value": "Illinois,Florida,Ontario", "description": "The same values as repeated occurrences: `state=Illinois&state=Florida&state=Ontario`." } }, "required": false, "description": "Find businesses in a specific state or province. Accepts a comma separated list (e.g., `Illinois`, `Florida`) or multiple `state` parameters (e.g., `state=Illinois&state=Florida`) of up to 20 values.\n\nUS states match either way they are sent, by full name or by two-letter code.\n\n**Examples:**\n\n`Illinois`\n\n`Illinois,Florida,Ontario`\n\n`IL,FL`" }, { "in": "query", "name": "city", "schema": { "oneOf": [ { "type": "string", "maxLength": 256 }, { "type": "array", "items": { "type": "string", "maxLength": 256 }, "maxItems": 20 } ] }, "example": "Chicago", "required": false, "description": "Find businesses in a specific city.\n\nAccepts multiple `city` parameters (e.g., `city=value1&city=value2`) of up to 20 values.\n\nValues cannot be comma separated here, as a comma can be part of the value. In the POST form, send an array instead.\n\n**Examples:**\n\n`Chicago`" }, { "in": "query", "name": "zipcode", "schema": { "oneOf": [ { "type": "string", "pattern": "^[^,]{0,256}(,[^,]{0,256}){0,19}$" }, { "type": "array", "items": { "type": "string", "maxLength": 256 }, "maxItems": 20 } ] }, "examples": { "single": { "value": "60602" }, "multiple": { "value": "60602,98112,33186", "description": "The same values as repeated occurrences: `zipcode=60602&zipcode=98112&zipcode=33186`." } }, "required": false, "description": "Find businesses in a specific ZIP / postal code. Accepts a comma separated list (e.g., `60602`, `98112`) or multiple `zipcode` parameters (e.g., `zipcode=60602&zipcode=98112`) of up to 20 values.\n\n**Examples:**\n\n`60602`\n\n`60602,98112,33186`" }, { "in": "query", "name": "district", "schema": { "oneOf": [ { "type": "string", "maxLength": 256 }, { "type": "array", "items": { "type": "string", "maxLength": 256 }, "maxItems": 20 } ] }, "example": "Chicago Loop", "required": false, "description": "Find businesses in a specific district or neighbourhood, when the listing carries one.\n\nAccepts multiple `district` parameters (e.g., `district=value1&district=value2`) of up to 20 values.\n\nValues cannot be comma separated here, as a comma can be part of the value. In the POST form, send an array instead.\n\n**Examples:**\n\n`Chicago Loop`" }, { "in": "query", "name": "name", "schema": { "type": "string", "maxLength": 256 }, "examples": { "miami": { "value": "Truist" }, "chicago": { "value": "Office of City Treasurer" }, "seattle": { "value": "Avante Catering" } }, "required": false, "description": "Find businesses by their display name.\n\n**Examples:**\n\n`Office of City Treasurer`\n\n`Avante Catering`\n\n`Truist`" }, { "in": "query", "name": "main_business_category", "schema": { "oneOf": [ { "type": "string", "pattern": "^[^,]{0,256}(,[^,]{0,256}){0,19}$" }, { "type": "array", "items": { "type": "string", "maxLength": 256 }, "maxItems": 20 } ] }, "examples": { "single": { "value": "Coffee shop" }, "multiple": { "value": "Coffee shop,Hotel,Bakery", "description": "The same values as repeated occurrences: `main_business_category=Coffee shop&main_business_category=Hotel&main_business_category=Bakery`." } }, "required": false, "description": "Find businesses whose primary category matches. Same value space as the business_category parameter. Accepts a comma separated list (e.g., `Coffee shop`, `Hotel`) or multiple `main_business_category` parameters (e.g., `main_business_category=Coffee shop&main_business_category=Hotel`) of up to 20 values.\n\n**Examples:**\n\n`Coffee shop`\n\n`Coffee shop,Hotel,Bakery`" }, { "in": "query", "name": "business_category_id", "schema": { "oneOf": [ { "type": "string", "pattern": "^[^,]{0,256}(,[^,]{0,256}){0,19}$" }, { "type": "array", "items": { "type": "string", "maxLength": 256 }, "maxItems": 20 } ] }, "examples": { "single": { "value": "bakery" }, "multiple": { "value": "bakery,catholic_church,psychotherapist", "description": "The same values as repeated occurrences: `business_category_id=bakery&business_category_id=catholic_church&business_category_id=psychotherapist`." } }, "required": false, "description": "Find businesses by Google's internal entity-type IDs. Accepts a comma separated list (e.g., `bakery`, `catholic_church`) or multiple `business_category_id` parameters (e.g., `business_category_id=bakery&business_category_id=catholic_church`) of up to 20 values.\n\nThese are entity types rather than the listing's categories: the values are broad and a listing usually carries several of them, so this is a wide filter.\n\nThe IDs are gcids (Google Maps category IDs). For a list of gcids see *https://www.openwebninja.com/blog/all-google-maps-categories*.\n\n**Examples:**\n\n`bakery`\n\n`bakery,catholic_church,psychotherapist`" }, { "in": "query", "name": "main_business_category_id", "schema": { "oneOf": [ { "type": "string", "pattern": "^[^,]{0,256}(,[^,]{0,256}){0,19}$" }, { "type": "array", "items": { "type": "string", "maxLength": 256 }, "maxItems": 20 } ] }, "examples": { "single": { "value": "restaurant" }, "multiple": { "value": "restaurant,hotel,dentist", "description": "The same values as repeated occurrences: `main_business_category_id=restaurant&main_business_category_id=hotel&main_business_category_id=dentist`." } }, "required": false, "description": "Find businesses by Google's internal ID of the primary category. Accepts a comma separated list (e.g., `restaurant`, `hotel`) or multiple `main_business_category_id` parameters (e.g., `main_business_category_id=restaurant&main_business_category_id=hotel`) of up to 20 values.\n\nThis is the machine ID, not the display label the main_business_category parameter matches, and the two can name different primaries.\n\nThe IDs are gcids (Google Maps category IDs). For a list of gcids see *https://www.openwebninja.com/blog/all-google-maps-categories*.\n\n**Examples:**\n\n`restaurant`\n\n`restaurant,hotel,dentist`" }, { "in": "query", "name": "phone_number", "schema": { "oneOf": [ { "type": "string", "pattern": "^[^,]{0,256}(,[^,]{0,256}){0,19}$" }, { "type": "array", "items": { "type": "string", "maxLength": 256 }, "maxItems": 20 } ] }, "examples": { "single": { "value": "+13127443356" }, "multiple": { "value": "+13127443356,+12063248900,+13053784725", "description": "The same values as repeated occurrences: `phone_number=+13127443356&phone_number=+12063248900`." } }, "required": false, "description": "Find businesses by phone number. Accepts a comma separated list (e.g., `+13127443356`, `+12063248900`) or multiple `phone_number` parameters (e.g., `phone_number=%2B13127443356&phone_number=%2B12063248900`) of up to 20 values.\n\nSend the number with its country code, either in E.164 *(`+14325551234`, URL-encoded as `%2B14325551234`)* or in a decorated form such as `1-432-555-1234`, `(432) 555-1234` or `0014325551234`.\n\n**Examples:**\n\n`+13127443356`\n\n`+13127443356,+12063248900,+13053784725`" }, { "in": "query", "name": "address", "schema": { "type": "string", "maxLength": 256 }, "examples": { "miami": { "value": "Truist, 12390 SW 120th St, Miami, FL 33186" }, "chicago": { "value": "Office of City Treasurer, 121 N LaSalle St #106, Chicago, IL 60602" }, "seattle": { "value": "Avante Catering, 5600 Delridge Wy SW, Seattle, WA 98106" } }, "required": false, "description": "Find businesses by their full formatted address, including the business name.\n\n**Examples:**\n\n`Office of City Treasurer, 121 N LaSalle St #106, Chicago, IL 60602`\n\n`Avante Catering, 5600 Delridge Wy SW, Seattle, WA 98106`\n\n`Truist, 12390 SW 120th St, Miami, FL 33186`" }, { "in": "query", "name": "street_address", "schema": { "oneOf": [ { "type": "string", "maxLength": 256 }, { "type": "array", "items": { "type": "string", "maxLength": 256 }, "maxItems": 20 } ] }, "example": "121 N LaSalle St #106", "required": false, "description": "Find businesses by the street line of their address on its own.\n\nA single value is matched loosely, which also finds spelling and abbreviation variants. Several values are matched exactly instead, which narrows the result.\n\nAccepts multiple `street_address` parameters (e.g., `street_address=value1&street_address=value2`) of up to 20 values.\n\nValues cannot be comma separated here, as a comma can be part of the value. In the POST form, send an array instead.\n\n**Examples:**\n\n`121 N LaSalle St #106`" }, { "in": "query", "name": "business_id", "schema": { "oneOf": [ { "type": "string", "pattern": "^[^,]{0,256}(,[^,]{0,256}){0,19}$" }, { "type": "array", "items": { "type": "string", "maxLength": 256 }, "maxItems": 20 } ] }, "examples": { "single": { "value": "0x102b644d009e013:0xea49e9ee285fa7bf" }, "multiple": { "value": "0x102b644d009e013:0xea49e9ee285fa7bf,0x1792d85c519234b:0x91eebb9c864b198d,0x1138baa323ef021:0x7c312666da760370", "description": "The same values as repeated occurrences: `business_id=id1&business_id=id2&business_id=id3`." } }, "required": false, "description": "Find businesses by their unique Business Id, matched exactly. Accepts a comma separated list (e.g., `0x102b644d009e013:0xea49e9ee285fa7bf`, `0x1792d85c519234b:0x91eebb9c864b198d`) or multiple `business_id` parameters (e.g., `business_id=0x102b644d009e013:0xea49e9ee285fa7bf&business_id=0x1792d85c519234b:0x91eebb9c864b198d`) of up to 20 values.\n\n**Examples:**\n\n`0x102b644d009e013:0xea49e9ee285fa7bf`\n\n`0x102b644d009e013:0xea49e9ee285fa7bf,0x1792d85c519234b:0x91eebb9c864b198d`" }, { "in": "query", "name": "owner_name", "schema": { "oneOf": [ { "type": "string", "maxLength": 256 }, { "type": "array", "items": { "type": "string", "maxLength": 256 }, "maxItems": 20 } ] }, "example": "Office of City Treasurer", "required": false, "description": "Find businesses by the name on the owner profile.\n\nAccepts multiple `owner_name` parameters (e.g., `owner_name=value1&owner_name=value2`) of up to 20 values.\n\nValues cannot be comma separated here, as a comma can be part of the value. In the POST form, send an array instead.\n\n**Examples:**\n\n`Office of City Treasurer`" }, { "in": "query", "name": "verified", "schema": { "type": "boolean" }, "example": true, "required": false, "description": "Find businesses by whether their Google listing is claimed by the owner: `true` for claimed listings, `false` for unclaimed ones.\n\nA business whose claim status is unknown, with no `verified` in its record, matches neither value, so `verified=false` never returns it. Claim status fills in as listings are refreshed, so coverage grows over the first month after release.\n\n**Examples:**\n\n`true`" }, { "in": "query", "name": "fields", "schema": { "type": "string", "pattern": "^\\s*$|^\\s*(business_id|name|address|lat|lng|categories|main_category|phone|website|tld|status|rating|review_count|place_id|google_mid|cid|place_link|timezone|owner_id|owner_name|owner_link|address_short|district|street_address|city|zipcode|state|country|photo_count|photos_sample|verified|opening_status|working_hours|opening_date|reviews_per_rating|price_level|reviews_link|booking_link|order_link|reservations_link|category_ids|main_category_id|about|closed_dow|open_24_7|located_in|hotel_stars|hotel_amenities|hotel_location_rating|hotel_review_summary|hotel_booking_options|hotel_results_from_web|first_seen|last_seen|last_changed)(\\s*,\\s*(business_id|name|address|lat|lng|categories|main_category|phone|website|tld|status|rating|review_count|place_id|google_mid|cid|place_link|timezone|owner_id|owner_name|owner_link|address_short|district|street_address|city|zipcode|state|country|photo_count|photos_sample|verified|opening_status|working_hours|opening_date|reviews_per_rating|price_level|reviews_link|booking_link|order_link|reservations_link|category_ids|main_category_id|about|closed_dow|open_24_7|located_in|hotel_stars|hotel_amenities|hotel_location_rating|hotel_review_summary|hotel_booking_options|hotel_results_from_web|first_seen|last_seen|last_changed)){0,54}\\s*$" }, "required": false, "description": "A comma separated list of business fields to include in the response (field projection).\n\nBy default all fields are returned. `business_id` is always included.\n\n**Allowed values:** `business_id`, `name`, `address`, `lat`, `lng`, `categories`, `main_category`, `phone`, `website`, `tld`, `status`, `rating`, `review_count`, `place_id`, `google_mid`, `cid`, `place_link`, `timezone`, `owner_id`, `owner_name`, `owner_link`, `address_short`, `district`, `street_address`, `city`, `zipcode`, `state`, `country`, `photo_count`, `photos_sample`, `verified`, `opening_status`, `working_hours`, `opening_date`, `reviews_per_rating`, `price_level`, `reviews_link`, `booking_link`, `order_link`, `reservations_link`, `category_ids`, `main_category_id`, `about`, `closed_dow`, `open_24_7`, `located_in`, `hotel_stars`, `hotel_amenities`, `hotel_location_rating`, `hotel_review_summary`, `hotel_booking_options`, `hotel_results_from_web`, `first_seen`, `last_seen`, `last_changed`\n\n**Note:** field projection trims the response body only. It does not change how the request is billed." } ], "description": "Search business listings within a given distance of a center coordinate point.\n\n`lat`, `lng` and `radius` are all required, and any field parameter of the Search endpoint can be combined with them.\n\nOne country is searched per request, and `country` is required.\n\n**Note:** `match_count` is the total number of matching businesses, not the number returned on this page. A `cursor` is returned while further pages are available and omitted on the last page.\n\n**Note:** a query that matches nothing is not an error. The response is a `200` with an empty `businesses` array.", "operationId": "near_realtime_business_data__Area_Search_By_Radius", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing detailed response schema" ], "pages": [ 1 ], "sourceId": "sds_y_pAgcC-xJrVMI2TjrXI0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_58jSAkKvEcC3bWRtd9F4t" } ], "x-zeroclick-services": [ "local-business-database" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "local-business-database", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "local-business-database", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/local-business-database/business-details": { "get": { "summary": "Business Details", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "request_id", "parameters", "data" ], "properties": { "data": { "type": "object", "required": [ "businesses", "match_count", "not_found" ], "properties": { "not_found": { "type": "array", "items": { "type": "string" }, "description": "The requested Business Ids that match no business, each once, in the order sent. Always present; empty when every id matched." }, "businesses": { "type": "array", "items": { "type": "object", "required": [ "business_id" ], "properties": { "cid": { "type": "string", "description": "Google CID (Customer ID) of the business." }, "lat": { "type": "number", "description": "Latitude of the business location." }, "lng": { "type": "number", "description": "Longitude of the business location." }, "tld": { "type": "string", "description": "Domain of the business website." }, "city": { "type": "string", "description": "City of the business location." }, "menu": { "type": "array", "items": { "type": "object", "required": [ "title", "description", "sections" ], "properties": { "title": { "type": "string", "nullable": true, "description": "Title of the menu." }, "sections": { "type": "array", "items": { "type": "object", "required": [ "title", "description", "menu_items" ], "properties": { "title": { "type": "string", "nullable": true, "description": "Title of the menu section." }, "menu_items": { "type": "array", "items": { "type": "object", "required": [ "title", "description", "price", "options" ], "properties": { "price": { "type": "string", "nullable": true, "description": "Price of the menu item as shown on Google Maps." }, "title": { "type": "string", "description": "Name of the menu item." }, "options": { "type": "array", "items": { "type": "object", "required": [ "title", "description", "price" ], "properties": { "price": { "type": "string", "nullable": true, "description": "Price of the menu item as shown on Google Maps." }, "title": { "type": "string", "description": "Name of the menu item." }, "description": { "type": "string", "nullable": true, "description": "Description of the menu item." } }, "additionalProperties": false }, "nullable": true, "description": "Variants of the menu item, such as sizes." }, "description": { "type": "string", "nullable": true, "description": "Description of the menu item." } }, "additionalProperties": false }, "description": "Items listed in this menu section." }, "description": { "type": "string", "nullable": true, "description": "Description of the menu section." } }, "additionalProperties": false }, "description": "Sections the menu is split into." }, "description": { "type": "string", "nullable": true, "description": "Description of the menu." } }, "additionalProperties": false }, "description": "Menu published by the business, grouped into sections." }, "name": { "type": "string", "description": "Display name of the business." }, "about": { "type": "object", "required": [ "summary", "details" ], "properties": { "details": { "type": "object", "nullable": true, "description": "Structured attribute map, grouped by attribute category (e.g. accessibility, amenities), each mapping an attribute identifier to a boolean.", "additionalProperties": { "type": "object", "additionalProperties": { "type": "boolean" } } }, "summary": { "type": "string", "nullable": true, "description": "Free-text description of the business." } }, "description": "Free-form summary and a structured details map of business attributes.", "additionalProperties": false }, "phone": { "type": "string", "description": "Business phone number in E.164 format when available." }, "state": { "type": "string", "description": "State / region of the business location." }, "rating": { "type": "number", "description": "Average review rating (1-5) on Google Maps." }, "status": { "enum": [ "operational", "closed", "temporarily_closed" ], "type": "string", "description": "Operational status of the business. Values: operational, closed, temporarily_closed." }, "address": { "type": "string", "description": "Full formatted address, including the business name." }, "country": { "type": "string", "description": "ISO 3166-1 alpha-2 country code of the business location: the country of its Google address or, when that address names none, the country of the map area the business was found in. Absent when neither is known." }, "website": { "type": "string", "description": "Business website URL." }, "zipcode": { "type": "string", "description": "ZIP / postal code of the business location." }, "district": { "type": "string", "description": "District or neighbourhood of the business location." }, "owner_id": { "type": "string", "description": "ID of the Google Maps contributor account that owns this listing." }, "place_id": { "type": "string", "description": "Google Maps Place ID." }, "timezone": { "type": "string", "description": "IANA timezone of the business location." }, "verified": { "type": "boolean", "description": "Whether the business is verified by Google." }, "last_seen": { "type": "string", "description": "ISO 8601 UTC datetime the listing was last collected." }, "open_24_7": { "type": "boolean", "description": "Whether the business is open 24 hours a day, every day of the week." }, "categories": { "type": "array", "items": { "type": "string" }, "description": "List of business categories as labelled by Google Maps." }, "closed_dow": { "type": "array", "items": { "type": "number" }, "description": "Days of the week the business is closed, as ISO-8601 day numbers (1 = Monday, 7 = Sunday)." }, "first_seen": { "type": "string", "description": "ISO 8601 UTC datetime the listing was first collected." }, "google_mid": { "type": "string", "description": "Google Knowledge Graph machine ID." }, "located_in": { "type": "object", "required": [ "google_id", "name" ], "properties": { "name": { "type": "string", "description": "Name of the parent place." }, "google_id": { "type": "string", "description": "Google ID of the parent place." } }, "description": "Parent place this business is located in (e.g. mall) when applicable.", "additionalProperties": false }, "order_link": { "type": "string", "description": "URL to place an order (when published)." }, "owner_link": { "type": "string", "description": "Link to the owner profile on Google Maps." }, "owner_name": { "type": "string", "description": "Display name of the owner profile." }, "photo_tabs": { "type": "array", "items": { "type": "string" }, "description": "Names of the photo category tabs Google Maps shows for the business (e.g. 'All', 'Menu', 'Food & drink')." }, "place_link": { "type": "string", "description": "Google Maps URL for the business." }, "price_tier": { "type": "number", "description": "Numeric price tier matching price_level, from 1 (least expensive) upwards." }, "business_id": { "type": "string", "description": "Unique Google identifier of the business." }, "hotel_stars": { "type": "number", "description": "Hotel-only: star rating (1-5). Present only for hotels." }, "photo_count": { "type": "number", "description": "Total number of photos available for the business." }, "price_level": { "type": "string", "description": "Price level as shown on Google Maps (e.g. '$10-20')." }, "booking_link": { "type": "string", "description": "URL to book a service or appointment (when published)." }, "category_ids": { "type": "array", "items": { "type": "string" }, "description": "Google's internal entity-type IDs for the business. Broader than categories, and usually several per business. The IDs are gcids (Google Maps category IDs). For a list of gcids see *https://www.openwebninja.com/blog/all-google-maps-categories*." }, "last_changed": { "type": "string", "description": "ISO 8601 UTC datetime the listing data last changed." }, "opening_date": { "type": "string", "description": "Date the business opened (when published by Google)." }, "review_count": { "type": "number", "description": "Total number of Google Maps reviews on the business." }, "reviews_link": { "type": "string", "description": "URL to view reviews on Google Maps." }, "address_short": { "type": "string", "description": "Formatted address without the business name." }, "main_category": { "type": "string", "description": "Primary business category as labelled by Google Maps." }, "photos_sample": { "type": "array", "items": { "type": "object", "required": [ "photo_id", "photo_url", "photo_url_large", "video_thumbnail_url", "latitude", "longitude", "type", "photo_datetime_utc", "photo_timestamp" ], "properties": { "type": { "enum": [ "photo", "street_view", "video" ], "type": "string", "description": "Media type. Values: photo, video, street_view." }, "latitude": { "type": "number", "nullable": true, "description": "Latitude where the photo was taken (when known)." }, "photo_id": { "type": "string", "description": "Unique Google identifier of the photo." }, "longitude": { "type": "number", "nullable": true, "description": "Longitude where the photo was taken (when known)." }, "photo_url": { "type": "string", "nullable": true, "description": "URL of the photo (default resolution)." }, "photo_timestamp": { "type": "number", "nullable": true, "description": "Unix epoch seconds matching photo_datetime_utc." }, "photo_url_large": { "type": "string", "nullable": true, "description": "URL of the photo at a larger resolution." }, "photo_datetime_utc": { "type": "string", "nullable": true, "description": "Original publication datetime of the photo in ISO 8601 UTC." }, "video_thumbnail_url": { "type": "string", "nullable": true, "description": "Thumbnail URL when the media is a video; null for still photos." } }, "additionalProperties": false }, "description": "Sample of representative photos for the business." }, "popular_times": { "type": "array", "items": { "type": "object", "required": [ "dow", "hours" ], "properties": { "dow": { "type": "number", "description": "Day of the week, as an ISO-8601 day number (1 = Monday, 7 = Sunday)." }, "hours": { "type": "array", "items": { "type": "object", "required": [ "hour", "busy_pct", "label", "wait" ], "properties": { "hour": { "type": "number", "description": "Hour of the day in 24-hour format, in the business timezone." }, "wait": { "type": "string", "nullable": true, "description": "Typical wait time at this hour, when Google publishes one." }, "label": { "type": "string", "nullable": true, "description": "Busyness label as shown on Google Maps (e.g. 'Usually not too busy')." }, "busy_pct": { "type": "number", "description": "How busy the business usually is at this hour, as a percentage of its peak." } }, "additionalProperties": false }, "description": "Hour-by-hour busyness for this day." } }, "additionalProperties": false }, "description": "Popular times histogram, one entry per day of the week." }, "working_hours": { "type": "object", "description": "Working hours map keyed by day of the week. Each value is an array of time-range strings; absent when not published.", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "opening_status": { "type": "string", "description": "Current opening status string as shown on Google Maps (e.g. 'Open', 'Closed', 'Open 24 hours')." }, "street_address": { "type": "string", "description": "Street name and number portion of the address." }, "hotel_amenities": { "type": "object", "description": "Hotel-only: map of amenity name to availability (true/false). Present only for hotels.", "additionalProperties": { "type": "boolean" } }, "main_category_id": { "type": "string", "description": "Google's internal ID of the primary category. The ID is a gcid (Google Maps category ID). For a list of gcids see *https://www.openwebninja.com/blog/all-google-maps-categories*." }, "business_services": { "type": "object", "description": "Map of service category to the list of services offered (when published by the owner).", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "reservations_link": { "type": "string", "description": "URL to make a reservation (when published)." }, "reviews_per_rating": { "type": "object", "required": [ "1", "2", "3", "4", "5" ], "properties": { "1": { "type": "number", "description": "Number of 1-star reviews." }, "2": { "type": "number", "description": "Number of 2-star reviews." }, "3": { "type": "number", "description": "Number of 3-star reviews." }, "4": { "type": "number", "description": "Number of 4-star reviews." }, "5": { "type": "number", "description": "Number of 5-star reviews." } }, "description": "Counts of reviews per integer rating from 1 to 5.", "additionalProperties": false }, "hotel_review_summary": { "type": "object", "description": "Hotel-only: AI-generated review summary. Present only for hotels.", "additionalProperties": { "type": "object", "required": [ "score", "summary" ], "properties": { "score": { "type": "number", "nullable": true }, "summary": { "type": "string", "nullable": true } }, "additionalProperties": false } }, "hotel_booking_options": { "type": "array", "items": { "type": "object", "required": [ "source", "price", "link", "source_favicon" ], "properties": { "link": { "type": "string", "nullable": true, "description": "URL to book with the provider." }, "price": { "type": "string", "nullable": true, "description": "Nightly price as shown by the provider." }, "rooms": { "type": "array", "items": { "type": "object", "required": [ "room_type", "link", "price" ], "properties": { "link": { "type": "string", "nullable": true, "description": "URL to book this room type." }, "price": { "type": "string", "nullable": true, "description": "Price of this room type as shown by the provider." }, "room_type": { "type": "string", "nullable": true, "description": "Name of the room type." } }, "additionalProperties": false }, "description": "Room types offered by this provider." }, "source": { "type": "string", "nullable": true, "description": "Booking provider the option comes from." }, "source_favicon": { "type": "string", "nullable": true, "description": "URL of the provider favicon." } }, "additionalProperties": false }, "description": "Hotel-only: booking options (provider, price, link). Present only for hotels with live rates." }, "hotel_location_rating": { "type": "object", "required": [ "Overall", "Things to do", "Transit", "Airports" ], "properties": { "Overall": { "type": "number", "nullable": true, "description": "Hotel-only: overall location rating." }, "Transit": { "type": "number", "nullable": true, "description": "Hotel-only: location rating for transit access." }, "Airports": { "type": "number", "nullable": true, "description": "Hotel-only: location rating for airport access." }, "Things to do": { "type": "number", "nullable": true, "description": "Hotel-only: location rating for things to do nearby." } }, "description": "Hotel-only: location rating breakdown when the business is a hotel.", "additionalProperties": false }, "hotel_results_from_web": { "type": "array", "items": { "type": "object", "required": [ "source", "link", "source_favicon" ], "properties": { "link": { "type": "string", "nullable": true, "description": "URL of the result." }, "source": { "type": "string", "nullable": true, "description": "Website the result comes from." }, "source_favicon": { "type": "string", "nullable": true, "description": "URL of the source favicon." } }, "additionalProperties": false }, "description": "Hotel-only: additional web-sourced results shown alongside the Google listing." } }, "additionalProperties": false }, "description": "List of businesses returned." }, "match_count": { "type": "number", "description": "Number of the requested Business Ids that resolved to a record. An id that matched nothing is listed in `not_found` instead, so this can be lower than the number of ids sent." } }, "description": "Full business records for the requested Business Ids, and the ids that matched nothing." }, "status": { "type": "string", "description": "The status of the API response." }, "parameters": { "type": "object", "description": "The parameters the API received and used for this request, echoed back.", "additionalProperties": true }, "request_id": { "type": "string", "description": "A unique ID to trace the API request." } } } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "request_id", "error" ], "properties": { "error": { "type": "object", "required": [ "message", "code" ], "properties": { "code": { "type": "integer", "description": "The HTTP status of this response, repeated." }, "message": { "type": "string", "description": "What went wrong, in English. Where a code names the fault, it ends this message in parentheses." } }, "description": "What went wrong." }, "status": { "type": "string", "description": "`ERROR` on every error response." }, "request_id": { "type": "string", "description": "A unique ID to trace the failed request." } } } } }, "description": "The request was refused.\n\n`error.message` ends with its code in parentheses, as in `(UNKNOWN_FIELD)`; a message that ends in none is `VALIDATION_ERROR`. Branch on the code rather than on the English before it:\n\n`VALIDATION_ERROR` - A parameter this operation accepts was sent in a form it does not, a required parameter is missing, or the request's path and method are not one this API serves. Correct the request: `message` names the offending parameter and the accepted form.\n\n`UNKNOWN_FIELD` - A parameter name this operation does not accept, or a name in `fields` it does not return. It is a spelling fix." }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." }, "429": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "request_id", "error" ], "properties": { "error": { "type": "object", "required": [ "message", "code" ], "properties": { "code": { "type": "integer", "description": "The HTTP status of this response, repeated." }, "message": { "type": "string", "description": "What went wrong, in English. Where a code names the fault, it ends this message in parentheses." } }, "description": "What went wrong." }, "status": { "type": "string", "description": "`ERROR` on every error response." }, "request_id": { "type": "string", "description": "A unique ID to trace the failed request." } } } } }, "description": "The plan behind this API key has no requests left for this API. `error.message` carries no code. Retrying does not help until the plan allows further requests." }, "500": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "request_id", "error" ], "properties": { "error": { "type": "object", "required": [ "message", "code" ], "properties": { "code": { "type": "integer", "description": "The HTTP status of this response, repeated." }, "message": { "type": "string", "description": "What went wrong, in English. Where a code names the fault, it ends this message in parentheses." } }, "description": "What went wrong." }, "status": { "type": "string", "description": "`ERROR` on every error response." }, "request_id": { "type": "string", "description": "A unique ID to trace the failed request." } } } } }, "description": "The request failed on this API's side.\n\n`error.message` ends with its code in parentheses, as in `(INTERNAL_ERROR)`. Branch on the code rather than on the English before it:\n\n`INTERNAL_ERROR` - An unexpected failure on this service's side, not a fault in the request; no further detail is echoed. Retry later, with backoff.\n\n**Note:** a 500 whose message ends in no code carries no further detail about its cause. Retry later, with backoff." }, "504": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "request_id", "error" ], "properties": { "error": { "type": "object", "required": [ "message", "code" ], "properties": { "code": { "type": "integer", "description": "The HTTP status of this response, repeated." }, "message": { "type": "string", "description": "What went wrong, in English. Where a code names the fault, it ends this message in parentheses." } }, "description": "What went wrong." }, "status": { "type": "string", "description": "`ERROR` on every error response." }, "request_id": { "type": "string", "description": "A unique ID to trace the failed request." } } } } }, "description": "The request did not complete within the time this API allows. `error.message` carries no code. Retry later, with backoff." } }, "parameters": [ { "in": "query", "name": "business_ids", "schema": { "oneOf": [ { "type": "string", "pattern": "^[^,]{0,256}(,[^,]{0,256}){0,499}$" }, { "type": "array", "items": { "type": "string", "maxLength": 256 }, "maxItems": 500 } ] }, "example": "0x102b644d009e013:0xea49e9ee285fa7bf", "examples": { "single": { "value": "0x102b644d009e013:0xea49e9ee285fa7bf" }, "multiple": { "value": "0x102b644d009e013:0xea49e9ee285fa7bf,0x1792d85c519234b:0x91eebb9c864b198d,0x1138baa323ef021:0x7c312666da760370", "description": "The same values as repeated occurrences: `business_ids=id1&business_ids=id2&business_ids=id3`." } }, "required": true, "description": "Unique Business Id, as returned in a business record's `business_id`.\n\n**Examples:**\n\n`0x102b644d009e013:0xea49e9ee285fa7bf`\n\nIn addition, batching of up to 500 Business Ids is supported in a single request using a comma separated list *(e.g. business_ids=id1,id2)*." }, { "in": "query", "name": "fields", "schema": { "type": "string", "pattern": "^\\s*$|^\\s*(business_id|name|address|lat|lng|categories|main_category|phone|website|tld|status|rating|review_count|place_id|google_mid|cid|place_link|timezone|owner_id|owner_name|owner_link|address_short|district|street_address|city|zipcode|state|country|photo_count|photos_sample|verified|opening_status|working_hours|opening_date|reviews_per_rating|price_level|reviews_link|booking_link|order_link|reservations_link|category_ids|main_category_id|about|closed_dow|open_24_7|located_in|hotel_stars|hotel_amenities|hotel_location_rating|hotel_review_summary|hotel_booking_options|hotel_results_from_web|first_seen|last_seen|last_changed|business_services|price_tier|menu|photo_tabs|popular_times)(\\s*,\\s*(business_id|name|address|lat|lng|categories|main_category|phone|website|tld|status|rating|review_count|place_id|google_mid|cid|place_link|timezone|owner_id|owner_name|owner_link|address_short|district|street_address|city|zipcode|state|country|photo_count|photos_sample|verified|opening_status|working_hours|opening_date|reviews_per_rating|price_level|reviews_link|booking_link|order_link|reservations_link|category_ids|main_category_id|about|closed_dow|open_24_7|located_in|hotel_stars|hotel_amenities|hotel_location_rating|hotel_review_summary|hotel_booking_options|hotel_results_from_web|first_seen|last_seen|last_changed|business_services|price_tier|menu|photo_tabs|popular_times)){0,59}\\s*$" }, "required": false, "description": "A comma separated list of business fields to include in the response (field projection).\n\nBy default all fields are returned. `business_id` is always included.\n\n**Allowed values:** `business_id`, `name`, `address`, `lat`, `lng`, `categories`, `main_category`, `phone`, `website`, `tld`, `status`, `rating`, `review_count`, `place_id`, `google_mid`, `cid`, `place_link`, `timezone`, `owner_id`, `owner_name`, `owner_link`, `address_short`, `district`, `street_address`, `city`, `zipcode`, `state`, `country`, `photo_count`, `photos_sample`, `verified`, `opening_status`, `working_hours`, `opening_date`, `reviews_per_rating`, `price_level`, `reviews_link`, `booking_link`, `order_link`, `reservations_link`, `category_ids`, `main_category_id`, `about`, `closed_dow`, `open_24_7`, `located_in`, `hotel_stars`, `hotel_amenities`, `hotel_location_rating`, `hotel_review_summary`, `hotel_booking_options`, `hotel_results_from_web`, `first_seen`, `last_seen`, `last_changed`, `business_services`, `price_tier`, `menu`, `photo_tabs`, `popular_times`\n\n**Note:** field projection trims the response body only. It does not change how the request is billed." } ], "description": "Get full business details by Business Id, including the menu, popular times, services and price tier - fields the search endpoints do not return.\n\nSupports batching of up to 500 Business Ids in a single request.\n\n**Note:** a Business Id that matches nothing is listed in `not_found` and absent from `businesses`, so `match_count` can be lower than the number of ids sent. Re-send only the ids that are neither returned nor in `not_found`. There is no `cursor` on this endpoint.", "operationId": "near_realtime_business_data__Business_Details", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing detailed response schema" ], "pages": [ 1 ], "sourceId": "sds_y_pAgcC-xJrVMI2TjrXI0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/business_id", "/description", "/operationId" ], "revisionId": "sdrn_58jSAkKvEcC3bWRtd9F4t" } ], "x-zeroclick-services": [ "local-business-database" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "local-business-database", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "local-business-database", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/local-business-database/business-photos": { "get": { "summary": "Business Photos", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "request_id", "parameters", "data" ], "properties": { "data": { "type": "object", "required": [ "photos", "match_count", "limit", "found", "business_id" ], "properties": { "found": { "type": "boolean", "description": "Whether a record for the requested Business Id was found." }, "limit": { "type": "number", "description": "Maximum number of results requested for this page (the limit parameter, or its default)." }, "photos": { "type": "array", "items": { "type": "object", "required": [ "photo_id", "photo_url", "photo_url_large", "video_thumbnail_url", "latitude", "longitude", "type", "photo_datetime_utc", "photo_timestamp" ], "properties": { "type": { "enum": [ "photo", "street_view", "video" ], "type": "string", "description": "Media type. Values: photo, video, street_view." }, "latitude": { "type": "number", "nullable": true, "description": "Latitude where the photo was taken (when known)." }, "photo_id": { "type": "string", "description": "Unique Google identifier of the photo." }, "longitude": { "type": "number", "nullable": true, "description": "Longitude where the photo was taken (when known)." }, "photo_url": { "type": "string", "nullable": true, "description": "URL of the photo (default resolution)." }, "photo_timestamp": { "type": "number", "nullable": true, "description": "Unix epoch seconds matching photo_datetime_utc." }, "photo_url_large": { "type": "string", "nullable": true, "description": "URL of the photo at a larger resolution." }, "photo_datetime_utc": { "type": "string", "nullable": true, "description": "Original publication datetime of the photo in ISO 8601 UTC." }, "video_thumbnail_url": { "type": "string", "nullable": true, "description": "Thumbnail URL when the media is a video; null for still photos." } }, "additionalProperties": false }, "description": "List of photos / videos returned." }, "business_id": { "type": "string", "description": "The Business Id the results belong to, as received." }, "match_count": { "type": "number", "description": "Number of photos returned on this page. Not the business's total photo count." } }, "description": "Photos returned for the business, with the page size applied." }, "cursor": { "type": "string", "description": "Pagination cursor for the next page of photos. Pass it back as the `cursor` parameter. Absent on the last page." }, "status": { "type": "string", "description": "The status of the API response." }, "parameters": { "type": "object", "description": "The parameters the API received and used for this request, echoed back.", "additionalProperties": true }, "request_id": { "type": "string", "description": "A unique ID to trace the API request." } } } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "request_id", "error" ], "properties": { "error": { "type": "object", "required": [ "message", "code" ], "properties": { "code": { "type": "integer", "description": "The HTTP status of this response, repeated." }, "message": { "type": "string", "description": "What went wrong, in English. Where a code names the fault, it ends this message in parentheses." } }, "description": "What went wrong." }, "status": { "type": "string", "description": "`ERROR` on every error response." }, "request_id": { "type": "string", "description": "A unique ID to trace the failed request." } } } } }, "description": "The request was refused.\n\n`error.message` ends with its code in parentheses, as in `(UNKNOWN_FIELD)`; a message that ends in none is `VALIDATION_ERROR`. Branch on the code rather than on the English before it:\n\n`VALIDATION_ERROR` - A parameter this operation accepts was sent in a form it does not, a required parameter is missing, or the request's path and method are not one this API serves. Correct the request: `message` names the offending parameter and the accepted form.\n\n`UNKNOWN_FIELD` - A parameter name this operation does not accept, or a name in `fields` it does not return. It is a spelling fix.\n\n`INVALID_CURSOR` - The page token is not one this API issued for this request, or it can no longer be resumed. Start again from the first page.\n\n`CURSOR_EXPIRED` - The page token was issued for this request, but the walk took longer than its lifetime. Start again from the first page." }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." }, "429": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "request_id", "error" ], "properties": { "error": { "type": "object", "required": [ "message", "code" ], "properties": { "code": { "type": "integer", "description": "The HTTP status of this response, repeated." }, "message": { "type": "string", "description": "What went wrong, in English. Where a code names the fault, it ends this message in parentheses." } }, "description": "What went wrong." }, "status": { "type": "string", "description": "`ERROR` on every error response." }, "request_id": { "type": "string", "description": "A unique ID to trace the failed request." } } } } }, "description": "The plan behind this API key has no requests left for this API. `error.message` carries no code. Retrying does not help until the plan allows further requests." }, "500": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "request_id", "error" ], "properties": { "error": { "type": "object", "required": [ "message", "code" ], "properties": { "code": { "type": "integer", "description": "The HTTP status of this response, repeated." }, "message": { "type": "string", "description": "What went wrong, in English. Where a code names the fault, it ends this message in parentheses." } }, "description": "What went wrong." }, "status": { "type": "string", "description": "`ERROR` on every error response." }, "request_id": { "type": "string", "description": "A unique ID to trace the failed request." } } } } }, "description": "The request failed on this API's side.\n\n`error.message` ends with its code in parentheses, as in `(INTERNAL_ERROR)`. Branch on the code rather than on the English before it:\n\n`INTERNAL_ERROR` - An unexpected failure on this service's side, not a fault in the request; no further detail is echoed. Retry later, with backoff.\n\n**Note:** a 500 whose message ends in no code carries no further detail about its cause. Retry later, with backoff." }, "502": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "request_id", "error" ], "properties": { "error": { "type": "object", "required": [ "message", "code" ], "properties": { "code": { "type": "integer", "description": "The HTTP status of this response, repeated." }, "message": { "type": "string", "description": "What went wrong, in English. Where a code names the fault, it ends this message in parentheses." } }, "description": "What went wrong." }, "status": { "type": "string", "description": "`ERROR` on every error response." }, "request_id": { "type": "string", "description": "A unique ID to trace the failed request." } } } } }, "description": "A service this API depends on did not complete the request.\n\n`error.message` ends with its code in parentheses, as in `(UPSTREAM_UNAVAILABLE)`. Branch on the code rather than on the English before it:\n\n`UPSTREAM_UNAVAILABLE` - The source this operation reads at request time refused the read or answered with something this API could not decode. It is transient: retry in a moment rather than changing the request.\n\n**Note:** a 502 whose message ends in no code carries no further detail about its cause. Retry later, with backoff." }, "504": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "request_id", "error" ], "properties": { "error": { "type": "object", "required": [ "message", "code" ], "properties": { "code": { "type": "integer", "description": "The HTTP status of this response, repeated." }, "message": { "type": "string", "description": "What went wrong, in English. Where a code names the fault, it ends this message in parentheses." } }, "description": "What went wrong." }, "status": { "type": "string", "description": "`ERROR` on every error response." }, "request_id": { "type": "string", "description": "A unique ID to trace the failed request." } } } } }, "description": "The request did not complete within the time this API allows. `error.message` carries no code. Retry later, with backoff." } }, "parameters": [ { "in": "query", "name": "business_id", "schema": { "type": "string", "maxLength": 256 }, "example": "0x102b644d009e013:0xea49e9ee285fa7bf", "required": true, "description": "Unique Business Id, as returned in a business record's `business_id`.\n\n**Examples:**\n\n`0x102b644d009e013:0xea49e9ee285fa7bf`" }, { "in": "query", "name": "limit", "schema": { "type": "integer" }, "example": 10, "required": false, "description": "Maximum number of business photos to return.\n\n**Allowed values:** `1-100`" }, { "in": "query", "name": "cursor", "schema": { "type": "string", "maxLength": 2048 }, "required": false, "description": "Pagination cursor for fetching the next page. Pass the `cursor` value returned in the previous response. Omit it on the first request.\n\n**Note:** a cursor is only valid for the exact query that produced it, and it expires. Do not build or edit one." }, { "in": "query", "name": "language", "schema": { "type": "string", "default": "en" }, "example": "en", "required": false, "description": "Set the language of the results.\n\nFor a list of supported language codes see *https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes*." }, { "in": "query", "name": "region", "schema": { "type": "string", "default": "us" }, "example": "us", "required": false, "description": "Query Google Maps from a particular region or country.\n\nFor a list of supported region/country codes see *https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2 (Alpha-2 code)*." } ], "description": "Get / paginate business photos by Business Id using a pagination cursor.\n\nPhotos are read from Google Maps at request time, so they are live rather than served from the database.\n\n**Note:** `match_count` is the number of photos on this page, not the business's total photo count.\n\n**Note:** `limit` is a maximum and not a promise - a business with fewer photos returns fewer. You have reached the end when a page comes back empty or without a `cursor`.", "operationId": "near_realtime_business_data__Business_Photos", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing detailed response schema" ], "pages": [ 1 ], "sourceId": "sds_y_pAgcC-xJrVMI2TjrXI0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_58jSAkKvEcC3bWRtd9F4t" } ], "x-zeroclick-services": [ "local-business-database" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "local-business-database", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "local-business-database", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/local-business-database/business-reviews": { "get": { "summary": "Business Reviews", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "request_id", "parameters", "data" ], "properties": { "data": { "type": "object", "required": [ "reviews", "match_count", "limit", "business_id", "found" ], "properties": { "found": { "type": "boolean", "description": "Whether a record for the requested Business Id was found." }, "limit": { "type": "number", "description": "Maximum number of results requested for this page (the limit parameter, or its default)." }, "reviews": { "type": "array", "items": { "type": "object", "required": [ "review_id", "review_text", "rating", "review_datetime_utc", "review_timestamp", "review_time", "review_link", "review_photos", "review_language", "review_text_translated", "review_text_translated_language", "like_count", "author_id", "author_link", "author_name", "author_photo_url", "author_review_count", "author_photo_count", "owner_response_time", "owner_response_text", "owner_response_language", "author_reviews_link", "author_is_local_guide", "service_quality", "review_form", "review_source", "review_source_logo" ], "properties": { "rating": { "type": "number", "description": "Star rating given in the review (1-5)." }, "author_id": { "type": "string", "nullable": true, "description": "Google Maps contributor ID of the review author." }, "review_id": { "type": "string", "description": "Unique Google identifier of the review." }, "like_count": { "type": "number", "nullable": true, "description": "Number of likes the review received." }, "author_link": { "type": "string", "nullable": true, "description": "URL to the author's Google Maps contributor profile." }, "author_name": { "type": "string", "nullable": true, "description": "Display name of the review author." }, "review_form": { "type": "object", "nullable": true, "description": "Structured questions the author answered (e.g. 'What kind of trip was it?').", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "number" } ] } }, "review_link": { "type": "string", "nullable": true, "description": "Direct Google Maps URL to the review." }, "review_text": { "type": "string", "nullable": true, "description": "Full text content of the review." }, "review_time": { "type": "string", "nullable": true, "description": "Human-friendly relative time of the review (e.g. '4 months ago') as shown on Google Maps." }, "review_photos": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "URLs of photos attached to the review." }, "review_source": { "type": "string", "nullable": true, "description": "Platform the review originates from (e.g. 'Google', 'Tripadvisor')." }, "review_language": { "type": "string", "nullable": true, "description": "ISO 639 language code of the review text." }, "service_quality": { "type": "object", "nullable": true, "description": "Optional service-quality tag the author selected when reviewing.", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "number" } ] } }, "author_photo_url": { "type": "string", "nullable": true, "description": "URL of the author's profile photo." }, "review_timestamp": { "type": "number", "nullable": true, "description": "Unix epoch seconds matching review_datetime_utc." }, "author_photo_count": { "type": "number", "nullable": true, "description": "Number of photos this author has posted." }, "review_source_logo": { "type": "string", "nullable": true, "description": "URL of the source platform logo." }, "author_review_count": { "type": "number", "nullable": true, "description": "Number of reviews this author has posted." }, "author_reviews_link": { "type": "string", "nullable": true, "description": "URL to all reviews by this author." }, "owner_response_text": { "type": "string", "nullable": true, "description": "Text of the business owner's response." }, "owner_response_time": { "type": "string", "nullable": true, "description": "Human-friendly relative time of the business owner response." }, "review_datetime_utc": { "type": "string", "nullable": true, "description": "ISO 8601 UTC datetime when the review was posted." }, "author_is_local_guide": { "type": "boolean", "nullable": true, "description": "Whether the author is a Google Local Guide." }, "review_text_translated": { "type": "string", "nullable": true, "description": "The review text translated into the requested language, when Google Maps offers a translation." }, "owner_response_language": { "type": "string", "nullable": true, "description": "ISO 639 language code of the owner response." }, "review_text_translated_language": { "type": "string", "nullable": true, "description": "ISO 639 language code the review was translated into." } }, "additionalProperties": false }, "description": "List of reviews returned." }, "business_id": { "type": "string", "description": "The Business Id the results belong to, as received." }, "match_count": { "type": "number", "description": "Number of reviews returned on this page. Not the business's total review count." } }, "description": "Reviews returned for the business, with the page size applied." }, "cursor": { "type": "string", "description": "Pagination cursor for the next page of reviews. Pass it back as the `cursor` parameter. Absent on the last page, and never returned when limit was below its maximum of 20." }, "status": { "type": "string", "description": "The status of the API response." }, "parameters": { "type": "object", "description": "The parameters the API received and used for this request, echoed back.", "additionalProperties": true }, "request_id": { "type": "string", "description": "A unique ID to trace the API request." } } } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "request_id", "error" ], "properties": { "error": { "type": "object", "required": [ "message", "code" ], "properties": { "code": { "type": "integer", "description": "The HTTP status of this response, repeated." }, "message": { "type": "string", "description": "What went wrong, in English. Where a code names the fault, it ends this message in parentheses." } }, "description": "What went wrong." }, "status": { "type": "string", "description": "`ERROR` on every error response." }, "request_id": { "type": "string", "description": "A unique ID to trace the failed request." } } } } }, "description": "The request was refused.\n\n`error.message` ends with its code in parentheses, as in `(UNKNOWN_FIELD)`; a message that ends in none is `VALIDATION_ERROR`. Branch on the code rather than on the English before it:\n\n`VALIDATION_ERROR` - A parameter this operation accepts was sent in a form it does not, a required parameter is missing, or the request's path and method are not one this API serves. Correct the request: `message` names the offending parameter and the accepted form.\n\n`UNKNOWN_FIELD` - A parameter name this operation does not accept, or a name in `fields` it does not return. It is a spelling fix.\n\n`INVALID_CURSOR` - The page token is not one this API issued for this request, or it can no longer be resumed. Start again from the first page.\n\n`CURSOR_EXPIRED` - The page token was issued for this request, but the walk took longer than its lifetime. Start again from the first page." }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." }, "429": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "request_id", "error" ], "properties": { "error": { "type": "object", "required": [ "message", "code" ], "properties": { "code": { "type": "integer", "description": "The HTTP status of this response, repeated." }, "message": { "type": "string", "description": "What went wrong, in English. Where a code names the fault, it ends this message in parentheses." } }, "description": "What went wrong." }, "status": { "type": "string", "description": "`ERROR` on every error response." }, "request_id": { "type": "string", "description": "A unique ID to trace the failed request." } } } } }, "description": "The plan behind this API key has no requests left for this API. `error.message` carries no code. Retrying does not help until the plan allows further requests." }, "500": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "request_id", "error" ], "properties": { "error": { "type": "object", "required": [ "message", "code" ], "properties": { "code": { "type": "integer", "description": "The HTTP status of this response, repeated." }, "message": { "type": "string", "description": "What went wrong, in English. Where a code names the fault, it ends this message in parentheses." } }, "description": "What went wrong." }, "status": { "type": "string", "description": "`ERROR` on every error response." }, "request_id": { "type": "string", "description": "A unique ID to trace the failed request." } } } } }, "description": "The request failed on this API's side.\n\n`error.message` ends with its code in parentheses, as in `(INTERNAL_ERROR)`. Branch on the code rather than on the English before it:\n\n`INTERNAL_ERROR` - An unexpected failure on this service's side, not a fault in the request; no further detail is echoed. Retry later, with backoff.\n\n**Note:** a 500 whose message ends in no code carries no further detail about its cause. Retry later, with backoff." }, "502": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "request_id", "error" ], "properties": { "error": { "type": "object", "required": [ "message", "code" ], "properties": { "code": { "type": "integer", "description": "The HTTP status of this response, repeated." }, "message": { "type": "string", "description": "What went wrong, in English. Where a code names the fault, it ends this message in parentheses." } }, "description": "What went wrong." }, "status": { "type": "string", "description": "`ERROR` on every error response." }, "request_id": { "type": "string", "description": "A unique ID to trace the failed request." } } } } }, "description": "A service this API depends on did not complete the request.\n\n`error.message` ends with its code in parentheses, as in `(UPSTREAM_UNAVAILABLE)`. Branch on the code rather than on the English before it:\n\n`UPSTREAM_UNAVAILABLE` - The source this operation reads at request time refused the read or answered with something this API could not decode. It is transient: retry in a moment rather than changing the request.\n\n**Note:** a 502 whose message ends in no code carries no further detail about its cause. Retry later, with backoff." }, "504": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "request_id", "error" ], "properties": { "error": { "type": "object", "required": [ "message", "code" ], "properties": { "code": { "type": "integer", "description": "The HTTP status of this response, repeated." }, "message": { "type": "string", "description": "What went wrong, in English. Where a code names the fault, it ends this message in parentheses." } }, "description": "What went wrong." }, "status": { "type": "string", "description": "`ERROR` on every error response." }, "request_id": { "type": "string", "description": "A unique ID to trace the failed request." } } } } }, "description": "The request did not complete within the time this API allows. `error.message` carries no code. Retry later, with backoff." } }, "parameters": [ { "in": "query", "name": "business_id", "schema": { "type": "string", "maxLength": 256 }, "example": "0x102b644d009e013:0xea49e9ee285fa7bf", "required": true, "description": "Unique Business Id, as returned in a business record's `business_id`.\n\n**Examples:**\n\n`0x102b644d009e013:0xea49e9ee285fa7bf`" }, { "in": "query", "name": "limit", "schema": { "type": "integer" }, "example": 10, "required": false, "description": "Maximum number of business reviews to return.\n\n**Allowed values:** `1-20`\n\n**Note:** a `cursor` is only returned when limit is left at its maximum of `20`." }, { "in": "query", "name": "cursor", "schema": { "type": "string", "maxLength": 1024 }, "required": false, "description": "Pagination cursor for fetching the next page. Pass the `cursor` value returned in the previous response. Omit it on the first request.\n\n**Note:** a cursor is only valid for the exact query that produced it, and it expires. Do not build or edit one." }, { "in": "query", "name": "sort_by", "schema": { "enum": [ "most_relevant", "newest", "highest_ranking", "lowest_ranking" ], "type": "string", "default": "most_relevant" }, "example": "most_relevant", "required": false, "description": "How to sort the reviews in the results." }, { "in": "query", "name": "language", "schema": { "type": "string", "default": "en" }, "example": "en", "required": false, "description": "Set the language of the results.\n\nFor a list of supported language codes see *https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes*." }, { "in": "query", "name": "region", "schema": { "type": "string", "default": "us" }, "example": "us", "required": false, "description": "Query Google Maps from a particular region or country.\n\nFor a list of supported region/country codes see *https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2 (Alpha-2 code)*." } ], "description": "Get / paginate business reviews by Business Id using a pagination cursor.\n\nReviews are read from Google Maps at request time, so they are live rather than served from the database.\n\n**Note:** `match_count` is the number of reviews on this page, not the business's total review count.\n\n**Note:** pagination requires `limit` to be left at its maximum of `20`. Below the maximum a single page is trimmed and no `cursor` is returned.", "operationId": "near_realtime_business_data__Business_Reviews", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing detailed response schema" ], "pages": [ 1 ], "sourceId": "sds_y_pAgcC-xJrVMI2TjrXI0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_58jSAkKvEcC3bWRtd9F4t" } ], "x-zeroclick-services": [ "local-business-database" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "local-business-database", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "local-business-database", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/local-business-database/search": { "get": { "summary": "Search", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "request_id", "parameters", "data" ], "properties": { "data": { "type": "object", "required": [ "businesses", "match_count", "limit" ], "properties": { "limit": { "type": "number", "description": "Maximum number of results requested for this page (the limit parameter, or its default)." }, "businesses": { "type": "array", "items": { "type": "object", "required": [ "business_id" ], "properties": { "cid": { "type": "string", "description": "Google CID (Customer ID) of the business." }, "lat": { "type": "number", "description": "Latitude of the business location." }, "lng": { "type": "number", "description": "Longitude of the business location." }, "tld": { "type": "string", "description": "Domain of the business website." }, "city": { "type": "string", "description": "City of the business location." }, "name": { "type": "string", "description": "Display name of the business." }, "about": { "type": "object", "required": [ "summary", "details" ], "properties": { "details": { "type": "object", "nullable": true, "description": "Structured attribute map, grouped by attribute category (e.g. accessibility, amenities), each mapping an attribute identifier to a boolean.", "additionalProperties": { "type": "object", "additionalProperties": { "type": "boolean" } } }, "summary": { "type": "string", "nullable": true, "description": "Free-text description of the business." } }, "description": "Free-form summary and a structured details map of business attributes.", "additionalProperties": false }, "phone": { "type": "string", "description": "Business phone number in E.164 format when available." }, "state": { "type": "string", "description": "State / region of the business location." }, "rating": { "type": "number", "description": "Average review rating (1-5) on Google Maps." }, "status": { "enum": [ "operational", "closed", "temporarily_closed" ], "type": "string", "description": "Operational status of the business. Values: operational, closed, temporarily_closed." }, "address": { "type": "string", "description": "Full formatted address, including the business name." }, "country": { "type": "string", "description": "ISO 3166-1 alpha-2 country code of the business location: the country of its Google address or, when that address names none, the country of the map area the business was found in. Absent when neither is known." }, "website": { "type": "string", "description": "Business website URL." }, "zipcode": { "type": "string", "description": "ZIP / postal code of the business location." }, "district": { "type": "string", "description": "District or neighbourhood of the business location." }, "owner_id": { "type": "string", "description": "ID of the Google Maps contributor account that owns this listing." }, "place_id": { "type": "string", "description": "Google Maps Place ID." }, "timezone": { "type": "string", "description": "IANA timezone of the business location." }, "verified": { "type": "boolean", "description": "Whether the business is verified by Google." }, "last_seen": { "type": "string", "description": "ISO 8601 UTC datetime the listing was last collected." }, "open_24_7": { "type": "boolean", "description": "Whether the business is open 24 hours a day, every day of the week." }, "categories": { "type": "array", "items": { "type": "string" }, "description": "List of business categories as labelled by Google Maps." }, "closed_dow": { "type": "array", "items": { "type": "number" }, "description": "Days of the week the business is closed, as ISO-8601 day numbers (1 = Monday, 7 = Sunday)." }, "first_seen": { "type": "string", "description": "ISO 8601 UTC datetime the listing was first collected." }, "google_mid": { "type": "string", "description": "Google Knowledge Graph machine ID." }, "located_in": { "type": "object", "required": [ "google_id", "name" ], "properties": { "name": { "type": "string", "description": "Name of the parent place." }, "google_id": { "type": "string", "description": "Google ID of the parent place." } }, "description": "Parent place this business is located in (e.g. mall) when applicable.", "additionalProperties": false }, "order_link": { "type": "string", "description": "URL to place an order (when published)." }, "owner_link": { "type": "string", "description": "Link to the owner profile on Google Maps." }, "owner_name": { "type": "string", "description": "Display name of the owner profile." }, "place_link": { "type": "string", "description": "Google Maps URL for the business." }, "business_id": { "type": "string", "description": "Unique Google identifier of the business." }, "hotel_stars": { "type": "number", "description": "Hotel-only: star rating (1-5). Present only for hotels." }, "photo_count": { "type": "number", "description": "Total number of photos available for the business." }, "price_level": { "type": "string", "description": "Price level as shown on Google Maps (e.g. '$10-20')." }, "booking_link": { "type": "string", "description": "URL to book a service or appointment (when published)." }, "category_ids": { "type": "array", "items": { "type": "string" }, "description": "Google's internal entity-type IDs for the business. Broader than categories, and usually several per business. The IDs are gcids (Google Maps category IDs). For a list of gcids see *https://www.openwebninja.com/blog/all-google-maps-categories*." }, "last_changed": { "type": "string", "description": "ISO 8601 UTC datetime the listing data last changed." }, "opening_date": { "type": "string", "description": "Date the business opened (when published by Google)." }, "review_count": { "type": "number", "description": "Total number of Google Maps reviews on the business." }, "reviews_link": { "type": "string", "description": "URL to view reviews on Google Maps." }, "address_short": { "type": "string", "description": "Formatted address without the business name." }, "main_category": { "type": "string", "description": "Primary business category as labelled by Google Maps." }, "photos_sample": { "type": "array", "items": { "type": "object", "required": [ "photo_id", "photo_url", "photo_url_large", "video_thumbnail_url", "latitude", "longitude", "type", "photo_datetime_utc", "photo_timestamp" ], "properties": { "type": { "enum": [ "photo", "street_view", "video" ], "type": "string", "description": "Media type. Values: photo, video, street_view." }, "latitude": { "type": "number", "nullable": true, "description": "Latitude where the photo was taken (when known)." }, "photo_id": { "type": "string", "description": "Unique Google identifier of the photo." }, "longitude": { "type": "number", "nullable": true, "description": "Longitude where the photo was taken (when known)." }, "photo_url": { "type": "string", "nullable": true, "description": "URL of the photo (default resolution)." }, "photo_timestamp": { "type": "number", "nullable": true, "description": "Unix epoch seconds matching photo_datetime_utc." }, "photo_url_large": { "type": "string", "nullable": true, "description": "URL of the photo at a larger resolution." }, "photo_datetime_utc": { "type": "string", "nullable": true, "description": "Original publication datetime of the photo in ISO 8601 UTC." }, "video_thumbnail_url": { "type": "string", "nullable": true, "description": "Thumbnail URL when the media is a video; null for still photos." } }, "additionalProperties": false }, "description": "Sample of representative photos for the business." }, "working_hours": { "type": "object", "description": "Working hours map keyed by day of the week. Each value is an array of time-range strings; absent when not published.", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "opening_status": { "type": "string", "description": "Current opening status string as shown on Google Maps (e.g. 'Open', 'Closed', 'Open 24 hours')." }, "street_address": { "type": "string", "description": "Street name and number portion of the address." }, "hotel_amenities": { "type": "object", "description": "Hotel-only: map of amenity name to availability (true/false). Present only for hotels.", "additionalProperties": { "type": "boolean" } }, "main_category_id": { "type": "string", "description": "Google's internal ID of the primary category. The ID is a gcid (Google Maps category ID). For a list of gcids see *https://www.openwebninja.com/blog/all-google-maps-categories*." }, "reservations_link": { "type": "string", "description": "URL to make a reservation (when published)." }, "reviews_per_rating": { "type": "object", "required": [ "1", "2", "3", "4", "5" ], "properties": { "1": { "type": "number", "description": "Number of 1-star reviews." }, "2": { "type": "number", "description": "Number of 2-star reviews." }, "3": { "type": "number", "description": "Number of 3-star reviews." }, "4": { "type": "number", "description": "Number of 4-star reviews." }, "5": { "type": "number", "description": "Number of 5-star reviews." } }, "description": "Counts of reviews per integer rating from 1 to 5.", "additionalProperties": false }, "hotel_review_summary": { "type": "object", "description": "Hotel-only: AI-generated review summary. Present only for hotels.", "additionalProperties": { "type": "object", "required": [ "score", "summary" ], "properties": { "score": { "type": "number", "nullable": true }, "summary": { "type": "string", "nullable": true } }, "additionalProperties": false } }, "hotel_booking_options": { "type": "array", "items": { "type": "object", "required": [ "source", "price", "link", "source_favicon" ], "properties": { "link": { "type": "string", "nullable": true, "description": "URL to book with the provider." }, "price": { "type": "string", "nullable": true, "description": "Nightly price as shown by the provider." }, "rooms": { "type": "array", "items": { "type": "object", "required": [ "room_type", "link", "price" ], "properties": { "link": { "type": "string", "nullable": true, "description": "URL to book this room type." }, "price": { "type": "string", "nullable": true, "description": "Price of this room type as shown by the provider." }, "room_type": { "type": "string", "nullable": true, "description": "Name of the room type." } }, "additionalProperties": false }, "description": "Room types offered by this provider." }, "source": { "type": "string", "nullable": true, "description": "Booking provider the option comes from." }, "source_favicon": { "type": "string", "nullable": true, "description": "URL of the provider favicon." } }, "additionalProperties": false }, "description": "Hotel-only: booking options (provider, price, link). Present only for hotels with live rates." }, "hotel_location_rating": { "type": "object", "required": [ "Overall", "Things to do", "Transit", "Airports" ], "properties": { "Overall": { "type": "number", "nullable": true, "description": "Hotel-only: overall location rating." }, "Transit": { "type": "number", "nullable": true, "description": "Hotel-only: location rating for transit access." }, "Airports": { "type": "number", "nullable": true, "description": "Hotel-only: location rating for airport access." }, "Things to do": { "type": "number", "nullable": true, "description": "Hotel-only: location rating for things to do nearby." } }, "description": "Hotel-only: location rating breakdown when the business is a hotel.", "additionalProperties": false }, "hotel_results_from_web": { "type": "array", "items": { "type": "object", "required": [ "source", "link", "source_favicon" ], "properties": { "link": { "type": "string", "nullable": true, "description": "URL of the result." }, "source": { "type": "string", "nullable": true, "description": "Website the result comes from." }, "source_favicon": { "type": "string", "nullable": true, "description": "URL of the source favicon." } }, "additionalProperties": false }, "description": "Hotel-only: additional web-sourced results shown alongside the Google listing." } }, "additionalProperties": false }, "description": "List of businesses returned." }, "match_count": { "type": "number", "description": "Total number of businesses matching the query, across all pages. It is counted on the first page and repeated on every later page, so it can differ from a fresh count if listings change while you page." } }, "description": "Businesses matching the query, with the total match count and the page size applied." }, "cursor": { "type": "string", "description": "Pagination cursor for the next page of results. Pass it back as the `cursor` parameter together with the same query. Absent on the last page." }, "status": { "type": "string", "description": "The status of the API response." }, "parameters": { "type": "object", "description": "The parameters the API received and used for this request, echoed back.", "additionalProperties": true }, "request_id": { "type": "string", "description": "A unique ID to trace the API request." } } } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "request_id", "error" ], "properties": { "error": { "type": "object", "required": [ "message", "code" ], "properties": { "code": { "type": "integer", "description": "The HTTP status of this response, repeated." }, "message": { "type": "string", "description": "What went wrong, in English. Where a code names the fault, it ends this message in parentheses." } }, "description": "What went wrong." }, "status": { "type": "string", "description": "`ERROR` on every error response." }, "request_id": { "type": "string", "description": "A unique ID to trace the failed request." } } } } }, "description": "The request was refused.\n\n`error.message` ends with its code in parentheses, as in `(UNKNOWN_FIELD)`; a message that ends in none is `VALIDATION_ERROR`. Branch on the code rather than on the English before it:\n\n`VALIDATION_ERROR` - A parameter this operation accepts was sent in a form it does not, a required parameter is missing, or the request's path and method are not one this API serves. Correct the request: `message` names the offending parameter and the accepted form.\n\n`UNKNOWN_FIELD` - A parameter name this operation does not accept, or a name in `fields` it does not return. It is a spelling fix.\n\n`NO_QUERY_FIELDS` - The request carried no field parameter at all. Add one: `limit` and `cursor` alone are not a query.\n\n`INVALID_CURSOR` - The page token is not one this API issued for this request, or it can no longer be resumed. Start again from the first page.\n\n`CURSOR_EXPIRED` - The page token was issued for this request, but the walk took longer than its lifetime. Start again from the first page." }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." }, "429": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "request_id", "error" ], "properties": { "error": { "type": "object", "required": [ "message", "code" ], "properties": { "code": { "type": "integer", "description": "The HTTP status of this response, repeated." }, "message": { "type": "string", "description": "What went wrong, in English. Where a code names the fault, it ends this message in parentheses." } }, "description": "What went wrong." }, "status": { "type": "string", "description": "`ERROR` on every error response." }, "request_id": { "type": "string", "description": "A unique ID to trace the failed request." } } } } }, "description": "The plan behind this API key has no requests left for this API. `error.message` carries no code. Retrying does not help until the plan allows further requests." }, "500": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "request_id", "error" ], "properties": { "error": { "type": "object", "required": [ "message", "code" ], "properties": { "code": { "type": "integer", "description": "The HTTP status of this response, repeated." }, "message": { "type": "string", "description": "What went wrong, in English. Where a code names the fault, it ends this message in parentheses." } }, "description": "What went wrong." }, "status": { "type": "string", "description": "`ERROR` on every error response." }, "request_id": { "type": "string", "description": "A unique ID to trace the failed request." } } } } }, "description": "The request failed on this API's side.\n\n`error.message` ends with its code in parentheses, as in `(INTERNAL_ERROR)`. Branch on the code rather than on the English before it:\n\n`INTERNAL_ERROR` - An unexpected failure on this service's side, not a fault in the request; no further detail is echoed. Retry later, with backoff.\n\n**Note:** a 500 whose message ends in no code carries no further detail about its cause. Retry later, with backoff." }, "502": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "request_id", "error" ], "properties": { "error": { "type": "object", "required": [ "message", "code" ], "properties": { "code": { "type": "integer", "description": "The HTTP status of this response, repeated." }, "message": { "type": "string", "description": "What went wrong, in English. Where a code names the fault, it ends this message in parentheses." } }, "description": "What went wrong." }, "status": { "type": "string", "description": "`ERROR` on every error response." }, "request_id": { "type": "string", "description": "A unique ID to trace the failed request." } } } } }, "description": "A service this API depends on did not complete the request.\n\n`error.message` ends with its code in parentheses, as in `(UPSTREAM_ERROR)`. Branch on the code rather than on the English before it:\n\n`UPSTREAM_ERROR` - The search backend rejected the query. Narrow the query rather than retrying it unchanged.\n\n**Note:** a 502 whose message ends in no code carries no further detail about its cause. Retry later, with backoff." }, "503": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "request_id", "error" ], "properties": { "error": { "type": "object", "required": [ "message", "code" ], "properties": { "code": { "type": "integer", "description": "The HTTP status of this response, repeated." }, "message": { "type": "string", "description": "What went wrong, in English. Where a code names the fault, it ends this message in parentheses." } }, "description": "What went wrong." }, "status": { "type": "string", "description": "`ERROR` on every error response." }, "request_id": { "type": "string", "description": "A unique ID to trace the failed request." } } } } }, "description": "This API is temporarily unable to serve the request.\n\n`error.message` ends with its code in parentheses, as in `(SEARCH_BUSY)`. Branch on the code rather than on the English before it:\n\n`SEARCH_BUSY` - The search backend is temporarily over capacity, which is not a fault in the request. Retry the same request after a few seconds, with backoff." }, "504": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "request_id", "error" ], "properties": { "error": { "type": "object", "required": [ "message", "code" ], "properties": { "code": { "type": "integer", "description": "The HTTP status of this response, repeated." }, "message": { "type": "string", "description": "What went wrong, in English. Where a code names the fault, it ends this message in parentheses." } }, "description": "What went wrong." }, "status": { "type": "string", "description": "`ERROR` on every error response." }, "request_id": { "type": "string", "description": "A unique ID to trace the failed request." } } } } }, "description": "The request did not complete within the time this API allows. `error.message` carries no code. Retry later, with backoff." } }, "parameters": [ { "in": "query", "name": "country", "schema": { "type": "string", "maxLength": 256 }, "example": "US", "required": true, "description": "Find businesses in a specific country, as one ISO 3166-1 alpha-2 code. It is required.\n\nSend one code per request. A list of codes, comma separated or as the parameter sent more than once, and an unknown code are rejected with a 400 error.\n\nFor a list of supported country codes see *https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2*.\n\n**Examples:**\n\n`US`" }, { "in": "query", "name": "limit", "schema": { "type": "integer" }, "example": 10, "required": false, "description": "Maximum number of businesses to return.\n\n**Allowed values:** `1-500`" }, { "in": "query", "name": "cursor", "schema": { "type": "string", "maxLength": 1024 }, "required": false, "description": "Pagination cursor for fetching the next page. Pass the `cursor` value returned in the previous response. Omit it on the first request.\n\n**Note:** a cursor is only valid for the exact query that produced it, and it expires. Do not build or edit one." }, { "in": "query", "name": "business_category", "schema": { "oneOf": [ { "type": "string", "pattern": "^[^,]{0,256}(,[^,]{0,256}){0,19}$" }, { "type": "array", "items": { "type": "string", "maxLength": 256 }, "maxItems": 20 } ] }, "examples": { "single": { "value": "restaurant" }, "multiple": { "value": "restaurant,bank,photography studio", "description": "The same values as repeated occurrences: `business_category=restaurant&business_category=bank&business_category=photography studio`." } }, "required": false, "description": "Find businesses carrying a specific category. Accepts a comma separated list (e.g., `restaurant`, `bank`) or multiple `business_category` parameters (e.g., `business_category=restaurant&business_category=bank`) of up to 20 values.\n\n**Examples:**\n\n`restaurant`\n\n`restaurant,bank,photography studio`" }, { "in": "query", "name": "state", "schema": { "oneOf": [ { "type": "string", "pattern": "^[^,]{0,256}(,[^,]{0,256}){0,19}$" }, { "type": "array", "items": { "type": "string", "maxLength": 256 }, "maxItems": 20 } ] }, "examples": { "codes": { "value": "IL,FL" }, "single": { "value": "Illinois" }, "multiple": { "value": "Illinois,Florida,Ontario", "description": "The same values as repeated occurrences: `state=Illinois&state=Florida&state=Ontario`." } }, "required": false, "description": "Find businesses in a specific state or province. Accepts a comma separated list (e.g., `Illinois`, `Florida`) or multiple `state` parameters (e.g., `state=Illinois&state=Florida`) of up to 20 values.\n\nUS states match either way they are sent, by full name or by two-letter code.\n\n**Examples:**\n\n`Illinois`\n\n`Illinois,Florida,Ontario`\n\n`IL,FL`" }, { "in": "query", "name": "city", "schema": { "oneOf": [ { "type": "string", "maxLength": 256 }, { "type": "array", "items": { "type": "string", "maxLength": 256 }, "maxItems": 20 } ] }, "example": "Chicago", "required": true, "description": "Find businesses in a specific city.\n\nAccepts multiple `city` parameters (e.g., `city=value1&city=value2`) of up to 20 values.\n\nValues cannot be comma separated here, as a comma can be part of the value. In the POST form, send an array instead.\n\n**Examples:**\n\n`Chicago`" }, { "in": "query", "name": "zipcode", "schema": { "oneOf": [ { "type": "string", "pattern": "^[^,]{0,256}(,[^,]{0,256}){0,19}$" }, { "type": "array", "items": { "type": "string", "maxLength": 256 }, "maxItems": 20 } ] }, "examples": { "single": { "value": "60602" }, "multiple": { "value": "60602,98112,33186", "description": "The same values as repeated occurrences: `zipcode=60602&zipcode=98112&zipcode=33186`." } }, "required": false, "description": "Find businesses in a specific ZIP / postal code. Accepts a comma separated list (e.g., `60602`, `98112`) or multiple `zipcode` parameters (e.g., `zipcode=60602&zipcode=98112`) of up to 20 values.\n\n**Examples:**\n\n`60602`\n\n`60602,98112,33186`" }, { "in": "query", "name": "district", "schema": { "oneOf": [ { "type": "string", "maxLength": 256 }, { "type": "array", "items": { "type": "string", "maxLength": 256 }, "maxItems": 20 } ] }, "example": "Chicago Loop", "required": false, "description": "Find businesses in a specific district or neighbourhood, when the listing carries one.\n\nAccepts multiple `district` parameters (e.g., `district=value1&district=value2`) of up to 20 values.\n\nValues cannot be comma separated here, as a comma can be part of the value. In the POST form, send an array instead.\n\n**Examples:**\n\n`Chicago Loop`" }, { "in": "query", "name": "name", "schema": { "type": "string", "maxLength": 256 }, "examples": { "miami": { "value": "Truist" }, "chicago": { "value": "Office of City Treasurer" }, "seattle": { "value": "Avante Catering" } }, "required": false, "description": "Find businesses by their display name.\n\n**Examples:**\n\n`Office of City Treasurer`\n\n`Avante Catering`\n\n`Truist`" }, { "in": "query", "name": "main_business_category", "schema": { "oneOf": [ { "type": "string", "pattern": "^[^,]{0,256}(,[^,]{0,256}){0,19}$" }, { "type": "array", "items": { "type": "string", "maxLength": 256 }, "maxItems": 20 } ] }, "examples": { "single": { "value": "Coffee shop" }, "multiple": { "value": "Coffee shop,Hotel,Bakery", "description": "The same values as repeated occurrences: `main_business_category=Coffee shop&main_business_category=Hotel&main_business_category=Bakery`." } }, "required": false, "description": "Find businesses whose primary category matches. Same value space as the business_category parameter. Accepts a comma separated list (e.g., `Coffee shop`, `Hotel`) or multiple `main_business_category` parameters (e.g., `main_business_category=Coffee shop&main_business_category=Hotel`) of up to 20 values.\n\n**Examples:**\n\n`Coffee shop`\n\n`Coffee shop,Hotel,Bakery`" }, { "in": "query", "name": "business_category_id", "schema": { "oneOf": [ { "type": "string", "pattern": "^[^,]{0,256}(,[^,]{0,256}){0,19}$" }, { "type": "array", "items": { "type": "string", "maxLength": 256 }, "maxItems": 20 } ] }, "examples": { "single": { "value": "bakery" }, "multiple": { "value": "bakery,catholic_church,psychotherapist", "description": "The same values as repeated occurrences: `business_category_id=bakery&business_category_id=catholic_church&business_category_id=psychotherapist`." } }, "required": false, "description": "Find businesses by Google's internal entity-type IDs. Accepts a comma separated list (e.g., `bakery`, `catholic_church`) or multiple `business_category_id` parameters (e.g., `business_category_id=bakery&business_category_id=catholic_church`) of up to 20 values.\n\nThese are entity types rather than the listing's categories: the values are broad and a listing usually carries several of them, so this is a wide filter.\n\nThe IDs are gcids (Google Maps category IDs). For a list of gcids see *https://www.openwebninja.com/blog/all-google-maps-categories*.\n\n**Examples:**\n\n`bakery`\n\n`bakery,catholic_church,psychotherapist`" }, { "in": "query", "name": "main_business_category_id", "schema": { "oneOf": [ { "type": "string", "pattern": "^[^,]{0,256}(,[^,]{0,256}){0,19}$" }, { "type": "array", "items": { "type": "string", "maxLength": 256 }, "maxItems": 20 } ] }, "examples": { "single": { "value": "restaurant" }, "multiple": { "value": "restaurant,hotel,dentist", "description": "The same values as repeated occurrences: `main_business_category_id=restaurant&main_business_category_id=hotel&main_business_category_id=dentist`." } }, "required": false, "description": "Find businesses by Google's internal ID of the primary category. Accepts a comma separated list (e.g., `restaurant`, `hotel`) or multiple `main_business_category_id` parameters (e.g., `main_business_category_id=restaurant&main_business_category_id=hotel`) of up to 20 values.\n\nThis is the machine ID, not the display label the main_business_category parameter matches, and the two can name different primaries.\n\nThe IDs are gcids (Google Maps category IDs). For a list of gcids see *https://www.openwebninja.com/blog/all-google-maps-categories*.\n\n**Examples:**\n\n`restaurant`\n\n`restaurant,hotel,dentist`" }, { "in": "query", "name": "phone_number", "schema": { "oneOf": [ { "type": "string", "pattern": "^[^,]{0,256}(,[^,]{0,256}){0,19}$" }, { "type": "array", "items": { "type": "string", "maxLength": 256 }, "maxItems": 20 } ] }, "examples": { "single": { "value": "+13127443356" }, "multiple": { "value": "+13127443356,+12063248900,+13053784725", "description": "The same values as repeated occurrences: `phone_number=+13127443356&phone_number=+12063248900`." } }, "required": false, "description": "Find businesses by phone number. Accepts a comma separated list (e.g., `+13127443356`, `+12063248900`) or multiple `phone_number` parameters (e.g., `phone_number=%2B13127443356&phone_number=%2B12063248900`) of up to 20 values.\n\nSend the number with its country code, either in E.164 *(`+14325551234`, URL-encoded as `%2B14325551234`)* or in a decorated form such as `1-432-555-1234`, `(432) 555-1234` or `0014325551234`.\n\n**Examples:**\n\n`+13127443356`\n\n`+13127443356,+12063248900,+13053784725`" }, { "in": "query", "name": "address", "schema": { "type": "string", "maxLength": 256 }, "examples": { "miami": { "value": "Truist, 12390 SW 120th St, Miami, FL 33186" }, "chicago": { "value": "Office of City Treasurer, 121 N LaSalle St #106, Chicago, IL 60602" }, "seattle": { "value": "Avante Catering, 5600 Delridge Wy SW, Seattle, WA 98106" } }, "required": false, "description": "Find businesses by their full formatted address, including the business name.\n\n**Examples:**\n\n`Office of City Treasurer, 121 N LaSalle St #106, Chicago, IL 60602`\n\n`Avante Catering, 5600 Delridge Wy SW, Seattle, WA 98106`\n\n`Truist, 12390 SW 120th St, Miami, FL 33186`" }, { "in": "query", "name": "street_address", "schema": { "oneOf": [ { "type": "string", "maxLength": 256 }, { "type": "array", "items": { "type": "string", "maxLength": 256 }, "maxItems": 20 } ] }, "example": "121 N LaSalle St #106", "required": false, "description": "Find businesses by the street line of their address on its own.\n\nA single value is matched loosely, which also finds spelling and abbreviation variants. Several values are matched exactly instead, which narrows the result.\n\nAccepts multiple `street_address` parameters (e.g., `street_address=value1&street_address=value2`) of up to 20 values.\n\nValues cannot be comma separated here, as a comma can be part of the value. In the POST form, send an array instead.\n\n**Examples:**\n\n`121 N LaSalle St #106`" }, { "in": "query", "name": "business_id", "schema": { "oneOf": [ { "type": "string", "pattern": "^[^,]{0,256}(,[^,]{0,256}){0,19}$" }, { "type": "array", "items": { "type": "string", "maxLength": 256 }, "maxItems": 20 } ] }, "examples": { "single": { "value": "0x102b644d009e013:0xea49e9ee285fa7bf" }, "multiple": { "value": "0x102b644d009e013:0xea49e9ee285fa7bf,0x1792d85c519234b:0x91eebb9c864b198d,0x1138baa323ef021:0x7c312666da760370", "description": "The same values as repeated occurrences: `business_id=id1&business_id=id2&business_id=id3`." } }, "required": false, "description": "Find businesses by their unique Business Id, matched exactly. Accepts a comma separated list (e.g., `0x102b644d009e013:0xea49e9ee285fa7bf`, `0x1792d85c519234b:0x91eebb9c864b198d`) or multiple `business_id` parameters (e.g., `business_id=0x102b644d009e013:0xea49e9ee285fa7bf&business_id=0x1792d85c519234b:0x91eebb9c864b198d`) of up to 20 values.\n\n**Examples:**\n\n`0x102b644d009e013:0xea49e9ee285fa7bf`\n\n`0x102b644d009e013:0xea49e9ee285fa7bf,0x1792d85c519234b:0x91eebb9c864b198d`" }, { "in": "query", "name": "owner_name", "schema": { "oneOf": [ { "type": "string", "maxLength": 256 }, { "type": "array", "items": { "type": "string", "maxLength": 256 }, "maxItems": 20 } ] }, "example": "Office of City Treasurer", "required": false, "description": "Find businesses by the name on the owner profile.\n\nAccepts multiple `owner_name` parameters (e.g., `owner_name=value1&owner_name=value2`) of up to 20 values.\n\nValues cannot be comma separated here, as a comma can be part of the value. In the POST form, send an array instead.\n\n**Examples:**\n\n`Office of City Treasurer`" }, { "in": "query", "name": "verified", "schema": { "type": "boolean" }, "example": true, "required": false, "description": "Find businesses by whether their Google listing is claimed by the owner: `true` for claimed listings, `false` for unclaimed ones.\n\nA business whose claim status is unknown, with no `verified` in its record, matches neither value, so `verified=false` never returns it. Claim status fills in as listings are refreshed, so coverage grows over the first month after release.\n\n**Examples:**\n\n`true`" }, { "in": "query", "name": "fields", "schema": { "type": "string", "pattern": "^\\s*$|^\\s*(business_id|name|address|lat|lng|categories|main_category|phone|website|tld|status|rating|review_count|place_id|google_mid|cid|place_link|timezone|owner_id|owner_name|owner_link|address_short|district|street_address|city|zipcode|state|country|photo_count|photos_sample|verified|opening_status|working_hours|opening_date|reviews_per_rating|price_level|reviews_link|booking_link|order_link|reservations_link|category_ids|main_category_id|about|closed_dow|open_24_7|located_in|hotel_stars|hotel_amenities|hotel_location_rating|hotel_review_summary|hotel_booking_options|hotel_results_from_web|first_seen|last_seen|last_changed)(\\s*,\\s*(business_id|name|address|lat|lng|categories|main_category|phone|website|tld|status|rating|review_count|place_id|google_mid|cid|place_link|timezone|owner_id|owner_name|owner_link|address_short|district|street_address|city|zipcode|state|country|photo_count|photos_sample|verified|opening_status|working_hours|opening_date|reviews_per_rating|price_level|reviews_link|booking_link|order_link|reservations_link|category_ids|main_category_id|about|closed_dow|open_24_7|located_in|hotel_stars|hotel_amenities|hotel_location_rating|hotel_review_summary|hotel_booking_options|hotel_results_from_web|first_seen|last_seen|last_changed)){0,54}\\s*$" }, "required": false, "description": "A comma separated list of business fields to include in the response (field projection).\n\nBy default all fields are returned. `business_id` is always included.\n\n**Allowed values:** `business_id`, `name`, `address`, `lat`, `lng`, `categories`, `main_category`, `phone`, `website`, `tld`, `status`, `rating`, `review_count`, `place_id`, `google_mid`, `cid`, `place_link`, `timezone`, `owner_id`, `owner_name`, `owner_link`, `address_short`, `district`, `street_address`, `city`, `zipcode`, `state`, `country`, `photo_count`, `photos_sample`, `verified`, `opening_status`, `working_hours`, `opening_date`, `reviews_per_rating`, `price_level`, `reviews_link`, `booking_link`, `order_link`, `reservations_link`, `category_ids`, `main_category_id`, `about`, `closed_dow`, `open_24_7`, `located_in`, `hotel_stars`, `hotel_amenities`, `hotel_location_rating`, `hotel_review_summary`, `hotel_booking_options`, `hotel_results_from_web`, `first_seen`, `last_seen`, `last_changed`\n\n**Note:** field projection trims the response body only. It does not change how the request is billed." } ], "description": "Search business listings by any combination of the field parameters below - name, category, address, city, ZIP code, state, country, phone number and more.\n\nAt least one of the filter parameters below is required for search. `country` is also required, and it does not count as a filter. To search inside a map area, use the Area Search By Bounding Box or the Area Search By Radius endpoint.\n\n**Note:** `match_count` is the total number of matching businesses, not the number returned on this page. A `cursor` is returned while further pages are available and omitted on the last page.\n\n**Note:** a query that matches nothing is not an error. The response is a `200` with an empty `businesses` array.", "operationId": "near_realtime_business_data__Search", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing detailed response schema" ], "pages": [ 1 ], "sourceId": "sds_y_pAgcC-xJrVMI2TjrXI0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/query", "/description", "/operationId" ], "revisionId": "sdrn_58jSAkKvEcC3bWRtd9F4t" } ], "x-zeroclick-services": [ "local-business-database" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "local-business-database", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "local-business-database", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] }, "post": { "summary": "Search (POST)", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "request_id", "parameters", "data" ], "properties": { "data": { "type": "object", "required": [ "businesses", "match_count", "limit" ], "properties": { "limit": { "type": "number", "description": "Maximum number of results requested for this page (the limit parameter, or its default)." }, "businesses": { "type": "array", "items": { "type": "object", "required": [ "business_id" ], "properties": { "cid": { "type": "string", "description": "Google CID (Customer ID) of the business." }, "lat": { "type": "number", "description": "Latitude of the business location." }, "lng": { "type": "number", "description": "Longitude of the business location." }, "tld": { "type": "string", "description": "Domain of the business website." }, "city": { "type": "string", "description": "City of the business location." }, "name": { "type": "string", "description": "Display name of the business." }, "about": { "type": "object", "required": [ "summary", "details" ], "properties": { "details": { "type": "object", "nullable": true, "description": "Structured attribute map, grouped by attribute category (e.g. accessibility, amenities), each mapping an attribute identifier to a boolean.", "additionalProperties": { "type": "object", "additionalProperties": { "type": "boolean" } } }, "summary": { "type": "string", "nullable": true, "description": "Free-text description of the business." } }, "description": "Free-form summary and a structured details map of business attributes.", "additionalProperties": false }, "phone": { "type": "string", "description": "Business phone number in E.164 format when available." }, "state": { "type": "string", "description": "State / region of the business location." }, "rating": { "type": "number", "description": "Average review rating (1-5) on Google Maps." }, "status": { "enum": [ "operational", "closed", "temporarily_closed" ], "type": "string", "description": "Operational status of the business. Values: operational, closed, temporarily_closed." }, "address": { "type": "string", "description": "Full formatted address, including the business name." }, "country": { "type": "string", "description": "ISO 3166-1 alpha-2 country code of the business location: the country of its Google address or, when that address names none, the country of the map area the business was found in. Absent when neither is known." }, "website": { "type": "string", "description": "Business website URL." }, "zipcode": { "type": "string", "description": "ZIP / postal code of the business location." }, "district": { "type": "string", "description": "District or neighbourhood of the business location." }, "owner_id": { "type": "string", "description": "ID of the Google Maps contributor account that owns this listing." }, "place_id": { "type": "string", "description": "Google Maps Place ID." }, "timezone": { "type": "string", "description": "IANA timezone of the business location." }, "verified": { "type": "boolean", "description": "Whether the business is verified by Google." }, "last_seen": { "type": "string", "description": "ISO 8601 UTC datetime the listing was last collected." }, "open_24_7": { "type": "boolean", "description": "Whether the business is open 24 hours a day, every day of the week." }, "categories": { "type": "array", "items": { "type": "string" }, "description": "List of business categories as labelled by Google Maps." }, "closed_dow": { "type": "array", "items": { "type": "number" }, "description": "Days of the week the business is closed, as ISO-8601 day numbers (1 = Monday, 7 = Sunday)." }, "first_seen": { "type": "string", "description": "ISO 8601 UTC datetime the listing was first collected." }, "google_mid": { "type": "string", "description": "Google Knowledge Graph machine ID." }, "located_in": { "type": "object", "required": [ "google_id", "name" ], "properties": { "name": { "type": "string", "description": "Name of the parent place." }, "google_id": { "type": "string", "description": "Google ID of the parent place." } }, "description": "Parent place this business is located in (e.g. mall) when applicable.", "additionalProperties": false }, "order_link": { "type": "string", "description": "URL to place an order (when published)." }, "owner_link": { "type": "string", "description": "Link to the owner profile on Google Maps." }, "owner_name": { "type": "string", "description": "Display name of the owner profile." }, "place_link": { "type": "string", "description": "Google Maps URL for the business." }, "business_id": { "type": "string", "description": "Unique Google identifier of the business." }, "hotel_stars": { "type": "number", "description": "Hotel-only: star rating (1-5). Present only for hotels." }, "photo_count": { "type": "number", "description": "Total number of photos available for the business." }, "price_level": { "type": "string", "description": "Price level as shown on Google Maps (e.g. '$10-20')." }, "booking_link": { "type": "string", "description": "URL to book a service or appointment (when published)." }, "category_ids": { "type": "array", "items": { "type": "string" }, "description": "Google's internal entity-type IDs for the business. Broader than categories, and usually several per business. The IDs are gcids (Google Maps category IDs). For a list of gcids see *https://www.openwebninja.com/blog/all-google-maps-categories*." }, "last_changed": { "type": "string", "description": "ISO 8601 UTC datetime the listing data last changed." }, "opening_date": { "type": "string", "description": "Date the business opened (when published by Google)." }, "review_count": { "type": "number", "description": "Total number of Google Maps reviews on the business." }, "reviews_link": { "type": "string", "description": "URL to view reviews on Google Maps." }, "address_short": { "type": "string", "description": "Formatted address without the business name." }, "main_category": { "type": "string", "description": "Primary business category as labelled by Google Maps." }, "photos_sample": { "type": "array", "items": { "type": "object", "required": [ "photo_id", "photo_url", "photo_url_large", "video_thumbnail_url", "latitude", "longitude", "type", "photo_datetime_utc", "photo_timestamp" ], "properties": { "type": { "enum": [ "photo", "street_view", "video" ], "type": "string", "description": "Media type. Values: photo, video, street_view." }, "latitude": { "type": "number", "nullable": true, "description": "Latitude where the photo was taken (when known)." }, "photo_id": { "type": "string", "description": "Unique Google identifier of the photo." }, "longitude": { "type": "number", "nullable": true, "description": "Longitude where the photo was taken (when known)." }, "photo_url": { "type": "string", "nullable": true, "description": "URL of the photo (default resolution)." }, "photo_timestamp": { "type": "number", "nullable": true, "description": "Unix epoch seconds matching photo_datetime_utc." }, "photo_url_large": { "type": "string", "nullable": true, "description": "URL of the photo at a larger resolution." }, "photo_datetime_utc": { "type": "string", "nullable": true, "description": "Original publication datetime of the photo in ISO 8601 UTC." }, "video_thumbnail_url": { "type": "string", "nullable": true, "description": "Thumbnail URL when the media is a video; null for still photos." } }, "additionalProperties": false }, "description": "Sample of representative photos for the business." }, "working_hours": { "type": "object", "description": "Working hours map keyed by day of the week. Each value is an array of time-range strings; absent when not published.", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "opening_status": { "type": "string", "description": "Current opening status string as shown on Google Maps (e.g. 'Open', 'Closed', 'Open 24 hours')." }, "street_address": { "type": "string", "description": "Street name and number portion of the address." }, "hotel_amenities": { "type": "object", "description": "Hotel-only: map of amenity name to availability (true/false). Present only for hotels.", "additionalProperties": { "type": "boolean" } }, "main_category_id": { "type": "string", "description": "Google's internal ID of the primary category. The ID is a gcid (Google Maps category ID). For a list of gcids see *https://www.openwebninja.com/blog/all-google-maps-categories*." }, "reservations_link": { "type": "string", "description": "URL to make a reservation (when published)." }, "reviews_per_rating": { "type": "object", "required": [ "1", "2", "3", "4", "5" ], "properties": { "1": { "type": "number", "description": "Number of 1-star reviews." }, "2": { "type": "number", "description": "Number of 2-star reviews." }, "3": { "type": "number", "description": "Number of 3-star reviews." }, "4": { "type": "number", "description": "Number of 4-star reviews." }, "5": { "type": "number", "description": "Number of 5-star reviews." } }, "description": "Counts of reviews per integer rating from 1 to 5.", "additionalProperties": false }, "hotel_review_summary": { "type": "object", "description": "Hotel-only: AI-generated review summary. Present only for hotels.", "additionalProperties": { "type": "object", "required": [ "score", "summary" ], "properties": { "score": { "type": "number", "nullable": true }, "summary": { "type": "string", "nullable": true } }, "additionalProperties": false } }, "hotel_booking_options": { "type": "array", "items": { "type": "object", "required": [ "source", "price", "link", "source_favicon" ], "properties": { "link": { "type": "string", "nullable": true, "description": "URL to book with the provider." }, "price": { "type": "string", "nullable": true, "description": "Nightly price as shown by the provider." }, "rooms": { "type": "array", "items": { "type": "object", "required": [ "room_type", "link", "price" ], "properties": { "link": { "type": "string", "nullable": true, "description": "URL to book this room type." }, "price": { "type": "string", "nullable": true, "description": "Price of this room type as shown by the provider." }, "room_type": { "type": "string", "nullable": true, "description": "Name of the room type." } }, "additionalProperties": false }, "description": "Room types offered by this provider." }, "source": { "type": "string", "nullable": true, "description": "Booking provider the option comes from." }, "source_favicon": { "type": "string", "nullable": true, "description": "URL of the provider favicon." } }, "additionalProperties": false }, "description": "Hotel-only: booking options (provider, price, link). Present only for hotels with live rates." }, "hotel_location_rating": { "type": "object", "required": [ "Overall", "Things to do", "Transit", "Airports" ], "properties": { "Overall": { "type": "number", "nullable": true, "description": "Hotel-only: overall location rating." }, "Transit": { "type": "number", "nullable": true, "description": "Hotel-only: location rating for transit access." }, "Airports": { "type": "number", "nullable": true, "description": "Hotel-only: location rating for airport access." }, "Things to do": { "type": "number", "nullable": true, "description": "Hotel-only: location rating for things to do nearby." } }, "description": "Hotel-only: location rating breakdown when the business is a hotel.", "additionalProperties": false }, "hotel_results_from_web": { "type": "array", "items": { "type": "object", "required": [ "source", "link", "source_favicon" ], "properties": { "link": { "type": "string", "nullable": true, "description": "URL of the result." }, "source": { "type": "string", "nullable": true, "description": "Website the result comes from." }, "source_favicon": { "type": "string", "nullable": true, "description": "URL of the source favicon." } }, "additionalProperties": false }, "description": "Hotel-only: additional web-sourced results shown alongside the Google listing." } }, "additionalProperties": false }, "description": "List of businesses returned." }, "match_count": { "type": "number", "description": "Total number of businesses matching the query, across all pages. It is counted on the first page and repeated on every later page, so it can differ from a fresh count if listings change while you page." } }, "description": "Businesses matching the query, with the total match count and the page size applied." }, "cursor": { "type": "string", "description": "Pagination cursor for the next page of results. Pass it back as the `cursor` parameter together with the same query. Absent on the last page." }, "status": { "type": "string", "description": "The status of the API response." }, "parameters": { "type": "object", "description": "The parameters the API received and used for this request, echoed back.", "additionalProperties": true }, "request_id": { "type": "string", "description": "A unique ID to trace the API request." } } } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "request_id", "error" ], "properties": { "error": { "type": "object", "required": [ "message", "code" ], "properties": { "code": { "type": "integer", "description": "The HTTP status of this response, repeated." }, "message": { "type": "string", "description": "What went wrong, in English. Where a code names the fault, it ends this message in parentheses." } }, "description": "What went wrong." }, "status": { "type": "string", "description": "`ERROR` on every error response." }, "request_id": { "type": "string", "description": "A unique ID to trace the failed request." } } } } }, "description": "The request was refused.\n\n`error.message` ends with its code in parentheses, as in `(UNKNOWN_FIELD)`; a message that ends in none is `VALIDATION_ERROR`. Branch on the code rather than on the English before it:\n\n`VALIDATION_ERROR` - A parameter this operation accepts was sent in a form it does not, a required parameter is missing, or the request's path and method are not one this API serves. Correct the request: `message` names the offending parameter and the accepted form.\n\n`UNKNOWN_FIELD` - A parameter name this operation does not accept, or a name in `fields` it does not return. It is a spelling fix.\n\n`NO_QUERY_FIELDS` - The request carried no field parameter at all. Add one: `limit` and `cursor` alone are not a query.\n\n`INVALID_CURSOR` - The page token is not one this API issued for this request, or it can no longer be resumed. Start again from the first page.\n\n`CURSOR_EXPIRED` - The page token was issued for this request, but the walk took longer than its lifetime. Start again from the first page." }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." }, "429": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "request_id", "error" ], "properties": { "error": { "type": "object", "required": [ "message", "code" ], "properties": { "code": { "type": "integer", "description": "The HTTP status of this response, repeated." }, "message": { "type": "string", "description": "What went wrong, in English. Where a code names the fault, it ends this message in parentheses." } }, "description": "What went wrong." }, "status": { "type": "string", "description": "`ERROR` on every error response." }, "request_id": { "type": "string", "description": "A unique ID to trace the failed request." } } } } }, "description": "The plan behind this API key has no requests left for this API. `error.message` carries no code. Retrying does not help until the plan allows further requests." }, "500": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "request_id", "error" ], "properties": { "error": { "type": "object", "required": [ "message", "code" ], "properties": { "code": { "type": "integer", "description": "The HTTP status of this response, repeated." }, "message": { "type": "string", "description": "What went wrong, in English. Where a code names the fault, it ends this message in parentheses." } }, "description": "What went wrong." }, "status": { "type": "string", "description": "`ERROR` on every error response." }, "request_id": { "type": "string", "description": "A unique ID to trace the failed request." } } } } }, "description": "The request failed on this API's side.\n\n`error.message` ends with its code in parentheses, as in `(INTERNAL_ERROR)`. Branch on the code rather than on the English before it:\n\n`INTERNAL_ERROR` - An unexpected failure on this service's side, not a fault in the request; no further detail is echoed. Retry later, with backoff.\n\n**Note:** a 500 whose message ends in no code carries no further detail about its cause. Retry later, with backoff." }, "502": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "request_id", "error" ], "properties": { "error": { "type": "object", "required": [ "message", "code" ], "properties": { "code": { "type": "integer", "description": "The HTTP status of this response, repeated." }, "message": { "type": "string", "description": "What went wrong, in English. Where a code names the fault, it ends this message in parentheses." } }, "description": "What went wrong." }, "status": { "type": "string", "description": "`ERROR` on every error response." }, "request_id": { "type": "string", "description": "A unique ID to trace the failed request." } } } } }, "description": "A service this API depends on did not complete the request.\n\n`error.message` ends with its code in parentheses, as in `(UPSTREAM_ERROR)`. Branch on the code rather than on the English before it:\n\n`UPSTREAM_ERROR` - The search backend rejected the query. Narrow the query rather than retrying it unchanged.\n\n**Note:** a 502 whose message ends in no code carries no further detail about its cause. Retry later, with backoff." }, "503": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "request_id", "error" ], "properties": { "error": { "type": "object", "required": [ "message", "code" ], "properties": { "code": { "type": "integer", "description": "The HTTP status of this response, repeated." }, "message": { "type": "string", "description": "What went wrong, in English. Where a code names the fault, it ends this message in parentheses." } }, "description": "What went wrong." }, "status": { "type": "string", "description": "`ERROR` on every error response." }, "request_id": { "type": "string", "description": "A unique ID to trace the failed request." } } } } }, "description": "This API is temporarily unable to serve the request.\n\n`error.message` ends with its code in parentheses, as in `(SEARCH_BUSY)`. Branch on the code rather than on the English before it:\n\n`SEARCH_BUSY` - The search backend is temporarily over capacity, which is not a fault in the request. Retry the same request after a few seconds, with backoff." }, "504": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "request_id", "error" ], "properties": { "error": { "type": "object", "required": [ "message", "code" ], "properties": { "code": { "type": "integer", "description": "The HTTP status of this response, repeated." }, "message": { "type": "string", "description": "What went wrong, in English. Where a code names the fault, it ends this message in parentheses." } }, "description": "What went wrong." }, "status": { "type": "string", "description": "`ERROR` on every error response." }, "request_id": { "type": "string", "description": "A unique ID to trace the failed request." } } } } }, "description": "The request did not complete within the time this API allows. `error.message` carries no code. Retry later, with backoff." } }, "description": "Search business listings by any combination of the fields below, sent as a JSON body. Same results as the GET form, and the form to use when the query is too long for a URL - for example a list of up to 20 values on several fields at once.\n\nAt least one of the filter parameters below is required for search. `country` is also required, and it does not count as a filter. This form also accepts an area: either `bottom_left` with `top_right`, or `lat` with `lng` and `radius`.\n\n**Note:** `match_count` is the total number of matching businesses, not the number returned on this page. A `cursor` is returned while further pages are available and omitted on the last page.\n\n**Note:** a query that matches nothing is not an error. The response is a `200` with an empty `businesses` array.", "operationId": "near_realtime_business_data__Search__POST_", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "country" ], "properties": { "lat": { "type": "number", "maximum": 90, "minimum": -90, "description": "Latitude of the center coordinate point of the area to search in.\n\nSend either bottom_left with top_right, or lat with lng and radius - not both, and not a partial group." }, "lng": { "type": "number", "maximum": 180, "minimum": -180, "description": "Longitude of the center coordinate point of the area to search in.\n\nSend either bottom_left with top_right, or lat with lng and radius - not both, and not a partial group." }, "city": { "oneOf": [ { "type": "string", "maxLength": 256 }, { "type": "array", "items": { "type": "string", "maxLength": 256 }, "maxItems": 20, "minItems": 1 } ], "example": "Chicago", "description": "Find businesses in a specific city.\n\nAccepts a JSON array (e.g., `[\"value1\", \"value2\"]`) of up to 20 values.\n\nValues cannot be comma separated here, as a comma can be part of the value. In the POST form, send an array instead." }, "name": { "type": "string", "example": "Office of City Treasurer", "maxLength": 256, "description": "Find businesses by their display name." }, "limit": { "type": "integer", "example": 10, "description": "Maximum number of businesses to return.\n\n**Allowed values:** `1-500`" }, "query": { "type": "string" }, "state": { "oneOf": [ { "type": "string", "maxLength": 256 }, { "type": "array", "items": { "type": "string", "maxLength": 256 }, "maxItems": 20, "minItems": 1 } ], "example": "Illinois", "description": "Find businesses in a specific state or province. Accepts a comma separated list (e.g., `Illinois`, `Florida`) or a JSON array (e.g., `[\"Illinois\", \"Florida\"]`) of up to 20 values.\n\nUS states match either way they are sent, by full name or by two-letter code." }, "cursor": { "type": "string", "maxLength": 1024, "description": "Pagination cursor for fetching the next page. Pass the `cursor` value returned in the previous response. Omit it on the first request.\n\n**Note:** a cursor is only valid for the exact query that produced it, and it expires. Do not build or edit one." }, "fields": { "oneOf": [ { "type": "string", "pattern": "^\\s*$|^\\s*(business_id|name|address|lat|lng|categories|main_category|phone|website|tld|status|rating|review_count|place_id|google_mid|cid|place_link|timezone|owner_id|owner_name|owner_link|address_short|district|street_address|city|zipcode|state|country|photo_count|photos_sample|verified|opening_status|working_hours|opening_date|reviews_per_rating|price_level|reviews_link|booking_link|order_link|reservations_link|category_ids|main_category_id|about|closed_dow|open_24_7|located_in|hotel_stars|hotel_amenities|hotel_location_rating|hotel_review_summary|hotel_booking_options|hotel_results_from_web|first_seen|last_seen|last_changed)(\\s*,\\s*(business_id|name|address|lat|lng|categories|main_category|phone|website|tld|status|rating|review_count|place_id|google_mid|cid|place_link|timezone|owner_id|owner_name|owner_link|address_short|district|street_address|city|zipcode|state|country|photo_count|photos_sample|verified|opening_status|working_hours|opening_date|reviews_per_rating|price_level|reviews_link|booking_link|order_link|reservations_link|category_ids|main_category_id|about|closed_dow|open_24_7|located_in|hotel_stars|hotel_amenities|hotel_location_rating|hotel_review_summary|hotel_booking_options|hotel_results_from_web|first_seen|last_seen|last_changed)){0,54}\\s*$" }, { "type": "array", "items": { "enum": [ "business_id", "name", "address", "lat", "lng", "categories", "main_category", "phone", "website", "tld", "status", "rating", "review_count", "place_id", "google_mid", "cid", "place_link", "timezone", "owner_id", "owner_name", "owner_link", "address_short", "district", "street_address", "city", "zipcode", "state", "country", "photo_count", "photos_sample", "verified", "opening_status", "working_hours", "opening_date", "reviews_per_rating", "price_level", "reviews_link", "booking_link", "order_link", "reservations_link", "category_ids", "main_category_id", "about", "closed_dow", "open_24_7", "located_in", "hotel_stars", "hotel_amenities", "hotel_location_rating", "hotel_review_summary", "hotel_booking_options", "hotel_results_from_web", "first_seen", "last_seen", "last_changed" ], "type": "string" }, "maxItems": 55, "minItems": 1 } ], "description": "A comma separated list of business fields to include in the response (field projection).\n\nBy default all fields are returned. `business_id` is always included.\n\n**Note:** field projection trims the response body only. It does not change how the request is billed." }, "radius": { "type": "number", "maximum": 100000, "minimum": 0, "description": "Radius of the area to search in, in meters.\n\n**Allowed values:** `1-100000`", "exclusiveMinimum": true }, "address": { "type": "string", "example": "Office of City Treasurer, 121 N LaSalle St #106, Chicago, IL 60602", "maxLength": 256, "description": "Find businesses by their full formatted address, including the business name." }, "country": { "type": "string", "example": "US", "maxLength": 256, "description": "Find businesses in a specific country, as one ISO 3166-1 alpha-2 code. It is required.\n\nSend one code per request, as a string. A list of codes, as an array or comma separated, and an unknown code are rejected with a 400 error.\n\nFor a list of supported country codes see *https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2*." }, "zipcode": { "oneOf": [ { "type": "string", "maxLength": 256 }, { "type": "array", "items": { "type": "string", "maxLength": 256 }, "maxItems": 20, "minItems": 1 } ], "example": "60602", "description": "Find businesses in a specific ZIP / postal code. Accepts a comma separated list (e.g., `60602`, `98112`) or a JSON array (e.g., `[\"60602\", \"98112\"]`) of up to 20 values." }, "district": { "oneOf": [ { "type": "string", "maxLength": 256 }, { "type": "array", "items": { "type": "string", "maxLength": 256 }, "maxItems": 20, "minItems": 1 } ], "example": "Chicago Loop", "description": "Find businesses in a specific district or neighbourhood, when the listing carries one.\n\nAccepts a JSON array (e.g., `[\"value1\", \"value2\"]`) of up to 20 values.\n\nValues cannot be comma separated here, as a comma can be part of the value. In the POST form, send an array instead." }, "verified": { "type": "boolean", "example": true, "description": "Find businesses by whether their Google listing is claimed by the owner: `true` for claimed listings, `false` for unclaimed ones.\n\nA business whose claim status is unknown, with no `verified` in its record, matches neither value, so `verified=false` never returns it. Claim status fills in as listings are refreshed, so coverage grows over the first month after release." }, "top_right": { "type": "string", "description": "The top-right (north-east) corner of the bounding box to search in, as a \"lat,lng\" string.\n\nSend either bottom_left with top_right, or lat with lng and radius - not both, and not a partial group." }, "owner_name": { "oneOf": [ { "type": "string", "maxLength": 256 }, { "type": "array", "items": { "type": "string", "maxLength": 256 }, "maxItems": 20, "minItems": 1 } ], "example": "Office of City Treasurer", "description": "Find businesses by the name on the owner profile.\n\nAccepts a JSON array (e.g., `[\"value1\", \"value2\"]`) of up to 20 values.\n\nValues cannot be comma separated here, as a comma can be part of the value. In the POST form, send an array instead." }, "bottom_left": { "type": "string", "description": "The bottom-left (south-west) corner of the bounding box to search in, as a \"lat,lng\" string.\n\nSend either bottom_left with top_right, or lat with lng and radius - not both, and not a partial group." }, "business_id": { "oneOf": [ { "type": "string", "maxLength": 256 }, { "type": "array", "items": { "type": "string", "maxLength": 256 }, "maxItems": 20, "minItems": 1 } ], "example": "0x102b644d009e013:0xea49e9ee285fa7bf", "description": "Find businesses by their unique Business Id, matched exactly. Accepts a comma separated list (e.g., `0x102b644d009e013:0xea49e9ee285fa7bf`, `0x1792d85c519234b:0x91eebb9c864b198d`) or a JSON array (e.g., `[\"0x102b644d009e013:0xea49e9ee285fa7bf\", \"0x1792d85c519234b:0x91eebb9c864b198d\"]`) of up to 20 values." }, "phone_number": { "oneOf": [ { "type": "string", "maxLength": 256 }, { "type": "array", "items": { "type": "string", "maxLength": 256 }, "maxItems": 20, "minItems": 1 } ], "example": "+13127443356", "description": "Find businesses by phone number. Accepts a comma separated list (e.g., `+13127443356`, `+12063248900`) or a JSON array (e.g., `[\"+13127443356\", \"+12063248900\"]`) of up to 20 values.\n\nSend the number with its country code, either in E.164 *(`+14325551234`, URL-encoded as `%2B14325551234`)* or in a decorated form such as `1-432-555-1234`, `(432) 555-1234` or `0014325551234`." }, "street_address": { "oneOf": [ { "type": "string", "maxLength": 256 }, { "type": "array", "items": { "type": "string", "maxLength": 256 }, "maxItems": 20, "minItems": 1 } ], "example": "121 N LaSalle St #106", "description": "Find businesses by the street line of their address on its own.\n\nA single value is matched loosely, which also finds spelling and abbreviation variants. Several values are matched exactly instead, which narrows the result.\n\nAccepts a JSON array (e.g., `[\"value1\", \"value2\"]`) of up to 20 values.\n\nValues cannot be comma separated here, as a comma can be part of the value. In the POST form, send an array instead." }, "business_category": { "oneOf": [ { "type": "string", "maxLength": 256 }, { "type": "array", "items": { "type": "string", "maxLength": 256 }, "maxItems": 20, "minItems": 1 } ], "example": "restaurant", "description": "Find businesses carrying a specific category. Accepts a comma separated list (e.g., `restaurant`, `bank`) or a JSON array (e.g., `[\"restaurant\", \"bank\"]`) of up to 20 values." }, "business_category_id": { "oneOf": [ { "type": "string", "maxLength": 256 }, { "type": "array", "items": { "type": "string", "maxLength": 256 }, "maxItems": 20, "minItems": 1 } ], "example": "bakery", "description": "Find businesses by Google's internal entity-type IDs. Accepts a comma separated list (e.g., `bakery`, `catholic_church`) or a JSON array (e.g., `[\"bakery\", \"catholic_church\"]`) of up to 20 values.\n\nThese are entity types rather than the listing's categories: the values are broad and a listing usually carries several of them, so this is a wide filter.\n\nThe IDs are gcids (Google Maps category IDs). For a list of gcids see *https://www.openwebninja.com/blog/all-google-maps-categories*." }, "main_business_category": { "oneOf": [ { "type": "string", "maxLength": 256 }, { "type": "array", "items": { "type": "string", "maxLength": 256 }, "maxItems": 20, "minItems": 1 } ], "example": "Coffee shop", "description": "Find businesses whose primary category matches. Same value space as the business_category parameter. Accepts a comma separated list (e.g., `Coffee shop`, `Hotel`) or a JSON array (e.g., `[\"Coffee shop\", \"Hotel\"]`) of up to 20 values." }, "main_business_category_id": { "oneOf": [ { "type": "string", "maxLength": 256 }, { "type": "array", "items": { "type": "string", "maxLength": 256 }, "maxItems": 20, "minItems": 1 } ], "example": "restaurant", "description": "Find businesses by Google's internal ID of the primary category. Accepts a comma separated list (e.g., `restaurant`, `hotel`) or a JSON array (e.g., `[\"restaurant\", \"hotel\"]`) of up to 20 values.\n\nThis is the machine ID, not the display label the main_business_category parameter matches, and the two can name different primaries.\n\nThe IDs are gcids (Google Maps category IDs). For a list of gcids see *https://www.openwebninja.com/blog/all-google-maps-categories*." } }, "description": "At least one of the filter parameters below is required for search. `country` is also required, and it does not count as a filter. An area is one field: a request carrying only `bottom_left` with `top_right`, or only `lat` with `lng` and `radius`, is a valid query.", "additionalProperties": false }, "examples": { "Request": { "value": { "city": "Chicago", "limit": 10, "state": "Illinois", "country": "US", "business_category": "restaurant" }, "summary": "Request" } } } }, "required": true }, "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing request body details" ], "pages": [ 1 ], "sourceId": "sds_1IfgtOxqP1q4cHvJ7VyPY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/required" ], "revisionId": "sdrn_mb4oPKVX4C1sgk5EHzdxz" }, { "gaps": [ "Missing request body schema details." ], "pages": [], "sourceId": "sds_2Dc9eyhO3NLPUm0GEbTiV", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/required" ], "revisionId": "sdrn_Z1eLurdzog7OgIWS9gcdZ" }, { "gaps": [ "Missing request body schema properties and response schema details." ], "pages": [], "sourceId": "sds_2EOeqrIsWKjYBjoNIGwV0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_ds2DI_Xad11MCFdnoGvH0" }, { "gaps": [ "Missing parameter details for query" ], "pages": [ 1 ], "sourceId": "sds_AF8bRESy69frdnjtCAF2z", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/required" ], "revisionId": "sdrn_nUAt1Ad8MTY5qaVlNUqO9" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_BowKpX7oIEvSZAa5G-8Cj", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description" ], "revisionId": "sdrn_AlkJCvRexbLp1t3wre1uD" }, { "gaps": [ "Missing request parameters schema details" ], "pages": [ 1 ], "sourceId": "sds_FK2maa1cDe4qcElj5U3zU", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/required" ], "revisionId": "sdrn_gZ-rMsS0AnYbgxe2iW2Nm" }, { "gaps": [ "Missing parameters, request body schema details, and response schema details." ], "pages": [], "sourceId": "sds_SWPCFBdhQTXC3OrJ98RML", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/required" ], "revisionId": "sdrn_bk6BUY0JsF4ImDRAT3nR8" }, { "gaps": [ "Missing schema details" ], "pages": [ 1 ], "sourceId": "sds_t1I2lol_F5DgGpe13n3Xt", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/required" ], "revisionId": "sdrn_OBuPoRSMenxSJ1CM3zwbN" }, { "gaps": [ "Missing request body schema" ], "pages": [], "sourceId": "sds_vdxxiVsx4OKV5vH7hrhwb", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_46RDkwnCaOF5IxAFfXTW0" }, { "gaps": [ "Missing request body schema" ], "pages": [ 1 ], "sourceId": "sds_ZS-xdAQ0s8auc1LcI7Ooo", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_7knEBvR-UUuEvVL1C_QLq" } ], "x-zeroclick-services": [ "local-business-database" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "local-business-database", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "local-business-database", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/local-business-data/business-details": { "get": { "summary": "Business Details", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "request_id", "parameters", "data" ], "properties": { "data": { "type": "array", "items": { "type": "object", "required": [ "business_id", "google_id", "name", "business_status" ], "properties": { "cid": { "type": "string", "nullable": true, "description": "Google CID (Customer ID) of the business." }, "tld": { "type": "string", "nullable": true, "description": "Top-level domain of the business website." }, "city": { "type": "string", "nullable": true, "description": "City of the business location." }, "name": { "type": "string", "description": "Display name of the business." }, "type": { "type": "string", "nullable": true, "description": "Primary business category as labelled by Google Maps." }, "about": { "type": "object", "nullable": true, "properties": { "details": { "type": "object", "nullable": true, "description": "Map of attribute groups (e.g. Amenities, Crowd, Service options) to attribute name -> boolean.", "additionalProperties": { "type": "object", "additionalProperties": { "type": "boolean" } } }, "summary": { "type": "string", "nullable": true, "description": "Free-text description of the business." } }, "description": "Free-form summary and a structured details map of business attributes." }, "state": { "type": "string", "nullable": true, "description": "State / region of the business location." }, "rating": { "type": "number", "nullable": true, "description": "Average review rating (1-5) on Google Maps." }, "address": { "type": "string", "nullable": true, "description": "Street address line of the business." }, "country": { "type": "string", "nullable": true, "description": "ISO 3166-1 alpha-2 country code of the business location." }, "website": { "type": "string", "nullable": true, "description": "Business website URL." }, "zipcode": { "type": "string", "nullable": true, "description": "ZIP / postal code of the business location." }, "district": { "type": "string", "nullable": true, "description": "District or neighbourhood of the business location." }, "latitude": { "type": "number", "description": "Latitude of the business location." }, "owner_id": { "type": "string", "nullable": true, "description": "ID of the Google Maps contributor account that owns this listing." }, "place_id": { "type": "string", "description": "Google Maps Place ID." }, "subtypes": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "List of additional business categories." }, "timezone": { "type": "string", "nullable": true, "description": "IANA timezone of the business location." }, "verified": { "type": "boolean", "description": "Whether the business is verified by Google." }, "directory": { "type": "array", "items": { "type": "object", "additionalProperties": true }, "nullable": true, "description": "List of businesses located in the same building / directory (e.g. mall, plaza). Conditional." }, "google_id": { "type": "string", "description": "Google's internal hexadecimal ID of the business." }, "longitude": { "type": "number", "description": "Longitude of the business location." }, "menu_link": { "type": "string", "nullable": true, "description": "URL of the business menu (when published)." }, "google_mid": { "type": "string", "nullable": true, "description": "Google Knowledge Graph machine ID." }, "located_in": { "type": "object", "nullable": true, "properties": { "name": { "type": "string", "description": "Name of the parent place." }, "google_id": { "type": "string", "description": "Google ID of the parent place." } }, "description": "Parent place this business is located in (e.g. mall) when applicable." }, "order_link": { "type": "string", "nullable": true, "description": "URL to place an order (when published)." }, "owner_link": { "type": "string", "nullable": true, "description": "Link to the owner profile on Google Maps." }, "owner_name": { "type": "string", "nullable": true, "description": "Display name of the owner profile." }, "place_link": { "type": "string", "description": "Google Maps URL for the business." }, "posts_link": { "type": "string", "nullable": true, "description": "URL to the full list of owner posts on Google Maps." }, "share_link": { "type": "string", "nullable": true, "description": "Shortened Google Maps share URL for the business. Returned when extract_share_link=true." }, "business_id": { "type": "string", "description": "Unique Google identifier of the business. Same value as google_id." }, "hotel_stars": { "type": "integer", "nullable": true, "description": "Hotel-only: star rating (1-5). Present only for hotels." }, "photo_count": { "type": "integer", "nullable": true, "description": "Total number of photos available for the business." }, "price_level": { "type": "string", "nullable": true, "description": "Price level as shown on Google Maps (e.g. '$', '$$')." }, "booking_link": { "type": "string", "nullable": true, "description": "URL to book a service or appointment." }, "full_address": { "type": "string", "description": "Full formatted address including business name." }, "opening_date": { "type": "string", "nullable": true, "description": "Date the business opened (when published by Google)." }, "phone_number": { "type": "string", "nullable": true, "description": "Business phone number in E.164 format when available." }, "posts_sample": { "type": "array", "items": { "type": "object", "properties": { "post_id": { "type": "string", "description": "Unique Google identifier of the owner post." }, "post_link": { "type": "string", "nullable": true, "description": "Direct URL to the post on Google." }, "post_text": { "type": "string", "nullable": true, "description": "Text content of the post." }, "post_links": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string", "description": "Target URL of the link." }, "caption": { "type": "string", "nullable": true, "description": "Caption of the link as shown on the post." } } }, "nullable": true, "description": "Outbound links attached to the post." }, "post_photos": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "URLs of photos attached to the post." }, "post_timestamp": { "type": "integer", "nullable": true, "description": "Unix epoch seconds matching post_datetime_utc." }, "post_datetime_utc": { "type": "string", "nullable": true, "description": "ISO 8601 UTC datetime when the post was published." } } }, "nullable": true, "description": "Sample of the most recent owner posts. Present in /business-details and /business-details-plus." }, "review_count": { "type": "integer", "nullable": true, "description": "Total number of Google Maps reviews on the business." }, "reviews_link": { "type": "string", "nullable": true, "description": "URL to view reviews on Google Maps." }, "photos_sample": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "Media type. Values: photo, video, street_view." }, "latitude": { "type": "number", "nullable": true, "description": "Latitude where the photo was taken (when known)." }, "photo_id": { "type": "string", "description": "Google Maps photo ID." }, "longitude": { "type": "number", "nullable": true, "description": "Longitude where the photo was taken (when known)." }, "photo_url": { "type": "string", "description": "URL of the photo (lower-resolution)." }, "photo_timestamp": { "type": "integer", "nullable": true, "description": "Unix epoch seconds matching photo_datetime_utc." }, "photo_url_large": { "type": "string", "nullable": true, "description": "URL of the photo at a larger resolution." }, "photo_datetime_utc": { "type": "string", "nullable": true, "description": "Original publication datetime of the photo in ISO 8601 UTC." }, "video_thumbnail_url": { "type": "string", "nullable": true, "description": "Thumbnail URL when the media is a video; null for still photos." } } }, "nullable": true, "description": "Up to ~10 representative photos for the business." }, "subtype_gcids": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "Internal Google category IDs corresponding to the primary type and subtypes." }, "working_hours": { "type": "object", "nullable": true, "description": "Working hours map keyed by day of the week. Each value is an array of time-range strings; empty object when not published.", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "opening_status": { "type": "string", "nullable": true, "description": "Current opening status string as shown on Google Maps (e.g. 'Open', 'Closed', 'Open 24 hours')." }, "reviews_sample": { "type": "array", "items": { "type": "object", "properties": { "rating": { "type": "integer", "description": "Star rating given in the review (1-5)." }, "author_id": { "type": "string", "nullable": true, "description": "Google Maps contributor ID of the review author." }, "review_id": { "type": "string", "description": "Unique Google identifier of the review." }, "like_count": { "type": "integer", "nullable": true, "description": "Number of likes the review received." }, "author_link": { "type": "string", "nullable": true, "description": "URL to the author's Google Maps profile." }, "author_name": { "type": "string", "nullable": true, "description": "Display name of the review author." }, "review_form": { "type": "object", "nullable": true, "description": "Structured questions the author answered (e.g. 'What kind of trip was it?').", "additionalProperties": { "type": "string" } }, "review_link": { "type": "string", "nullable": true, "description": "Direct Google Maps URL to the review." }, "review_text": { "type": "string", "nullable": true, "description": "Full text content of the review." }, "review_photos": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "URLs of photos attached to the review." }, "review_source": { "type": "string", "nullable": true, "description": "Platform the review originates from (e.g. 'Google', 'Tripadvisor')." }, "review_language": { "type": "string", "nullable": true, "description": "ISO 639 language code of the review text." }, "service_quality": { "type": "string", "nullable": true, "description": "Optional service-quality tag the author selected." }, "author_photo_url": { "type": "string", "nullable": true, "description": "URL of the author's profile photo." }, "review_timestamp": { "type": "integer", "nullable": true, "description": "Unix epoch seconds matching review_datetime_utc." }, "author_review_count": { "type": "integer", "nullable": true, "description": "Number of reviews this author has posted." }, "author_reviews_link": { "type": "string", "nullable": true, "description": "URL to all reviews by this author." }, "owner_response_text": { "type": "string", "nullable": true, "description": "Text of the business owner's response." }, "review_datetime_utc": { "type": "string", "nullable": true, "description": "ISO 8601 UTC datetime when the review was posted." }, "hotel_rating_breakdown": { "type": "object", "nullable": true, "description": "Hotel-only: per-aspect ratings (Rooms, Service, Location, etc.).", "additionalProperties": { "type": "integer" } }, "owner_response_language": { "type": "string", "nullable": true, "description": "ISO 639 language code of the owner response." }, "author_local_guide_level": { "type": "integer", "nullable": true, "description": "Google Local Guide level (1-10) of the author." }, "owner_response_timestamp": { "type": "integer", "nullable": true, "description": "Unix epoch seconds matching owner_response_datetime_utc." }, "owner_response_datetime_utc": { "type": "string", "nullable": true, "description": "ISO 8601 UTC datetime when the business owner responded." } } }, "nullable": true, "description": "Sample of recent reviews. Present in /business-details and /business-details-plus." }, "street_address": { "type": "string", "nullable": true, "description": "Street name and number portion of the address." }, "business_status": { "type": "string", "description": "Operational status. Values: OPEN, CLOSED_TEMPORARILY, CLOSED_PERMANENTLY." }, "hotel_amenities": { "type": "object", "nullable": true, "description": "Hotel-only: map of amenity name to availability (true/false). Present only for hotels.", "additionalProperties": { "type": "boolean" } }, "global_plus_code": { "type": "string", "nullable": true, "description": "Global Open Location Code (Plus Code) for the business location." }, "business_services": { "type": "object", "nullable": true, "description": "Map of service category -> list of services offered (when published by the owner).", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "reservations_link": { "type": "string", "nullable": true, "description": "URL to make a reservation." }, "compound_plus_code": { "type": "string", "nullable": true, "description": "Compound (short) Plus Code with a nearby locality." }, "reviews_per_rating": { "type": "object", "nullable": true, "properties": { "1": { "type": "integer", "description": "Number of 1-star reviews." }, "2": { "type": "integer", "description": "Number of 2-star reviews." }, "3": { "type": "integer", "description": "Number of 3-star reviews." }, "4": { "type": "integer", "description": "Number of 4-star reviews." }, "5": { "type": "integer", "description": "Number of 5-star reviews." } }, "description": "Counts of reviews per integer rating from 1 to 5." }, "emails_and_contacts": { "type": "object", "nullable": true, "properties": { "yelp": { "type": "string", "nullable": true, "description": "Yelp listing URL." }, "emails": { "type": "array", "items": { "type": "string" }, "description": "Email addresses found on the business website." }, "github": { "type": "string", "nullable": true, "description": "GitHub profile URL." }, "tiktok": { "type": "string", "nullable": true, "description": "TikTok profile URL." }, "twitter": { "type": "string", "nullable": true, "description": "Twitter/X profile URL." }, "youtube": { "type": "string", "nullable": true, "description": "YouTube channel URL." }, "facebook": { "type": "string", "nullable": true, "description": "Facebook profile URL." }, "linkedin": { "type": "string", "nullable": true, "description": "LinkedIn profile URL." }, "snapchat": { "type": "string", "nullable": true, "description": "Snapchat profile URL." }, "instagram": { "type": "string", "nullable": true, "description": "Instagram profile URL." }, "pinterest": { "type": "string", "nullable": true, "description": "Pinterest profile URL." }, "phone_numbers": { "type": "array", "items": { "type": "string" }, "description": "Phone numbers found on the business website." } }, "description": "Emails and social-network profiles extracted from the business website. Populated when extract_emails_and_contacts=true (the default for /business-details)." }, "hotel_review_summary": { "type": "object", "nullable": true, "description": "Hotel-only: AI-generated review summary. Present only for hotels.", "additionalProperties": true }, "hotel_booking_options": { "type": "array", "items": { "type": "object", "additionalProperties": true }, "nullable": true, "description": "Hotel-only: array of booking options (provider, price, link). Present only for hotels with live rates." }, "hotel_location_rating": { "type": "object", "nullable": true, "description": "Hotel-only: location rating breakdown when the business is a hotel.", "additionalProperties": true }, "hotel_price_for_dates": { "type": "string", "nullable": true, "description": "Hotel-only: nightly price string when Google has live rates." }, "requested_business_id": { "type": "string", "description": "The exact business_id from the request, echoed back. Useful when batching multiple IDs." }, "hotel_results_from_web": { "type": "array", "items": { "type": "object", "additionalProperties": true }, "nullable": true, "description": "Hotel-only: additional web-sourced results / reviews shown alongside the Google listing." }, "keywords_mentioned_in_reviews": { "type": "array", "items": { "type": "object", "required": [ "keyword", "review_count" ], "properties": { "keyword": { "type": "string", "description": "The keyword extracted from reviews." }, "review_count": { "type": "integer", "description": "Number of reviews mentioning this keyword." } } }, "nullable": true, "description": "Keywords most frequently mentioned in reviews, with counts. Returned by /business-details-plus only (AI-enriched, ?extended_details=true)." } } }, "description": "List of businesses returned." }, "status": { "type": "string", "description": "The status of the API response." }, "parameters": { "type": "object", "properties": { "region": { "type": "string", "description": "The region/country code used for the response." }, "language": { "type": "string", "description": "The language code used for the response." }, "business_id": { "type": "string", "description": "The business_id as received in the request." }, "coordinates": { "type": "string", "description": "Geographic bias coordinates used (lat,lng)." }, "extract_share_link": { "type": "boolean", "description": "Whether a Google Maps share link was extracted." }, "extract_emails_and_contacts": { "type": "boolean", "description": "Whether email/contact extraction was performed." } }, "description": "The parameters the API received and used for this request, echoed back." }, "request_id": { "type": "string", "description": "A unique ID to trace the API request." } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "business_id", "schema": { "type": "string", "example": "0x880fd393d427a591:0x8cba02d713a995ed" }, "example": "0x880fd393d427a591:0x8cba02d713a995ed", "required": true, "description": "Unique Business Id. Accepts `google_id` / `business_id` or `place_id`. \n\n **Examples:** \n `0x880fd393d427a591:0x8cba02d713a995ed` \n `ChIJkaUn1JPTD4gR7ZWpE9cCuow` \n \n In addition, batching of up to 20 Business Ids is supported in a single request using a comma separated list *(e.g. business_id=id1,id2)*." }, { "in": "query", "name": "extract_emails_and_contacts", "schema": { "type": "boolean", "default": true }, "description": "Whether to extract emails, contacts and social profiles for the business. \n In case true, businesses will be enriched with a emails_and_contacts field, potentially containing emails, phones, Facebook, LinkedIn, Instagram and other social profiles." }, { "in": "query", "name": "extract_share_link", "schema": { "type": "boolean", "default": false }, "description": "Whether to extract place's share link for the business. \n In case true, businesses will be enriched with a share_link field containing a shortened Google URL for sharing *(e.g. https://goo.gl/maps/oxndE8SVaNU5CV6p6)*." }, { "in": "query", "name": "fields", "schema": { "type": "string" }, "description": "A comma separated list of business fields to include in the response (field projection). \n By default all fields are returned." }, { "in": "query", "name": "region", "schema": { "type": "string", "default": "us" }, "description": "Query Google Maps from a particular region or country. \n For a list of supported region/country codes see *https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes (Alpha-2 code)*." }, { "in": "query", "name": "language", "schema": { "type": "string", "default": "eu" }, "description": "Set the language of the results. \n For a list of supported language codes see *https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes*." }, { "in": "query", "name": "coordinates", "schema": { "type": "string" }, "description": "Geographic coordinates of the location from which the query is applied - recommended to use so that results are biased towards this location. \n Defaults to some central location in the region (see the region parameter)." } ], "description": "Get full business details including emails and social contacts. \n Supports batching of up to 20 Business Ids.", "operationId": "local_business_data__get__business_details", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" } ], "x-zeroclick-services": [ "local-business-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "local-business-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "local-business-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/local-business-data/business-details-plus": { "get": { "summary": "Business Details Plus", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "request_id", "parameters", "data" ], "properties": { "data": { "type": "array", "items": { "type": "object", "required": [ "business_id", "google_id", "name", "business_status" ], "properties": { "cid": { "type": "string", "nullable": true, "description": "Google CID (Customer ID) of the business." }, "tld": { "type": "string", "nullable": true, "description": "Top-level domain of the business website." }, "city": { "type": "string", "nullable": true, "description": "City of the business location." }, "name": { "type": "string", "description": "Display name of the business." }, "type": { "type": "string", "nullable": true, "description": "Primary business category as labelled by Google Maps." }, "about": { "type": "object", "nullable": true, "properties": { "details": { "type": "object", "nullable": true, "description": "Map of attribute groups (e.g. Amenities, Crowd, Service options) to attribute name -> boolean.", "additionalProperties": { "type": "object", "additionalProperties": { "type": "boolean" } } }, "summary": { "type": "string", "nullable": true, "description": "Free-text description of the business." } }, "description": "Free-form summary and a structured details map of business attributes." }, "state": { "type": "string", "nullable": true, "description": "State / region of the business location." }, "rating": { "type": "number", "nullable": true, "description": "Average review rating (1-5) on Google Maps." }, "address": { "type": "string", "nullable": true, "description": "Street address line of the business." }, "country": { "type": "string", "nullable": true, "description": "ISO 3166-1 alpha-2 country code of the business location." }, "website": { "type": "string", "nullable": true, "description": "Business website URL." }, "zipcode": { "type": "string", "nullable": true, "description": "ZIP / postal code of the business location." }, "district": { "type": "string", "nullable": true, "description": "District or neighbourhood of the business location." }, "latitude": { "type": "number", "description": "Latitude of the business location." }, "owner_id": { "type": "string", "nullable": true, "description": "ID of the Google Maps contributor account that owns this listing." }, "place_id": { "type": "string", "description": "Google Maps Place ID." }, "subtypes": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "List of additional business categories." }, "timezone": { "type": "string", "nullable": true, "description": "IANA timezone of the business location." }, "verified": { "type": "boolean", "description": "Whether the business is verified by Google." }, "directory": { "type": "array", "items": { "type": "object", "additionalProperties": true }, "nullable": true, "description": "List of businesses located in the same building / directory (e.g. mall, plaza). Conditional." }, "google_id": { "type": "string", "description": "Google's internal hexadecimal ID of the business." }, "longitude": { "type": "number", "description": "Longitude of the business location." }, "menu_link": { "type": "string", "nullable": true, "description": "URL of the business menu (when published)." }, "google_mid": { "type": "string", "nullable": true, "description": "Google Knowledge Graph machine ID." }, "located_in": { "type": "object", "nullable": true, "properties": { "name": { "type": "string", "description": "Name of the parent place." }, "google_id": { "type": "string", "description": "Google ID of the parent place." } }, "description": "Parent place this business is located in (e.g. mall) when applicable." }, "order_link": { "type": "string", "nullable": true, "description": "URL to place an order (when published)." }, "owner_link": { "type": "string", "nullable": true, "description": "Link to the owner profile on Google Maps." }, "owner_name": { "type": "string", "nullable": true, "description": "Display name of the owner profile." }, "place_link": { "type": "string", "description": "Google Maps URL for the business." }, "posts_link": { "type": "string", "nullable": true, "description": "URL to the full list of owner posts on Google Maps." }, "share_link": { "type": "string", "nullable": true, "description": "Shortened Google Maps share URL for the business. Returned when extract_share_link=true." }, "business_id": { "type": "string", "description": "Unique Google identifier of the business. Same value as google_id." }, "hotel_stars": { "type": "integer", "nullable": true, "description": "Hotel-only: star rating (1-5). Present only for hotels." }, "photo_count": { "type": "integer", "nullable": true, "description": "Total number of photos available for the business." }, "price_level": { "type": "string", "nullable": true, "description": "Price level as shown on Google Maps (e.g. '$', '$$')." }, "booking_link": { "type": "string", "nullable": true, "description": "URL to book a service or appointment." }, "full_address": { "type": "string", "description": "Full formatted address including business name." }, "opening_date": { "type": "string", "nullable": true, "description": "Date the business opened (when published by Google)." }, "phone_number": { "type": "string", "nullable": true, "description": "Business phone number in E.164 format when available." }, "posts_sample": { "type": "array", "items": { "type": "object", "properties": { "post_id": { "type": "string", "description": "Unique Google identifier of the owner post." }, "post_link": { "type": "string", "nullable": true, "description": "Direct URL to the post on Google." }, "post_text": { "type": "string", "nullable": true, "description": "Text content of the post." }, "post_links": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string", "description": "Target URL of the link." }, "caption": { "type": "string", "nullable": true, "description": "Caption of the link as shown on the post." } } }, "nullable": true, "description": "Outbound links attached to the post." }, "post_photos": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "URLs of photos attached to the post." }, "post_timestamp": { "type": "integer", "nullable": true, "description": "Unix epoch seconds matching post_datetime_utc." }, "post_datetime_utc": { "type": "string", "nullable": true, "description": "ISO 8601 UTC datetime when the post was published." } } }, "nullable": true, "description": "Sample of the most recent owner posts. Present in /business-details and /business-details-plus." }, "review_count": { "type": "integer", "nullable": true, "description": "Total number of Google Maps reviews on the business." }, "reviews_link": { "type": "string", "nullable": true, "description": "URL to view reviews on Google Maps." }, "photos_sample": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "Media type. Values: photo, video, street_view." }, "latitude": { "type": "number", "nullable": true, "description": "Latitude where the photo was taken (when known)." }, "photo_id": { "type": "string", "description": "Google Maps photo ID." }, "longitude": { "type": "number", "nullable": true, "description": "Longitude where the photo was taken (when known)." }, "photo_url": { "type": "string", "description": "URL of the photo (lower-resolution)." }, "photo_timestamp": { "type": "integer", "nullable": true, "description": "Unix epoch seconds matching photo_datetime_utc." }, "photo_url_large": { "type": "string", "nullable": true, "description": "URL of the photo at a larger resolution." }, "photo_datetime_utc": { "type": "string", "nullable": true, "description": "Original publication datetime of the photo in ISO 8601 UTC." }, "video_thumbnail_url": { "type": "string", "nullable": true, "description": "Thumbnail URL when the media is a video; null for still photos." } } }, "nullable": true, "description": "Up to ~10 representative photos for the business." }, "subtype_gcids": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "Internal Google category IDs corresponding to the primary type and subtypes." }, "working_hours": { "type": "object", "nullable": true, "description": "Working hours map keyed by day of the week. Each value is an array of time-range strings; empty object when not published.", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "opening_status": { "type": "string", "nullable": true, "description": "Current opening status string as shown on Google Maps (e.g. 'Open', 'Closed', 'Open 24 hours')." }, "reviews_sample": { "type": "array", "items": { "type": "object", "properties": { "rating": { "type": "integer", "description": "Star rating given in the review (1-5)." }, "author_id": { "type": "string", "nullable": true, "description": "Google Maps contributor ID of the review author." }, "review_id": { "type": "string", "description": "Unique Google identifier of the review." }, "like_count": { "type": "integer", "nullable": true, "description": "Number of likes the review received." }, "author_link": { "type": "string", "nullable": true, "description": "URL to the author's Google Maps profile." }, "author_name": { "type": "string", "nullable": true, "description": "Display name of the review author." }, "review_form": { "type": "object", "nullable": true, "description": "Structured questions the author answered (e.g. 'What kind of trip was it?').", "additionalProperties": { "type": "string" } }, "review_link": { "type": "string", "nullable": true, "description": "Direct Google Maps URL to the review." }, "review_text": { "type": "string", "nullable": true, "description": "Full text content of the review." }, "review_photos": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "URLs of photos attached to the review." }, "review_source": { "type": "string", "nullable": true, "description": "Platform the review originates from (e.g. 'Google', 'Tripadvisor')." }, "review_language": { "type": "string", "nullable": true, "description": "ISO 639 language code of the review text." }, "service_quality": { "type": "string", "nullable": true, "description": "Optional service-quality tag the author selected." }, "author_photo_url": { "type": "string", "nullable": true, "description": "URL of the author's profile photo." }, "review_timestamp": { "type": "integer", "nullable": true, "description": "Unix epoch seconds matching review_datetime_utc." }, "author_review_count": { "type": "integer", "nullable": true, "description": "Number of reviews this author has posted." }, "author_reviews_link": { "type": "string", "nullable": true, "description": "URL to all reviews by this author." }, "owner_response_text": { "type": "string", "nullable": true, "description": "Text of the business owner's response." }, "review_datetime_utc": { "type": "string", "nullable": true, "description": "ISO 8601 UTC datetime when the review was posted." }, "hotel_rating_breakdown": { "type": "object", "nullable": true, "description": "Hotel-only: per-aspect ratings (Rooms, Service, Location, etc.).", "additionalProperties": { "type": "integer" } }, "owner_response_language": { "type": "string", "nullable": true, "description": "ISO 639 language code of the owner response." }, "author_local_guide_level": { "type": "integer", "nullable": true, "description": "Google Local Guide level (1-10) of the author." }, "owner_response_timestamp": { "type": "integer", "nullable": true, "description": "Unix epoch seconds matching owner_response_datetime_utc." }, "owner_response_datetime_utc": { "type": "string", "nullable": true, "description": "ISO 8601 UTC datetime when the business owner responded." } } }, "nullable": true, "description": "Sample of recent reviews. Present in /business-details and /business-details-plus." }, "street_address": { "type": "string", "nullable": true, "description": "Street name and number portion of the address." }, "business_status": { "type": "string", "description": "Operational status. Values: OPEN, CLOSED_TEMPORARILY, CLOSED_PERMANENTLY." }, "hotel_amenities": { "type": "object", "nullable": true, "description": "Hotel-only: map of amenity name to availability (true/false). Present only for hotels.", "additionalProperties": { "type": "boolean" } }, "global_plus_code": { "type": "string", "nullable": true, "description": "Global Open Location Code (Plus Code) for the business location." }, "business_services": { "type": "object", "nullable": true, "description": "Map of service category -> list of services offered (when published by the owner).", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "reservations_link": { "type": "string", "nullable": true, "description": "URL to make a reservation." }, "compound_plus_code": { "type": "string", "nullable": true, "description": "Compound (short) Plus Code with a nearby locality." }, "reviews_per_rating": { "type": "object", "nullable": true, "properties": { "1": { "type": "integer", "description": "Number of 1-star reviews." }, "2": { "type": "integer", "description": "Number of 2-star reviews." }, "3": { "type": "integer", "description": "Number of 3-star reviews." }, "4": { "type": "integer", "description": "Number of 4-star reviews." }, "5": { "type": "integer", "description": "Number of 5-star reviews." } }, "description": "Counts of reviews per integer rating from 1 to 5." }, "emails_and_contacts": { "type": "object", "nullable": true, "properties": { "yelp": { "type": "string", "nullable": true, "description": "Yelp listing URL." }, "emails": { "type": "array", "items": { "type": "string" }, "description": "Email addresses found on the business website." }, "github": { "type": "string", "nullable": true, "description": "GitHub profile URL." }, "tiktok": { "type": "string", "nullable": true, "description": "TikTok profile URL." }, "twitter": { "type": "string", "nullable": true, "description": "Twitter/X profile URL." }, "youtube": { "type": "string", "nullable": true, "description": "YouTube channel URL." }, "facebook": { "type": "string", "nullable": true, "description": "Facebook profile URL." }, "linkedin": { "type": "string", "nullable": true, "description": "LinkedIn profile URL." }, "snapchat": { "type": "string", "nullable": true, "description": "Snapchat profile URL." }, "instagram": { "type": "string", "nullable": true, "description": "Instagram profile URL." }, "pinterest": { "type": "string", "nullable": true, "description": "Pinterest profile URL." }, "phone_numbers": { "type": "array", "items": { "type": "string" }, "description": "Phone numbers found on the business website." } }, "description": "Emails and social-network profiles extracted from the business website. Populated when extract_emails_and_contacts=true (the default for /business-details)." }, "hotel_review_summary": { "type": "object", "nullable": true, "description": "Hotel-only: AI-generated review summary. Present only for hotels.", "additionalProperties": true }, "hotel_booking_options": { "type": "array", "items": { "type": "object", "additionalProperties": true }, "nullable": true, "description": "Hotel-only: array of booking options (provider, price, link). Present only for hotels with live rates." }, "hotel_location_rating": { "type": "object", "nullable": true, "description": "Hotel-only: location rating breakdown when the business is a hotel.", "additionalProperties": true }, "hotel_price_for_dates": { "type": "string", "nullable": true, "description": "Hotel-only: nightly price string when Google has live rates." }, "requested_business_id": { "type": "string", "description": "The exact business_id from the request, echoed back. Useful when batching multiple IDs." }, "hotel_results_from_web": { "type": "array", "items": { "type": "object", "additionalProperties": true }, "nullable": true, "description": "Hotel-only: additional web-sourced results / reviews shown alongside the Google listing." }, "keywords_mentioned_in_reviews": { "type": "array", "items": { "type": "object", "required": [ "keyword", "review_count" ], "properties": { "keyword": { "type": "string", "description": "The keyword extracted from reviews." }, "review_count": { "type": "integer", "description": "Number of reviews mentioning this keyword." } } }, "nullable": true, "description": "Keywords most frequently mentioned in reviews, with counts. Returned by /business-details-plus only (AI-enriched, ?extended_details=true)." } } }, "description": "List of businesses returned." }, "status": { "type": "string", "description": "The status of the API response." }, "parameters": { "type": "object", "properties": { "region": { "type": "string", "description": "The region/country code used for the response." }, "language": { "type": "string", "description": "The language code used for the response." }, "business_id": { "type": "string", "description": "The business_id as received in the request." }, "coordinates": { "type": "string", "description": "Geographic bias coordinates used (lat,lng)." }, "extract_share_link": { "type": "boolean", "description": "Whether a Google Maps share link was extracted." }, "extract_emails_and_contacts": { "type": "boolean", "description": "Whether email/contact extraction was performed." } }, "description": "The parameters the API received and used for this request, echoed back." }, "request_id": { "type": "string", "description": "A unique ID to trace the API request." } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "business_id", "schema": { "type": "string", "example": "0x880fd393d427a591:0x8cba02d713a995ed" }, "example": "0x880fd393d427a591:0x8cba02d713a995ed", "required": true, "description": "Unique Business Id. Accepts `google_id` / `business_id` or `place_id`.\n\n **Examples:**\n `0x880fd393d427a591:0x8cba02d713a995ed`\n `ChIJkaUn1JPTD4gR7ZWpE9cCuow`\n\n In addition, batching of up to 20 Business Ids is supported in a single request using a comma separated list *(e.g. business_id=id1,id2)*." }, { "in": "query", "name": "extract_emails_and_contacts", "schema": { "type": "boolean", "default": true }, "description": "Whether to extract emails, contacts and social profiles for the business.\n In case true, businesses will be enriched with an emails_and_contacts field, potentially containing emails, phones, Facebook, LinkedIn, Instagram and other social profiles." }, { "in": "query", "name": "extract_share_link", "schema": { "type": "boolean", "default": false }, "description": "Whether to extract place's share link for the business.\n In case true, businesses will be enriched with a share_link field containing a shortened Google URL for sharing." }, { "in": "query", "name": "fields", "schema": { "type": "string" }, "description": "A comma separated list of business fields to include in the response (field projection).\n By default all fields are returned." }, { "in": "query", "name": "region", "schema": { "type": "string", "default": "us" }, "description": "Query Google Maps from a particular region or country.\n For a list of supported region/country codes see *https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes (Alpha-2 code)*." }, { "in": "query", "name": "language", "schema": { "type": "string", "default": "en" }, "description": "Set the language of the results.\n For a list of supported language codes see *https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes*." }, { "in": "query", "name": "coordinates", "schema": { "type": "string" }, "description": "Geographic coordinates of the location from which the query is applied - recommended to use so that results are biased towards this location.\n Defaults to some central location in the region (see the region parameter)." } ], "description": "Get full business details PLUS additional AI-powered enrichments — currently includes `keywords_mentioned_in_reviews`, an array of the keywords most frequently surfaced in the business' Google Maps reviews together with how many reviews mention each.\n\n All `/business-details` request parameters and response fields are supported.\n\n **Cost: 2 credits per business.**\n\n Supports batching of up to 20 Business Ids.", "operationId": "local_business_data__get__business_details_plus", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" } ], "x-zeroclick-services": [ "local-business-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "local-business-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "local-business-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/local-business-data/business-photos": { "get": { "summary": "Business Photos", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "request_id", "parameters", "data" ], "properties": { "data": { "type": "array", "items": { "type": "object", "required": [ "photo_id", "photo_url", "type" ], "properties": { "type": { "type": "string", "description": "Media type. Values: photo, video, street_view." }, "latitude": { "type": "number", "nullable": true, "description": "Latitude where the photo was taken (when known)." }, "photo_id": { "type": "string", "description": "Unique Google identifier of the photo." }, "longitude": { "type": "number", "nullable": true, "description": "Longitude where the photo was taken (when known)." }, "photo_url": { "type": "string", "description": "URL of the photo (default resolution)." }, "photo_timestamp": { "type": "integer", "nullable": true, "description": "Unix epoch seconds matching photo_datetime_utc." }, "photo_url_large": { "type": "string", "nullable": true, "description": "URL of the photo at a larger resolution." }, "photo_datetime_utc": { "type": "string", "nullable": true, "description": "Original publication datetime of the photo in ISO 8601 UTC." }, "video_thumbnail_url": { "type": "string", "nullable": true, "description": "Thumbnail URL when the media is a video; null for still photos." } } }, "description": "List of photos / videos returned." }, "cursor": { "type": "string", "nullable": true, "description": "Cursor to fetch the next page of photos. Null when no more pages." }, "status": { "type": "string", "description": "The status of the API response." }, "parameters": { "type": "object", "properties": { "limit": { "type": "integer", "description": "Maximum number of photos requested." }, "region": { "type": "string", "description": "Region code used for the request." }, "is_video": { "type": "boolean", "description": "Whether only videos are being returned." }, "language": { "type": "string", "description": "Language code used for the response." }, "business_id": { "type": "string", "description": "The business_id as received." } }, "description": "The parameters the API received and used for this request, echoed back." }, "request_id": { "type": "string", "description": "A unique ID to trace the API request." } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "business_id", "schema": { "type": "string", "example": "0x89c259b5a9bd152b:0x31453e62a3be9f76" }, "example": "0x89c259b5a9bd152b:0x31453e62a3be9f76", "required": true, "description": "Unique Business Id. Accepts `google_id` / `business_id` or `place_id`. \n\n **Examples:** \n `0x880fd393d427a591:0x8cba02d713a995ed` \n `ChIJkaUn1JPTD4gR7ZWpE9cCuow`" }, { "in": "query", "name": "limit", "schema": { "type": "string", "default": 20 }, "description": "Maximum number of business photos to return.\n \n **Allowed values:** `1-100`" }, { "in": "query", "name": "cursor", "schema": { "type": "string" }, "description": "Specify the cursor obtained from the previous request to get the next of result page (use for pagination)." }, { "in": "query", "name": "is_video", "schema": { "type": "boolean", "default": false }, "description": "Only return video type media (type=video) or not." }, { "in": "query", "name": "region", "schema": { "type": "string", "default": "us" }, "description": "Query Google Maps from a particular region or country. \n For a list of supported region/country codes see *https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes (Alpha-2 code)*." }, { "in": "query", "name": "fields", "schema": { "type": "string" }, "description": "A comma separated list of review fields to include in the response (field projection). \n By default all fields are returned." } ], "description": "Get business photos by Business Id.", "operationId": "local_business_data__get__business_photos", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" } ], "x-zeroclick-services": [ "local-business-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "local-business-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "local-business-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/local-business-data/business-posts": { "get": { "summary": "Business Posts", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "request_id", "parameters", "data" ], "properties": { "data": { "type": "object", "required": [ "posts" ], "properties": { "posts": { "type": "array", "items": { "type": "object", "required": [ "post_id" ], "properties": { "post_id": { "type": "string", "description": "Unique Google identifier of the owner post." }, "post_link": { "type": "string", "nullable": true, "description": "Direct URL to the post on Google." }, "post_text": { "type": "string", "nullable": true, "description": "Text content of the post." }, "post_links": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string", "description": "Target URL of the link." }, "caption": { "type": "string", "nullable": true, "description": "Caption of the link as shown on the post." } } }, "nullable": true, "description": "Outbound links attached to the post." }, "post_photos": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "URLs of photos attached to the post." }, "post_timestamp": { "type": "integer", "nullable": true, "description": "Unix epoch seconds matching post_datetime_utc." }, "post_datetime_utc": { "type": "string", "nullable": true, "description": "ISO 8601 UTC datetime when the post was published." } } }, "description": "Owner posts in chronological order." }, "cursor": { "type": "string", "nullable": true, "description": "Cursor to fetch the next page. Null when no more pages." } }, "description": "Business posts page." }, "status": { "type": "string", "description": "The status of the API response." }, "parameters": { "type": "object", "properties": { "cursor": { "type": "string", "nullable": true, "description": "Pagination cursor passed in (when continuing a previous request)." }, "region": { "type": "string", "description": "Region code used for the request." }, "language": { "type": "string", "description": "Language code used for the response." }, "business_id": { "type": "string", "description": "The business_id as received." } }, "description": "The parameters the API received and used for this request, echoed back." }, "request_id": { "type": "string", "description": "A unique ID to trace the API request." } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "business_id", "schema": { "type": "string", "example": "0x880fd393d427a591:0x8cba02d713a995ed" }, "example": "0x880fd393d427a591:0x8cba02d713a995ed", "required": true, "description": "Unique Business Id. Accepts `google_id` / `business_id` or `place_id`. \n\n **Examples:** \n `0x880fd393d427a591:0x8cba02d713a995ed` \n `ChIJkaUn1JPTD4gR7ZWpE9cCuow` " }, { "in": "query", "name": "cursor", "schema": { "type": "string" }, "description": "Specify the cursor obtained from the previous request to get the next of result page (use for pagination)." }, { "in": "query", "name": "region", "schema": { "type": "string", "default": "us" }, "description": "Query Google Maps from a particular region or country. \n For a list of supported region/country codes see *https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes (Alpha-2 code)*." }, { "in": "query", "name": "language", "schema": { "type": "string", "default": "en" }, "description": "Set the language of the results. For a list of supported language codes see *https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes*." } ], "description": "Get all / paginate Business Owner Posts (\"From the owner\" section on Google Maps) by Business Id, sorted chronologically.", "operationId": "local_business_data__get__business_posts", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" } ], "x-zeroclick-services": [ "local-business-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "local-business-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "local-business-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/local-business-data/business-reviews-v2": { "get": { "summary": "Business Reviews", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "request_id", "parameters", "data" ], "properties": { "data": { "type": "object", "required": [ "reviews" ], "properties": { "cursor": { "type": "string", "nullable": true, "description": "Pagination cursor for the next page of reviews. Pass it back as the `cursor` query parameter to fetch the next page. `null` when there are no more reviews." }, "reviews": { "type": "array", "items": { "type": "object", "required": [ "review_id", "rating" ], "properties": { "rating": { "type": "integer", "description": "Star rating given in the review (1-5)." }, "author_id": { "type": "string", "nullable": true, "description": "Google Maps contributor ID of the review author." }, "review_id": { "type": "string", "description": "Unique Google identifier of the review." }, "like_count": { "type": "integer", "nullable": true, "description": "Number of likes the review received." }, "author_link": { "type": "string", "nullable": true, "description": "URL to the author's Google Maps contributor profile." }, "author_name": { "type": "string", "nullable": true, "description": "Display name of the review author." }, "review_form": { "type": "object", "nullable": true, "description": "Free-form structured questions the author answered (e.g. 'What kind of trip was it?').", "additionalProperties": { "type": "string" } }, "review_link": { "type": "string", "nullable": true, "description": "Direct Google Maps URL to the review." }, "review_text": { "type": "string", "nullable": true, "description": "Full text content of the review." }, "review_time": { "type": "string", "nullable": true, "description": "Human-friendly relative time of the review (e.g. '4 months ago') as shown on Google Maps." }, "review_photos": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "URLs of photos attached to the review." }, "review_source": { "type": "string", "nullable": true, "description": "Platform from which the review originates (e.g. 'Google', 'Tripadvisor')." }, "review_language": { "type": "string", "nullable": true, "description": "ISO 639 language code of the review text." }, "service_quality": { "type": "string", "nullable": true, "description": "Optional service-quality tag the author selected when reviewing." }, "author_photo_url": { "type": "string", "nullable": true, "description": "URL of the author's profile photo." }, "review_timestamp": { "type": "integer", "nullable": true, "description": "Unix epoch seconds matching review_datetime_utc." }, "author_photo_count": { "type": "integer", "nullable": true, "description": "Number of photos this author has posted." }, "review_source_logo": { "type": "string", "nullable": true, "description": "URL of the source platform logo." }, "author_review_count": { "type": "integer", "nullable": true, "description": "Number of reviews this author has posted." }, "author_reviews_link": { "type": "string", "nullable": true, "description": "URL to all reviews by this author." }, "owner_response_text": { "type": "string", "nullable": true, "description": "Text of the business owner's response." }, "owner_response_time": { "type": "string", "nullable": true, "description": "Human-friendly relative time of the owner response." }, "review_datetime_utc": { "type": "string", "nullable": true, "description": "ISO 8601 UTC datetime when the review was posted." }, "author_is_local_guide": { "type": "boolean", "nullable": true, "description": "Whether the author is a Google Local Guide." }, "hotel_rating_breakdown": { "type": "object", "nullable": true, "description": "Hotel-only: per-aspect ratings (Rooms, Service, Location, etc.) selected by the author.", "additionalProperties": { "type": "integer" } }, "owner_response_language": { "type": "string", "nullable": true, "description": "ISO 639 language code of the owner response." }, "author_local_guide_level": { "type": "integer", "nullable": true, "description": "Google Local Guide level (1-10) of the author." }, "owner_response_timestamp": { "type": "integer", "nullable": true, "description": "Unix epoch seconds matching owner_response_datetime_utc." }, "owner_response_datetime_utc": { "type": "string", "nullable": true, "description": "ISO 8601 UTC datetime when the business owner responded to the review." }, "review_text_translated_language": { "type": "string", "nullable": true, "description": "ISO 639 language code the review was translated into (when translate_reviews=true)." } } }, "description": "List of reviews returned." } }, "description": "Reviews returned for the business, plus the pagination cursor." }, "status": { "type": "string", "description": "The status of the API response." }, "parameters": { "type": "object", "properties": { "limit": { "type": "integer", "description": "Maximum number of reviews requested." }, "cursor": { "type": "string", "nullable": true, "description": "Pagination cursor used for this request (null on the first page)." }, "region": { "type": "string", "description": "Region code used for the request." }, "sort_by": { "type": "string", "description": "Sort order applied. Values: most_relevant, newest, highest_ranking, lowest_ranking." }, "language": { "type": "string", "description": "Language code used for the reviews." }, "business_id": { "type": "string", "description": "The business_id as received." }, "translate_reviews": { "type": "boolean", "description": "Whether reviews were translated into the requested language." } }, "description": "The parameters the API received and used for this request, echoed back." }, "request_id": { "type": "string", "description": "A unique ID to trace the API request." } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "business_id", "schema": { "type": "string", "example": "0x89c259b5a9bd152b:0x31453e62a3be9f76" }, "example": "0x89c259b5a9bd152b:0x31453e62a3be9f76", "required": true, "description": "Unique Business Id. Accepts `google_id` / `business_id` or `place_id`. \n\n **Examples:** \n `0x880fd393d427a591:0x8cba02d713a995ed` \n `ChIJkaUn1JPTD4gR7ZWpE9cCuow`" }, { "in": "query", "name": "limit", "schema": { "type": "string", "default": 20 }, "description": "Maximum number of business reviews to return. \n\n **Allowed values:** `1-100`" }, { "in": "query", "name": "cursor", "schema": { "type": "string" }, "description": "Pagination cursor for fetching the next page of reviews. Pass the `cursor` value returned in the previous response's `data.cursor`. Omit on the first request to start from the most relevant reviews." }, { "in": "query", "name": "translate_reviews", "schema": { "type": "boolean" }, "description": "Whether to translate reviews to the language specified as the language parameter (defaults to false)." }, { "in": "query", "name": "query", "schema": { "type": "string" }, "description": "Return reviews matching a text query" }, { "in": "query", "name": "sort_by", "schema": { "enum": [ "most_relevant", "newest", "highest_ranking", "lowest_ranking" ], "type": "string", "default": "most_relevant" }, "description": "How to sort the reviews in the results." }, { "in": "query", "name": "fields", "schema": { "type": "string" }, "description": "A comma separated list of review fields to include in the response (field projection). \n By default all fields are returned." }, { "in": "query", "name": "region", "schema": { "type": "string", "default": "us" }, "description": "Query Google Maps from a particular region or country. \n For a list of supported region/country codes see *https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes (Alpha-2 code)*." }, { "in": "query", "name": "language", "schema": { "type": "string", "default": "en" }, "description": "Set the language of the results. For a list of supported language codes see *https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes*." } ], "description": "Get all / paginate business reviews by Business Id using a pagination cursor.", "operationId": "local_business_data__get__business_reviews_v2", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing explicit parameter definitions in documentation" ], "pages": [], "sourceId": "sds_BowKpX7oIEvSZAa5G-8Cj", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_AlkJCvRexbLp1t3wre1uD" }, { "gaps": [ "Missing detailed response schema" ], "pages": [ 1 ], "sourceId": "sds_y_pAgcC-xJrVMI2TjrXI0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_58jSAkKvEcC3bWRtd9F4t" } ], "x-zeroclick-services": [ "local-business-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "local-business-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "local-business-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/local-business-data/photo-details": { "get": { "summary": "Business Photo Details", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "request_id", "parameters", "data" ], "properties": { "data": { "type": "array", "items": { "type": "object", "required": [ "photo_id" ], "properties": { "width": { "type": "integer", "nullable": true, "description": "Original width of the photo in pixels." }, "height": { "type": "integer", "nullable": true, "description": "Original height of the photo in pixels." }, "caption": { "type": "string", "nullable": true, "description": "Caption for the photo (when published)." }, "owner_id": { "type": "string", "nullable": true, "description": "Google contributor ID of the photo's owner." }, "photo_id": { "type": "string", "description": "Unique Google identifier of the photo." }, "owner_name": { "type": "string", "nullable": true, "description": "Display name of the photo's owner." }, "owner_photo": { "type": "string", "nullable": true, "description": "URL of the owner's profile photo." }, "owner_profile_link": { "type": "string", "nullable": true, "description": "URL of the owner's Google Maps contributor profile." } } }, "description": "List of photo detail objects (one per requested photo_id)." }, "status": { "type": "string", "description": "The status of the API response." }, "parameters": { "type": "object", "properties": { "region": { "type": "string", "description": "Region code used for the request." }, "language": { "type": "string", "description": "Language code used for the response." }, "photo_id": { "type": "string", "description": "The photo_id as received." }, "business_id": { "type": "string", "description": "The business_id as received." }, "coordinates": { "type": "string", "description": "Geographic bias coordinates used (lat,lng)." } }, "description": "The parameters the API received and used for this request, echoed back." }, "request_id": { "type": "string", "description": "A unique ID to trace the API request." } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "business_id", "schema": { "type": "string", "example": "0x89c259b5a9bd152b:0x31453e62a3be9f76" }, "example": "0x89c259b5a9bd152b:0x31453e62a3be9f76", "required": true, "description": "The Business Id of the business for which the photo belongs. Accepts `google_id` / `business_id` or `place_id`. \n\n **Examples:** \n `0x880fd393d427a591:0x8cba02d713a995ed` \n `ChIJkaUn1JPTD4gR7ZWpE9cCuow`" }, { "in": "query", "name": "photo_id", "schema": { "type": "string", "example": "AF1QipMPYCqZ5Fe8a7Jc51KT9pWOS5c6tOKY_xvkCl23" }, "example": "AF1QipMPYCqZ5Fe8a7Jc51KT9pWOS5c6tOKY_xvkCl23", "required": true, "description": "Photo Id of the photo to fetch. \n In addition, batching of up to 20 Photo Ids is supported in a single request using a comma separated list *(e.g. photo_id=id1,id2)*." } ], "description": "Get extra details about a business photo - caption, owner name and avatar, and more information. \n Supports batching of up to 20 Photo Ids.", "operationId": "local_business_data__get__photo_details", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing detailed response schema" ], "pages": [ 1 ], "sourceId": "sds_y_pAgcC-xJrVMI2TjrXI0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_58jSAkKvEcC3bWRtd9F4t" } ], "x-zeroclick-services": [ "local-business-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "local-business-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "local-business-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/local-business-data/reverse-geocoding": { "get": { "summary": "Reverse Geocoding", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "request_id", "parameters", "data" ], "properties": { "data": { "type": "array", "items": { "type": "object", "required": [ "business_id", "google_id", "name", "business_status" ], "properties": { "cid": { "type": "string", "nullable": true, "description": "Google CID (Customer ID) of the business." }, "tld": { "type": "string", "nullable": true, "description": "Top-level domain of the business website." }, "city": { "type": "string", "nullable": true, "description": "City of the business location." }, "name": { "type": "string", "description": "Display name of the business." }, "type": { "type": "string", "nullable": true, "description": "Primary business category as labelled by Google Maps." }, "about": { "type": "object", "nullable": true, "properties": { "details": { "type": "object", "nullable": true, "description": "Map of attribute groups (e.g. Amenities, Crowd, Service options) to attribute name -> boolean.", "additionalProperties": { "type": "object", "additionalProperties": { "type": "boolean" } } }, "summary": { "type": "string", "nullable": true, "description": "Free-text description of the business." } }, "description": "Free-form summary and a structured details map of business attributes." }, "state": { "type": "string", "nullable": true, "description": "State / region of the business location." }, "rating": { "type": "number", "nullable": true, "description": "Average review rating (1-5) on Google Maps." }, "address": { "type": "string", "nullable": true, "description": "Street address line of the business." }, "country": { "type": "string", "nullable": true, "description": "ISO 3166-1 alpha-2 country code of the business location." }, "website": { "type": "string", "nullable": true, "description": "Business website URL." }, "zipcode": { "type": "string", "nullable": true, "description": "ZIP / postal code of the business location." }, "district": { "type": "string", "nullable": true, "description": "District or neighbourhood of the business location." }, "latitude": { "type": "number", "description": "Latitude of the business location." }, "owner_id": { "type": "string", "nullable": true, "description": "ID of the Google Maps contributor account that owns this listing." }, "place_id": { "type": "string", "description": "Google Maps Place ID." }, "subtypes": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "List of additional business categories." }, "timezone": { "type": "string", "nullable": true, "description": "IANA timezone of the business location." }, "verified": { "type": "boolean", "description": "Whether the business is verified by Google." }, "directory": { "type": "array", "items": { "type": "object", "additionalProperties": true }, "nullable": true, "description": "List of businesses located in the same building / directory (e.g. mall, plaza). Conditional." }, "google_id": { "type": "string", "description": "Google's internal hexadecimal ID of the business." }, "longitude": { "type": "number", "description": "Longitude of the business location." }, "menu_link": { "type": "string", "nullable": true, "description": "URL of the business menu (when published)." }, "google_mid": { "type": "string", "nullable": true, "description": "Google Knowledge Graph machine ID." }, "located_in": { "type": "object", "nullable": true, "properties": { "name": { "type": "string", "description": "Name of the parent place." }, "google_id": { "type": "string", "description": "Google ID of the parent place." } }, "description": "Parent place this business is located in (e.g. mall) when applicable." }, "order_link": { "type": "string", "nullable": true, "description": "URL to place an order (when published)." }, "owner_link": { "type": "string", "nullable": true, "description": "Link to the owner profile on Google Maps." }, "owner_name": { "type": "string", "nullable": true, "description": "Display name of the owner profile." }, "place_link": { "type": "string", "description": "Google Maps URL for the business." }, "posts_link": { "type": "string", "nullable": true, "description": "URL to the full list of owner posts on Google Maps." }, "share_link": { "type": "string", "nullable": true, "description": "Shortened Google Maps share URL for the business. Returned when extract_share_link=true." }, "business_id": { "type": "string", "description": "Unique Google identifier of the business. Same value as google_id." }, "hotel_stars": { "type": "integer", "nullable": true, "description": "Hotel-only: star rating (1-5). Present only for hotels." }, "photo_count": { "type": "integer", "nullable": true, "description": "Total number of photos available for the business." }, "price_level": { "type": "string", "nullable": true, "description": "Price level as shown on Google Maps (e.g. '$', '$$')." }, "booking_link": { "type": "string", "nullable": true, "description": "URL to book a service or appointment." }, "full_address": { "type": "string", "description": "Full formatted address including business name." }, "opening_date": { "type": "string", "nullable": true, "description": "Date the business opened (when published by Google)." }, "phone_number": { "type": "string", "nullable": true, "description": "Business phone number in E.164 format when available." }, "posts_sample": { "type": "array", "items": { "type": "object", "properties": { "post_id": { "type": "string", "description": "Unique Google identifier of the owner post." }, "post_link": { "type": "string", "nullable": true, "description": "Direct URL to the post on Google." }, "post_text": { "type": "string", "nullable": true, "description": "Text content of the post." }, "post_links": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string", "description": "Target URL of the link." }, "caption": { "type": "string", "nullable": true, "description": "Caption of the link as shown on the post." } } }, "nullable": true, "description": "Outbound links attached to the post." }, "post_photos": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "URLs of photos attached to the post." }, "post_timestamp": { "type": "integer", "nullable": true, "description": "Unix epoch seconds matching post_datetime_utc." }, "post_datetime_utc": { "type": "string", "nullable": true, "description": "ISO 8601 UTC datetime when the post was published." } } }, "nullable": true, "description": "Sample of the most recent owner posts. Present in /business-details and /business-details-plus." }, "review_count": { "type": "integer", "nullable": true, "description": "Total number of Google Maps reviews on the business." }, "reviews_link": { "type": "string", "nullable": true, "description": "URL to view reviews on Google Maps." }, "photos_sample": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "Media type. Values: photo, video, street_view." }, "latitude": { "type": "number", "nullable": true, "description": "Latitude where the photo was taken (when known)." }, "photo_id": { "type": "string", "description": "Google Maps photo ID." }, "longitude": { "type": "number", "nullable": true, "description": "Longitude where the photo was taken (when known)." }, "photo_url": { "type": "string", "description": "URL of the photo (lower-resolution)." }, "photo_timestamp": { "type": "integer", "nullable": true, "description": "Unix epoch seconds matching photo_datetime_utc." }, "photo_url_large": { "type": "string", "nullable": true, "description": "URL of the photo at a larger resolution." }, "photo_datetime_utc": { "type": "string", "nullable": true, "description": "Original publication datetime of the photo in ISO 8601 UTC." }, "video_thumbnail_url": { "type": "string", "nullable": true, "description": "Thumbnail URL when the media is a video; null for still photos." } } }, "nullable": true, "description": "Up to ~10 representative photos for the business." }, "subtype_gcids": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "Internal Google category IDs corresponding to the primary type and subtypes." }, "working_hours": { "type": "object", "nullable": true, "description": "Working hours map keyed by day of the week. Each value is an array of time-range strings; empty object when not published.", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "opening_status": { "type": "string", "nullable": true, "description": "Current opening status string as shown on Google Maps (e.g. 'Open', 'Closed', 'Open 24 hours')." }, "reviews_sample": { "type": "array", "items": { "type": "object", "properties": { "rating": { "type": "integer", "description": "Star rating given in the review (1-5)." }, "author_id": { "type": "string", "nullable": true, "description": "Google Maps contributor ID of the review author." }, "review_id": { "type": "string", "description": "Unique Google identifier of the review." }, "like_count": { "type": "integer", "nullable": true, "description": "Number of likes the review received." }, "author_link": { "type": "string", "nullable": true, "description": "URL to the author's Google Maps profile." }, "author_name": { "type": "string", "nullable": true, "description": "Display name of the review author." }, "review_form": { "type": "object", "nullable": true, "description": "Structured questions the author answered (e.g. 'What kind of trip was it?').", "additionalProperties": { "type": "string" } }, "review_link": { "type": "string", "nullable": true, "description": "Direct Google Maps URL to the review." }, "review_text": { "type": "string", "nullable": true, "description": "Full text content of the review." }, "review_photos": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "URLs of photos attached to the review." }, "review_source": { "type": "string", "nullable": true, "description": "Platform the review originates from (e.g. 'Google', 'Tripadvisor')." }, "review_language": { "type": "string", "nullable": true, "description": "ISO 639 language code of the review text." }, "service_quality": { "type": "string", "nullable": true, "description": "Optional service-quality tag the author selected." }, "author_photo_url": { "type": "string", "nullable": true, "description": "URL of the author's profile photo." }, "review_timestamp": { "type": "integer", "nullable": true, "description": "Unix epoch seconds matching review_datetime_utc." }, "author_review_count": { "type": "integer", "nullable": true, "description": "Number of reviews this author has posted." }, "author_reviews_link": { "type": "string", "nullable": true, "description": "URL to all reviews by this author." }, "owner_response_text": { "type": "string", "nullable": true, "description": "Text of the business owner's response." }, "review_datetime_utc": { "type": "string", "nullable": true, "description": "ISO 8601 UTC datetime when the review was posted." }, "hotel_rating_breakdown": { "type": "object", "nullable": true, "description": "Hotel-only: per-aspect ratings (Rooms, Service, Location, etc.).", "additionalProperties": { "type": "integer" } }, "owner_response_language": { "type": "string", "nullable": true, "description": "ISO 639 language code of the owner response." }, "author_local_guide_level": { "type": "integer", "nullable": true, "description": "Google Local Guide level (1-10) of the author." }, "owner_response_timestamp": { "type": "integer", "nullable": true, "description": "Unix epoch seconds matching owner_response_datetime_utc." }, "owner_response_datetime_utc": { "type": "string", "nullable": true, "description": "ISO 8601 UTC datetime when the business owner responded." } } }, "nullable": true, "description": "Sample of recent reviews. Present in /business-details and /business-details-plus." }, "street_address": { "type": "string", "nullable": true, "description": "Street name and number portion of the address." }, "business_status": { "type": "string", "description": "Operational status. Values: OPEN, CLOSED_TEMPORARILY, CLOSED_PERMANENTLY." }, "hotel_amenities": { "type": "object", "nullable": true, "description": "Hotel-only: map of amenity name to availability (true/false). Present only for hotels.", "additionalProperties": { "type": "boolean" } }, "global_plus_code": { "type": "string", "nullable": true, "description": "Global Open Location Code (Plus Code) for the business location." }, "business_services": { "type": "object", "nullable": true, "description": "Map of service category -> list of services offered (when published by the owner).", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "reservations_link": { "type": "string", "nullable": true, "description": "URL to make a reservation." }, "compound_plus_code": { "type": "string", "nullable": true, "description": "Compound (short) Plus Code with a nearby locality." }, "reviews_per_rating": { "type": "object", "nullable": true, "properties": { "1": { "type": "integer", "description": "Number of 1-star reviews." }, "2": { "type": "integer", "description": "Number of 2-star reviews." }, "3": { "type": "integer", "description": "Number of 3-star reviews." }, "4": { "type": "integer", "description": "Number of 4-star reviews." }, "5": { "type": "integer", "description": "Number of 5-star reviews." } }, "description": "Counts of reviews per integer rating from 1 to 5." }, "emails_and_contacts": { "type": "object", "nullable": true, "properties": { "yelp": { "type": "string", "nullable": true, "description": "Yelp listing URL." }, "emails": { "type": "array", "items": { "type": "string" }, "description": "Email addresses found on the business website." }, "github": { "type": "string", "nullable": true, "description": "GitHub profile URL." }, "tiktok": { "type": "string", "nullable": true, "description": "TikTok profile URL." }, "twitter": { "type": "string", "nullable": true, "description": "Twitter/X profile URL." }, "youtube": { "type": "string", "nullable": true, "description": "YouTube channel URL." }, "facebook": { "type": "string", "nullable": true, "description": "Facebook profile URL." }, "linkedin": { "type": "string", "nullable": true, "description": "LinkedIn profile URL." }, "snapchat": { "type": "string", "nullable": true, "description": "Snapchat profile URL." }, "instagram": { "type": "string", "nullable": true, "description": "Instagram profile URL." }, "pinterest": { "type": "string", "nullable": true, "description": "Pinterest profile URL." }, "phone_numbers": { "type": "array", "items": { "type": "string" }, "description": "Phone numbers found on the business website." } }, "description": "Emails and social-network profiles extracted from the business website. Populated when extract_emails_and_contacts=true (the default for /business-details)." }, "hotel_review_summary": { "type": "object", "nullable": true, "description": "Hotel-only: AI-generated review summary. Present only for hotels.", "additionalProperties": true }, "hotel_booking_options": { "type": "array", "items": { "type": "object", "additionalProperties": true }, "nullable": true, "description": "Hotel-only: array of booking options (provider, price, link). Present only for hotels with live rates." }, "hotel_location_rating": { "type": "object", "nullable": true, "description": "Hotel-only: location rating breakdown when the business is a hotel.", "additionalProperties": true }, "hotel_price_for_dates": { "type": "string", "nullable": true, "description": "Hotel-only: nightly price string when Google has live rates." }, "requested_business_id": { "type": "string", "description": "The exact business_id from the request, echoed back. Useful when batching multiple IDs." }, "hotel_results_from_web": { "type": "array", "items": { "type": "object", "additionalProperties": true }, "nullable": true, "description": "Hotel-only: additional web-sourced results / reviews shown alongside the Google listing." }, "keywords_mentioned_in_reviews": { "type": "array", "items": { "type": "object", "required": [ "keyword", "review_count" ], "properties": { "keyword": { "type": "string", "description": "The keyword extracted from reviews." }, "review_count": { "type": "integer", "description": "Number of reviews mentioning this keyword." } } }, "nullable": true, "description": "Keywords most frequently mentioned in reviews, with counts. Returned by /business-details-plus only (AI-enriched, ?extended_details=true)." } } }, "description": "List of businesses returned." }, "status": { "type": "string", "description": "The status of the API response." }, "parameters": { "type": "object", "properties": { "lat": { "type": "number", "description": "Latitude as received." }, "lng": { "type": "number", "description": "Longitude as received." }, "region": { "type": "string", "description": "Region code used for the request." }, "language": { "type": "string", "description": "Language code used for the response." } }, "description": "The parameters the API received and used for this request, echoed back." }, "request_id": { "type": "string", "description": "A unique ID to trace the API request." } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "lat", "schema": { "type": "string", "default": 40.6958453, "example": "40.6958453" }, "example": "40.6958453", "required": true, "description": "Latitude of the geographic coordinates to search near by." }, { "in": "query", "name": "lng", "schema": { "type": "string", "default": -73.9799119, "example": "-73.9799119" }, "example": "-73.9799119", "required": true, "description": "Longitude of the geographic coordinates to search near by." }, { "in": "query", "name": "region", "schema": { "type": "string", "default": "us" }, "description": "Query Google Maps from a particular region or country. \n For a list of supported region/country codes see *https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes (Alpha-2 code)*." }, { "in": "query", "name": "language", "schema": { "type": "string", "default": "en" }, "description": "Set the language of the results. For a list of supported language codes see *https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2*." }, { "in": "query", "name": "fields", "schema": { "type": "string" }, "description": "A comma separated list of business fields to include in the response (field projection). \n By default all fields are returned." } ], "description": "Get the details of a place or address in a specific geographic location by latitude and longitude (reverse geocoding). \n This endpoint implements the \"What's here?\" functionality available on Google Maps (right click on the map).", "operationId": "local_business_data__get__reverse_geocoding", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing detailed response schema" ], "pages": [ 1 ], "sourceId": "sds_y_pAgcC-xJrVMI2TjrXI0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/lat/schema/type", "/parameters/query/lng/schema/type", "/description", "/operationId" ], "revisionId": "sdrn_58jSAkKvEcC3bWRtd9F4t" } ], "x-zeroclick-services": [ "local-business-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "local-business-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "local-business-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/local-business-data/review-details": { "get": { "summary": "Business Review Details", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "request_id", "parameters", "data" ], "properties": { "data": { "type": "array", "items": { "type": "object", "required": [ "review_id", "rating" ], "properties": { "rating": { "type": "integer", "description": "Star rating given in the review (1-5)." }, "author_id": { "type": "string", "nullable": true, "description": "Google Maps contributor ID of the review author." }, "review_id": { "type": "string", "description": "Unique Google identifier of the review." }, "like_count": { "type": "integer", "nullable": true, "description": "Number of likes the review received." }, "author_link": { "type": "string", "nullable": true, "description": "URL to the author's Google Maps contributor profile." }, "author_name": { "type": "string", "nullable": true, "description": "Display name of the review author." }, "review_form": { "type": "object", "nullable": true, "description": "Free-form structured questions the author answered (e.g. 'What kind of trip was it?').", "additionalProperties": { "type": "string" } }, "review_link": { "type": "string", "nullable": true, "description": "Direct Google Maps URL to the review." }, "review_text": { "type": "string", "nullable": true, "description": "Full text content of the review." }, "review_time": { "type": "string", "nullable": true, "description": "Human-friendly relative time of the review (e.g. '4 months ago') as shown on Google Maps." }, "review_photos": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "URLs of photos attached to the review." }, "review_source": { "type": "string", "nullable": true, "description": "Platform from which the review originates (e.g. 'Google', 'Tripadvisor')." }, "review_language": { "type": "string", "nullable": true, "description": "ISO 639 language code of the review text." }, "service_quality": { "type": "string", "nullable": true, "description": "Optional service-quality tag the author selected when reviewing." }, "author_photo_url": { "type": "string", "nullable": true, "description": "URL of the author's profile photo." }, "review_timestamp": { "type": "integer", "nullable": true, "description": "Unix epoch seconds matching review_datetime_utc." }, "author_photo_count": { "type": "integer", "nullable": true, "description": "Number of photos this author has posted." }, "review_source_logo": { "type": "string", "nullable": true, "description": "URL of the source platform logo." }, "author_review_count": { "type": "integer", "nullable": true, "description": "Number of reviews this author has posted." }, "author_reviews_link": { "type": "string", "nullable": true, "description": "URL to all reviews by this author." }, "owner_response_text": { "type": "string", "nullable": true, "description": "Text of the business owner's response." }, "owner_response_time": { "type": "string", "nullable": true, "description": "Human-friendly relative time of the owner response." }, "review_datetime_utc": { "type": "string", "nullable": true, "description": "ISO 8601 UTC datetime when the review was posted." }, "author_is_local_guide": { "type": "boolean", "nullable": true, "description": "Whether the author is a Google Local Guide." }, "hotel_rating_breakdown": { "type": "object", "nullable": true, "description": "Hotel-only: per-aspect ratings (Rooms, Service, Location, etc.) selected by the author.", "additionalProperties": { "type": "integer" } }, "owner_response_language": { "type": "string", "nullable": true, "description": "ISO 639 language code of the owner response." }, "author_local_guide_level": { "type": "integer", "nullable": true, "description": "Google Local Guide level (1-10) of the author." }, "owner_response_timestamp": { "type": "integer", "nullable": true, "description": "Unix epoch seconds matching owner_response_datetime_utc." }, "owner_response_datetime_utc": { "type": "string", "nullable": true, "description": "ISO 8601 UTC datetime when the business owner responded to the review." }, "review_text_translated_language": { "type": "string", "nullable": true, "description": "ISO 639 language code the review was translated into (when translate_reviews=true)." } } }, "description": "List of reviews returned." }, "status": { "type": "string", "description": "The status of the API response." }, "parameters": { "type": "object", "properties": { "region": { "type": "string", "description": "Region code used for the request." }, "language": { "type": "string", "description": "Language code used for the response." }, "business_id": { "type": "string", "description": "The business_id as received." }, "coordinates": { "type": "string", "description": "Geographic bias coordinates used (lat,lng)." }, "review_author_id": { "type": "string", "description": "The review_author_id as received." } }, "description": "The parameters the API received and used for this request, echoed back." }, "request_id": { "type": "string", "description": "A unique ID to trace the API request." } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "business_id", "schema": { "type": "string", "example": "0x89c259b5a9bd152b:0x31453e62a3be9f76" }, "example": "0x89c259b5a9bd152b:0x31453e62a3be9f76", "required": true, "description": "The Business Id of the business for which the review belongs. Accepts `google_id` / `business_id` or `place_id`. \n\n **Examples:** \n `0x880fd393d427a591:0x8cba02d713a995ed` \n `ChIJkaUn1JPTD4gR7ZWpE9cCuow` " }, { "in": "query", "name": "review_author_id", "schema": { "type": "string", "example": "110228754725692228062" }, "example": "110228754725692228062", "required": true, "description": "Review author id (i.e review `author_id` field). \n In addition, batching of up to 20 Review Author Ids is supported in a single request using a comma separated list *(e.g.review_author_id=id1,id2)*." }, { "in": "query", "name": "region", "schema": { "type": "string", "default": "us" }, "description": "Query Google Maps from a particular region or country. \n For a list of supported region/country codes see *https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes (Alpha-2 code)*." }, { "in": "query", "name": "language", "schema": { "type": "string", "default": "en" }, "description": "Set the language of the results. \n For a list of supported language codes see *https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes*." } ], "description": "Get the details of a specific review by Google Id / Business Id or Google Place Id and Review Author Id.", "operationId": "local_business_data__get__review_details", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing detailed response schema" ], "pages": [ 1 ], "sourceId": "sds_y_pAgcC-xJrVMI2TjrXI0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/review_id", "/description", "/operationId" ], "revisionId": "sdrn_58jSAkKvEcC3bWRtd9F4t" } ], "x-zeroclick-services": [ "local-business-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "local-business-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "local-business-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/local-business-data/search": { "get": { "summary": "Search", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "request_id", "parameters", "data" ], "properties": { "data": { "type": "array", "items": { "type": "object", "required": [ "business_id", "google_id", "name", "business_status" ], "properties": { "cid": { "type": "string", "nullable": true, "description": "Google CID (Customer ID) of the business." }, "tld": { "type": "string", "nullable": true, "description": "Top-level domain of the business website." }, "city": { "type": "string", "nullable": true, "description": "City of the business location." }, "name": { "type": "string", "description": "Display name of the business." }, "type": { "type": "string", "nullable": true, "description": "Primary business category as labelled by Google Maps." }, "about": { "type": "object", "nullable": true, "properties": { "details": { "type": "object", "nullable": true, "description": "Map of attribute groups (e.g. Amenities, Crowd, Service options) to attribute name -> boolean.", "additionalProperties": { "type": "object", "additionalProperties": { "type": "boolean" } } }, "summary": { "type": "string", "nullable": true, "description": "Free-text description of the business." } }, "description": "Free-form summary and a structured details map of business attributes." }, "state": { "type": "string", "nullable": true, "description": "State / region of the business location." }, "rating": { "type": "number", "nullable": true, "description": "Average review rating (1-5) on Google Maps." }, "address": { "type": "string", "nullable": true, "description": "Street address line of the business." }, "country": { "type": "string", "nullable": true, "description": "ISO 3166-1 alpha-2 country code of the business location." }, "website": { "type": "string", "nullable": true, "description": "Business website URL." }, "zipcode": { "type": "string", "nullable": true, "description": "ZIP / postal code of the business location." }, "district": { "type": "string", "nullable": true, "description": "District or neighbourhood of the business location." }, "latitude": { "type": "number", "description": "Latitude of the business location." }, "owner_id": { "type": "string", "nullable": true, "description": "ID of the Google Maps contributor account that owns this listing." }, "place_id": { "type": "string", "description": "Google Maps Place ID." }, "subtypes": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "List of additional business categories." }, "timezone": { "type": "string", "nullable": true, "description": "IANA timezone of the business location." }, "verified": { "type": "boolean", "description": "Whether the business is verified by Google." }, "directory": { "type": "array", "items": { "type": "object", "additionalProperties": true }, "nullable": true, "description": "List of businesses located in the same building / directory (e.g. mall, plaza). Conditional." }, "google_id": { "type": "string", "description": "Google's internal hexadecimal ID of the business." }, "longitude": { "type": "number", "description": "Longitude of the business location." }, "menu_link": { "type": "string", "nullable": true, "description": "URL of the business menu (when published)." }, "google_mid": { "type": "string", "nullable": true, "description": "Google Knowledge Graph machine ID." }, "located_in": { "type": "object", "nullable": true, "properties": { "name": { "type": "string", "description": "Name of the parent place." }, "google_id": { "type": "string", "description": "Google ID of the parent place." } }, "description": "Parent place this business is located in (e.g. mall) when applicable." }, "order_link": { "type": "string", "nullable": true, "description": "URL to place an order (when published)." }, "owner_link": { "type": "string", "nullable": true, "description": "Link to the owner profile on Google Maps." }, "owner_name": { "type": "string", "nullable": true, "description": "Display name of the owner profile." }, "place_link": { "type": "string", "description": "Google Maps URL for the business." }, "posts_link": { "type": "string", "nullable": true, "description": "URL to the full list of owner posts on Google Maps." }, "share_link": { "type": "string", "nullable": true, "description": "Shortened Google Maps share URL for the business. Returned when extract_share_link=true." }, "business_id": { "type": "string", "description": "Unique Google identifier of the business. Same value as google_id." }, "hotel_stars": { "type": "integer", "nullable": true, "description": "Hotel-only: star rating (1-5). Present only for hotels." }, "photo_count": { "type": "integer", "nullable": true, "description": "Total number of photos available for the business." }, "price_level": { "type": "string", "nullable": true, "description": "Price level as shown on Google Maps (e.g. '$', '$$')." }, "booking_link": { "type": "string", "nullable": true, "description": "URL to book a service or appointment." }, "full_address": { "type": "string", "description": "Full formatted address including business name." }, "opening_date": { "type": "string", "nullable": true, "description": "Date the business opened (when published by Google)." }, "phone_number": { "type": "string", "nullable": true, "description": "Business phone number in E.164 format when available." }, "posts_sample": { "type": "array", "items": { "type": "object", "properties": { "post_id": { "type": "string", "description": "Unique Google identifier of the owner post." }, "post_link": { "type": "string", "nullable": true, "description": "Direct URL to the post on Google." }, "post_text": { "type": "string", "nullable": true, "description": "Text content of the post." }, "post_links": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string", "description": "Target URL of the link." }, "caption": { "type": "string", "nullable": true, "description": "Caption of the link as shown on the post." } } }, "nullable": true, "description": "Outbound links attached to the post." }, "post_photos": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "URLs of photos attached to the post." }, "post_timestamp": { "type": "integer", "nullable": true, "description": "Unix epoch seconds matching post_datetime_utc." }, "post_datetime_utc": { "type": "string", "nullable": true, "description": "ISO 8601 UTC datetime when the post was published." } } }, "nullable": true, "description": "Sample of the most recent owner posts. Present in /business-details and /business-details-plus." }, "review_count": { "type": "integer", "nullable": true, "description": "Total number of Google Maps reviews on the business." }, "reviews_link": { "type": "string", "nullable": true, "description": "URL to view reviews on Google Maps." }, "photos_sample": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "Media type. Values: photo, video, street_view." }, "latitude": { "type": "number", "nullable": true, "description": "Latitude where the photo was taken (when known)." }, "photo_id": { "type": "string", "description": "Google Maps photo ID." }, "longitude": { "type": "number", "nullable": true, "description": "Longitude where the photo was taken (when known)." }, "photo_url": { "type": "string", "description": "URL of the photo (lower-resolution)." }, "photo_timestamp": { "type": "integer", "nullable": true, "description": "Unix epoch seconds matching photo_datetime_utc." }, "photo_url_large": { "type": "string", "nullable": true, "description": "URL of the photo at a larger resolution." }, "photo_datetime_utc": { "type": "string", "nullable": true, "description": "Original publication datetime of the photo in ISO 8601 UTC." }, "video_thumbnail_url": { "type": "string", "nullable": true, "description": "Thumbnail URL when the media is a video; null for still photos." } } }, "nullable": true, "description": "Up to ~10 representative photos for the business." }, "subtype_gcids": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "Internal Google category IDs corresponding to the primary type and subtypes." }, "working_hours": { "type": "object", "nullable": true, "description": "Working hours map keyed by day of the week. Each value is an array of time-range strings; empty object when not published.", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "opening_status": { "type": "string", "nullable": true, "description": "Current opening status string as shown on Google Maps (e.g. 'Open', 'Closed', 'Open 24 hours')." }, "reviews_sample": { "type": "array", "items": { "type": "object", "properties": { "rating": { "type": "integer", "description": "Star rating given in the review (1-5)." }, "author_id": { "type": "string", "nullable": true, "description": "Google Maps contributor ID of the review author." }, "review_id": { "type": "string", "description": "Unique Google identifier of the review." }, "like_count": { "type": "integer", "nullable": true, "description": "Number of likes the review received." }, "author_link": { "type": "string", "nullable": true, "description": "URL to the author's Google Maps profile." }, "author_name": { "type": "string", "nullable": true, "description": "Display name of the review author." }, "review_form": { "type": "object", "nullable": true, "description": "Structured questions the author answered (e.g. 'What kind of trip was it?').", "additionalProperties": { "type": "string" } }, "review_link": { "type": "string", "nullable": true, "description": "Direct Google Maps URL to the review." }, "review_text": { "type": "string", "nullable": true, "description": "Full text content of the review." }, "review_photos": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "URLs of photos attached to the review." }, "review_source": { "type": "string", "nullable": true, "description": "Platform the review originates from (e.g. 'Google', 'Tripadvisor')." }, "review_language": { "type": "string", "nullable": true, "description": "ISO 639 language code of the review text." }, "service_quality": { "type": "string", "nullable": true, "description": "Optional service-quality tag the author selected." }, "author_photo_url": { "type": "string", "nullable": true, "description": "URL of the author's profile photo." }, "review_timestamp": { "type": "integer", "nullable": true, "description": "Unix epoch seconds matching review_datetime_utc." }, "author_review_count": { "type": "integer", "nullable": true, "description": "Number of reviews this author has posted." }, "author_reviews_link": { "type": "string", "nullable": true, "description": "URL to all reviews by this author." }, "owner_response_text": { "type": "string", "nullable": true, "description": "Text of the business owner's response." }, "review_datetime_utc": { "type": "string", "nullable": true, "description": "ISO 8601 UTC datetime when the review was posted." }, "hotel_rating_breakdown": { "type": "object", "nullable": true, "description": "Hotel-only: per-aspect ratings (Rooms, Service, Location, etc.).", "additionalProperties": { "type": "integer" } }, "owner_response_language": { "type": "string", "nullable": true, "description": "ISO 639 language code of the owner response." }, "author_local_guide_level": { "type": "integer", "nullable": true, "description": "Google Local Guide level (1-10) of the author." }, "owner_response_timestamp": { "type": "integer", "nullable": true, "description": "Unix epoch seconds matching owner_response_datetime_utc." }, "owner_response_datetime_utc": { "type": "string", "nullable": true, "description": "ISO 8601 UTC datetime when the business owner responded." } } }, "nullable": true, "description": "Sample of recent reviews. Present in /business-details and /business-details-plus." }, "street_address": { "type": "string", "nullable": true, "description": "Street name and number portion of the address." }, "business_status": { "type": "string", "description": "Operational status. Values: OPEN, CLOSED_TEMPORARILY, CLOSED_PERMANENTLY." }, "hotel_amenities": { "type": "object", "nullable": true, "description": "Hotel-only: map of amenity name to availability (true/false). Present only for hotels.", "additionalProperties": { "type": "boolean" } }, "global_plus_code": { "type": "string", "nullable": true, "description": "Global Open Location Code (Plus Code) for the business location." }, "business_services": { "type": "object", "nullable": true, "description": "Map of service category -> list of services offered (when published by the owner).", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "reservations_link": { "type": "string", "nullable": true, "description": "URL to make a reservation." }, "compound_plus_code": { "type": "string", "nullable": true, "description": "Compound (short) Plus Code with a nearby locality." }, "reviews_per_rating": { "type": "object", "nullable": true, "properties": { "1": { "type": "integer", "description": "Number of 1-star reviews." }, "2": { "type": "integer", "description": "Number of 2-star reviews." }, "3": { "type": "integer", "description": "Number of 3-star reviews." }, "4": { "type": "integer", "description": "Number of 4-star reviews." }, "5": { "type": "integer", "description": "Number of 5-star reviews." } }, "description": "Counts of reviews per integer rating from 1 to 5." }, "emails_and_contacts": { "type": "object", "nullable": true, "properties": { "yelp": { "type": "string", "nullable": true, "description": "Yelp listing URL." }, "emails": { "type": "array", "items": { "type": "string" }, "description": "Email addresses found on the business website." }, "github": { "type": "string", "nullable": true, "description": "GitHub profile URL." }, "tiktok": { "type": "string", "nullable": true, "description": "TikTok profile URL." }, "twitter": { "type": "string", "nullable": true, "description": "Twitter/X profile URL." }, "youtube": { "type": "string", "nullable": true, "description": "YouTube channel URL." }, "facebook": { "type": "string", "nullable": true, "description": "Facebook profile URL." }, "linkedin": { "type": "string", "nullable": true, "description": "LinkedIn profile URL." }, "snapchat": { "type": "string", "nullable": true, "description": "Snapchat profile URL." }, "instagram": { "type": "string", "nullable": true, "description": "Instagram profile URL." }, "pinterest": { "type": "string", "nullable": true, "description": "Pinterest profile URL." }, "phone_numbers": { "type": "array", "items": { "type": "string" }, "description": "Phone numbers found on the business website." } }, "description": "Emails and social-network profiles extracted from the business website. Populated when extract_emails_and_contacts=true (the default for /business-details)." }, "hotel_review_summary": { "type": "object", "nullable": true, "description": "Hotel-only: AI-generated review summary. Present only for hotels.", "additionalProperties": true }, "hotel_booking_options": { "type": "array", "items": { "type": "object", "additionalProperties": true }, "nullable": true, "description": "Hotel-only: array of booking options (provider, price, link). Present only for hotels with live rates." }, "hotel_location_rating": { "type": "object", "nullable": true, "description": "Hotel-only: location rating breakdown when the business is a hotel.", "additionalProperties": true }, "hotel_price_for_dates": { "type": "string", "nullable": true, "description": "Hotel-only: nightly price string when Google has live rates." }, "requested_business_id": { "type": "string", "description": "The exact business_id from the request, echoed back. Useful when batching multiple IDs." }, "hotel_results_from_web": { "type": "array", "items": { "type": "object", "additionalProperties": true }, "nullable": true, "description": "Hotel-only: additional web-sourced results / reviews shown alongside the Google listing." }, "keywords_mentioned_in_reviews": { "type": "array", "items": { "type": "object", "required": [ "keyword", "review_count" ], "properties": { "keyword": { "type": "string", "description": "The keyword extracted from reviews." }, "review_count": { "type": "integer", "description": "Number of reviews mentioning this keyword." } } }, "nullable": true, "description": "Keywords most frequently mentioned in reviews, with counts. Returned by /business-details-plus only (AI-enriched, ?extended_details=true)." } } }, "description": "List of businesses returned." }, "status": { "type": "string", "description": "The status of the API response." }, "parameters": { "type": "object", "properties": { "lat": { "type": "number", "description": "Latitude bias center used for the search." }, "lng": { "type": "number", "description": "Longitude bias center used for the search." }, "zoom": { "type": "integer", "description": "Map zoom level used for the search." }, "limit": { "type": "integer", "description": "Maximum number of results requested." }, "query": { "type": "string", "description": "The search query as received." }, "offset": { "type": "integer", "description": "Number of results skipped (for pagination)." }, "region": { "type": "string", "description": "The region/country code used for the search." }, "language": { "type": "string", "description": "The language code used for the search." }, "extract_emails_and_contacts": { "type": "boolean", "description": "Whether email/contact extraction was requested for each business." } }, "description": "The parameters the API received and used for this request, echoed back." }, "request_id": { "type": "string", "description": "A unique ID to trace the API request." } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "query", "schema": { "type": "string", "example": "Hotels in San Francisco, USA" }, "example": "Hotels in San Francisco, USA", "required": true, "description": "Search query / keyword \n\n **Examples:** \n `Plumbers near New-York, USA` \n `Bars in 94102, USA` " }, { "in": "query", "name": "limit", "schema": { "type": "integer", "default": 20 }, "description": "Maximum number of businesses to return. \n\n **Allowed values:** `1-500`" }, { "in": "query", "name": "lat", "schema": { "type": "string", "default": 37.359428 }, "description": "Latitude of the coordinates point from which the query is applied - recommended to use so that results are biased towards this location. \n Defaults to some central location in the region (see the region parameter)." }, { "in": "query", "name": "lng", "schema": { "type": "string", "default": -121.925337 }, "description": "Longitude of the coordinates point from which the query is applied - recommended to use so that results are biased towards this location. \n Defaults to some central location in the region (see the region parameter)." }, { "in": "query", "name": "zoom", "schema": { "type": "string", "default": 13 }, "description": "Zoom level on which to make the search (the viewport is determined by lat, lng and zoom)." }, { "in": "query", "name": "language", "schema": { "type": "string", "default": "en" }, "description": "Set the language of the results. For a list of supported language codes see *https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes*." }, { "in": "query", "name": "region", "schema": { "type": "string", "default": "us" }, "description": "Query Google Maps from a particular region or country. \n For a list of supported region/country codes see *https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes (Alpha-2 code)*." }, { "in": "query", "name": "subtypes", "schema": { "type": "string" }, "description": "Find businesses with specific subtypes, specified as a comma separated list of types (business categories). \n For the complete list of types, see *https://daltonluka.com/blog/google-my-business-categories*. \n \n **Examples:** \n `Plumber,Carpenter,Electrician` \n `Night club,Dance club,Bar,Pub`" }, { "in": "query", "name": "verified", "schema": { "type": "boolean" }, "description": "Only return verified businesses" }, { "in": "query", "name": "business_status", "schema": { "type": "string" }, "description": "Find businesses with specific status, specified as a comma separated list of the following values: \n `OPEN, CLOSED_TEMPORARILY, CLOSED` \n \n **Examples:** \n `OPEN` \n `CLOSED_TEMPORARILY,CLOSED`" }, { "in": "query", "name": "extract_emails_and_contacts", "schema": { "type": "boolean", "default": false }, "description": "Extract emails, contacts and social profiles for each business in the response. \n In case true, businesses will be enriched with a emails_and_contacts field with emails, phones, Facebook, LinkedIn, Instagram and other social profiles. \n \n **Note:** in case `true`, the endpoint will scrape emails and contacts from the business website (in case non-empty). \n For each such business, the API will charge an additional credit." }, { "in": "query", "name": "fields", "schema": { "type": "string" }, "description": "A comma separated list of business fields to include in the response (field projection). \n By default all fields are returned." } ], "description": "Search local businesses on Google Maps with an option to pull emails and social profile links from their website (see the `extract_emails_and_contacts` parameter below).", "operationId": "local_business_data__get__search", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing explicit parameter definitions in documentation" ], "pages": [], "sourceId": "sds_BowKpX7oIEvSZAa5G-8Cj", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_AlkJCvRexbLp1t3wre1uD" }, { "gaps": [ "Missing detailed response schema" ], "pages": [ 1 ], "sourceId": "sds_y_pAgcC-xJrVMI2TjrXI0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_58jSAkKvEcC3bWRtd9F4t" } ], "x-zeroclick-services": [ "local-business-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "local-business-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "local-business-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] }, "post": { "summary": "Bulk Search", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "request_id", "parameters", "data" ], "properties": { "data": { "type": "array", "items": { "type": "object", "required": [ "business_id", "google_id", "name", "business_status" ], "properties": { "cid": { "type": "string", "nullable": true, "description": "Google CID (Customer ID) of the business." }, "tld": { "type": "string", "nullable": true, "description": "Top-level domain of the business website." }, "city": { "type": "string", "nullable": true, "description": "City of the business location." }, "name": { "type": "string", "description": "Display name of the business." }, "type": { "type": "string", "nullable": true, "description": "Primary business category as labelled by Google Maps." }, "about": { "type": "object", "nullable": true, "properties": { "details": { "type": "object", "nullable": true, "description": "Map of attribute groups (e.g. Amenities, Crowd, Service options) to attribute name -> boolean.", "additionalProperties": { "type": "object", "additionalProperties": { "type": "boolean" } } }, "summary": { "type": "string", "nullable": true, "description": "Free-text description of the business." } }, "description": "Free-form summary and a structured details map of business attributes." }, "state": { "type": "string", "nullable": true, "description": "State / region of the business location." }, "rating": { "type": "number", "nullable": true, "description": "Average review rating (1-5) on Google Maps." }, "address": { "type": "string", "nullable": true, "description": "Street address line of the business." }, "country": { "type": "string", "nullable": true, "description": "ISO 3166-1 alpha-2 country code of the business location." }, "website": { "type": "string", "nullable": true, "description": "Business website URL." }, "zipcode": { "type": "string", "nullable": true, "description": "ZIP / postal code of the business location." }, "district": { "type": "string", "nullable": true, "description": "District or neighbourhood of the business location." }, "latitude": { "type": "number", "description": "Latitude of the business location." }, "owner_id": { "type": "string", "nullable": true, "description": "ID of the Google Maps contributor account that owns this listing." }, "place_id": { "type": "string", "description": "Google Maps Place ID." }, "subtypes": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "List of additional business categories." }, "timezone": { "type": "string", "nullable": true, "description": "IANA timezone of the business location." }, "verified": { "type": "boolean", "description": "Whether the business is verified by Google." }, "directory": { "type": "array", "items": { "type": "object", "additionalProperties": true }, "nullable": true, "description": "List of businesses located in the same building / directory (e.g. mall, plaza). Conditional." }, "google_id": { "type": "string", "description": "Google's internal hexadecimal ID of the business." }, "longitude": { "type": "number", "description": "Longitude of the business location." }, "menu_link": { "type": "string", "nullable": true, "description": "URL of the business menu (when published)." }, "google_mid": { "type": "string", "nullable": true, "description": "Google Knowledge Graph machine ID." }, "located_in": { "type": "object", "nullable": true, "properties": { "name": { "type": "string", "description": "Name of the parent place." }, "google_id": { "type": "string", "description": "Google ID of the parent place." } }, "description": "Parent place this business is located in (e.g. mall) when applicable." }, "order_link": { "type": "string", "nullable": true, "description": "URL to place an order (when published)." }, "owner_link": { "type": "string", "nullable": true, "description": "Link to the owner profile on Google Maps." }, "owner_name": { "type": "string", "nullable": true, "description": "Display name of the owner profile." }, "place_link": { "type": "string", "description": "Google Maps URL for the business." }, "posts_link": { "type": "string", "nullable": true, "description": "URL to the full list of owner posts on Google Maps." }, "share_link": { "type": "string", "nullable": true, "description": "Shortened Google Maps share URL for the business. Returned when extract_share_link=true." }, "business_id": { "type": "string", "description": "Unique Google identifier of the business. Same value as google_id." }, "hotel_stars": { "type": "integer", "nullable": true, "description": "Hotel-only: star rating (1-5). Present only for hotels." }, "photo_count": { "type": "integer", "nullable": true, "description": "Total number of photos available for the business." }, "price_level": { "type": "string", "nullable": true, "description": "Price level as shown on Google Maps (e.g. '$', '$$')." }, "booking_link": { "type": "string", "nullable": true, "description": "URL to book a service or appointment." }, "full_address": { "type": "string", "description": "Full formatted address including business name." }, "opening_date": { "type": "string", "nullable": true, "description": "Date the business opened (when published by Google)." }, "phone_number": { "type": "string", "nullable": true, "description": "Business phone number in E.164 format when available." }, "posts_sample": { "type": "array", "items": { "type": "object", "properties": { "post_id": { "type": "string", "description": "Unique Google identifier of the owner post." }, "post_link": { "type": "string", "nullable": true, "description": "Direct URL to the post on Google." }, "post_text": { "type": "string", "nullable": true, "description": "Text content of the post." }, "post_links": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string", "description": "Target URL of the link." }, "caption": { "type": "string", "nullable": true, "description": "Caption of the link as shown on the post." } } }, "nullable": true, "description": "Outbound links attached to the post." }, "post_photos": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "URLs of photos attached to the post." }, "post_timestamp": { "type": "integer", "nullable": true, "description": "Unix epoch seconds matching post_datetime_utc." }, "post_datetime_utc": { "type": "string", "nullable": true, "description": "ISO 8601 UTC datetime when the post was published." } } }, "nullable": true, "description": "Sample of the most recent owner posts. Present in /business-details and /business-details-plus." }, "review_count": { "type": "integer", "nullable": true, "description": "Total number of Google Maps reviews on the business." }, "reviews_link": { "type": "string", "nullable": true, "description": "URL to view reviews on Google Maps." }, "photos_sample": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "Media type. Values: photo, video, street_view." }, "latitude": { "type": "number", "nullable": true, "description": "Latitude where the photo was taken (when known)." }, "photo_id": { "type": "string", "description": "Google Maps photo ID." }, "longitude": { "type": "number", "nullable": true, "description": "Longitude where the photo was taken (when known)." }, "photo_url": { "type": "string", "description": "URL of the photo (lower-resolution)." }, "photo_timestamp": { "type": "integer", "nullable": true, "description": "Unix epoch seconds matching photo_datetime_utc." }, "photo_url_large": { "type": "string", "nullable": true, "description": "URL of the photo at a larger resolution." }, "photo_datetime_utc": { "type": "string", "nullable": true, "description": "Original publication datetime of the photo in ISO 8601 UTC." }, "video_thumbnail_url": { "type": "string", "nullable": true, "description": "Thumbnail URL when the media is a video; null for still photos." } } }, "nullable": true, "description": "Up to ~10 representative photos for the business." }, "subtype_gcids": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "Internal Google category IDs corresponding to the primary type and subtypes." }, "working_hours": { "type": "object", "nullable": true, "description": "Working hours map keyed by day of the week. Each value is an array of time-range strings; empty object when not published.", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "opening_status": { "type": "string", "nullable": true, "description": "Current opening status string as shown on Google Maps (e.g. 'Open', 'Closed', 'Open 24 hours')." }, "reviews_sample": { "type": "array", "items": { "type": "object", "properties": { "rating": { "type": "integer", "description": "Star rating given in the review (1-5)." }, "author_id": { "type": "string", "nullable": true, "description": "Google Maps contributor ID of the review author." }, "review_id": { "type": "string", "description": "Unique Google identifier of the review." }, "like_count": { "type": "integer", "nullable": true, "description": "Number of likes the review received." }, "author_link": { "type": "string", "nullable": true, "description": "URL to the author's Google Maps profile." }, "author_name": { "type": "string", "nullable": true, "description": "Display name of the review author." }, "review_form": { "type": "object", "nullable": true, "description": "Structured questions the author answered (e.g. 'What kind of trip was it?').", "additionalProperties": { "type": "string" } }, "review_link": { "type": "string", "nullable": true, "description": "Direct Google Maps URL to the review." }, "review_text": { "type": "string", "nullable": true, "description": "Full text content of the review." }, "review_photos": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "URLs of photos attached to the review." }, "review_source": { "type": "string", "nullable": true, "description": "Platform the review originates from (e.g. 'Google', 'Tripadvisor')." }, "review_language": { "type": "string", "nullable": true, "description": "ISO 639 language code of the review text." }, "service_quality": { "type": "string", "nullable": true, "description": "Optional service-quality tag the author selected." }, "author_photo_url": { "type": "string", "nullable": true, "description": "URL of the author's profile photo." }, "review_timestamp": { "type": "integer", "nullable": true, "description": "Unix epoch seconds matching review_datetime_utc." }, "author_review_count": { "type": "integer", "nullable": true, "description": "Number of reviews this author has posted." }, "author_reviews_link": { "type": "string", "nullable": true, "description": "URL to all reviews by this author." }, "owner_response_text": { "type": "string", "nullable": true, "description": "Text of the business owner's response." }, "review_datetime_utc": { "type": "string", "nullable": true, "description": "ISO 8601 UTC datetime when the review was posted." }, "hotel_rating_breakdown": { "type": "object", "nullable": true, "description": "Hotel-only: per-aspect ratings (Rooms, Service, Location, etc.).", "additionalProperties": { "type": "integer" } }, "owner_response_language": { "type": "string", "nullable": true, "description": "ISO 639 language code of the owner response." }, "author_local_guide_level": { "type": "integer", "nullable": true, "description": "Google Local Guide level (1-10) of the author." }, "owner_response_timestamp": { "type": "integer", "nullable": true, "description": "Unix epoch seconds matching owner_response_datetime_utc." }, "owner_response_datetime_utc": { "type": "string", "nullable": true, "description": "ISO 8601 UTC datetime when the business owner responded." } } }, "nullable": true, "description": "Sample of recent reviews. Present in /business-details and /business-details-plus." }, "street_address": { "type": "string", "nullable": true, "description": "Street name and number portion of the address." }, "business_status": { "type": "string", "description": "Operational status. Values: OPEN, CLOSED_TEMPORARILY, CLOSED_PERMANENTLY." }, "hotel_amenities": { "type": "object", "nullable": true, "description": "Hotel-only: map of amenity name to availability (true/false). Present only for hotels.", "additionalProperties": { "type": "boolean" } }, "global_plus_code": { "type": "string", "nullable": true, "description": "Global Open Location Code (Plus Code) for the business location." }, "business_services": { "type": "object", "nullable": true, "description": "Map of service category -> list of services offered (when published by the owner).", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "reservations_link": { "type": "string", "nullable": true, "description": "URL to make a reservation." }, "compound_plus_code": { "type": "string", "nullable": true, "description": "Compound (short) Plus Code with a nearby locality." }, "reviews_per_rating": { "type": "object", "nullable": true, "properties": { "1": { "type": "integer", "description": "Number of 1-star reviews." }, "2": { "type": "integer", "description": "Number of 2-star reviews." }, "3": { "type": "integer", "description": "Number of 3-star reviews." }, "4": { "type": "integer", "description": "Number of 4-star reviews." }, "5": { "type": "integer", "description": "Number of 5-star reviews." } }, "description": "Counts of reviews per integer rating from 1 to 5." }, "emails_and_contacts": { "type": "object", "nullable": true, "properties": { "yelp": { "type": "string", "nullable": true, "description": "Yelp listing URL." }, "emails": { "type": "array", "items": { "type": "string" }, "description": "Email addresses found on the business website." }, "github": { "type": "string", "nullable": true, "description": "GitHub profile URL." }, "tiktok": { "type": "string", "nullable": true, "description": "TikTok profile URL." }, "twitter": { "type": "string", "nullable": true, "description": "Twitter/X profile URL." }, "youtube": { "type": "string", "nullable": true, "description": "YouTube channel URL." }, "facebook": { "type": "string", "nullable": true, "description": "Facebook profile URL." }, "linkedin": { "type": "string", "nullable": true, "description": "LinkedIn profile URL." }, "snapchat": { "type": "string", "nullable": true, "description": "Snapchat profile URL." }, "instagram": { "type": "string", "nullable": true, "description": "Instagram profile URL." }, "pinterest": { "type": "string", "nullable": true, "description": "Pinterest profile URL." }, "phone_numbers": { "type": "array", "items": { "type": "string" }, "description": "Phone numbers found on the business website." } }, "description": "Emails and social-network profiles extracted from the business website. Populated when extract_emails_and_contacts=true (the default for /business-details)." }, "hotel_review_summary": { "type": "object", "nullable": true, "description": "Hotel-only: AI-generated review summary. Present only for hotels.", "additionalProperties": true }, "hotel_booking_options": { "type": "array", "items": { "type": "object", "additionalProperties": true }, "nullable": true, "description": "Hotel-only: array of booking options (provider, price, link). Present only for hotels with live rates." }, "hotel_location_rating": { "type": "object", "nullable": true, "description": "Hotel-only: location rating breakdown when the business is a hotel.", "additionalProperties": true }, "hotel_price_for_dates": { "type": "string", "nullable": true, "description": "Hotel-only: nightly price string when Google has live rates." }, "requested_business_id": { "type": "string", "description": "The exact business_id from the request, echoed back. Useful when batching multiple IDs." }, "hotel_results_from_web": { "type": "array", "items": { "type": "object", "additionalProperties": true }, "nullable": true, "description": "Hotel-only: additional web-sourced results / reviews shown alongside the Google listing." }, "keywords_mentioned_in_reviews": { "type": "array", "items": { "type": "object", "required": [ "keyword", "review_count" ], "properties": { "keyword": { "type": "string", "description": "The keyword extracted from reviews." }, "review_count": { "type": "integer", "description": "Number of reviews mentioning this keyword." } } }, "nullable": true, "description": "Keywords most frequently mentioned in reviews, with counts. Returned by /business-details-plus only (AI-enriched, ?extended_details=true)." } } }, "description": "List of businesses returned." }, "status": { "type": "string", "description": "The status of the API response." }, "parameters": { "type": "object", "properties": { "lat": { "type": "number", "description": "Latitude bias center used for the search." }, "lng": { "type": "number", "description": "Longitude bias center used for the search." }, "zoom": { "type": "integer", "description": "Map zoom level used for the search." }, "limit": { "type": "integer", "description": "Maximum number of results requested." }, "query": { "type": "string", "description": "The search query as received." }, "offset": { "type": "integer", "description": "Number of results skipped (for pagination)." }, "region": { "type": "string", "description": "The region/country code used for the search." }, "language": { "type": "string", "description": "The language code used for the search." }, "extract_emails_and_contacts": { "type": "boolean", "description": "Whether email/contact extraction was requested for each business." } }, "description": "The parameters the API received and used for this request, echoed back." }, "request_id": { "type": "string", "description": "A unique ID to trace the API request." } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "description": "Search multiple queries in a single request (up to 20 queries). Returns a flat, normalized list of businesses aggregated across all queries.", "operationId": "local_business_data__post__search", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "queries" ], "properties": { "zoom": { "type": "integer", "default": 13, "example": 13, "description": "Map zoom level used for each query (higher = tighter area). Allowed values: 0-22." }, "dedup": { "type": "boolean", "default": true, "example": true, "description": "If true, deduplicate overlapping businesses across queries." }, "limit": { "type": "integer", "default": 20, "example": 5, "description": "Maximum number of businesses to return per query. Allowed values: 1-500." }, "query": { "type": "string" }, "offset": { "type": "integer", "default": 0, "example": 0, "description": "Number of businesses to skip per query, for pagination. Allowed values: 0-500." }, "region": { "type": "string", "default": "us", "example": "us", "description": "Query Google Maps from a particular region / country (ISO 3166-1 alpha-2 code)." }, "queries": { "type": "array", "items": { "type": "string" }, "example": [ "plumber in texas", "coffee shop in san francisco", "hotels in new york" ], "maxItems": 20, "minItems": 1, "description": "List of search queries to run in a single request (each treated like a normal Search query). Up to 20 queries per request." }, "language": { "type": "string", "default": "en", "example": "en", "description": "Set the language of the results (ISO 639-1 code)." }, "location": { "type": "string" }, "coordinates": { "type": "string", "example": "40.685219,-74.081180", "description": "Bias the search toward a specific location, as a \"lat,lng\" string." } } }, "example": { "zoom": 13, "dedup": true, "limit": 5, "offset": 0, "region": "us", "queries": [ "plumber in texas", "coffee shop in san francisco", "hotels in new york" ], "language": "en", "coordinates": "40.685219,-74.081180" } } }, "required": true }, "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing request body schema details" ], "pages": [ 1 ], "sourceId": "sds_0prF_Y5BkmqQXtEQyheXN", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/required" ], "revisionId": "sdrn_Z5rvTt1qYfVU6DSLLxPnI" }, { "gaps": [ "Missing request body details" ], "pages": [ 1 ], "sourceId": "sds_1IfgtOxqP1q4cHvJ7VyPY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/required" ], "revisionId": "sdrn_mb4oPKVX4C1sgk5EHzdxz" }, { "gaps": [ "Missing request body schema details." ], "pages": [], "sourceId": "sds_2Dc9eyhO3NLPUm0GEbTiV", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/required" ], "revisionId": "sdrn_Z1eLurdzog7OgIWS9gcdZ" }, { "gaps": [ "Missing request body schema properties and response schema details." ], "pages": [], "sourceId": "sds_2EOeqrIsWKjYBjoNIGwV0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_ds2DI_Xad11MCFdnoGvH0" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_5hlhZJYspBPaHxKN7OhqJ", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/required" ], "revisionId": "sdrn_3lrPg3Nc0kbMzAAAdVFHe" }, { "gaps": [ "Missing parameter details for query" ], "pages": [ 1 ], "sourceId": "sds_AF8bRESy69frdnjtCAF2z", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/required" ], "revisionId": "sdrn_nUAt1Ad8MTY5qaVlNUqO9" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_BowKpX7oIEvSZAa5G-8Cj", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description" ], "revisionId": "sdrn_AlkJCvRexbLp1t3wre1uD" }, { "gaps": [ "Missing request body schema and response schema" ], "pages": [ 1 ], "sourceId": "sds_bygUmn2K86zcEr8uYnytH", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_lRwIurwEjFC6EgANnKCbC" }, { "gaps": [ "Missing request parameters schema details" ], "pages": [ 1 ], "sourceId": "sds_FK2maa1cDe4qcElj5U3zU", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/required" ], "revisionId": "sdrn_gZ-rMsS0AnYbgxe2iW2Nm" }, { "gaps": [ "Missing request body schema and response schema" ], "pages": [ 1 ], "sourceId": "sds_fZv-ITvZDV87-KqyW2hgn", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_aohUeFTorAhUkoXJ0nrWa" }, { "gaps": [ "Missing request body schema and response schema" ], "pages": [ 1 ], "sourceId": "sds_jRl0O0t2JNWjX4MjQ_kC5", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/required" ], "revisionId": "sdrn_0KHmU6zKJBn3JfGQhhbYP" }, { "gaps": [ "Missing request body schema and response schema" ], "pages": [ 1 ], "sourceId": "sds_MAxJPNBPJFwSKQLj1M1dr", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/required" ], "revisionId": "sdrn_QFW9HQumx231aOJCusPx0" }, { "gaps": [ "Missing full request body schema" ], "pages": [ 1 ], "sourceId": "sds_QIFfeTcLDOFoTiC9diV0b", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/required" ], "revisionId": "sdrn_1pOKvi_ZPvz0xrF_bUbDr" }, { "gaps": [ "Missing response schema details" ], "pages": [ 1 ], "sourceId": "sds_soxpzUWt2CLoTKLGBZfNb", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/required" ], "revisionId": "sdrn_3H-1br_3SJ3ASZfGOL5Yr" }, { "gaps": [ "Missing parameters, request body schema details, and response schema details." ], "pages": [], "sourceId": "sds_SWPCFBdhQTXC3OrJ98RML", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/required" ], "revisionId": "sdrn_bk6BUY0JsF4ImDRAT3nR8" }, { "gaps": [ "Missing schema details" ], "pages": [ 1 ], "sourceId": "sds_t1I2lol_F5DgGpe13n3Xt", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/required" ], "revisionId": "sdrn_OBuPoRSMenxSJ1CM3zwbN" }, { "gaps": [ "Missing schema definition for response body" ], "pages": [ 1 ], "sourceId": "sds_vaNNaw5q29aKLh-qRSfR0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/required" ], "revisionId": "sdrn_SrJ_OL_N_pZ70W8niC6g0" }, { "gaps": [ "Missing request body schema" ], "pages": [], "sourceId": "sds_vdxxiVsx4OKV5vH7hrhwb", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_46RDkwnCaOF5IxAFfXTW0" }, { "gaps": [ "Missing request body schema" ], "pages": [ 1 ], "sourceId": "sds_ZS-xdAQ0s8auc1LcI7Ooo", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_7knEBvR-UUuEvVL1C_QLq" } ], "x-zeroclick-services": [ "local-business-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "local-business-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "local-business-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/local-business-data/search-in-area": { "get": { "summary": "Area Search (Zoom Level)", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "request_id", "parameters", "data" ], "properties": { "data": { "type": "array", "items": { "type": "object", "required": [ "business_id", "google_id", "name", "business_status" ], "properties": { "cid": { "type": "string", "nullable": true, "description": "Google CID (Customer ID) of the business." }, "tld": { "type": "string", "nullable": true, "description": "Top-level domain of the business website." }, "city": { "type": "string", "nullable": true, "description": "City of the business location." }, "name": { "type": "string", "description": "Display name of the business." }, "type": { "type": "string", "nullable": true, "description": "Primary business category as labelled by Google Maps." }, "about": { "type": "object", "nullable": true, "properties": { "details": { "type": "object", "nullable": true, "description": "Map of attribute groups (e.g. Amenities, Crowd, Service options) to attribute name -> boolean.", "additionalProperties": { "type": "object", "additionalProperties": { "type": "boolean" } } }, "summary": { "type": "string", "nullable": true, "description": "Free-text description of the business." } }, "description": "Free-form summary and a structured details map of business attributes." }, "state": { "type": "string", "nullable": true, "description": "State / region of the business location." }, "rating": { "type": "number", "nullable": true, "description": "Average review rating (1-5) on Google Maps." }, "address": { "type": "string", "nullable": true, "description": "Street address line of the business." }, "country": { "type": "string", "nullable": true, "description": "ISO 3166-1 alpha-2 country code of the business location." }, "website": { "type": "string", "nullable": true, "description": "Business website URL." }, "zipcode": { "type": "string", "nullable": true, "description": "ZIP / postal code of the business location." }, "district": { "type": "string", "nullable": true, "description": "District or neighbourhood of the business location." }, "latitude": { "type": "number", "description": "Latitude of the business location." }, "owner_id": { "type": "string", "nullable": true, "description": "ID of the Google Maps contributor account that owns this listing." }, "place_id": { "type": "string", "description": "Google Maps Place ID." }, "subtypes": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "List of additional business categories." }, "timezone": { "type": "string", "nullable": true, "description": "IANA timezone of the business location." }, "verified": { "type": "boolean", "description": "Whether the business is verified by Google." }, "directory": { "type": "array", "items": { "type": "object", "additionalProperties": true }, "nullable": true, "description": "List of businesses located in the same building / directory (e.g. mall, plaza). Conditional." }, "google_id": { "type": "string", "description": "Google's internal hexadecimal ID of the business." }, "longitude": { "type": "number", "description": "Longitude of the business location." }, "menu_link": { "type": "string", "nullable": true, "description": "URL of the business menu (when published)." }, "google_mid": { "type": "string", "nullable": true, "description": "Google Knowledge Graph machine ID." }, "located_in": { "type": "object", "nullable": true, "properties": { "name": { "type": "string", "description": "Name of the parent place." }, "google_id": { "type": "string", "description": "Google ID of the parent place." } }, "description": "Parent place this business is located in (e.g. mall) when applicable." }, "order_link": { "type": "string", "nullable": true, "description": "URL to place an order (when published)." }, "owner_link": { "type": "string", "nullable": true, "description": "Link to the owner profile on Google Maps." }, "owner_name": { "type": "string", "nullable": true, "description": "Display name of the owner profile." }, "place_link": { "type": "string", "description": "Google Maps URL for the business." }, "posts_link": { "type": "string", "nullable": true, "description": "URL to the full list of owner posts on Google Maps." }, "share_link": { "type": "string", "nullable": true, "description": "Shortened Google Maps share URL for the business. Returned when extract_share_link=true." }, "business_id": { "type": "string", "description": "Unique Google identifier of the business. Same value as google_id." }, "hotel_stars": { "type": "integer", "nullable": true, "description": "Hotel-only: star rating (1-5). Present only for hotels." }, "photo_count": { "type": "integer", "nullable": true, "description": "Total number of photos available for the business." }, "price_level": { "type": "string", "nullable": true, "description": "Price level as shown on Google Maps (e.g. '$', '$$')." }, "booking_link": { "type": "string", "nullable": true, "description": "URL to book a service or appointment." }, "full_address": { "type": "string", "description": "Full formatted address including business name." }, "opening_date": { "type": "string", "nullable": true, "description": "Date the business opened (when published by Google)." }, "phone_number": { "type": "string", "nullable": true, "description": "Business phone number in E.164 format when available." }, "posts_sample": { "type": "array", "items": { "type": "object", "properties": { "post_id": { "type": "string", "description": "Unique Google identifier of the owner post." }, "post_link": { "type": "string", "nullable": true, "description": "Direct URL to the post on Google." }, "post_text": { "type": "string", "nullable": true, "description": "Text content of the post." }, "post_links": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string", "description": "Target URL of the link." }, "caption": { "type": "string", "nullable": true, "description": "Caption of the link as shown on the post." } } }, "nullable": true, "description": "Outbound links attached to the post." }, "post_photos": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "URLs of photos attached to the post." }, "post_timestamp": { "type": "integer", "nullable": true, "description": "Unix epoch seconds matching post_datetime_utc." }, "post_datetime_utc": { "type": "string", "nullable": true, "description": "ISO 8601 UTC datetime when the post was published." } } }, "nullable": true, "description": "Sample of the most recent owner posts. Present in /business-details and /business-details-plus." }, "review_count": { "type": "integer", "nullable": true, "description": "Total number of Google Maps reviews on the business." }, "reviews_link": { "type": "string", "nullable": true, "description": "URL to view reviews on Google Maps." }, "photos_sample": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "Media type. Values: photo, video, street_view." }, "latitude": { "type": "number", "nullable": true, "description": "Latitude where the photo was taken (when known)." }, "photo_id": { "type": "string", "description": "Google Maps photo ID." }, "longitude": { "type": "number", "nullable": true, "description": "Longitude where the photo was taken (when known)." }, "photo_url": { "type": "string", "description": "URL of the photo (lower-resolution)." }, "photo_timestamp": { "type": "integer", "nullable": true, "description": "Unix epoch seconds matching photo_datetime_utc." }, "photo_url_large": { "type": "string", "nullable": true, "description": "URL of the photo at a larger resolution." }, "photo_datetime_utc": { "type": "string", "nullable": true, "description": "Original publication datetime of the photo in ISO 8601 UTC." }, "video_thumbnail_url": { "type": "string", "nullable": true, "description": "Thumbnail URL when the media is a video; null for still photos." } } }, "nullable": true, "description": "Up to ~10 representative photos for the business." }, "subtype_gcids": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "Internal Google category IDs corresponding to the primary type and subtypes." }, "working_hours": { "type": "object", "nullable": true, "description": "Working hours map keyed by day of the week. Each value is an array of time-range strings; empty object when not published.", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "opening_status": { "type": "string", "nullable": true, "description": "Current opening status string as shown on Google Maps (e.g. 'Open', 'Closed', 'Open 24 hours')." }, "reviews_sample": { "type": "array", "items": { "type": "object", "properties": { "rating": { "type": "integer", "description": "Star rating given in the review (1-5)." }, "author_id": { "type": "string", "nullable": true, "description": "Google Maps contributor ID of the review author." }, "review_id": { "type": "string", "description": "Unique Google identifier of the review." }, "like_count": { "type": "integer", "nullable": true, "description": "Number of likes the review received." }, "author_link": { "type": "string", "nullable": true, "description": "URL to the author's Google Maps profile." }, "author_name": { "type": "string", "nullable": true, "description": "Display name of the review author." }, "review_form": { "type": "object", "nullable": true, "description": "Structured questions the author answered (e.g. 'What kind of trip was it?').", "additionalProperties": { "type": "string" } }, "review_link": { "type": "string", "nullable": true, "description": "Direct Google Maps URL to the review." }, "review_text": { "type": "string", "nullable": true, "description": "Full text content of the review." }, "review_photos": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "URLs of photos attached to the review." }, "review_source": { "type": "string", "nullable": true, "description": "Platform the review originates from (e.g. 'Google', 'Tripadvisor')." }, "review_language": { "type": "string", "nullable": true, "description": "ISO 639 language code of the review text." }, "service_quality": { "type": "string", "nullable": true, "description": "Optional service-quality tag the author selected." }, "author_photo_url": { "type": "string", "nullable": true, "description": "URL of the author's profile photo." }, "review_timestamp": { "type": "integer", "nullable": true, "description": "Unix epoch seconds matching review_datetime_utc." }, "author_review_count": { "type": "integer", "nullable": true, "description": "Number of reviews this author has posted." }, "author_reviews_link": { "type": "string", "nullable": true, "description": "URL to all reviews by this author." }, "owner_response_text": { "type": "string", "nullable": true, "description": "Text of the business owner's response." }, "review_datetime_utc": { "type": "string", "nullable": true, "description": "ISO 8601 UTC datetime when the review was posted." }, "hotel_rating_breakdown": { "type": "object", "nullable": true, "description": "Hotel-only: per-aspect ratings (Rooms, Service, Location, etc.).", "additionalProperties": { "type": "integer" } }, "owner_response_language": { "type": "string", "nullable": true, "description": "ISO 639 language code of the owner response." }, "author_local_guide_level": { "type": "integer", "nullable": true, "description": "Google Local Guide level (1-10) of the author." }, "owner_response_timestamp": { "type": "integer", "nullable": true, "description": "Unix epoch seconds matching owner_response_datetime_utc." }, "owner_response_datetime_utc": { "type": "string", "nullable": true, "description": "ISO 8601 UTC datetime when the business owner responded." } } }, "nullable": true, "description": "Sample of recent reviews. Present in /business-details and /business-details-plus." }, "street_address": { "type": "string", "nullable": true, "description": "Street name and number portion of the address." }, "business_status": { "type": "string", "description": "Operational status. Values: OPEN, CLOSED_TEMPORARILY, CLOSED_PERMANENTLY." }, "hotel_amenities": { "type": "object", "nullable": true, "description": "Hotel-only: map of amenity name to availability (true/false). Present only for hotels.", "additionalProperties": { "type": "boolean" } }, "global_plus_code": { "type": "string", "nullable": true, "description": "Global Open Location Code (Plus Code) for the business location." }, "business_services": { "type": "object", "nullable": true, "description": "Map of service category -> list of services offered (when published by the owner).", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "reservations_link": { "type": "string", "nullable": true, "description": "URL to make a reservation." }, "compound_plus_code": { "type": "string", "nullable": true, "description": "Compound (short) Plus Code with a nearby locality." }, "reviews_per_rating": { "type": "object", "nullable": true, "properties": { "1": { "type": "integer", "description": "Number of 1-star reviews." }, "2": { "type": "integer", "description": "Number of 2-star reviews." }, "3": { "type": "integer", "description": "Number of 3-star reviews." }, "4": { "type": "integer", "description": "Number of 4-star reviews." }, "5": { "type": "integer", "description": "Number of 5-star reviews." } }, "description": "Counts of reviews per integer rating from 1 to 5." }, "emails_and_contacts": { "type": "object", "nullable": true, "properties": { "yelp": { "type": "string", "nullable": true, "description": "Yelp listing URL." }, "emails": { "type": "array", "items": { "type": "string" }, "description": "Email addresses found on the business website." }, "github": { "type": "string", "nullable": true, "description": "GitHub profile URL." }, "tiktok": { "type": "string", "nullable": true, "description": "TikTok profile URL." }, "twitter": { "type": "string", "nullable": true, "description": "Twitter/X profile URL." }, "youtube": { "type": "string", "nullable": true, "description": "YouTube channel URL." }, "facebook": { "type": "string", "nullable": true, "description": "Facebook profile URL." }, "linkedin": { "type": "string", "nullable": true, "description": "LinkedIn profile URL." }, "snapchat": { "type": "string", "nullable": true, "description": "Snapchat profile URL." }, "instagram": { "type": "string", "nullable": true, "description": "Instagram profile URL." }, "pinterest": { "type": "string", "nullable": true, "description": "Pinterest profile URL." }, "phone_numbers": { "type": "array", "items": { "type": "string" }, "description": "Phone numbers found on the business website." } }, "description": "Emails and social-network profiles extracted from the business website. Populated when extract_emails_and_contacts=true (the default for /business-details)." }, "hotel_review_summary": { "type": "object", "nullable": true, "description": "Hotel-only: AI-generated review summary. Present only for hotels.", "additionalProperties": true }, "hotel_booking_options": { "type": "array", "items": { "type": "object", "additionalProperties": true }, "nullable": true, "description": "Hotel-only: array of booking options (provider, price, link). Present only for hotels with live rates." }, "hotel_location_rating": { "type": "object", "nullable": true, "description": "Hotel-only: location rating breakdown when the business is a hotel.", "additionalProperties": true }, "hotel_price_for_dates": { "type": "string", "nullable": true, "description": "Hotel-only: nightly price string when Google has live rates." }, "requested_business_id": { "type": "string", "description": "The exact business_id from the request, echoed back. Useful when batching multiple IDs." }, "hotel_results_from_web": { "type": "array", "items": { "type": "object", "additionalProperties": true }, "nullable": true, "description": "Hotel-only: additional web-sourced results / reviews shown alongside the Google listing." }, "keywords_mentioned_in_reviews": { "type": "array", "items": { "type": "object", "required": [ "keyword", "review_count" ], "properties": { "keyword": { "type": "string", "description": "The keyword extracted from reviews." }, "review_count": { "type": "integer", "description": "Number of reviews mentioning this keyword." } } }, "nullable": true, "description": "Keywords most frequently mentioned in reviews, with counts. Returned by /business-details-plus only (AI-enriched, ?extended_details=true)." } } }, "description": "List of businesses returned." }, "status": { "type": "string", "description": "The status of the API response." }, "parameters": { "type": "object", "properties": { "lat": { "type": "number", "description": "Latitude bias center used for the search." }, "lng": { "type": "number", "description": "Longitude bias center used for the search." }, "zoom": { "type": "integer", "description": "Map zoom level used for the search." }, "limit": { "type": "integer", "description": "Maximum number of results requested." }, "query": { "type": "string", "description": "The search query as received." }, "offset": { "type": "integer", "description": "Number of results skipped (for pagination)." }, "region": { "type": "string", "description": "The region/country code used for the search." }, "language": { "type": "string", "description": "The language code used for the search." }, "extract_emails_and_contacts": { "type": "boolean", "description": "Whether email/contact extraction was requested for each business." } }, "description": "The parameters the API received and used for this request, echoed back." }, "request_id": { "type": "string", "description": "A unique ID to trace the API request." } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "query", "schema": { "type": "string", "example": "pizza" }, "example": "pizza", "required": true, "description": "Search query / keyword" }, { "in": "query", "name": "lat", "schema": { "type": "string", "default": 37.359428, "example": "37.359428" }, "example": "37.359428", "required": true, "description": "Latitude of the center coordinate point of the area to search in." }, { "in": "query", "name": "lng", "schema": { "type": "string", "default": -121.925337, "example": "-121.925337" }, "example": "-121.925337", "required": true, "description": "Longitude of the center coordinate point of the area to search in." }, { "in": "query", "name": "zoom", "schema": { "type": "string", "example": "13" }, "example": "13", "required": true, "description": "Zoom level on which to make the search (the search area / viewport is determined by lat, lng and zoom on a 1000x1000 screen)" }, { "in": "query", "name": "limit", "schema": { "type": "string", "default": 20 }, "description": "Maximum number of businesses to return. \n\n **Allowed values:** `1-500`" }, { "in": "query", "name": "language", "schema": { "type": "string", "default": "en" }, "description": "Set the language of the results. \n For a list of supported language codes see *https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes*." }, { "in": "query", "name": "region", "schema": { "type": "string", "default": "us" }, "description": "Query Google Maps from a particular region or country. \n For a list of supported region/country codes see *https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes (Alpha-2 code)*." }, { "in": "query", "name": "subtypes", "schema": { "type": "string" }, "description": "Find businesses with specific subtypes, specified as a comma separated list of types (business categories). \n For the complete list of types, see *https://daltonluka.com/blog/google-my-business-categories*. \n \n **Examples:** \n `Plumber,Carpenter,Electrician` \n `Night club,Dance club,Bar,Pub` " }, { "in": "query", "name": "extract_emails_and_contacts", "schema": { "type": "boolean", "default": false }, "description": "Extract emails, contacts and social profiles for each business in the response. \n In case true, businesses will be enriched with a emails_and_contacts field with emails, phones, Facebook, LinkedIn, Instagram and other social profiles.\n \n **Note:** in case `true`, the endpoint will scrape emails and contacts from the business website (in case non-empty). \n For each such business, the API will charge an additional credit." }, { "in": "query", "name": "fields", "schema": { "type": "string" }, "description": "A comma separated list of business fields to include in the response (field projection). \n By default all fields are returned." } ], "description": "Search businesses in a specific geographic area defined by a center coordinate point and zoom level. \n To see it in action, make a query on Google Maps, wait for the results to show, move the map or change the zoom and click \"Search this area\" at the top.", "operationId": "local_business_data__get__search_in_area", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing detailed response schema" ], "pages": [ 1 ], "sourceId": "sds_y_pAgcC-xJrVMI2TjrXI0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/area", "/description", "/operationId" ], "revisionId": "sdrn_58jSAkKvEcC3bWRtd9F4t" } ], "x-zeroclick-services": [ "local-business-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "local-business-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "local-business-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/local-business-data/search-nearby": { "get": { "summary": "Search Nearby", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "request_id", "parameters", "data" ], "properties": { "data": { "type": "array", "items": { "type": "object", "required": [ "business_id", "google_id", "name", "business_status" ], "properties": { "cid": { "type": "string", "nullable": true, "description": "Google CID (Customer ID) of the business." }, "tld": { "type": "string", "nullable": true, "description": "Top-level domain of the business website." }, "city": { "type": "string", "nullable": true, "description": "City of the business location." }, "name": { "type": "string", "description": "Display name of the business." }, "type": { "type": "string", "nullable": true, "description": "Primary business category as labelled by Google Maps." }, "about": { "type": "object", "nullable": true, "properties": { "details": { "type": "object", "nullable": true, "description": "Map of attribute groups (e.g. Amenities, Crowd, Service options) to attribute name -> boolean.", "additionalProperties": { "type": "object", "additionalProperties": { "type": "boolean" } } }, "summary": { "type": "string", "nullable": true, "description": "Free-text description of the business." } }, "description": "Free-form summary and a structured details map of business attributes." }, "state": { "type": "string", "nullable": true, "description": "State / region of the business location." }, "rating": { "type": "number", "nullable": true, "description": "Average review rating (1-5) on Google Maps." }, "address": { "type": "string", "nullable": true, "description": "Street address line of the business." }, "country": { "type": "string", "nullable": true, "description": "ISO 3166-1 alpha-2 country code of the business location." }, "website": { "type": "string", "nullable": true, "description": "Business website URL." }, "zipcode": { "type": "string", "nullable": true, "description": "ZIP / postal code of the business location." }, "district": { "type": "string", "nullable": true, "description": "District or neighbourhood of the business location." }, "latitude": { "type": "number", "description": "Latitude of the business location." }, "owner_id": { "type": "string", "nullable": true, "description": "ID of the Google Maps contributor account that owns this listing." }, "place_id": { "type": "string", "description": "Google Maps Place ID." }, "subtypes": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "List of additional business categories." }, "timezone": { "type": "string", "nullable": true, "description": "IANA timezone of the business location." }, "verified": { "type": "boolean", "description": "Whether the business is verified by Google." }, "directory": { "type": "array", "items": { "type": "object", "additionalProperties": true }, "nullable": true, "description": "List of businesses located in the same building / directory (e.g. mall, plaza). Conditional." }, "google_id": { "type": "string", "description": "Google's internal hexadecimal ID of the business." }, "longitude": { "type": "number", "description": "Longitude of the business location." }, "menu_link": { "type": "string", "nullable": true, "description": "URL of the business menu (when published)." }, "google_mid": { "type": "string", "nullable": true, "description": "Google Knowledge Graph machine ID." }, "located_in": { "type": "object", "nullable": true, "properties": { "name": { "type": "string", "description": "Name of the parent place." }, "google_id": { "type": "string", "description": "Google ID of the parent place." } }, "description": "Parent place this business is located in (e.g. mall) when applicable." }, "order_link": { "type": "string", "nullable": true, "description": "URL to place an order (when published)." }, "owner_link": { "type": "string", "nullable": true, "description": "Link to the owner profile on Google Maps." }, "owner_name": { "type": "string", "nullable": true, "description": "Display name of the owner profile." }, "place_link": { "type": "string", "description": "Google Maps URL for the business." }, "posts_link": { "type": "string", "nullable": true, "description": "URL to the full list of owner posts on Google Maps." }, "share_link": { "type": "string", "nullable": true, "description": "Shortened Google Maps share URL for the business. Returned when extract_share_link=true." }, "business_id": { "type": "string", "description": "Unique Google identifier of the business. Same value as google_id." }, "hotel_stars": { "type": "integer", "nullable": true, "description": "Hotel-only: star rating (1-5). Present only for hotels." }, "photo_count": { "type": "integer", "nullable": true, "description": "Total number of photos available for the business." }, "price_level": { "type": "string", "nullable": true, "description": "Price level as shown on Google Maps (e.g. '$', '$$')." }, "booking_link": { "type": "string", "nullable": true, "description": "URL to book a service or appointment." }, "full_address": { "type": "string", "description": "Full formatted address including business name." }, "opening_date": { "type": "string", "nullable": true, "description": "Date the business opened (when published by Google)." }, "phone_number": { "type": "string", "nullable": true, "description": "Business phone number in E.164 format when available." }, "posts_sample": { "type": "array", "items": { "type": "object", "properties": { "post_id": { "type": "string", "description": "Unique Google identifier of the owner post." }, "post_link": { "type": "string", "nullable": true, "description": "Direct URL to the post on Google." }, "post_text": { "type": "string", "nullable": true, "description": "Text content of the post." }, "post_links": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string", "description": "Target URL of the link." }, "caption": { "type": "string", "nullable": true, "description": "Caption of the link as shown on the post." } } }, "nullable": true, "description": "Outbound links attached to the post." }, "post_photos": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "URLs of photos attached to the post." }, "post_timestamp": { "type": "integer", "nullable": true, "description": "Unix epoch seconds matching post_datetime_utc." }, "post_datetime_utc": { "type": "string", "nullable": true, "description": "ISO 8601 UTC datetime when the post was published." } } }, "nullable": true, "description": "Sample of the most recent owner posts. Present in /business-details and /business-details-plus." }, "review_count": { "type": "integer", "nullable": true, "description": "Total number of Google Maps reviews on the business." }, "reviews_link": { "type": "string", "nullable": true, "description": "URL to view reviews on Google Maps." }, "photos_sample": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "Media type. Values: photo, video, street_view." }, "latitude": { "type": "number", "nullable": true, "description": "Latitude where the photo was taken (when known)." }, "photo_id": { "type": "string", "description": "Google Maps photo ID." }, "longitude": { "type": "number", "nullable": true, "description": "Longitude where the photo was taken (when known)." }, "photo_url": { "type": "string", "description": "URL of the photo (lower-resolution)." }, "photo_timestamp": { "type": "integer", "nullable": true, "description": "Unix epoch seconds matching photo_datetime_utc." }, "photo_url_large": { "type": "string", "nullable": true, "description": "URL of the photo at a larger resolution." }, "photo_datetime_utc": { "type": "string", "nullable": true, "description": "Original publication datetime of the photo in ISO 8601 UTC." }, "video_thumbnail_url": { "type": "string", "nullable": true, "description": "Thumbnail URL when the media is a video; null for still photos." } } }, "nullable": true, "description": "Up to ~10 representative photos for the business." }, "subtype_gcids": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "Internal Google category IDs corresponding to the primary type and subtypes." }, "working_hours": { "type": "object", "nullable": true, "description": "Working hours map keyed by day of the week. Each value is an array of time-range strings; empty object when not published.", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "opening_status": { "type": "string", "nullable": true, "description": "Current opening status string as shown on Google Maps (e.g. 'Open', 'Closed', 'Open 24 hours')." }, "reviews_sample": { "type": "array", "items": { "type": "object", "properties": { "rating": { "type": "integer", "description": "Star rating given in the review (1-5)." }, "author_id": { "type": "string", "nullable": true, "description": "Google Maps contributor ID of the review author." }, "review_id": { "type": "string", "description": "Unique Google identifier of the review." }, "like_count": { "type": "integer", "nullable": true, "description": "Number of likes the review received." }, "author_link": { "type": "string", "nullable": true, "description": "URL to the author's Google Maps profile." }, "author_name": { "type": "string", "nullable": true, "description": "Display name of the review author." }, "review_form": { "type": "object", "nullable": true, "description": "Structured questions the author answered (e.g. 'What kind of trip was it?').", "additionalProperties": { "type": "string" } }, "review_link": { "type": "string", "nullable": true, "description": "Direct Google Maps URL to the review." }, "review_text": { "type": "string", "nullable": true, "description": "Full text content of the review." }, "review_photos": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "URLs of photos attached to the review." }, "review_source": { "type": "string", "nullable": true, "description": "Platform the review originates from (e.g. 'Google', 'Tripadvisor')." }, "review_language": { "type": "string", "nullable": true, "description": "ISO 639 language code of the review text." }, "service_quality": { "type": "string", "nullable": true, "description": "Optional service-quality tag the author selected." }, "author_photo_url": { "type": "string", "nullable": true, "description": "URL of the author's profile photo." }, "review_timestamp": { "type": "integer", "nullable": true, "description": "Unix epoch seconds matching review_datetime_utc." }, "author_review_count": { "type": "integer", "nullable": true, "description": "Number of reviews this author has posted." }, "author_reviews_link": { "type": "string", "nullable": true, "description": "URL to all reviews by this author." }, "owner_response_text": { "type": "string", "nullable": true, "description": "Text of the business owner's response." }, "review_datetime_utc": { "type": "string", "nullable": true, "description": "ISO 8601 UTC datetime when the review was posted." }, "hotel_rating_breakdown": { "type": "object", "nullable": true, "description": "Hotel-only: per-aspect ratings (Rooms, Service, Location, etc.).", "additionalProperties": { "type": "integer" } }, "owner_response_language": { "type": "string", "nullable": true, "description": "ISO 639 language code of the owner response." }, "author_local_guide_level": { "type": "integer", "nullable": true, "description": "Google Local Guide level (1-10) of the author." }, "owner_response_timestamp": { "type": "integer", "nullable": true, "description": "Unix epoch seconds matching owner_response_datetime_utc." }, "owner_response_datetime_utc": { "type": "string", "nullable": true, "description": "ISO 8601 UTC datetime when the business owner responded." } } }, "nullable": true, "description": "Sample of recent reviews. Present in /business-details and /business-details-plus." }, "street_address": { "type": "string", "nullable": true, "description": "Street name and number portion of the address." }, "business_status": { "type": "string", "description": "Operational status. Values: OPEN, CLOSED_TEMPORARILY, CLOSED_PERMANENTLY." }, "hotel_amenities": { "type": "object", "nullable": true, "description": "Hotel-only: map of amenity name to availability (true/false). Present only for hotels.", "additionalProperties": { "type": "boolean" } }, "global_plus_code": { "type": "string", "nullable": true, "description": "Global Open Location Code (Plus Code) for the business location." }, "business_services": { "type": "object", "nullable": true, "description": "Map of service category -> list of services offered (when published by the owner).", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "reservations_link": { "type": "string", "nullable": true, "description": "URL to make a reservation." }, "compound_plus_code": { "type": "string", "nullable": true, "description": "Compound (short) Plus Code with a nearby locality." }, "reviews_per_rating": { "type": "object", "nullable": true, "properties": { "1": { "type": "integer", "description": "Number of 1-star reviews." }, "2": { "type": "integer", "description": "Number of 2-star reviews." }, "3": { "type": "integer", "description": "Number of 3-star reviews." }, "4": { "type": "integer", "description": "Number of 4-star reviews." }, "5": { "type": "integer", "description": "Number of 5-star reviews." } }, "description": "Counts of reviews per integer rating from 1 to 5." }, "emails_and_contacts": { "type": "object", "nullable": true, "properties": { "yelp": { "type": "string", "nullable": true, "description": "Yelp listing URL." }, "emails": { "type": "array", "items": { "type": "string" }, "description": "Email addresses found on the business website." }, "github": { "type": "string", "nullable": true, "description": "GitHub profile URL." }, "tiktok": { "type": "string", "nullable": true, "description": "TikTok profile URL." }, "twitter": { "type": "string", "nullable": true, "description": "Twitter/X profile URL." }, "youtube": { "type": "string", "nullable": true, "description": "YouTube channel URL." }, "facebook": { "type": "string", "nullable": true, "description": "Facebook profile URL." }, "linkedin": { "type": "string", "nullable": true, "description": "LinkedIn profile URL." }, "snapchat": { "type": "string", "nullable": true, "description": "Snapchat profile URL." }, "instagram": { "type": "string", "nullable": true, "description": "Instagram profile URL." }, "pinterest": { "type": "string", "nullable": true, "description": "Pinterest profile URL." }, "phone_numbers": { "type": "array", "items": { "type": "string" }, "description": "Phone numbers found on the business website." } }, "description": "Emails and social-network profiles extracted from the business website. Populated when extract_emails_and_contacts=true (the default for /business-details)." }, "hotel_review_summary": { "type": "object", "nullable": true, "description": "Hotel-only: AI-generated review summary. Present only for hotels.", "additionalProperties": true }, "hotel_booking_options": { "type": "array", "items": { "type": "object", "additionalProperties": true }, "nullable": true, "description": "Hotel-only: array of booking options (provider, price, link). Present only for hotels with live rates." }, "hotel_location_rating": { "type": "object", "nullable": true, "description": "Hotel-only: location rating breakdown when the business is a hotel.", "additionalProperties": true }, "hotel_price_for_dates": { "type": "string", "nullable": true, "description": "Hotel-only: nightly price string when Google has live rates." }, "requested_business_id": { "type": "string", "description": "The exact business_id from the request, echoed back. Useful when batching multiple IDs." }, "hotel_results_from_web": { "type": "array", "items": { "type": "object", "additionalProperties": true }, "nullable": true, "description": "Hotel-only: additional web-sourced results / reviews shown alongside the Google listing." }, "keywords_mentioned_in_reviews": { "type": "array", "items": { "type": "object", "required": [ "keyword", "review_count" ], "properties": { "keyword": { "type": "string", "description": "The keyword extracted from reviews." }, "review_count": { "type": "integer", "description": "Number of reviews mentioning this keyword." } } }, "nullable": true, "description": "Keywords most frequently mentioned in reviews, with counts. Returned by /business-details-plus only (AI-enriched, ?extended_details=true)." } } }, "description": "List of businesses returned." }, "status": { "type": "string", "description": "The status of the API response." }, "parameters": { "type": "object", "properties": { "lat": { "type": "number", "description": "Latitude center used for the nearby search." }, "lng": { "type": "number", "description": "Longitude center used for the nearby search." }, "limit": { "type": "integer", "description": "Maximum number of results requested." }, "query": { "type": "string", "description": "The search query as received." }, "region": { "type": "string", "description": "The region/country code used for the search." }, "language": { "type": "string", "description": "The language code used for the search." }, "extract_emails_and_contacts": { "type": "boolean", "description": "Whether email/contact extraction was requested for each business." } }, "description": "The parameters the API received and used for this request, echoed back." }, "request_id": { "type": "string", "description": "A unique ID to trace the API request." } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "query", "schema": { "type": "string", "example": "plumbers" }, "example": "plumbers", "required": true, "description": "Search query / keyword \n\n **Examples:** \n `Bars and pubs` \n `Plumbers`" }, { "in": "query", "name": "lat", "schema": { "type": "string", "default": 37.359428, "example": "37.359428" }, "example": "37.359428", "required": true, "description": "Latitude of the geographic coordinates to search near by." }, { "in": "query", "name": "lng", "schema": { "type": "string", "default": -121.925337, "example": "-121.925337" }, "example": "-121.925337", "required": true, "description": "Longitude of the geographic coordinates to search near by." }, { "in": "query", "name": "limit", "schema": { "type": "string", "default": 20 }, "description": "Maximum number of businesses to return. \n\n **Allowed values:** `1-500`" }, { "in": "query", "name": "language", "schema": { "type": "string", "default": "en" }, "description": "Set the language of the results. For a list of supported language codes see *https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes*." }, { "in": "query", "name": "region", "schema": { "type": "string", "default": "us" }, "description": "Query Google Maps from a particular region or country. \n For a list of supported region/country codes see *https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes (Alpha-2 code)*." }, { "in": "query", "name": "subtypes", "schema": { "type": "string" }, "description": "Find businesses with specific subtypes, specified as a comma separated list of types (business categories). \n For the complete list of types, see *https://daltonluka.com/blog/google-my-business-categories*. \n \n **Examples:** \n `Plumber,Carpenter,Electrician` \n `Night club,Dance club,Bar,Pub` " }, { "in": "query", "name": "extract_emails_and_contacts", "schema": { "type": "boolean", "default": false }, "description": "Extract emails, contacts and social profiles for each business in the response. \n In case true, businesses will be enriched with a emails_and_contacts field with emails, phones, Facebook, LinkedIn, Instagram and other social profiles. \n \n **Note:** in case true, the endpoint will scrape emails and contacts from the business website (in case non-empty). \n For each such business, the API will charge an additional credit." }, { "in": "query", "name": "fields", "schema": { "type": "string" }, "description": "A comma separated list of business fields to include in the response (field projection). \n By default all fields are returned." } ], "description": "Search businesses near by specific geographic coordinates. \n To see it in action, right click on a specific point in the map on Google Maps and select \"Search nearby\", enter a query and search.", "operationId": "local_business_data__get__search_nearby", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing detailed response schema" ], "pages": [ 1 ], "sourceId": "sds_y_pAgcC-xJrVMI2TjrXI0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/lat/schema/type", "/parameters/query/lng/schema/type", "/description", "/operationId" ], "revisionId": "sdrn_58jSAkKvEcC3bWRtd9F4t" } ], "x-zeroclick-services": [ "local-business-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "local-business-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "local-business-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/local-rank-tracker/calculate-grid-coordinates": { "get": { "summary": "Calculate Grid Coordinate Points", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "rc": { "type": "array", "items": { "type": "integer", "description": "A list of integer values representing some data" } }, "lat": { "type": "number", "description": "The latitude of a data point" }, "lng": { "type": "number", "description": "The longitude of a data point" } } } }, "status": { "type": "string", "description": "The status of the response" }, "parameters": { "type": "object", "properties": { "lat": { "type": "string", "description": "The latitude used in the request" }, "lng": { "type": "string", "description": "The longitude used in the request" }, "radius": { "type": "string", "description": "The radius used in the request" }, "grid_size": { "type": "string", "description": "The size of the grid for the response" }, "radius_units": { "type": "string", "description": "The units of measurement for the radius" } } }, "request_id": { "type": "string", "description": "A unique identifier for the request" } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "lat", "schema": { "type": "number", "default": 37.341759 }, "example": "37.341759", "required": true, "description": "Grid center coordinate point latitude value." }, { "in": "query", "name": "lng", "schema": { "type": "number", "default": -121.938314 }, "example": "-121.938314", "required": true, "description": "Grid center coordinate point longitude value." }, { "in": "query", "name": "grid_size", "schema": { "enum": [ 3, 5, 7, 9, 11, 13, 15 ], "type": "number", "default": 3 }, "example": "3", "required": true, "description": "The size of the grid *(i.e. 3x3, 5x5, 7x7, etc)*." }, { "in": "query", "name": "radius", "schema": { "type": "number", "default": 1 }, "example": "1", "required": true, "description": "The distance between coordinate points (on the same row / column in the grid). \n The units of the radius are determined by the distance_units parameter. \n \n **Allowed values:** `0.1-100`" }, { "in": "query", "name": "radius_units", "schema": { "type": "number", "default": "km" }, "description": "Distance measurement units to use for the radius parameter (kilometers / miles). \n\n **Allowed values:** `km, mi`" } ], "description": "Get all grid coordinate points based on a center geocoordinate point and distance arguments.", "operationId": "local_rank_tracker__get__calculate_grid_coordinates", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing detailed response schema" ], "pages": [ 1 ], "sourceId": "sds_y_pAgcC-xJrVMI2TjrXI0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_58jSAkKvEcC3bWRtd9F4t" } ], "x-zeroclick-services": [ "local-rank-tracker" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "local-rank-tracker", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "local-rank-tracker", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/local-rank-tracker/grid": { "get": { "summary": "Full Grid Search", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "found": { "type": "integer", "description": "The number of locations found in the search" }, "points": { "type": "integer", "description": "The total number of points analyzed in the search" }, "average_rank": { "type": "number", "description": "The average rank of found locations" }, "found_percent": { "type": "integer", "description": "The percentage of locations found relative to points analyzed" }, "average_total_rank": { "type": "number", "description": "The overall average rank of all analyzed locations" }, "top_3_rank_percent": { "type": "integer", "description": "The percentage of locations ranked in the top 3" } } }, "status": { "type": "string", "description": "The status of the response" }, "parameters": { "type": "object", "properties": { "lat": { "type": "string", "description": "The latitude coordinate of the search location" }, "lng": { "type": "string", "description": "The longitude coordinate of the search location" }, "zoom": { "type": "string", "description": "The zoom level of the search area" }, "query": { "type": "string", "description": "The search query used in the request" }, "radius": { "type": "string", "description": "The radius of the search area" }, "place_id": { "type": "string", "description": "The unique identifier for the place" }, "grid_size": { "type": "string", "description": "The size of the grid used in the search" }, "radius_units": { "type": "string", "description": "The units of measurement for the radius" } } }, "request_id": { "type": "string", "description": "A unique identifier for the request" } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "place_id", "schema": { "type": "string" }, "example": "ChIJoejvAr3Mj4ARtHrbKxtAHXI", "required": true, "description": "The Google Place ID of the business to match against in results." }, { "in": "query", "name": "query", "schema": { "type": "string" }, "example": "web design", "required": true, "description": "Search query / keyword." }, { "in": "query", "name": "lat", "schema": { "type": "number", "default": 37.341759 }, "example": "37.341759", "required": true, "description": "Grid center coordinate point latitude value." }, { "in": "query", "name": "lng", "schema": { "type": "number", "default": -121.938314 }, "example": "-121.938314", "required": true, "description": "Grid center coordinate point longitude value." }, { "in": "query", "name": "grid_size", "schema": { "enum": [ 3, 5, 7, 9, 11, 13, 15 ], "type": "number", "default": 3 }, "example": "3", "required": true, "description": "The size of the grid *(i.e. 3x3, 5x5, 7x7, etc)*." }, { "in": "query", "name": "radius", "schema": { "type": "number", "default": 1 }, "example": "1", "required": true, "description": "The distance between coordinate points (on the same row / column in the grid). \n The units of the radius are determined by the distance_units parameter. \n \n **Allowed values:** `0.1-100` " }, { "in": "query", "name": "shape", "schema": { "enum": [ "square", "round" ], "type": "string", "default": "square" }, "description": "The shape of the grid (square or round)." }, { "in": "query", "name": "radius_units", "schema": { "enum": [ "km", "mi" ], "type": "string", "default": "km" }, "description": "Distance measurement units to use for the radius parameter (kilometers / miles).." }, { "in": "query", "name": "zoom", "schema": { "type": "number", "default": 13 }, "description": "Google Maps zoom level to use for search on each grid point. \n\n **Allowed values:** `0-18`" } ], "description": "Make a full grid search and get the ranking of a specific business in every coordinate point in the grid. \n The grid cells / entires in the results are ordered left-to-right then top-down.", "operationId": "local_rank_tracker__get__grid", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing detailed response schema" ], "pages": [ 1 ], "sourceId": "sds_y_pAgcC-xJrVMI2TjrXI0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/business_id", "/description", "/operationId" ], "revisionId": "sdrn_58jSAkKvEcC3bWRtd9F4t" } ], "x-zeroclick-services": [ "local-rank-tracker" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "local-rank-tracker", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "local-rank-tracker", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/local-rank-tracker/places": { "get": { "summary": "Search Business Locations", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "count": { "type": "integer", "description": "The total number of results returned" }, "results": { "type": "array", "items": { "type": "object", "properties": { "cid": { "type": "string", "description": "A unique customer identifier for the place" }, "lat": { "type": "number", "description": "The latitude coordinate of the place" }, "lng": { "type": "number", "description": "The longitude coordinate of the place" }, "sab": { "type": "boolean", "description": "Indicates whether the place is a Service Area Business (SAB)" }, "name": { "type": "string", "description": "The name of the place" }, "address": { "type": "string", "description": "The address of the place" }, "country": { "type": "string", "description": "The country where the place is located" }, "place_id": { "type": "string", "description": "The unique identifier for the place" }, "google_id": { "type": "string", "description": "The Google identifier for the place" }, "place_link": { "type": "string", "description": "A URL link to the place's details" } } } } } }, "status": { "type": "string", "description": "The status of the response" }, "parameters": { "type": "object", "properties": { "near": { "type": "string", "description": "The location near which to search" }, "query": { "type": "string", "description": "The search query used in the request" } } }, "request_id": { "type": "string", "description": "A unique identifier for the request" } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "query", "schema": { "type": "string" }, "example": "Jives Media", "required": true, "description": "Search query." }, { "in": "query", "name": "near", "schema": { "type": "string" }, "description": "Narrow down your search results by using a city, state, country or any other free-form location string." } ], "description": "Returns a list of found Google My Business locations based on search query, including Service Area Businesses (SAB).", "operationId": "local_rank_tracker__get__places", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing detailed response schema" ], "pages": [ 1 ], "sourceId": "sds_y_pAgcC-xJrVMI2TjrXI0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_58jSAkKvEcC3bWRtd9F4t" } ], "x-zeroclick-services": [ "local-rank-tracker" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "local-rank-tracker", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "local-rank-tracker", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/local-rank-tracker/ranking-at-coordinate": { "get": { "summary": "Ranking at Coordinate Point", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "lat": { "type": "number", "description": "Latitude of the found location" }, "lng": { "type": "number", "description": "Longitude of the found location" }, "rank": { "type": "integer", "description": "Ranking of the location in search results" }, "count": { "type": "integer", "description": "Total number of results found" }, "found": { "type": "boolean", "description": "Indicates if the location was found" }, "results": { "type": "array", "items": { "type": "object", "properties": { "cid": { "type": "string", "description": "The Google CID identifier of the place" }, "lat": { "type": "number", "description": "Latitude of the place" }, "lng": { "type": "number", "description": "Longitude of the place" }, "sab": { "type": "boolean", "description": "Indicates if the place is a service area business" }, "name": { "type": "string", "description": "The name of the place" }, "rank": { "type": "integer", "description": "The rank of the place in search results" }, "rating": { "type": "number", "description": "The average rating of the place" }, "address": { "type": "string", "description": "The address of the place" }, "country": { "type": "string", "description": "The country where the place is located" }, "reviews": { "type": "integer", "description": "The number of reviews for the place" }, "website": { "type": "string", "description": "The website of the place" }, "place_id": { "type": "string", "description": "The unique identifier of the place" }, "subtypes": { "type": "array", "items": { "type": "string" }, "description": "The subcategories of the place" }, "verified": { "type": "boolean", "description": "Indicates if the place is verified by Google" }, "google_id": { "type": "string", "description": "The Google ID of the place" }, "place_link": { "type": "string", "description": "The Google Maps link to the place" }, "phone_number": { "type": "string", "description": "The phone number of the place" }, "business_status": { "type": "string", "description": "The operational status of the business" } } } } } }, "status": { "type": "string", "description": "The status of the response" }, "parameters": { "type": "object", "properties": { "lat": { "type": "string", "description": "The latitude of the search location" }, "lng": { "type": "string", "description": "The longitude of the search location" }, "zoom": { "type": "string", "description": "The zoom level of the map" }, "query": { "type": "string", "description": "The search query parameter" }, "place_id": { "type": "string", "description": "The unique identifier of the place" } } }, "request_id": { "type": "string", "description": "A unique identifier for the request" } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "place_id", "schema": { "type": "string" }, "example": "ChIJ0zS4SOvLj4AR1obZVVeLFM0", "required": true, "description": "The Google Place ID of the business to match against in results." }, { "in": "query", "name": "query", "schema": { "type": "string" }, "example": "web design", "required": true, "description": "Search query / keyword." }, { "in": "query", "name": "lat", "schema": { "type": "number", "default": 37.341759 }, "example": "37.341759", "required": true, "description": "Coordinate point latitude value." }, { "in": "query", "name": "lng", "schema": { "type": "number", "default": -121.938314 }, "example": "-121.938314", "required": true, "description": "Coordinate point longitude value." }, { "in": "query", "name": "zoom", "schema": { "type": "number", "default": 13 }, "description": "Google Maps zoom level. \n\n **Allowed values:** `0-18`" } ], "description": "Get search results at the specified coordinate point and additional ranking data for the business with `place_id`.", "operationId": "local_rank_tracker__get__ranking_at_coordinate", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing detailed response schema" ], "pages": [ 1 ], "sourceId": "sds_y_pAgcC-xJrVMI2TjrXI0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_58jSAkKvEcC3bWRtd9F4t" } ], "x-zeroclick-services": [ "local-rank-tracker" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "local-rank-tracker", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "local-rank-tracker", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/local-rank-tracker/search": { "get": { "summary": "Keyword Search at Coordinate Point", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "count": { "type": "integer", "description": "The number of results returned." }, "results": { "type": "array", "items": { "type": "object", "properties": { "cid": { "type": "string", "description": "The Google Maps customer ID for the place." }, "lat": { "type": "number", "description": "The latitude coordinate of the place." }, "lng": { "type": "number", "description": "The longitude coordinate of the place." }, "sab": { "type": "boolean", "description": "Indicates if the place is a Service Area Business." }, "name": { "type": "string", "description": "The name of the place." }, "rank": { "type": "integer", "description": "The ranking of the place in the search results." }, "rating": { "type": "number", "description": "The average rating of the place." }, "address": { "type": "string", "description": "The formatted address of the place." }, "country": { "type": "string", "description": "The country where the place is located." }, "reviews": { "type": "integer", "description": "The number of reviews the place has received." }, "website": { "type": "string", "description": "The official website of the place." }, "place_id": { "type": "string", "description": "The unique identifier for the place." }, "verified": { "type": "boolean", "description": "Indicates if the place is verified on Google." }, "google_id": { "type": "string", "description": "The unique Google identifier for the place." }, "place_link": { "type": "string", "description": "The Google Maps link to the place." }, "phone_number": { "type": "string", "description": "The phone number of the place." }, "business_status": { "type": "string", "description": "The operational status of the business." } } } } } }, "status": { "type": "string", "description": "The status of the response." }, "parameters": { "type": "object", "properties": { "lat": { "type": "string", "description": "The latitude coordinate for the search." }, "lng": { "type": "string", "description": "The longitude coordinate for the search." }, "zoom": { "type": "string", "description": "The zoom level of the search." }, "query": { "type": "string", "description": "The search query parameter." } } }, "request_id": { "type": "string", "description": "A unique identifier for the request." } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "query", "schema": { "type": "string" }, "example": "web design", "required": true, "description": "Search query / keyword." }, { "in": "query", "name": "lat", "schema": { "type": "number", "default": 37.341759 }, "example": "37.341759", "required": true, "description": "Coordinate point latitude value." }, { "in": "query", "name": "lng", "schema": { "type": "number", "default": -121.938314 }, "example": "-121.938314", "required": true, "description": "Coordinate point longitude value." }, { "in": "query", "name": "zoom", "schema": { "type": "number", "default": 13 }, "description": "Google Maps zoom level. \n\n **Allowed values:** `0-18`" } ], "description": "Get search results at the specified coordinate point without any rank comparison data.", "operationId": "local_rank_tracker__get__search", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing detailed response schema" ], "pages": [ 1 ], "sourceId": "sds_y_pAgcC-xJrVMI2TjrXI0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_58jSAkKvEcC3bWRtd9F4t" } ], "x-zeroclick-services": [ "local-rank-tracker" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "local-rank-tracker", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "local-rank-tracker", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/play-store-apps/app-details": { "get": { "summary": "App Details", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "price": { "type": "integer", "description": "The price of the app in minor currency units" }, "app_id": { "type": "string", "description": "The unique identifier of the app" }, "rating": { "type": "number", "description": "The average rating of the app" }, "is_paid": { "type": "boolean", "description": "Indicates if the app is paid" }, "trailer": { "type": "string", "description": "The URL of the app's trailer video" }, "app_icon": { "type": "string", "description": "The URL of the app icon" }, "app_name": { "type": "string", "description": "The name of the app" }, "chart_rank": { "type": "integer", "description": "The rank of the app in the chart" }, "chart_label": { "type": "string", "description": "The chart category label" }, "num_ratings": { "type": "integer", "description": "The total number of ratings" }, "num_reviews": { "type": "integer", "description": "The total number of reviews" }, "app_category": { "type": "string", "description": "The category of the app" }, "contains_ads": { "type": "boolean", "description": "Indicates if the app contains ads" }, "app_developer": { "type": "string", "description": "The name of the app developer" }, "app_page_link": { "type": "string", "description": "The URL to the app's page" }, "num_downloads": { "type": "string", "description": "The number of downloads in string format" }, "price_currency": { "type": "string", "description": "The currency of the app price" }, "app_category_id": { "type": "string", "description": "The ID of the app category" }, "app_description": { "type": "string", "description": "A brief description of the app" }, "current_version": { "type": "string", "description": "The current version of the app" }, "app_content_rating": { "type": "string", "description": "The content rating of the app" }, "app_developer_email": { "type": "string", "description": "The contact email of the developer" }, "max_android_version": { "type": "string", "description": "The maximum supported Android version" }, "min_android_version": { "type": "string", "description": "The minimum Android version required" }, "num_downloads_exact": { "type": "integer", "description": "The exact number of downloads" }, "privacy_policy_link": { "type": "string", "description": "The URL to the app's privacy policy" }, "app_developer_website": { "type": "string", "description": "The developer's website URL" }, "max_android_api_level": { "type": "integer", "description": "The maximum supported Android API level" }, "min_android_api_level": { "type": "string", "description": "The minimum Android API level required" }, "app_updated_at_timestamp": { "type": "integer", "description": "Timestamp of the last update" }, "current_version_whatsnew": { "type": "string", "description": "Details of what's new in the current version" }, "app_updated_at_datetime_utc": { "type": "string", "description": "Datetime of the last update in UTC" }, "app_first_released_at_timestamp": { "type": "integer", "description": "The timestamp of the first release" }, "app_first_released_at_datetime_utc": { "type": "string", "description": "The first release date in UTC" }, "current_version_released_at_timestamp": { "type": "string", "description": "Timestamp of the current version release" }, "current_version_released_at_datetime_utc": { "type": "string", "description": "Datetime of the current version release in UTC" } } } }, "status": { "type": "string", "description": "The status of the response" }, "request_id": { "type": "string", "description": "The unique identifier for the request" } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "app_id", "schema": { "type": "string" }, "example": "com.google.android.apps.subscriptions.red", "required": true, "description": "App Id. Batching of up to 100 App Ids is supported by separating multiple ids by comma (e.g. com.snapchat.android,com.microsoft.teams)." }, { "in": "query", "name": "region", "schema": { "type": "string", "default": "US" }, "description": "The country code of country/region to use, specified as a 2-letter country code - see ISO 3166-1 alpha-2." }, { "in": "query", "name": "language", "schema": { "type": "string", "default": "EN" }, "description": "The language to use, specified as a 2-letter language code - see ISO 639-1 alpha-2." } ], "description": "Get full app details.", "operationId": "play_store_apps__get__app_details", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing detailed response schema" ], "pages": [ 1 ], "sourceId": "sds_y_pAgcC-xJrVMI2TjrXI0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_58jSAkKvEcC3bWRtd9F4t" } ], "x-zeroclick-services": [ "play-store-apps" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "play-store-apps", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "play-store-apps", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/play-store-apps/app-reviews": { "get": { "summary": "App Reviews", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "cursor": { "type": "string", "description": "A pagination cursor for fetching the next set of results" }, "reviews": { "type": "array", "items": { "type": "object", "properties": { "author_id": { "type": "string", "description": "A unique identifier for the author" }, "review_id": { "type": "string", "description": "A unique identifier for the review" }, "author_name": { "type": "string", "description": "The name of the review author" }, "review_text": { "type": "string", "description": "The text content of the review" }, "author_photo": { "type": "string", "description": "URL to the author's profile photo" }, "review_likes": { "type": "integer", "description": "The number of likes on the review" }, "review_rating": { "type": "integer", "description": "The rating given by the reviewer" }, "review_timestamp": { "type": "integer", "description": "The timestamp of when the review was submitted" }, "author_app_version": { "type": "string", "description": "The app version used by the author" }, "app_developer_reply": { "type": "string", "description": "The developer's reply to the review, if available" }, "review_datetime_utc": { "type": "string", "description": "The UTC date and time of the review" }, "app_developer_reply_timestamp": { "type": "string", "description": "Timestamp of the developer's reply, if available" }, "app_developer_reply_datetime_utc": { "type": "string", "description": "The UTC datetime of the developer's reply, if available" } } } } } }, "status": { "type": "string", "description": "The status of the response" }, "request_id": { "type": "string", "description": "A unique identifier for the request" } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "app_id", "schema": { "type": "string" }, "example": "com.snapchat.android", "required": true, "description": "App Id of the app for which to get reviews." }, { "in": "query", "name": "limit", "schema": { "type": "integer", "default": 20, "maximum": 4000, "minimum": 1 }, "description": "Maximum number of reviews in the results." }, { "in": "query", "name": "cursor", "schema": { "type": "string" }, "description": "Specify a cursor from the previous request to get the next set of results." }, { "in": "query", "name": "sort_by", "schema": { "enum": [ "MOST_RELEVANT", "NEWEST", "RATING" ], "type": "string", "default": "MOST_RELEVANT" }, "description": "How to sort the reviews in the results." }, { "in": "query", "name": "device", "schema": { "enum": [ "PHONE", "TABLET", "CHROMEBOOK" ], "type": "string", "default": "PHONE" }, "description": "Only return reviews made on a specific device type." }, { "in": "query", "name": "rating", "schema": { "enum": [ "ANY", "ONE_STAR", "TWO_STARS", "THREE_STARS", "FOUR_STARS", "FIVE_STARS" ], "type": "string", "default": "ANY" }, "description": "Only return reviews with a certain star rating." }, { "in": "query", "name": "region", "schema": { "type": "string", "default": "US" }, "description": "The country code of country/region to use, specified as a 2-letter country code - see ISO 3166-1 alpha-2." }, { "in": "query", "name": "language", "schema": { "type": "string", "default": "EN" }, "description": "The language to use, specified as a 2-letter language code - see ISO 639-1 alpha-2." } ], "description": "Get all app reviews.", "operationId": "play_store_apps__get__app_reviews", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing detailed response schema" ], "pages": [ 1 ], "sourceId": "sds_y_pAgcC-xJrVMI2TjrXI0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_58jSAkKvEcC3bWRtd9F4t" } ], "x-zeroclick-services": [ "play-store-apps" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "play-store-apps", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "play-store-apps", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/play-store-apps/categories": { "get": { "summary": "App Categories", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The category identifier used as the `category` query param on charts endpoints." }, "name": { "type": "string", "description": "Human-readable category name." } } }, "description": "Array of Google Play app categories with their identifiers and display names." }, "status": { "type": "string", "description": "The status of the API response." }, "request_id": { "type": "string", "description": "Unique identifier for the API request." } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "No additional params", "schema": { "type": "string" }, "description": "No additional params" } ], "description": "Get the full list of Google Play app categories. The returned categories can be used with the Charts endpoints (as the category parameter).", "operationId": "play_store_apps__get__categories", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing parameter definitions and response schema." ], "pages": [ 1 ], "sourceId": "sds__1fiQu9RHG0jaOVImz_2s", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_fMzoiFNl9X0S__Sj10MeV" }, { "gaps": [ "Missing parameter definitions and response schema" ], "pages": [], "sourceId": "sds_1IfgtOxqP1q4cHvJ7VyPY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_mb4oPKVX4C1sgk5EHzdxz" }, { "gaps": [ "Missing parameter definitions and response schema details." ], "pages": [], "sourceId": "sds_72qMF9r94Nlws9PyhMdQm", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_Y4vhW7SNsmRcmxb4fXsm8" }, { "gaps": [ "Missing parameter definitions and response schema." ], "pages": [], "sourceId": "sds_G0U8VUwSzsI5a3e1H5DC1", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_YNvYe3cGaeWzpXoXqMHAs" }, { "gaps": [ "Missing parameter definitions and response schema" ], "pages": [ 1 ], "sourceId": "sds_MAxJPNBPJFwSKQLj1M1dr", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_QFW9HQumx231aOJCusPx0" }, { "gaps": [ "No documentation provided for parameters or response schema." ], "pages": [], "sourceId": "sds_qhTee9rhe4IsP9VM8R0Jx", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_n1Qua5iIILpqbVggnqZhR" }, { "gaps": [ "No documentation provided for parameters or response schema." ], "pages": [], "sourceId": "sds_rT9_GyymiamliAo644CKz", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_PfyiCRgYUBzYaNQGBu0of" }, { "gaps": [ "Missing query parameters or response schema details." ], "pages": [ 1 ], "sourceId": "sds_t1I2lol_F5DgGpe13n3Xt", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_OBuPoRSMenxSJ1CM3zwbN" }, { "gaps": [ "Missing parameter definitions and response schema" ], "pages": [ 1 ], "sourceId": "sds_wvqPOTBJ3ELhy96dsub_l", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_f7m9IOfd1EwYpLs8JZOMM" } ], "x-zeroclick-services": [ "play-store-apps" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "play-store-apps", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "play-store-apps", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/play-store-apps/search": { "get": { "summary": "Search", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "apps": { "type": "array", "items": { "type": "object" }, "description": "Array of matching Google Play apps." }, "cursor": { "type": "string", "description": "A pagination cursor for fetching the next set of results" } } }, "status": { "type": "string", "description": "The status of the response" }, "request_id": { "type": "string", "description": "A unique identifier for the request" } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "q", "schema": { "type": "string" }, "example": "notes", "required": true, "description": "Search query." }, { "in": "query", "name": "cursor", "schema": { "type": "string" }, "description": "Specify a cursor from the previous request to get the next set of results." }, { "in": "query", "name": "region", "schema": { "type": "string", "default": "us" }, "description": "The country code of country/region to use, specified as a 2-letter country code - see ISO 3166-1 alpha-2." }, { "in": "query", "name": "language", "schema": { "type": "string", "default": "en" }, "description": "The language to use, specified as a 2-letter language code - see ISO 639-1 alpha-2." } ], "description": "Search for apps on the Store.", "operationId": "play_store_apps__get__search", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing full parameter list and response schema." ], "pages": [ 1 ], "sourceId": "sds__1fiQu9RHG0jaOVImz_2s", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_fMzoiFNl9X0S__Sj10MeV" }, { "gaps": [ "Missing full parameter list and response schema" ], "pages": [], "sourceId": "sds_1IfgtOxqP1q4cHvJ7VyPY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/query", "/description", "/operationId" ], "revisionId": "sdrn_mb4oPKVX4C1sgk5EHzdxz" }, { "gaps": [ "Missing full parameter list and response schema." ], "pages": [], "sourceId": "sds_72qMF9r94Nlws9PyhMdQm", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_Y4vhW7SNsmRcmxb4fXsm8" }, { "gaps": [ "Missing response schema." ], "pages": [], "sourceId": "sds_G0U8VUwSzsI5a3e1H5DC1", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_YNvYe3cGaeWzpXoXqMHAs" }, { "gaps": [ "Missing full parameter list and response schema" ], "pages": [ 1 ], "sourceId": "sds_MAxJPNBPJFwSKQLj1M1dr", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/query", "/description", "/operationId" ], "revisionId": "sdrn_QFW9HQumx231aOJCusPx0" }, { "gaps": [ "No documentation provided for response schema." ], "pages": [], "sourceId": "sds_qhTee9rhe4IsP9VM8R0Jx", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/query", "/description", "/operationId" ], "revisionId": "sdrn_n1Qua5iIILpqbVggnqZhR" }, { "gaps": [ "No documentation provided for parameters or response schema." ], "pages": [], "sourceId": "sds_rT9_GyymiamliAo644CKz", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/query", "/description", "/operationId" ], "revisionId": "sdrn_PfyiCRgYUBzYaNQGBu0of" }, { "gaps": [ "Missing pagination or filtering parameters." ], "pages": [ 1 ], "sourceId": "sds_t1I2lol_F5DgGpe13n3Xt", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_OBuPoRSMenxSJ1CM3zwbN" }, { "gaps": [ "Missing response schema" ], "pages": [ 1 ], "sourceId": "sds_wvqPOTBJ3ELhy96dsub_l", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_f7m9IOfd1EwYpLs8JZOMM" } ], "x-zeroclick-services": [ "play-store-apps" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "play-store-apps", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "play-store-apps", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/play-store-apps/top-free-apps": { "get": { "summary": "Top Free Apps", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "required": [ "app_id", "app_name", "app_developer", "app_page_link" ], "properties": { "price": { "type": "number", "nullable": true, "description": "Listed price in the regional currency (0 for free apps)." }, "app_id": { "type": "string", "description": "Google Play package id of the app." }, "photos": { "type": "array", "items": { "type": "string", "description": "Screenshot URL." }, "nullable": true, "description": "Screenshot image URLs from the Play Store listing." }, "rating": { "type": "number", "nullable": true, "description": "Average user rating (0–5)." }, "is_paid": { "type": "boolean", "nullable": true, "description": "Whether the app is paid (true) or free (false)." }, "trailer": { "type": "string", "nullable": true, "description": "URL of the app's video trailer, when available." }, "app_icon": { "type": "string", "nullable": true, "description": "URL of the app's icon image." }, "app_name": { "type": "string", "description": "Display name of the app." }, "chart_rank": { "type": "integer", "nullable": true, "description": "Position of the app in the chart (1-based)." }, "chart_label": { "type": "string", "nullable": true, "description": "Label of the chart the app is part of (e.g. \"top grossing productivity\")." }, "num_ratings": { "type": "integer", "nullable": true, "description": "Total number of user ratings." }, "num_reviews": { "type": "integer", "nullable": true, "description": "Total number of user reviews." }, "app_category": { "type": "string", "nullable": true, "description": "Human-readable Google Play category of the app." }, "contains_ads": { "type": "boolean", "nullable": true, "description": "Whether the app contains ads." }, "app_developer": { "type": "string", "description": "Developer / publisher name." }, "app_page_link": { "type": "string", "description": "Canonical Google Play URL of the app." }, "num_downloads": { "type": "string", "nullable": true, "description": "Approximate install count as displayed on the Play Store (e.g. \"1,000,000,000+\")." }, "price_currency": { "type": "string", "nullable": true, "description": "ISO 4217 currency code of `price`. Null for free apps." }, "app_category_id": { "type": "string", "nullable": true, "description": "Google Play category id (uppercase machine code, e.g. PRODUCTIVITY, GAME_ADVENTURE)." }, "app_description": { "type": "string", "nullable": true, "description": "Full app description text from the Play Store listing." }, "app_permissions": { "type": "array", "items": { "type": "string", "description": "Permission description." }, "nullable": true, "description": "Android permissions requested by the app." }, "current_version": { "type": "string", "nullable": true, "description": "Current version string of the app, when surfaced by the Play Store." }, "app_content_rating": { "type": "string", "nullable": true, "description": "Content rating label (e.g. Everyone, Teen, Mature)." }, "reviews_per_rating": { "type": "object", "nullable": true, "properties": { "1": { "type": "integer", "description": "Number of 1-star ratings." }, "2": { "type": "integer", "description": "Number of 2-star ratings." }, "3": { "type": "integer", "description": "Number of 3-star ratings." }, "4": { "type": "integer", "description": "Number of 4-star ratings." }, "5": { "type": "integer", "description": "Number of 5-star ratings." } }, "description": "Count of ratings per star bucket (keys '1'..'5')." }, "security_practices": { "type": "array", "items": { "type": "string", "description": "Security practice." }, "nullable": true, "description": "Data Safety section: security practices declared by the developer." }, "app_developer_email": { "type": "string", "nullable": true, "description": "Developer's contact email." }, "max_android_version": { "type": "string", "nullable": true, "description": "Maximum Android version the app supports, when declared." }, "min_android_version": { "type": "string", "nullable": true, "description": "Minimum Android version the app supports." }, "num_downloads_exact": { "type": "integer", "nullable": true, "description": "Exact install count when available." }, "privacy_policy_link": { "type": "string", "nullable": true, "description": "URL of the developer's privacy policy." }, "app_developer_website": { "type": "string", "nullable": true, "description": "Developer's website URL." }, "max_android_api_level": { "type": "integer", "nullable": true, "description": "Maximum Android API level the app supports, when declared." }, "min_android_api_level": { "type": "integer", "nullable": true, "description": "Minimum Android API level the app supports." }, "app_updated_at_timestamp": { "type": "integer", "nullable": true, "description": "Unix timestamp (seconds) of the last app update on the Play Store." }, "current_version_whatsnew": { "type": "string", "nullable": true, "description": "\"What's new\" notes for the current version." }, "data_shared_by_app_and_why": { "type": "object", "nullable": true, "description": "Data Safety section: data the app shares, grouped by data category. Keys are category names; values map field name to comma-separated purposes.", "additionalProperties": true }, "app_updated_at_datetime_utc": { "type": "string", "nullable": true, "description": "ISO 8601 UTC datetime of the last app update." }, "data_collected_by_app_and_why": { "type": "object", "nullable": true, "description": "Data Safety section: data the app collects, grouped by data category. Keys are category names; values map field name to comma-separated purposes.", "additionalProperties": true }, "app_first_released_at_timestamp": { "type": "integer", "nullable": true, "description": "Unix timestamp (seconds) of the first release of the app." }, "app_first_released_at_datetime_utc": { "type": "string", "nullable": true, "description": "ISO 8601 UTC datetime of the first release of the app." }, "current_version_released_at_timestamp": { "type": "integer", "nullable": true, "description": "Unix timestamp (seconds) of the current version release, when surfaced." }, "current_version_released_at_datetime_utc": { "type": "string", "nullable": true, "description": "ISO 8601 UTC datetime of the current version release, when surfaced." } } }, "description": "Array of top-free apps for the requested country/category." }, "status": { "type": "string", "description": "The status of the response" }, "request_id": { "type": "string", "description": "A unique identifier for the request" } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "category", "schema": { "type": "string" }, "description": "Get the chart in a specific Google Play category (e.g. SOCIAL)." }, { "in": "query", "name": "limit", "schema": { "type": "integer", "default": 50, "maximum": 200, "minimum": 1 }, "description": "Limit the number of results. \n\n **Note:** requests with a limit value between 101-200 will be charged double (2 requests)." }, { "in": "query", "name": "region", "schema": { "type": "string", "default": "US" }, "description": "The country code of country/region to use, specified as a 2-letter country code - see ISO 3166-1 alpha-2." }, { "in": "query", "name": "language", "schema": { "type": "string", "default": "EN" }, "description": "The language to use, specified as a 2-letter language code - see ISO 639-1 alpha-2." } ], "description": "Top free apps chart. Supports getting the chart for specific Google Play categories.", "operationId": "play_store_apps__get__top_free_apps", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing response schema" ], "pages": [], "sourceId": "sds_1IfgtOxqP1q4cHvJ7VyPY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_mb4oPKVX4C1sgk5EHzdxz" }, { "gaps": [ "Missing response schema." ], "pages": [], "sourceId": "sds_72qMF9r94Nlws9PyhMdQm", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_Y4vhW7SNsmRcmxb4fXsm8" }, { "gaps": [ "No documentation provided for response schema." ], "pages": [], "sourceId": "sds_qhTee9rhe4IsP9VM8R0Jx", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_n1Qua5iIILpqbVggnqZhR" }, { "gaps": [ "No documentation provided for parameters or response schema." ], "pages": [], "sourceId": "sds_rT9_GyymiamliAo644CKz", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_PfyiCRgYUBzYaNQGBu0of" }, { "gaps": [ "Missing limit or category parameters." ], "pages": [ 1 ], "sourceId": "sds_t1I2lol_F5DgGpe13n3Xt", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_OBuPoRSMenxSJ1CM3zwbN" }, { "gaps": [ "Missing response schema" ], "pages": [ 1 ], "sourceId": "sds_wvqPOTBJ3ELhy96dsub_l", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_f7m9IOfd1EwYpLs8JZOMM" } ], "x-zeroclick-services": [ "play-store-apps" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "play-store-apps", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "play-store-apps", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/play-store-apps/top-free-games": { "get": { "summary": "Top Free Games", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "required": [ "app_id", "app_name", "app_developer", "app_page_link" ], "properties": { "price": { "type": "number", "nullable": true, "description": "Listed price in the regional currency (0 for free apps)." }, "app_id": { "type": "string", "description": "Google Play package id of the app." }, "photos": { "type": "array", "items": { "type": "string", "description": "Screenshot URL." }, "nullable": true, "description": "Screenshot image URLs from the Play Store listing." }, "rating": { "type": "number", "nullable": true, "description": "Average user rating (0–5)." }, "is_paid": { "type": "boolean", "nullable": true, "description": "Whether the app is paid (true) or free (false)." }, "trailer": { "type": "string", "nullable": true, "description": "URL of the app's video trailer, when available." }, "app_icon": { "type": "string", "nullable": true, "description": "URL of the app's icon image." }, "app_name": { "type": "string", "description": "Display name of the app." }, "chart_rank": { "type": "integer", "nullable": true, "description": "Position of the app in the chart (1-based)." }, "chart_label": { "type": "string", "nullable": true, "description": "Label of the chart the app is part of (e.g. \"top grossing productivity\")." }, "num_ratings": { "type": "integer", "nullable": true, "description": "Total number of user ratings." }, "num_reviews": { "type": "integer", "nullable": true, "description": "Total number of user reviews." }, "app_category": { "type": "string", "nullable": true, "description": "Human-readable Google Play category of the app." }, "contains_ads": { "type": "boolean", "nullable": true, "description": "Whether the app contains ads." }, "app_developer": { "type": "string", "description": "Developer / publisher name." }, "app_page_link": { "type": "string", "description": "Canonical Google Play URL of the app." }, "num_downloads": { "type": "string", "nullable": true, "description": "Approximate install count as displayed on the Play Store (e.g. \"1,000,000,000+\")." }, "price_currency": { "type": "string", "nullable": true, "description": "ISO 4217 currency code of `price`. Null for free apps." }, "app_category_id": { "type": "string", "nullable": true, "description": "Google Play category id (uppercase machine code, e.g. PRODUCTIVITY, GAME_ADVENTURE)." }, "app_description": { "type": "string", "nullable": true, "description": "Full app description text from the Play Store listing." }, "app_permissions": { "type": "array", "items": { "type": "string", "description": "Permission description." }, "nullable": true, "description": "Android permissions requested by the app." }, "current_version": { "type": "string", "nullable": true, "description": "Current version string of the app, when surfaced by the Play Store." }, "app_content_rating": { "type": "string", "nullable": true, "description": "Content rating label (e.g. Everyone, Teen, Mature)." }, "reviews_per_rating": { "type": "object", "nullable": true, "properties": { "1": { "type": "integer", "description": "Number of 1-star ratings." }, "2": { "type": "integer", "description": "Number of 2-star ratings." }, "3": { "type": "integer", "description": "Number of 3-star ratings." }, "4": { "type": "integer", "description": "Number of 4-star ratings." }, "5": { "type": "integer", "description": "Number of 5-star ratings." } }, "description": "Count of ratings per star bucket (keys '1'..'5')." }, "security_practices": { "type": "array", "items": { "type": "string", "description": "Security practice." }, "nullable": true, "description": "Data Safety section: security practices declared by the developer." }, "app_developer_email": { "type": "string", "nullable": true, "description": "Developer's contact email." }, "max_android_version": { "type": "string", "nullable": true, "description": "Maximum Android version the app supports, when declared." }, "min_android_version": { "type": "string", "nullable": true, "description": "Minimum Android version the app supports." }, "num_downloads_exact": { "type": "integer", "nullable": true, "description": "Exact install count when available." }, "privacy_policy_link": { "type": "string", "nullable": true, "description": "URL of the developer's privacy policy." }, "app_developer_website": { "type": "string", "nullable": true, "description": "Developer's website URL." }, "max_android_api_level": { "type": "integer", "nullable": true, "description": "Maximum Android API level the app supports, when declared." }, "min_android_api_level": { "type": "integer", "nullable": true, "description": "Minimum Android API level the app supports." }, "app_updated_at_timestamp": { "type": "integer", "nullable": true, "description": "Unix timestamp (seconds) of the last app update on the Play Store." }, "current_version_whatsnew": { "type": "string", "nullable": true, "description": "\"What's new\" notes for the current version." }, "data_shared_by_app_and_why": { "type": "object", "nullable": true, "description": "Data Safety section: data the app shares, grouped by data category. Keys are category names; values map field name to comma-separated purposes.", "additionalProperties": true }, "app_updated_at_datetime_utc": { "type": "string", "nullable": true, "description": "ISO 8601 UTC datetime of the last app update." }, "data_collected_by_app_and_why": { "type": "object", "nullable": true, "description": "Data Safety section: data the app collects, grouped by data category. Keys are category names; values map field name to comma-separated purposes.", "additionalProperties": true }, "app_first_released_at_timestamp": { "type": "integer", "nullable": true, "description": "Unix timestamp (seconds) of the first release of the app." }, "app_first_released_at_datetime_utc": { "type": "string", "nullable": true, "description": "ISO 8601 UTC datetime of the first release of the app." }, "current_version_released_at_timestamp": { "type": "integer", "nullable": true, "description": "Unix timestamp (seconds) of the current version release, when surfaced." }, "current_version_released_at_datetime_utc": { "type": "string", "nullable": true, "description": "ISO 8601 UTC datetime of the current version release, when surfaced." } } }, "description": "Array of top-free games for the requested country/category." }, "status": { "type": "string", "description": "The status of the response" }, "request_id": { "type": "string", "description": "A unique identifier for the request" } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "category", "schema": { "type": "string" }, "description": "Get the chart in a specific Google Play category (e.g. SOCIAL)." }, { "in": "query", "name": "limit", "schema": { "type": "integer", "default": 50, "maximum": 200, "minimum": 1 }, "description": "Limit the number of results. \n\n **Note:** requests with a limit value between 101-200 will be charged double (2 requests)." }, { "in": "query", "name": "region", "schema": { "type": "integer", "default": "US" }, "description": "The country code of country/region to use, specified as a 2-letter country code - see ISO 3166-1 alpha-2." }, { "in": "query", "name": "language", "schema": { "type": "string", "default": "EN" }, "description": "The language to use, specified as a 2-letter language code - see ISO 639-1 alpha-2." } ], "description": "Top free games chart. Supports getting the chart for specific Google Play categories.", "operationId": "play_store_apps__get__top_free_games", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing response schema" ], "pages": [], "sourceId": "sds_1IfgtOxqP1q4cHvJ7VyPY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_mb4oPKVX4C1sgk5EHzdxz" }, { "gaps": [ "Missing response schema." ], "pages": [], "sourceId": "sds_72qMF9r94Nlws9PyhMdQm", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_Y4vhW7SNsmRcmxb4fXsm8" }, { "gaps": [ "No documentation provided for response schema." ], "pages": [], "sourceId": "sds_qhTee9rhe4IsP9VM8R0Jx", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_n1Qua5iIILpqbVggnqZhR" }, { "gaps": [ "No documentation provided for parameters or response schema." ], "pages": [], "sourceId": "sds_rT9_GyymiamliAo644CKz", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_PfyiCRgYUBzYaNQGBu0of" }, { "gaps": [ "Missing limit parameters." ], "pages": [ 1 ], "sourceId": "sds_t1I2lol_F5DgGpe13n3Xt", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_OBuPoRSMenxSJ1CM3zwbN" }, { "gaps": [ "Missing response schema" ], "pages": [ 1 ], "sourceId": "sds_wvqPOTBJ3ELhy96dsub_l", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_f7m9IOfd1EwYpLs8JZOMM" } ], "x-zeroclick-services": [ "play-store-apps" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "play-store-apps", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "play-store-apps", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/play-store-apps/top-grossing-apps": { "get": { "summary": "Top Grossing Apps", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "required": [ "app_id", "app_name", "app_developer", "app_page_link" ], "properties": { "price": { "type": "number", "nullable": true, "description": "Listed price in the regional currency (0 for free apps)." }, "app_id": { "type": "string", "description": "Google Play package id of the app." }, "photos": { "type": "array", "items": { "type": "string", "description": "Screenshot URL." }, "nullable": true, "description": "Screenshot image URLs from the Play Store listing." }, "rating": { "type": "number", "nullable": true, "description": "Average user rating (0–5)." }, "is_paid": { "type": "boolean", "nullable": true, "description": "Whether the app is paid (true) or free (false)." }, "trailer": { "type": "string", "nullable": true, "description": "URL of the app's video trailer, when available." }, "app_icon": { "type": "string", "nullable": true, "description": "URL of the app's icon image." }, "app_name": { "type": "string", "description": "Display name of the app." }, "chart_rank": { "type": "integer", "nullable": true, "description": "Position of the app in the chart (1-based)." }, "chart_label": { "type": "string", "nullable": true, "description": "Label of the chart the app is part of (e.g. \"top grossing productivity\")." }, "num_ratings": { "type": "integer", "nullable": true, "description": "Total number of user ratings." }, "num_reviews": { "type": "integer", "nullable": true, "description": "Total number of user reviews." }, "app_category": { "type": "string", "nullable": true, "description": "Human-readable Google Play category of the app." }, "contains_ads": { "type": "boolean", "nullable": true, "description": "Whether the app contains ads." }, "app_developer": { "type": "string", "description": "Developer / publisher name." }, "app_page_link": { "type": "string", "description": "Canonical Google Play URL of the app." }, "num_downloads": { "type": "string", "nullable": true, "description": "Approximate install count as displayed on the Play Store (e.g. \"1,000,000,000+\")." }, "price_currency": { "type": "string", "nullable": true, "description": "ISO 4217 currency code of `price`. Null for free apps." }, "app_category_id": { "type": "string", "nullable": true, "description": "Google Play category id (uppercase machine code, e.g. PRODUCTIVITY, GAME_ADVENTURE)." }, "app_description": { "type": "string", "nullable": true, "description": "Full app description text from the Play Store listing." }, "app_permissions": { "type": "array", "items": { "type": "string", "description": "Permission description." }, "nullable": true, "description": "Android permissions requested by the app." }, "current_version": { "type": "string", "nullable": true, "description": "Current version string of the app, when surfaced by the Play Store." }, "app_content_rating": { "type": "string", "nullable": true, "description": "Content rating label (e.g. Everyone, Teen, Mature)." }, "reviews_per_rating": { "type": "object", "nullable": true, "properties": { "1": { "type": "integer", "description": "Number of 1-star ratings." }, "2": { "type": "integer", "description": "Number of 2-star ratings." }, "3": { "type": "integer", "description": "Number of 3-star ratings." }, "4": { "type": "integer", "description": "Number of 4-star ratings." }, "5": { "type": "integer", "description": "Number of 5-star ratings." } }, "description": "Count of ratings per star bucket (keys '1'..'5')." }, "security_practices": { "type": "array", "items": { "type": "string", "description": "Security practice." }, "nullable": true, "description": "Data Safety section: security practices declared by the developer." }, "app_developer_email": { "type": "string", "nullable": true, "description": "Developer's contact email." }, "max_android_version": { "type": "string", "nullable": true, "description": "Maximum Android version the app supports, when declared." }, "min_android_version": { "type": "string", "nullable": true, "description": "Minimum Android version the app supports." }, "num_downloads_exact": { "type": "integer", "nullable": true, "description": "Exact install count when available." }, "privacy_policy_link": { "type": "string", "nullable": true, "description": "URL of the developer's privacy policy." }, "app_developer_website": { "type": "string", "nullable": true, "description": "Developer's website URL." }, "max_android_api_level": { "type": "integer", "nullable": true, "description": "Maximum Android API level the app supports, when declared." }, "min_android_api_level": { "type": "integer", "nullable": true, "description": "Minimum Android API level the app supports." }, "app_updated_at_timestamp": { "type": "integer", "nullable": true, "description": "Unix timestamp (seconds) of the last app update on the Play Store." }, "current_version_whatsnew": { "type": "string", "nullable": true, "description": "\"What's new\" notes for the current version." }, "data_shared_by_app_and_why": { "type": "object", "nullable": true, "description": "Data Safety section: data the app shares, grouped by data category. Keys are category names; values map field name to comma-separated purposes.", "additionalProperties": true }, "app_updated_at_datetime_utc": { "type": "string", "nullable": true, "description": "ISO 8601 UTC datetime of the last app update." }, "data_collected_by_app_and_why": { "type": "object", "nullable": true, "description": "Data Safety section: data the app collects, grouped by data category. Keys are category names; values map field name to comma-separated purposes.", "additionalProperties": true }, "app_first_released_at_timestamp": { "type": "integer", "nullable": true, "description": "Unix timestamp (seconds) of the first release of the app." }, "app_first_released_at_datetime_utc": { "type": "string", "nullable": true, "description": "ISO 8601 UTC datetime of the first release of the app." }, "current_version_released_at_timestamp": { "type": "integer", "nullable": true, "description": "Unix timestamp (seconds) of the current version release, when surfaced." }, "current_version_released_at_datetime_utc": { "type": "string", "nullable": true, "description": "ISO 8601 UTC datetime of the current version release, when surfaced." } } }, "description": "Array of top-grossing apps for the requested country/category." }, "status": { "type": "string", "description": "The status of the response." }, "request_id": { "type": "string", "description": "A unique identifier for the request." } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "category", "schema": { "type": "string" }, "description": "Get the chart in a specific Google Play category (e.g. SOCIAL)." }, { "in": "query", "name": "limit", "schema": { "type": "integer", "default": 50, "maximum": 200, "minimum": 1 }, "description": "Limit the number of results. \n\n **Note:** requests with a limit value between 101-200 will be charged double (2 requests)." }, { "in": "query", "name": "region", "schema": { "type": "string", "default": "US" }, "description": "The country code of country/region to use, specified as a 2-letter country code - see ISO 3166-1 alpha-2." }, { "in": "query", "name": "language", "schema": { "type": "string", "default": "EN" }, "description": "The language to use, specified as a 2-letter language code - see ISO 639-1 alpha-2." } ], "description": "Top grossing apps chart. Supports getting the chart for specific Google Play categories.", "operationId": "play_store_apps__get__top_grossing_apps", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing response schema" ], "pages": [], "sourceId": "sds_1IfgtOxqP1q4cHvJ7VyPY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_mb4oPKVX4C1sgk5EHzdxz" }, { "gaps": [ "Missing response schema." ], "pages": [], "sourceId": "sds_72qMF9r94Nlws9PyhMdQm", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_Y4vhW7SNsmRcmxb4fXsm8" }, { "gaps": [ "No documentation provided for response schema." ], "pages": [], "sourceId": "sds_qhTee9rhe4IsP9VM8R0Jx", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_n1Qua5iIILpqbVggnqZhR" }, { "gaps": [ "No documentation provided for parameters or response schema." ], "pages": [], "sourceId": "sds_rT9_GyymiamliAo644CKz", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_PfyiCRgYUBzYaNQGBu0of" }, { "gaps": [ "Missing limit parameters." ], "pages": [ 1 ], "sourceId": "sds_t1I2lol_F5DgGpe13n3Xt", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_OBuPoRSMenxSJ1CM3zwbN" }, { "gaps": [ "Missing response schema" ], "pages": [ 1 ], "sourceId": "sds_wvqPOTBJ3ELhy96dsub_l", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_f7m9IOfd1EwYpLs8JZOMM" } ], "x-zeroclick-services": [ "play-store-apps" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "play-store-apps", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "play-store-apps", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/play-store-apps/top-grossing-games": { "get": { "summary": "Top Grossing Games", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "required": [ "app_id", "app_name", "app_developer", "app_page_link" ], "properties": { "price": { "type": "number", "nullable": true, "description": "Listed price in the regional currency (0 for free apps)." }, "app_id": { "type": "string", "description": "Google Play package id of the app." }, "photos": { "type": "array", "items": { "type": "string", "description": "Screenshot URL." }, "nullable": true, "description": "Screenshot image URLs from the Play Store listing." }, "rating": { "type": "number", "nullable": true, "description": "Average user rating (0–5)." }, "is_paid": { "type": "boolean", "nullable": true, "description": "Whether the app is paid (true) or free (false)." }, "trailer": { "type": "string", "nullable": true, "description": "URL of the app's video trailer, when available." }, "app_icon": { "type": "string", "nullable": true, "description": "URL of the app's icon image." }, "app_name": { "type": "string", "description": "Display name of the app." }, "chart_rank": { "type": "integer", "nullable": true, "description": "Position of the app in the chart (1-based)." }, "chart_label": { "type": "string", "nullable": true, "description": "Label of the chart the app is part of (e.g. \"top grossing productivity\")." }, "num_ratings": { "type": "integer", "nullable": true, "description": "Total number of user ratings." }, "num_reviews": { "type": "integer", "nullable": true, "description": "Total number of user reviews." }, "app_category": { "type": "string", "nullable": true, "description": "Human-readable Google Play category of the app." }, "contains_ads": { "type": "boolean", "nullable": true, "description": "Whether the app contains ads." }, "app_developer": { "type": "string", "description": "Developer / publisher name." }, "app_page_link": { "type": "string", "description": "Canonical Google Play URL of the app." }, "num_downloads": { "type": "string", "nullable": true, "description": "Approximate install count as displayed on the Play Store (e.g. \"1,000,000,000+\")." }, "price_currency": { "type": "string", "nullable": true, "description": "ISO 4217 currency code of `price`. Null for free apps." }, "app_category_id": { "type": "string", "nullable": true, "description": "Google Play category id (uppercase machine code, e.g. PRODUCTIVITY, GAME_ADVENTURE)." }, "app_description": { "type": "string", "nullable": true, "description": "Full app description text from the Play Store listing." }, "app_permissions": { "type": "array", "items": { "type": "string", "description": "Permission description." }, "nullable": true, "description": "Android permissions requested by the app." }, "current_version": { "type": "string", "nullable": true, "description": "Current version string of the app, when surfaced by the Play Store." }, "app_content_rating": { "type": "string", "nullable": true, "description": "Content rating label (e.g. Everyone, Teen, Mature)." }, "reviews_per_rating": { "type": "object", "nullable": true, "properties": { "1": { "type": "integer", "description": "Number of 1-star ratings." }, "2": { "type": "integer", "description": "Number of 2-star ratings." }, "3": { "type": "integer", "description": "Number of 3-star ratings." }, "4": { "type": "integer", "description": "Number of 4-star ratings." }, "5": { "type": "integer", "description": "Number of 5-star ratings." } }, "description": "Count of ratings per star bucket (keys '1'..'5')." }, "security_practices": { "type": "array", "items": { "type": "string", "description": "Security practice." }, "nullable": true, "description": "Data Safety section: security practices declared by the developer." }, "app_developer_email": { "type": "string", "nullable": true, "description": "Developer's contact email." }, "max_android_version": { "type": "string", "nullable": true, "description": "Maximum Android version the app supports, when declared." }, "min_android_version": { "type": "string", "nullable": true, "description": "Minimum Android version the app supports." }, "num_downloads_exact": { "type": "integer", "nullable": true, "description": "Exact install count when available." }, "privacy_policy_link": { "type": "string", "nullable": true, "description": "URL of the developer's privacy policy." }, "app_developer_website": { "type": "string", "nullable": true, "description": "Developer's website URL." }, "max_android_api_level": { "type": "integer", "nullable": true, "description": "Maximum Android API level the app supports, when declared." }, "min_android_api_level": { "type": "integer", "nullable": true, "description": "Minimum Android API level the app supports." }, "app_updated_at_timestamp": { "type": "integer", "nullable": true, "description": "Unix timestamp (seconds) of the last app update on the Play Store." }, "current_version_whatsnew": { "type": "string", "nullable": true, "description": "\"What's new\" notes for the current version." }, "data_shared_by_app_and_why": { "type": "object", "nullable": true, "description": "Data Safety section: data the app shares, grouped by data category. Keys are category names; values map field name to comma-separated purposes.", "additionalProperties": true }, "app_updated_at_datetime_utc": { "type": "string", "nullable": true, "description": "ISO 8601 UTC datetime of the last app update." }, "data_collected_by_app_and_why": { "type": "object", "nullable": true, "description": "Data Safety section: data the app collects, grouped by data category. Keys are category names; values map field name to comma-separated purposes.", "additionalProperties": true }, "app_first_released_at_timestamp": { "type": "integer", "nullable": true, "description": "Unix timestamp (seconds) of the first release of the app." }, "app_first_released_at_datetime_utc": { "type": "string", "nullable": true, "description": "ISO 8601 UTC datetime of the first release of the app." }, "current_version_released_at_timestamp": { "type": "integer", "nullable": true, "description": "Unix timestamp (seconds) of the current version release, when surfaced." }, "current_version_released_at_datetime_utc": { "type": "string", "nullable": true, "description": "ISO 8601 UTC datetime of the current version release, when surfaced." } } }, "description": "Array of top-grossing games for the requested country/category." }, "status": { "type": "string", "description": "The status of the response" }, "request_id": { "type": "string", "description": "A unique identifier for the request" } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "category", "schema": { "type": "string" }, "description": "Get the chart in a specific Google Play category (e.g. SOCIAL)." }, { "in": "query", "name": "limit", "schema": { "type": "integer", "default": 50, "maximum": 200, "minimum": 1 }, "description": "Limit the number of results. \n\n **Note:** requests with a limit value between 101-200 will be charged double (2 requests)." }, { "in": "query", "name": "region", "schema": { "type": "integer", "default": "US" }, "description": "The country code of country/region to use, specified as a 2-letter country code - see ISO 3166-1 alpha-2." }, { "in": "query", "name": "language", "schema": { "type": "string", "default": "EN" }, "description": "The language to use, specified as a 2-letter language code - see ISO 639-1 alpha-2." } ], "description": "Top grossing games chart. Supports getting the chart for specific Google Play categories.", "operationId": "play_store_apps__get__top_grossing_games", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing response schema" ], "pages": [], "sourceId": "sds_1IfgtOxqP1q4cHvJ7VyPY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_mb4oPKVX4C1sgk5EHzdxz" }, { "gaps": [ "Missing response schema." ], "pages": [], "sourceId": "sds_72qMF9r94Nlws9PyhMdQm", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_Y4vhW7SNsmRcmxb4fXsm8" }, { "gaps": [ "No documentation provided for response schema." ], "pages": [], "sourceId": "sds_qhTee9rhe4IsP9VM8R0Jx", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_n1Qua5iIILpqbVggnqZhR" }, { "gaps": [ "No documentation provided for parameters or response schema." ], "pages": [], "sourceId": "sds_rT9_GyymiamliAo644CKz", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_PfyiCRgYUBzYaNQGBu0of" }, { "gaps": [ "Missing limit parameters." ], "pages": [ 1 ], "sourceId": "sds_t1I2lol_F5DgGpe13n3Xt", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_OBuPoRSMenxSJ1CM3zwbN" }, { "gaps": [ "Missing response schema" ], "pages": [ 1 ], "sourceId": "sds_wvqPOTBJ3ELhy96dsub_l", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_f7m9IOfd1EwYpLs8JZOMM" } ], "x-zeroclick-services": [ "play-store-apps" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "play-store-apps", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "play-store-apps", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/play-store-apps/top-paid-apps": { "get": { "summary": "Top Paid Apps", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "required": [ "app_id", "app_name", "app_developer", "app_page_link" ], "properties": { "price": { "type": "number", "nullable": true, "description": "Listed price in the regional currency (0 for free apps)." }, "app_id": { "type": "string", "description": "Google Play package id of the app." }, "photos": { "type": "array", "items": { "type": "string", "description": "Screenshot URL." }, "nullable": true, "description": "Screenshot image URLs from the Play Store listing." }, "rating": { "type": "number", "nullable": true, "description": "Average user rating (0–5)." }, "is_paid": { "type": "boolean", "nullable": true, "description": "Whether the app is paid (true) or free (false)." }, "trailer": { "type": "string", "nullable": true, "description": "URL of the app's video trailer, when available." }, "app_icon": { "type": "string", "nullable": true, "description": "URL of the app's icon image." }, "app_name": { "type": "string", "description": "Display name of the app." }, "chart_rank": { "type": "integer", "nullable": true, "description": "Position of the app in the chart (1-based)." }, "chart_label": { "type": "string", "nullable": true, "description": "Label of the chart the app is part of (e.g. \"top grossing productivity\")." }, "num_ratings": { "type": "integer", "nullable": true, "description": "Total number of user ratings." }, "num_reviews": { "type": "integer", "nullable": true, "description": "Total number of user reviews." }, "app_category": { "type": "string", "nullable": true, "description": "Human-readable Google Play category of the app." }, "contains_ads": { "type": "boolean", "nullable": true, "description": "Whether the app contains ads." }, "app_developer": { "type": "string", "description": "Developer / publisher name." }, "app_page_link": { "type": "string", "description": "Canonical Google Play URL of the app." }, "num_downloads": { "type": "string", "nullable": true, "description": "Approximate install count as displayed on the Play Store (e.g. \"1,000,000,000+\")." }, "price_currency": { "type": "string", "nullable": true, "description": "ISO 4217 currency code of `price`. Null for free apps." }, "app_category_id": { "type": "string", "nullable": true, "description": "Google Play category id (uppercase machine code, e.g. PRODUCTIVITY, GAME_ADVENTURE)." }, "app_description": { "type": "string", "nullable": true, "description": "Full app description text from the Play Store listing." }, "app_permissions": { "type": "array", "items": { "type": "string", "description": "Permission description." }, "nullable": true, "description": "Android permissions requested by the app." }, "current_version": { "type": "string", "nullable": true, "description": "Current version string of the app, when surfaced by the Play Store." }, "app_content_rating": { "type": "string", "nullable": true, "description": "Content rating label (e.g. Everyone, Teen, Mature)." }, "reviews_per_rating": { "type": "object", "nullable": true, "properties": { "1": { "type": "integer", "description": "Number of 1-star ratings." }, "2": { "type": "integer", "description": "Number of 2-star ratings." }, "3": { "type": "integer", "description": "Number of 3-star ratings." }, "4": { "type": "integer", "description": "Number of 4-star ratings." }, "5": { "type": "integer", "description": "Number of 5-star ratings." } }, "description": "Count of ratings per star bucket (keys '1'..'5')." }, "security_practices": { "type": "array", "items": { "type": "string", "description": "Security practice." }, "nullable": true, "description": "Data Safety section: security practices declared by the developer." }, "app_developer_email": { "type": "string", "nullable": true, "description": "Developer's contact email." }, "max_android_version": { "type": "string", "nullable": true, "description": "Maximum Android version the app supports, when declared." }, "min_android_version": { "type": "string", "nullable": true, "description": "Minimum Android version the app supports." }, "num_downloads_exact": { "type": "integer", "nullable": true, "description": "Exact install count when available." }, "privacy_policy_link": { "type": "string", "nullable": true, "description": "URL of the developer's privacy policy." }, "app_developer_website": { "type": "string", "nullable": true, "description": "Developer's website URL." }, "max_android_api_level": { "type": "integer", "nullable": true, "description": "Maximum Android API level the app supports, when declared." }, "min_android_api_level": { "type": "integer", "nullable": true, "description": "Minimum Android API level the app supports." }, "app_updated_at_timestamp": { "type": "integer", "nullable": true, "description": "Unix timestamp (seconds) of the last app update on the Play Store." }, "current_version_whatsnew": { "type": "string", "nullable": true, "description": "\"What's new\" notes for the current version." }, "data_shared_by_app_and_why": { "type": "object", "nullable": true, "description": "Data Safety section: data the app shares, grouped by data category. Keys are category names; values map field name to comma-separated purposes.", "additionalProperties": true }, "app_updated_at_datetime_utc": { "type": "string", "nullable": true, "description": "ISO 8601 UTC datetime of the last app update." }, "data_collected_by_app_and_why": { "type": "object", "nullable": true, "description": "Data Safety section: data the app collects, grouped by data category. Keys are category names; values map field name to comma-separated purposes.", "additionalProperties": true }, "app_first_released_at_timestamp": { "type": "integer", "nullable": true, "description": "Unix timestamp (seconds) of the first release of the app." }, "app_first_released_at_datetime_utc": { "type": "string", "nullable": true, "description": "ISO 8601 UTC datetime of the first release of the app." }, "current_version_released_at_timestamp": { "type": "integer", "nullable": true, "description": "Unix timestamp (seconds) of the current version release, when surfaced." }, "current_version_released_at_datetime_utc": { "type": "string", "nullable": true, "description": "ISO 8601 UTC datetime of the current version release, when surfaced." } } }, "description": "Array of top-paid apps for the requested country/category." }, "status": { "type": "string", "description": "The status of the response" }, "request_id": { "type": "string", "description": "A unique identifier for the request" } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "category", "schema": { "type": "string" }, "description": "Get the chart in a specific Google Play category (e.g. SOCIAL)." }, { "in": "query", "name": "limit", "schema": { "type": "integer", "default": 50, "maximum": 200, "minimum": 1 }, "description": "Limit the number of results. \n\n **Note:** requests with a limit value between 101-200 will be charged double (2 requests)." }, { "in": "query", "name": "region", "schema": { "type": "string", "default": "US" }, "description": "The country code of country/region to use, specified as a 2-letter country code - see ISO 3166-1 alpha-2." }, { "in": "query", "name": "language", "schema": { "type": "string", "default": "EN" }, "description": "The language to use, specified as a 2-letter language code - see ISO 639-1 alpha-2." } ], "description": "Top paid apps chart. Supports getting the chart for specific Google Play categories.", "operationId": "play_store_apps__get__top_paid_apps", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing response schema" ], "pages": [], "sourceId": "sds_1IfgtOxqP1q4cHvJ7VyPY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_mb4oPKVX4C1sgk5EHzdxz" }, { "gaps": [ "Missing response schema." ], "pages": [], "sourceId": "sds_72qMF9r94Nlws9PyhMdQm", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_Y4vhW7SNsmRcmxb4fXsm8" }, { "gaps": [ "No documentation provided for response schema." ], "pages": [], "sourceId": "sds_qhTee9rhe4IsP9VM8R0Jx", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_n1Qua5iIILpqbVggnqZhR" }, { "gaps": [ "No documentation provided for parameters or response schema." ], "pages": [], "sourceId": "sds_rT9_GyymiamliAo644CKz", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_PfyiCRgYUBzYaNQGBu0of" }, { "gaps": [ "Missing limit parameters." ], "pages": [ 1 ], "sourceId": "sds_t1I2lol_F5DgGpe13n3Xt", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_OBuPoRSMenxSJ1CM3zwbN" }, { "gaps": [ "Missing response schema" ], "pages": [ 1 ], "sourceId": "sds_wvqPOTBJ3ELhy96dsub_l", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_f7m9IOfd1EwYpLs8JZOMM" } ], "x-zeroclick-services": [ "play-store-apps" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "play-store-apps", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "play-store-apps", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/play-store-apps/top-paid-games": { "get": { "summary": "Top Paid Games", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "required": [ "app_id", "app_name", "app_developer", "app_page_link" ], "properties": { "price": { "type": "number", "nullable": true, "description": "Listed price in the regional currency (0 for free apps)." }, "app_id": { "type": "string", "description": "Google Play package id of the app." }, "photos": { "type": "array", "items": { "type": "string", "description": "Screenshot URL." }, "nullable": true, "description": "Screenshot image URLs from the Play Store listing." }, "rating": { "type": "number", "nullable": true, "description": "Average user rating (0–5)." }, "is_paid": { "type": "boolean", "nullable": true, "description": "Whether the app is paid (true) or free (false)." }, "trailer": { "type": "string", "nullable": true, "description": "URL of the app's video trailer, when available." }, "app_icon": { "type": "string", "nullable": true, "description": "URL of the app's icon image." }, "app_name": { "type": "string", "description": "Display name of the app." }, "chart_rank": { "type": "integer", "nullable": true, "description": "Position of the app in the chart (1-based)." }, "chart_label": { "type": "string", "nullable": true, "description": "Label of the chart the app is part of (e.g. \"top grossing productivity\")." }, "num_ratings": { "type": "integer", "nullable": true, "description": "Total number of user ratings." }, "num_reviews": { "type": "integer", "nullable": true, "description": "Total number of user reviews." }, "app_category": { "type": "string", "nullable": true, "description": "Human-readable Google Play category of the app." }, "contains_ads": { "type": "boolean", "nullable": true, "description": "Whether the app contains ads." }, "app_developer": { "type": "string", "description": "Developer / publisher name." }, "app_page_link": { "type": "string", "description": "Canonical Google Play URL of the app." }, "num_downloads": { "type": "string", "nullable": true, "description": "Approximate install count as displayed on the Play Store (e.g. \"1,000,000,000+\")." }, "price_currency": { "type": "string", "nullable": true, "description": "ISO 4217 currency code of `price`. Null for free apps." }, "app_category_id": { "type": "string", "nullable": true, "description": "Google Play category id (uppercase machine code, e.g. PRODUCTIVITY, GAME_ADVENTURE)." }, "app_description": { "type": "string", "nullable": true, "description": "Full app description text from the Play Store listing." }, "app_permissions": { "type": "array", "items": { "type": "string", "description": "Permission description." }, "nullable": true, "description": "Android permissions requested by the app." }, "current_version": { "type": "string", "nullable": true, "description": "Current version string of the app, when surfaced by the Play Store." }, "app_content_rating": { "type": "string", "nullable": true, "description": "Content rating label (e.g. Everyone, Teen, Mature)." }, "reviews_per_rating": { "type": "object", "nullable": true, "properties": { "1": { "type": "integer", "description": "Number of 1-star ratings." }, "2": { "type": "integer", "description": "Number of 2-star ratings." }, "3": { "type": "integer", "description": "Number of 3-star ratings." }, "4": { "type": "integer", "description": "Number of 4-star ratings." }, "5": { "type": "integer", "description": "Number of 5-star ratings." } }, "description": "Count of ratings per star bucket (keys '1'..'5')." }, "security_practices": { "type": "array", "items": { "type": "string", "description": "Security practice." }, "nullable": true, "description": "Data Safety section: security practices declared by the developer." }, "app_developer_email": { "type": "string", "nullable": true, "description": "Developer's contact email." }, "max_android_version": { "type": "string", "nullable": true, "description": "Maximum Android version the app supports, when declared." }, "min_android_version": { "type": "string", "nullable": true, "description": "Minimum Android version the app supports." }, "num_downloads_exact": { "type": "integer", "nullable": true, "description": "Exact install count when available." }, "privacy_policy_link": { "type": "string", "nullable": true, "description": "URL of the developer's privacy policy." }, "app_developer_website": { "type": "string", "nullable": true, "description": "Developer's website URL." }, "max_android_api_level": { "type": "integer", "nullable": true, "description": "Maximum Android API level the app supports, when declared." }, "min_android_api_level": { "type": "integer", "nullable": true, "description": "Minimum Android API level the app supports." }, "app_updated_at_timestamp": { "type": "integer", "nullable": true, "description": "Unix timestamp (seconds) of the last app update on the Play Store." }, "current_version_whatsnew": { "type": "string", "nullable": true, "description": "\"What's new\" notes for the current version." }, "data_shared_by_app_and_why": { "type": "object", "nullable": true, "description": "Data Safety section: data the app shares, grouped by data category. Keys are category names; values map field name to comma-separated purposes.", "additionalProperties": true }, "app_updated_at_datetime_utc": { "type": "string", "nullable": true, "description": "ISO 8601 UTC datetime of the last app update." }, "data_collected_by_app_and_why": { "type": "object", "nullable": true, "description": "Data Safety section: data the app collects, grouped by data category. Keys are category names; values map field name to comma-separated purposes.", "additionalProperties": true }, "app_first_released_at_timestamp": { "type": "integer", "nullable": true, "description": "Unix timestamp (seconds) of the first release of the app." }, "app_first_released_at_datetime_utc": { "type": "string", "nullable": true, "description": "ISO 8601 UTC datetime of the first release of the app." }, "current_version_released_at_timestamp": { "type": "integer", "nullable": true, "description": "Unix timestamp (seconds) of the current version release, when surfaced." }, "current_version_released_at_datetime_utc": { "type": "string", "nullable": true, "description": "ISO 8601 UTC datetime of the current version release, when surfaced." } } }, "description": "Array of top-paid games for the requested country/category." }, "status": { "type": "string", "description": "The status of the response." }, "request_id": { "type": "string", "description": "A unique identifier for the request." } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "category", "schema": { "type": "string" }, "description": "Get the chart in a specific Google Play category (e.g. SOCIAL)." }, { "in": "query", "name": "limit", "schema": { "type": "integer", "default": 50, "maximum": 200, "minimum": 1 }, "description": "Limit the number of results. \n\n **Note:** requests with a limit value between 101-200 will be charged double (2 requests)." }, { "in": "query", "name": "region", "schema": { "type": "integer", "default": "US" }, "description": "The country code of country/region to use, specified as a 2-letter country code - see ISO 3166-1 alpha-2." }, { "in": "query", "name": "language", "schema": { "type": "string", "default": "EN" }, "description": "The language to use, specified as a 2-letter language code - see ISO 639-1 alpha-2." } ], "description": "Top paid games chart. Supports getting the chart for specific Google Play categories.", "operationId": "play_store_apps__get__top_paid_games", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing response schema" ], "pages": [], "sourceId": "sds_1IfgtOxqP1q4cHvJ7VyPY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_mb4oPKVX4C1sgk5EHzdxz" }, { "gaps": [ "Missing response schema." ], "pages": [], "sourceId": "sds_72qMF9r94Nlws9PyhMdQm", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_Y4vhW7SNsmRcmxb4fXsm8" }, { "gaps": [ "No documentation provided for response schema." ], "pages": [], "sourceId": "sds_qhTee9rhe4IsP9VM8R0Jx", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_n1Qua5iIILpqbVggnqZhR" }, { "gaps": [ "No documentation provided for parameters or response schema." ], "pages": [], "sourceId": "sds_rT9_GyymiamliAo644CKz", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_PfyiCRgYUBzYaNQGBu0of" }, { "gaps": [ "Missing limit parameters." ], "pages": [ 1 ], "sourceId": "sds_t1I2lol_F5DgGpe13n3Xt", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_OBuPoRSMenxSJ1CM3zwbN" }, { "gaps": [ "Missing response schema" ], "pages": [ 1 ], "sourceId": "sds_wvqPOTBJ3ELhy96dsub_l", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_f7m9IOfd1EwYpLs8JZOMM" } ], "x-zeroclick-services": [ "play-store-apps" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "play-store-apps", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "play-store-apps", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-amazon-data/asin-to-gtin": { "get": { "summary": "ASIN to GTIN", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "asin": { "type": "string", "description": "The Amazon Standard Identification Number (ASIN) of the product." }, "results": { "type": "array", "items": { "type": "object", "properties": { "type": { "enum": [ "EAN-13", "UPC", "ISBN" ], "type": "string", "description": "The type of the identifier, such as ISBN, UPC, or EAN-13." }, "value": { "type": "string", "description": "The value of the identifier (e.g., the actual code)." } } } } } }, "status": { "type": "string", "description": "The status of the response." }, "request_id": { "type": "string", "description": "A unique identifier for the request." } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "asin", "schema": { "type": "string" }, "example": "B01FHOWYA2", "required": true, "description": "Amazon product ASIN to convert." }, { "in": "query", "name": "country", "schema": { "enum": [ "US", "AU", "BR", "CA", "CN", "FR", "DE", "IN", "IT", "MX", "NL", "SG", "ES", "TR", "AE", "GB", "JP", "SA", "PL", "SE", "BE", "EG", "ZA", "IE" ], "type": "string", "default": "US" }, "description": "Sets the Amazon domain, marketplace country, language and currency." } ], "description": "Convert an Amazon ASIN to GTIN / EAN / UPS identifiers. Valid values for type are EAN-13, UPC, or ISBN.", "operationId": "realtime_amazon_data__get__asin_to_gtin", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_5-N-bD-w4FEvDbPufA7rY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_JMX_MdcNKNvBSfEXsR78v" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_D1eKbJ9D0SJoHD3LLOLYI", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_WiAI6D9DA33xLudF2TJIh" } ], "x-zeroclick-services": [ "realtime-amazon-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-amazon-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-amazon-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-amazon-data/best-sellers": { "get": { "summary": "Best Sellers", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "domain": { "type": "string", "description": "Amazon marketplace domain" }, "country": { "type": "string", "description": "Country code for the best sellers list" }, "best_sellers": { "type": "array", "items": { "type": "object", "properties": { "asin": { "type": "string", "description": "Amazon Standard Identification Number" }, "rank": { "type": "integer", "description": "Current ranking position in best sellers list" }, "product_url": { "type": "string", "description": "URL to product page" }, "product_photo": { "type": "string", "description": "URL of main product image" }, "product_price": { "type": "string", "description": "Current price of the product" }, "product_title": { "type": "string", "description": "Title/name of the product" }, "rank_change_label": { "type": "string", "description": "Indicator of rank change from previous period" }, "product_num_ratings": { "type": "integer", "description": "Number of customer ratings" }, "product_star_rating": { "type": "string", "description": "Average customer rating" } } } } } }, "status": { "type": "string", "description": "Status of the API response" }, "request_id": { "type": "string", "description": "Unique identifier for the API request" } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "category", "schema": { "type": "string" }, "example": "software", "required": true, "description": "Best sellers category to return products for. \n Supports top level best sellers categories (e.g. software). \n In addition, subcategories / category path can be specified as well, separated by / (e.g. software/229535) - this can be seen in best sellers URLs, e.g. https://www.amazon.com/Best-Sellers-Software-Business-Office/zgbs/software/229535." }, { "in": "query", "name": "type", "schema": { "enum": [ "BEST_SELLERS", "GIFT_IDEAS", "MOST_WISHED_FOR", "MOVERS_AND_SHAKERS", "NEW_RELEASES" ], "type": "string", "default": "BEST_SELLERS" }, "description": "Type of Best Seller list to return." }, { "in": "query", "name": "page", "schema": { "type": "integer", "default": 1 }, "description": "Page to return." }, { "in": "query", "name": "country", "schema": { "enum": [ "US", "AU", "BR", "CA", "CN", "FR", "DE", "IN", "IT", "MX", "NL", "SG", "ES", "TR", "AE", "GB", "JP", "SA", "PL", "SE", "BE", "EG", "ZA", "IE" ], "type": "string", "default": "US" }, "description": "Sets the Amazon domain, marketplace country, language and currency." }, { "in": "query", "name": "delivery_country", "schema": { "type": "string" }, "example": "NL", "description": "Delivery destination country (ISO 3166-1 alpha-2 code, e.g. `NL`). When set, delivery dates, shipping costs, availability and offers reflect delivery to this country instead of the marketplace's domestic delivery. Defaults to the marketplace country. \n Only specific `country` / `delivery_country` combinations are supported. Currently supported: `country` = `DE`, `FR`, `IT` or `ES` with `delivery_country` = `NL`. \n Other combinations return a 400 error. If you need another combination, contact us at support@openwebninja.com and we will look into adding it." }, { "in": "query", "name": "delivery_zipcode", "schema": { "type": "string" }, "description": "Postal / ZIP code within the `country` marketplace, in its usual format, used as the delivery address so delivery dates, costs, availability and offers reflect it. An invalid zip code returns a 400 error. Cannot be combined with a different `delivery_country`." }, { "in": "query", "name": "language", "schema": { "type": "string" }, "description": "The language of the results. In case not specified, results will be returned in the default domain language. \n\n **Supported languages per country:** \n `US`: en_US, es_US \n `AU`: en_AU \n `BR`: pt_BR \n `CA`: en_CA, fr_CA \n `FR`: fr_FR, en_GB \n `DE`: de_DE, en_GB, cs_CZ, nl_NL, pl_PL, tr_TR, da_DK \n `IN`: en_IN, hi_IN, ta_IN, te_IN, kn_IN, ml_IN, bn_IN, mr_IN \n `IT`: it_IT, en_GB \n `MX`: es_MX \n `NL`: nl_NL, en_GB \n `SG`: en_SG \n `ES`: es_ES, pt_PT, en_GB \n `TR`: tr_TR \n `AE`: en_AE, ar_AE \n `GB`: en_GB \n `JP`: ja_JP, en_US, zh_CN \n `SA`: ar_AE, en_AE \n `PL`: pl_PL \n `SE`: sv_SE, en_GB \n `BE`: fr_BE, nl_BE, en_GB \n `EG`: ar_AE, en_AE \n `ZA`: en_ZA \n `IE`: en_IE " }, { "in": "query", "name": "fields", "schema": { "type": "string" }, "description": "A comma separated list of product fields to include in the response (field projection). \n By default all fields are returned." } ], "description": "Get Amazon Best Sellers, including prices, ratings, rank and more data points available on Amazon Best Sellers listings. \n Supports all Amazon Best Seller list types using the type parameter: \n Best Sellers, New Releases, Movers & Shakers, Most Wished For, Gift Ideas.", "operationId": "realtime_amazon_data__get__best_sellers", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_5-N-bD-w4FEvDbPufA7rY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_JMX_MdcNKNvBSfEXsR78v" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_D1eKbJ9D0SJoHD3LLOLYI", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_WiAI6D9DA33xLudF2TJIh" } ], "x-zeroclick-services": [ "realtime-amazon-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-amazon-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-amazon-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-amazon-data/deal-products": { "get": { "summary": "Deal Products", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "domain": { "type": "string", "description": "Amazon marketplace domain" }, "country": { "type": "string", "description": "Country code for the products" }, "products": { "type": "array", "items": { "type": "object", "properties": { "deal_badge": { "type": "string", "description": "Badge/label for the deal" }, "deal_price": { "type": "string", "description": "Current discounted price" }, "list_price": { "type": "string", "description": "Original price before discount" }, "product_url": { "type": "string", "description": "URL to the product page" }, "product_asin": { "type": "string", "description": "Amazon Standard Identification Number" }, "product_photo": { "type": "string", "description": "URL of the product image" }, "product_title": { "type": "string", "description": "Title/name of the product" }, "additional_info": { "type": "array", "items": { "type": "string" }, "description": "Additional info strings shown on the deal card." }, "savings_percentage": { "type": "string", "description": "Percentage savings from list price" } } } } } }, "status": { "type": "string", "description": "Status of the API response" }, "request_id": { "type": "string", "description": "Unique identifier for the API request" } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "deal_id", "schema": { "type": "string" }, "example": "B08B477BHS", "required": true, "description": "Deal ID of the deal to fetch" }, { "in": "query", "name": "country", "schema": { "enum": [ "US", "AU", "BR", "CA", "CN", "FR", "DE", "IN", "IT", "MX", "NL", "SG", "ES", "TR", "AE", "GB", "JP", "SA", "PL", "SE", "BE", "EG", "ZA", "IE" ], "type": "string", "default": "US" }, "description": "Sets the Amazon domain, marketplace country, language and currency." }, { "in": "query", "name": "delivery_country", "schema": { "type": "string" }, "example": "NL", "description": "Delivery destination country (ISO 3166-1 alpha-2 code, e.g. `NL`). When set, delivery dates, shipping costs, availability and offers reflect delivery to this country instead of the marketplace's domestic delivery. Defaults to the marketplace country. \n Only specific `country` / `delivery_country` combinations are supported. Currently supported: `country` = `DE`, `FR`, `IT` or `ES` with `delivery_country` = `NL`. \n Other combinations return a 400 error. If you need another combination, contact us at support@openwebninja.com and we will look into adding it." }, { "in": "query", "name": "delivery_zipcode", "schema": { "type": "string" }, "description": "Postal / ZIP code within the `country` marketplace, in its usual format, used as the delivery address so delivery dates, costs, availability and offers reflect it. An invalid zip code returns a 400 error. Cannot be combined with a different `delivery_country`." }, { "in": "query", "name": "sort_by", "schema": { "enum": [ "FEATURED", "LOWEST_PRICE", "HIGHEST_PRICE", "REVIEWS", "NEWEST", "BEST_SELLERS" ], "type": "string", "default": "FEATURED" }, "description": "Return products in a specific order. " }, { "in": "query", "name": "page", "schema": { "type": "integer", "default": 1 }, "description": "Results page to return." }, { "in": "query", "name": "language", "schema": { "type": "string" }, "description": "The language of the results. In case not specified, results will be returned in the default domain language. \n\n **Supported languages per country:** \n `US`: en_US, es_US \n `AU`: en_AU \n `BR`: pt_BR \n `CA`: en_CA, fr_CA \n `FR`: fr_FR, en_GB \n `DE`: de_DE, en_GB, cs_CZ, nl_NL, pl_PL, tr_TR, da_DK \n `IN`: en_IN, hi_IN, ta_IN, te_IN, kn_IN, ml_IN, bn_IN, mr_IN \n `IT`: it_IT, en_GB \n `MX`: es_MX \n `NL`: nl_NL, en_GB \n `SG`: en_SG \n `ES`: es_ES, pt_PT, en_GB \n `TR`: tr_TR \n `AE`: en_AE, ar_AE \n `GB`: en_GB \n `JP`: ja_JP, en_US, zh_CN \n `SA`: ar_AE, en_AE \n `PL`: pl_PL \n `SE`: sv_SE, en_GB \n `BE`: fr_BE, nl_BE, en_GB \n `EG`: ar_AE, en_AE \n `ZA`: en_ZA \n `IE`: en_IE " }, { "in": "query", "name": "fields", "schema": { "type": "string" }, "description": "A comma separated list of deal product fields to include in the response (field projection). \n By default all fields are returned." } ], "description": "Get the products of a specific deal by Deal ID. Supports pagination using the page parameter. \n For now, only works for MULTI_ITEM deals with no canonical_deal_url (i.e. when deal_url is in the form of https://amazon_domain/deal/deal_id).", "operationId": "realtime_amazon_data__get__deal_products", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_5-N-bD-w4FEvDbPufA7rY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_JMX_MdcNKNvBSfEXsR78v" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_D1eKbJ9D0SJoHD3LLOLYI", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_WiAI6D9DA33xLudF2TJIh" } ], "x-zeroclick-services": [ "realtime-amazon-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-amazon-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-amazon-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-amazon-data/deals-v2": { "get": { "summary": "Deals", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "deals": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "Type classification of the deal" }, "deal_id": { "type": "string", "description": "Unique identifier for the deal" }, "deal_url": { "type": "string", "description": "URL to the deal page" }, "deal_type": { "type": "string", "description": "Type/category of the deal" }, "deal_badge": { "type": "string", "description": "Badge/label for the deal" }, "deal_photo": { "type": "string", "description": "URL of the deal image" }, "deal_state": { "type": "string", "description": "Current state/status of the deal" }, "deal_title": { "type": "string", "description": "Title/name of the deal" }, "deal_ends_at": { "type": "string", "description": "End timestamp of the deal" }, "product_asin": { "type": "string", "description": "ASIN of the product in deal" }, "deal_starts_at": { "type": "string", "description": "Start timestamp of the deal" }, "canonical_deal_url": { "type": "string", "description": "Canonical URL for the deal" }, "savings_percentage": { "type": "integer", "description": "Percentage discount offered" } } } }, "domain": { "type": "string", "description": "Amazon marketplace domain" }, "country": { "type": "string", "description": "Country code for the deals" }, "total_deals": { "type": "string", "nullable": true, "description": "Total number of deals (null if not available)" } } }, "status": { "type": "string", "description": "Status of the API response" }, "request_id": { "type": "string", "description": "Unique identifier for the API request" } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "country", "schema": { "enum": [ "US", "AU", "BR", "CA", "CN", "FR", "DE", "IN", "IT", "MX", "NL", "SG", "ES", "TR", "AE", "GB", "JP", "SA", "PL", "SE", "BE", "EG", "ZA", "IE" ], "type": "string", "default": "US" }, "description": "Sets the Amazon domain, marketplace country, language and currency." }, { "in": "query", "name": "delivery_country", "schema": { "type": "string" }, "example": "NL", "description": "Delivery destination country (ISO 3166-1 alpha-2 code, e.g. `NL`). When set, delivery dates, shipping costs, availability and offers reflect delivery to this country instead of the marketplace's domestic delivery. Defaults to the marketplace country. \n Only specific `country` / `delivery_country` combinations are supported. Currently supported: `country` = `DE`, `FR`, `IT` or `ES` with `delivery_country` = `NL`. \n Other combinations return a 400 error. If you need another combination, contact us at support@openwebninja.com and we will look into adding it." }, { "in": "query", "name": "delivery_zipcode", "schema": { "type": "string" }, "description": "Postal / ZIP code within the `country` marketplace, in its usual format, used as the delivery address so delivery dates, costs, availability and offers reflect it. An invalid zip code returns a 400 error. Cannot be combined with a different `delivery_country`." }, { "in": "query", "name": "offset", "schema": { "type": "string" }, "description": "Number of results to skip / index to start from (for pagination). Works with multiples of 30 (like on Amazons deals page) - 0, 30, 60, 90, etc." }, { "in": "query", "name": "categories", "schema": { "type": "string" }, "description": "Return deals with products in specific categories / departments. \n Multiple categories can be specified as a comma (,) separated list. \n Numeric category id's can be found in the URL after selecting a specific category on https://www.amazon.com/deals." }, { "in": "query", "name": "min_product_star_rating", "schema": { "enum": [ "ALL", "1", "2", "3", "4" ], "type": "string", "default": "ALL" }, "description": "Return deals with products star rating greater than a specific value" }, { "in": "query", "name": "price_range", "schema": { "enum": [ "ALL", "1", "2", "3", "4", "5" ], "type": "string", "default": "ALL" }, "description": "Return deals with price within a specific price range. \n 1 is lowest price range shown on Amazon (e.g. Under $25) while 5 is the highest price range (e.g. $200 & Above)." }, { "in": "query", "name": "discount_range", "schema": { "enum": [ "ALL", "1", "2", "3", "4", "5" ], "type": "string", "default": "ALL" }, "description": "Return deals with discount within a specific discount range. \n 1 is lowest discount range shown on Amazon (e.g. 10% off or more) while 5 is the highest discount range (e.g. 70% off or more)." }, { "in": "query", "name": "brands", "schema": { "type": "string" }, "description": "Return deals with products by specific brands. \n Multiple brands can be specified separated by comma (,). \n In addition, brand names can be found under the Brand filter on the filter/refinements panel on https://www.amazon.com/deals (when applicable)." }, { "in": "query", "name": "prime_early_access", "schema": { "type": "boolean" }, "description": "Only return prime early access deals." }, { "in": "query", "name": "prime_exclusive", "schema": { "type": "boolean" }, "description": "Only return prime exclusive deals." }, { "in": "query", "name": "lightning_deals", "schema": { "type": "boolean" }, "description": "Only return lightning deals" }, { "in": "query", "name": "language", "schema": { "type": "string" }, "description": "The language of the results. In case not specified, results will be returned in the default domain language. \n\n **Supported languages per country:** \n `US`: en_US, es_US \n `AU`: en_AU \n `BR`: pt_BR \n `CA`: en_CA, fr_CA \n `FR`: fr_FR, en_GB \n `DE`: de_DE, en_GB, cs_CZ, nl_NL, pl_PL, tr_TR, da_DK \n `IN`: en_IN, hi_IN, ta_IN, te_IN, kn_IN, ml_IN, bn_IN, mr_IN \n `IT`: it_IT, en_GB \n `MX`: es_MX \n `NL`: nl_NL, en_GB \n `SG`: en_SG \n `ES`: es_ES, pt_PT, en_GB \n `TR`: tr_TR \n `AE`: en_AE, ar_AE \n `GB`: en_GB \n `JP`: ja_JP, en_US, zh_CN \n `SA`: ar_AE, en_AE \n `PL`: pl_PL \n `SE`: sv_SE, en_GB \n `BE`: fr_BE, nl_BE, en_GB \n `EG`: ar_AE, en_AE \n `ZA`: en_ZA \n `IE`: en_IE " }, { "in": "query", "name": "fields", "schema": { "type": "string" }, "description": "A comma separated list of deal fields to include in the response (field projection). \n By default all fields are returned." } ], "description": "Get Amazon Deals (Today's Deals / Top Deals, Best Deals, and Lightning Deals) with support for all deal types, filters, and options available on Amazon.", "operationId": "realtime_amazon_data__get__deals_v2", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_5-N-bD-w4FEvDbPufA7rY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_JMX_MdcNKNvBSfEXsR78v" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_D1eKbJ9D0SJoHD3LLOLYI", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_WiAI6D9DA33xLudF2TJIh" } ], "x-zeroclick-services": [ "realtime-amazon-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-amazon-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-amazon-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-amazon-data/gtin-to-asin": { "get": { "summary": "GTIN to ASIN", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "products": { "type": "array", "items": { "type": "object", "properties": { "asin": { "type": "string", "description": "Amazon Standard Identification Number (ASIN) of the matched product." }, "product_url": { "type": "string", "description": "Canonical Amazon product URL." }, "product_rank": { "type": "integer", "description": "Sales rank within the rank_category. Null when unavailable." }, "product_photo": { "type": "string", "description": "URL of the main product image." }, "product_price": { "type": "number", "description": "Displayed product price. Null when unavailable." }, "product_title": { "type": "string", "description": "Full product title as shown on Amazon." }, "rank_category": { "type": "string", "description": "Category to which product_rank applies." }, "product_num_ratings": { "type": "integer", "description": "Total number of customer ratings. Null when unavailable." }, "product_star_rating": { "type": "string", "description": "Average customer star rating. Null when unavailable." } } } } } }, "status": { "type": "string", "description": "The status of the response." }, "request_id": { "type": "string", "description": "A unique identifier for the request." } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "product_identifier", "schema": { "type": "string" }, "example": "9780132350884", "required": true, "description": "Product identifier to look up on Amazon. Supports GTIN, EAN-13, UPC, or ISBN." }, { "in": "query", "name": "country", "schema": { "enum": [ "US", "AU", "BR", "CA", "FR", "DE", "IN", "IT", "MX", "NL", "SG", "ES", "TR", "AE", "GB", "JP", "SA", "PL", "SE", "BE", "EG", "ZA", "IE" ], "type": "string", "default": "US" }, "description": "Sets the Amazon store to look the code up in. BE, EG, IE, SA, SE and ZA currently return no match for most codes. CN (Amazon China) is not supported." } ], "description": "Find Amazon products by GTIN, EAN, UPC, or ISBN. Returns a list of matching ASINs along with key product attributes (title, photo, URL, price, rating, rank).", "operationId": "realtime_amazon_data__get__gtin_to_asin", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_5-N-bD-w4FEvDbPufA7rY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_JMX_MdcNKNvBSfEXsR78v" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_D1eKbJ9D0SJoHD3LLOLYI", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_WiAI6D9DA33xLudF2TJIh" } ], "x-zeroclick-services": [ "realtime-amazon-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-amazon-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-amazon-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-amazon-data/influencer-post-products": { "get": { "summary": "Influencer Post Products", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "cursor": { "type": "string", "description": "Pagination token for next page of results" }, "domain": { "type": "string", "description": "Domain associated with the post" }, "country": { "type": "string", "description": "Country associated with the post data" }, "post_id": { "type": "string", "description": "Identifier of the returned post" }, "products": { "type": "array", "items": { "type": "object" }, "description": "Products linked to the influencer post." }, "has_next_page": { "type": "boolean", "description": "Indicates if more results are available" } } }, "status": { "type": "string", "description": "The status of the API response" }, "parameters": { "type": "object", "properties": { "country": { "type": "string", "description": "Country code for the request" }, "post_id": { "type": "string", "description": "Identifier of the requested post" }, "language": { "type": "string", "description": "Language code for the request" } } }, "request_id": { "type": "string", "description": "Unique identifier for the API request" } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "influencer_name", "schema": { "type": "string" }, "example": "madison.lecroy", "required": true }, { "in": "query", "name": "post_id", "schema": { "type": "string" }, "example": "amzn1.ideas.382NVFBNK3GGQ", "required": true, "description": "Influencer Post ID (e.g. amzn1.ideas.1N84PQ3CI4NW0) of the list post for which to get product items (only posts with post_type=List are allowed)." }, { "in": "query", "name": "cursor", "schema": { "type": "string" }, "description": "Set the cursor value from the response of the previous call to get the next results page." }, { "in": "query", "name": "language", "schema": { "type": "string" }, "description": "The language of the results. In case not specified, results will be returned in the default domain language. \n\n **Supported languages per country:** \n `US`: en_US, es_US \n `AU`: en_AU \n `BR`: pt_BR \n `CA`: en_CA, fr_CA \n `FR`: fr_FR, en_GB \n `DE`: de_DE, en_GB, cs_CZ, nl_NL, pl_PL, tr_TR, da_DK \n `IN`: en_IN, hi_IN, ta_IN, te_IN, kn_IN, ml_IN, bn_IN, mr_IN \n `IT`: it_IT, en_GB \n `MX`: es_MX \n `NL`: nl_NL, en_GB \n `SG`: en_SG \n `ES`: es_ES, pt_PT, en_GB \n `TR`: tr_TR \n `AE`: en_AE, ar_AE \n `GB`: en_GB \n `JP`: ja_JP, en_US, zh_CN \n `SA`: ar_AE, en_AE \n `PL`: pl_PL \n `SE`: sv_SE, en_GB \n `BE`: fr_BE, nl_BE, en_GB \n `EG`: ar_AE, en_AE \n `ZA`: en_ZA \n `IE`: en_IE " } ], "description": "Get the list of products related to a \"List\" type post by Post ID.", "operationId": "realtime_amazon_data__get__influencer_post_products", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_5-N-bD-w4FEvDbPufA7rY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_JMX_MdcNKNvBSfEXsR78v" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_D1eKbJ9D0SJoHD3LLOLYI", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_WiAI6D9DA33xLudF2TJIh" } ], "x-zeroclick-services": [ "realtime-amazon-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-amazon-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-amazon-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-amazon-data/influencer-posts": { "get": { "summary": "Influencer Posts", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the influencer" }, "posts": { "type": "array", "items": { "type": "object" }, "description": "List of influencer posts (videos / lists / shoppable content)." }, "cursor": { "type": "string", "description": "Pagination cursor for next page" }, "domain": { "type": "string", "description": "Amazon marketplace domain" }, "country": { "type": "string", "description": "Country associated with the influencer" }, "has_next_page": { "type": "boolean", "description": "Indicates if more posts are available" } } }, "status": { "type": "string", "description": "Status of the API response" }, "parameters": { "type": "object", "properties": { "limit": { "type": "integer", "description": "Maximum number of posts to return" }, "scope": { "type": "string", "description": "Scope of posts to retrieve" }, "country": { "type": "string", "description": "Country code for the influencer data" }, "influencer_name": { "type": "string", "description": "Name of the influencer being queried" } } }, "request_id": { "type": "string", "description": "Unique identifier for the API request" } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "influencer_name", "schema": { "type": "string" }, "example": "tastemade", "required": true, "description": "The Amazon Influencer name for which to get posts" }, { "in": "query", "name": "country", "schema": { "enum": [ "US", "AU", "BR", "CA", "CN", "FR", "DE", "IN", "IT", "MX", "NL", "SG", "ES", "TR", "AE", "GB", "JP", "SA", "PL", "SE", "BE", "EG", "ZA", "IE" ], "type": "string", "default": "US" }, "description": "Sets the Amazon domain, marketplace country, language and currency." }, { "in": "query", "name": "scope", "schema": { "enum": [ "ALL", "IDEA_LISTS", "PHOTOS", "VIDEOS" ], "type": "string", "default": "ALL" }, "description": "Return the results in a specific scope." }, { "in": "query", "name": "query", "schema": { "type": "string" }, "description": "Find posts matching a search query." }, { "in": "query", "name": "cursor", "schema": { "type": "string" }, "description": "A cursor to get the next set of results, it can be used for for paging purposes. \n\n **Note:** the cursor value for the next set of results is returned by this endpoint under data.cursor." }, { "in": "query", "name": "limit", "schema": { "type": "integer", "default": 20, "maximum": 100, "minimum": 1 }, "description": "Maximum number of posts to return." }, { "in": "query", "name": "language", "schema": { "type": "string" }, "description": "The language of the results. In case not specified, results will be returned in the default domain language. \n\n **Supported languages per country:** \n `US`: en_US, es_US \n `AU`: en_AU \n `BR`: pt_BR \n `CA`: en_CA, fr_CA \n `FR`: fr_FR, en_GB \n `DE`: de_DE, en_GB, cs_CZ, nl_NL, pl_PL, tr_TR, da_DK \n `IN`: en_IN, hi_IN, ta_IN, te_IN, kn_IN, ml_IN, bn_IN, mr_IN \n `IT`: it_IT, en_GB \n `MX`: es_MX \n `NL`: nl_NL, en_GB \n `SG`: en_SG \n `ES`: es_ES, pt_PT, en_GB \n `TR`: tr_TR \n `AE`: en_AE, ar_AE \n `GB`: en_GB \n `JP`: ja_JP, en_US, zh_CN \n `SA`: ar_AE, en_AE \n `PL`: pl_PL \n `SE`: sv_SE, en_GB \n `BE`: fr_BE, nl_BE, en_GB \n `EG`: ar_AE, en_AE \n `ZA`: en_ZA \n `IE`: en_IE " }, { "in": "query", "name": "fields", "schema": { "type": "string" }, "description": "A comma separated list of influencer post fields to include in the response (field projection). \n By default all fields are returned." } ], "description": "Get all Amazon Influencer posts with pagination support.", "operationId": "realtime_amazon_data__get__influencer_posts", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_5-N-bD-w4FEvDbPufA7rY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_JMX_MdcNKNvBSfEXsR78v" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_D1eKbJ9D0SJoHD3LLOLYI", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_WiAI6D9DA33xLudF2TJIh" } ], "x-zeroclick-services": [ "realtime-amazon-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-amazon-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-amazon-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-amazon-data/influencer-profile": { "get": { "summary": "Influencer Profile", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "object", "properties": { "data": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the influencer" }, "domain": { "type": "string", "description": "Amazon marketplace domain" }, "country": { "type": "string", "description": "Country associated with the influencer" }, "posts_count": { "type": "integer", "description": "Number of posts by the influencer" }, "profile_link": { "type": "string", "description": "URL to the influencer's profile" }, "has_curations": { "type": "boolean", "description": "Whether the influencer has product curations" }, "is_top_creator": { "type": "boolean", "description": "Whether the influencer is a top creator" }, "affiliate_status": { "type": "string", "description": "Status of the influencer's affiliate program" }, "profile_description": { "type": "string", "description": "Description of the influencer's profile" } } }, "status": { "type": "string", "description": "Status of the API response" }, "parameters": { "type": "object", "properties": { "country": { "type": "string", "description": "Country code for the influencer data" }, "influencer_name": { "type": "string", "description": "Name of the influencer being queried" } } }, "request_id": { "type": "string", "description": "Unique identifier for the API request" } } } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "influencer_name", "schema": { "type": "string" }, "example": "tastemade", "required": true, "description": "The Amazon Influencer name for which to get profile details" }, { "in": "query", "name": "country", "schema": { "enum": [ "US", "AU", "BR", "CA", "CN", "FR", "DE", "IN", "IT", "MX", "NL", "SG", "ES", "TR", "AE", "GB", "JP", "SA", "PL", "SE", "BE", "EG", "ZA", "IE" ], "type": "string", "default": "US" }, "description": "Sets the Amazon domain, marketplace country, language and currency." }, { "in": "query", "name": "fields", "schema": { "type": "string" }, "description": "A comma separated list of influencer profile fields to include in the response (field projection). \n By default all fields are returned." }, { "in": "query", "name": "language", "schema": { "type": "string" }, "description": "The language of the results. In case not specified, results will be returned in the default domain language. \n\n **Supported languages per country:** \n `US`: en_US, es_US \n `AU`: en_AU \n `BR`: pt_BR \n `CA`: en_CA, fr_CA \n `FR`: fr_FR, en_GB \n `DE`: de_DE, en_GB, cs_CZ, nl_NL, pl_PL, tr_TR, da_DK \n `IN`: en_IN, hi_IN, ta_IN, te_IN, kn_IN, ml_IN, bn_IN, mr_IN \n `IT`: it_IT, en_GB \n `MX`: es_MX \n `NL`: nl_NL, en_GB \n `SG`: en_SG \n `ES`: es_ES, pt_PT, en_GB \n `TR`: tr_TR \n `AE`: en_AE, ar_AE \n `GB`: en_GB \n `JP`: ja_JP, en_US, zh_CN \n `SA`: ar_AE, en_AE \n `PL`: pl_PL \n `SE`: sv_SE, en_GB \n `BE`: fr_BE, nl_BE, en_GB \n `EG`: ar_AE, en_AE \n `ZA`: en_ZA \n `IE`: en_IE " } ], "description": "Get Amazon Influencer profile details from the Amazon Influencer store page *(e.g. https://www.amazon.com/shop/tastemade)*.", "operationId": "realtime_amazon_data__get__influencer_profile", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_5-N-bD-w4FEvDbPufA7rY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_JMX_MdcNKNvBSfEXsR78v" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_D1eKbJ9D0SJoHD3LLOLYI", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_WiAI6D9DA33xLudF2TJIh" } ], "x-zeroclick-services": [ "realtime-amazon-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-amazon-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-amazon-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-amazon-data/product-category-list": { "get": { "summary": "Product Category List", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the item." }, "name": { "type": "string", "description": "The name of the item." } } } }, "status": { "type": "string", "description": "The status of the response." }, "request_id": { "type": "string", "description": "A unique identifier for the request." } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "country", "schema": { "enum": [ "US", "AU", "BR", "CA", "CN", "FR", "DE", "IN", "IT", "MX", "NL", "SG", "ES", "TR", "AE", "GB", "JP", "SA", "PL", "SE", "BE", "EG", "ZA", "IE" ], "type": "string", "default": "US" }, "description": "Sets the Amazon domain, marketplace country, language and currency." } ], "description": "Get Amazon product categories per country / Amazon domain (for use with the \"category_id\" parameter of the Product Search only).", "operationId": "realtime_amazon_data__get__product_category_list", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_5-N-bD-w4FEvDbPufA7rY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_JMX_MdcNKNvBSfEXsR78v" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_D1eKbJ9D0SJoHD3LLOLYI", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_WiAI6D9DA33xLudF2TJIh" } ], "x-zeroclick-services": [ "realtime-amazon-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-amazon-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-amazon-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-amazon-data/product-details": { "get": { "summary": "Product Details", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "asin": { "type": "string", "description": "ASIN of the returned product." }, "country": { "type": "string", "description": "Marketplace country where the product data was fetched." }, "category": { "type": "object", "properties": { "id": { "type": "string", "description": "Category identifier." }, "name": { "type": "string", "description": "Category name." } } }, "currency": { "type": "string", "description": "Currency of the listed price." }, "delivery": { "type": "string", "description": "Delivery message as shown on the product page." }, "is_prime": { "type": "boolean", "description": "Whether the product is eligible for Prime." }, "buy_boxes": { "type": "array", "items": { "type": "object", "properties": { "price": { "type": "string", "description": "The offer price" }, "title": { "type": "string", "description": "Heading of the buy box option (e.g. the offer condition or purchase option)." }, "is_fba": { "type": "boolean", "nullable": true, "description": "True when the offer is fulfilled by Amazon (FBA, or sold by Amazon), false when the seller fulfils it (including Easy Ship / Managed by Amazon offers). Null when not shown." }, "unit_price": { "type": "string", "nullable": true, "description": "The price per unit, when available" } } }, "description": "All buy box options shown on the product page (e.g. one per offer condition or purchase option). Empty when the page shows a single buy box." }, "has_aplus": { "type": "boolean", "description": "Whether the listing includes A+ Content (EBC)." }, "has_video": { "type": "boolean", "description": "Whether the main product listing shows video." }, "unit_count": { "type": "integer", "nullable": true, "description": "Number of items in the product, from its Number of Items attribute. Null when not stated." }, "parent_asin": { "type": "string", "description": "Parent ASIN for the variation family." }, "product_url": { "type": "string", "description": "Canonical Amazon product URL." }, "top_reviews": { "type": "array", "items": { "type": "object", "properties": { "country": { "type": "string", "nullable": true, "description": "Country code (ISO 3166-1 alpha-2) of the Amazon marketplace the review was written on. Omitted when it cannot be determined." }, "is_vine": { "type": "boolean", "description": "Indicates whether the review is part of the Amazon Vine program." }, "review_id": { "type": "string", "description": "Unique identifier of the review on Amazon." }, "review_date": { "type": "string", "description": "Human-readable date string for when the review was posted." }, "review_link": { "type": "string", "description": "Direct URL to the review on Amazon." }, "review_title": { "type": "string", "description": "Title or headline of the review." }, "review_video": { "type": "string", "nullable": true, "description": "URL of a video attached to the review. Null when there is none." }, "helpful_votes": { "type": "integer", "nullable": true, "description": "Number of people who found the review helpful. Null when not shown." }, "review_author": { "type": "string", "description": "Display name of the review author." }, "review_images": { "type": "array", "items": { "type": "string" }, "description": "Photos attached to the review." }, "review_comment": { "type": "string", "description": "Full text content of the review." }, "review_date_iso": { "type": "string", "nullable": true, "description": "Review date in ISO 8601 format (YYYY-MM-DD). Null when the date cannot be read." }, "review_language": { "type": "string", "nullable": true, "description": "Language code (ISO 639-1) of the review text. Omitted when it cannot be determined." }, "review_author_id": { "type": "string", "description": "Internal Amazon identifier of the review author." }, "is_different_asin": { "type": "boolean", "nullable": true, "description": "True when the review was written for a different ASIN than the requested one (another variant of the listing, or the product on another marketplace). Null when the reviewed ASIN is not shown." }, "review_author_url": { "type": "string", "description": "URL to the review author's Amazon profile." }, "review_star_rating": { "type": "string", "description": "Star rating given by the reviewer as a string." }, "is_verified_purchase": { "type": "boolean", "description": "Indicates whether the review is marked as a verified purchase." }, "review_author_avatar": { "type": "string", "description": "URL of the review author's avatar image." }, "reviewed_product_asin": { "type": "string", "description": "ASIN of the specific product/variation that was reviewed." }, "helpful_vote_statement": { "type": "string", "description": "Text describing how many users found the review helpful." }, "reviewed_product_variant": { "type": "object", "properties": { "Size": { "type": "string", "description": "Size option of the product variant reviewed." }, "Color": { "type": "string", "description": "Color of the product variant reviewed." }, "Product grade": { "type": "string", "description": "Condition or grading of the renewed/refurbished product." }, "Service provider": { "type": "string", "description": "Service provider or carrier associated with the device." } } } } }, "description": "Top reviews from the product's primary marketplace." }, "landing_asin": { "type": "string", "description": "ASIN of the product Amazon actually served. Differs from asin when the requested ASIN is a variation parent (a child is selected) or was redirected (see is_redirected)." }, "main_buy_box": { "type": "object", "nullable": true, "properties": { "price": { "type": "string", "description": "The Buy Box offer price" }, "title": { "type": "string", "nullable": true, "description": "Heading of the selected buy box option when the page offers several (e.g. the offer condition or purchase option)." }, "is_fba": { "type": "boolean", "nullable": true, "description": "True when the offer is fulfilled by Amazon (FBA, or sold by Amazon), false when the seller fulfils it (including Easy Ship / Managed by Amazon offers). Null when not shown." }, "seller": { "type": "string", "description": "Name of the Buy Box seller" }, "seller_id": { "type": "string", "description": "Unique identifier of the Buy Box seller" }, "ships_from": { "type": "string", "description": "Where the Buy Box offer ships from" }, "unit_price": { "type": "string", "nullable": true, "description": "The price per unit, when available" }, "seller_link": { "type": "string", "description": "URL to the Buy Box seller's Amazon profile" }, "return_policy": { "type": "string", "nullable": true, "description": "The return policy for the Buy Box offer" } }, "description": "The featured Buy Box offer for the product" }, "product_slug": { "type": "string", "nullable": true, "description": "SEO-friendly slug derived from the product title." }, "sales_volume": { "type": "string", "nullable": true, "description": "Sales velocity/volume label if present." }, "about_product": { "type": "array", "items": { "type": "string" }, "description": "Bullet points from the 'About this item' section." }, "category_path": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Breadcrumb node ID." }, "link": { "type": "string", "description": "URL to the breadcrumb category." }, "name": { "type": "string", "description": "Breadcrumb node name." } } } }, "customers_say": { "type": "string", "description": "High-level customer sentiment summary." }, "is_redirected": { "type": "boolean", "nullable": true, "description": "True when Amazon served a different product than the requested asin (e.g. a merged or retired ASIN); landing_asin is the ASIN served. Requesting a variation parent and landing on one of its children is not a redirect. Null when the served ASIN cannot be determined." }, "product_photo": { "type": "string", "description": "URL of the main product image." }, "product_price": { "type": "string", "nullable": true, "description": "Displayed current price." }, "product_title": { "type": "string", "description": "Full product title as shown on Amazon." }, "brand_store_id": { "type": "string", "nullable": true, "description": "ID of the brand's Amazon store, from the byline's Visit the Store link. Null when the byline does not link to a brand store." }, "has_brandstory": { "type": "boolean", "description": "Whether the listing includes a Brand Story module." }, "is_best_seller": { "type": "boolean", "description": "Whether the product is flagged as a Best Seller." }, "marketplace_id": { "type": "string", "nullable": true, "description": "Amazon marketplace ID of the domain." }, "product_byline": { "type": "string", "description": "Byline text (e.g., brand/store attribution)." }, "product_offers": { "type": "array", "items": { "type": "object", "properties": { "is_fba": { "type": "boolean", "nullable": true, "description": "True when the offer is fulfilled by Amazon (FBA, or sold by Amazon), false when the seller fulfils it (including Easy Ship / Managed by Amazon offers)." }, "seller": { "type": "string", "description": "Name of the seller" }, "currency": { "type": "string", "description": "The currency in which the offer price is displayed" }, "seller_id": { "type": "string", "description": "Unique identifier of the seller" }, "ships_from": { "type": "string", "description": "Location from which the offer ships" }, "seller_link": { "type": "string", "description": "URL to the seller's Amazon profile" }, "delivery_time": { "type": "string", "nullable": true, "description": "Estimated delivery time for the offer" }, "product_price": { "type": "string", "description": "The offer price" }, "delivery_price": { "type": "string", "description": "Delivery price for the offer" }, "product_condition": { "type": "string", "description": "Condition of the offer (e.g., New, Refurbished, Used)" }, "seller_num_ratings": { "type": "integer", "nullable": true, "description": "Number of ratings the seller has received. Null for new sellers and for offers sold by Amazon." }, "seller_star_rating": { "type": "string", "nullable": true, "description": "The star rating of the seller" }, "product_original_price": { "type": "string", "nullable": true, "description": "The offer's original price before any discount" }, "seller_star_rating_info": { "type": "string", "nullable": true, "description": "Additional information about the seller's ratings" }, "seller_positive_ratings_percentage": { "type": "integer", "nullable": true, "description": "Percentage of the seller's ratings that are positive, over the period stated in seller_star_rating_info (usually the last 12 months). Null for new sellers and for offers sold by Amazon." } } }, "nullable": true, "description": "Offers from all sellers, the same offer objects as the Product Offers endpoint returns (first page of offers, all conditions). Returned only with include_offers=true. Null if the offers could not be retrieved." }, "product_photos": { "type": "array", "items": { "type": "string" }, "description": "URLs of product photos." }, "product_videos": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Video ID." }, "title": { "type": "string", "description": "Video title." }, "video_url": { "type": "string", "description": "URL of the video stream." }, "parent_asin": { "type": "string", "description": "Parent ASIN of the product's variation family." }, "video_width": { "type": "string", "description": "Video width in pixels." }, "product_asin": { "type": "string", "description": "ASIN of the product the video is shown for." }, "video_height": { "type": "string", "description": "Video height in pixels." }, "thumbnail_url": { "type": "string", "description": "URL of the video thumbnail." } } }, "description": "Product videos shown on the product page." }, "review_aspects": { "type": "object", "nullable": true, "description": "Aspects customers mention in reviews, keyed by aspect label as shown on the page, with the overall sentiment for each: POSITIVE, MIXED or NEGATIVE.", "additionalProperties": { "type": "string" } }, "product_details": { "type": "object", "description": "Key/value map of product detail attributes (Brand, Model, Color, etc.).", "additionalProperties": { "type": "string" } }, "unit_price_unit": { "type": "string", "nullable": true, "description": "Unit the price per unit is quoted for, as shown on the product page (e.g. 100 g, fluid ounce, count). Null when no unit price is shown." }, "delivery_zipcode": { "type": "string", "nullable": true, "description": "Zip / postal code of the delivery location the product data reflects. Equals the requested delivery_zipcode when it was applied. Null when the delivery location has no zip code (e.g. a delivery country)." }, "is_amazon_choice": { "type": "boolean", "description": "Whether the product is marked as Amazon's Choice." }, "unit_price_value": { "type": "number", "nullable": true, "description": "Numeric value of the price per unit (unit_price), in `currency` units. Null when no unit price is shown." }, "best_sellers_rank": { "type": "array", "items": { "type": "object", "properties": { "link": { "type": "string", "nullable": true, "description": "Link to the category's Best Sellers list." }, "rank": { "type": "integer", "description": "Rank of the product in the category." }, "category": { "type": "string", "description": "Category name as shown on the product page." } } }, "nullable": true, "description": "Best Sellers Rank entries with numeric ranks, main category first, then sub-categories. The text form stays in product_information. Null when not shown." }, "carousel_products": { "type": "array", "items": { "type": "object", "properties": { "asin": { "type": "string", "description": "ASIN of the recommended product." }, "badges": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "Badges shown on the product (e.g. #1 Best Seller, Amazon's Choice). Null when none." }, "position": { "type": "integer", "description": "Position of the product in its carousel, starting at 1." }, "product_url": { "type": "string", "description": "Amazon product URL of the recommended product." }, "product_photo": { "type": "string", "nullable": true, "description": "URL of the product photo." }, "product_price": { "type": "string", "nullable": true, "description": "Current price. Null when not shown." }, "product_title": { "type": "string", "nullable": true, "description": "Title of the recommended product." }, "carousel_title": { "type": "string", "nullable": true, "description": "Title of the carousel the product appears in." }, "product_num_ratings": { "type": "integer", "nullable": true, "description": "Number of ratings." }, "product_star_rating": { "type": "string", "nullable": true, "description": "Average star rating." }, "product_original_price": { "type": "string", "nullable": true, "description": "Original price before discounts. Null when not shown." } } }, "nullable": true, "description": "Products from the product page's recommendation carousels (e.g. Customers who viewed this item also viewed), with the carousel title and the product's position in it. Null when none are shown." }, "delivery_location": { "type": "string", "nullable": true, "description": "Delivery location the product data reflects, as shown in the page's Deliver to header (town and postcode). Null when not shown." }, "product_num_offers": { "type": "integer", "description": "Count of available offers for this product." }, "product_variations": { "type": "object", "properties": { "color": { "type": "array", "items": { "type": "object", "properties": { "asin": { "type": "string", "description": "ASIN of this specific color variation." }, "photo": { "type": "string", "description": "Image URL for the color swatch." }, "value": { "type": "string", "description": "Color name/value." }, "is_available": { "type": "boolean", "description": "Availability of this variation." } } } } } }, "sponsored_products": { "type": "array", "items": { "type": "object", "properties": { "asin": { "type": "string", "description": "ASIN of the advertised product." }, "ad_type": { "type": "string", "description": "Ad format. Values: sponsored_products, sponsored_brands, sponsored_brands_video." }, "product_url": { "type": "string", "description": "Amazon product URL of the advertised product." }, "product_photo": { "type": "string", "nullable": true, "description": "URL of the product photo shown in the ad." }, "product_price": { "type": "string", "nullable": true, "description": "Price shown in the ad. Null when not shown." }, "product_title": { "type": "string", "nullable": true, "description": "Title of the advertised product." }, "product_num_ratings": { "type": "integer", "nullable": true, "description": "Number of ratings shown in the ad." }, "product_star_rating": { "type": "string", "nullable": true, "description": "Average star rating shown in the ad." } } }, "nullable": true, "description": "Sponsored products advertised on the product page (Sponsored Products, Sponsored Brands and Sponsored Brands video ads). Null when none are shown." }, "top_reviews_global": { "type": "array", "items": { "type": "object", "properties": { "country": { "type": "string", "nullable": true, "description": "Country code (ISO 3166-1 alpha-2) of the Amazon marketplace the review was written on. Omitted when it cannot be determined." }, "is_vine": { "type": "boolean", "description": "Whether the review is part of the Vine program." }, "review_id": { "type": "string", "description": "Unique review identifier." }, "review_date": { "type": "string", "description": "Date the review was posted." }, "review_link": { "type": "string", "description": "Permalink to the review on Amazon." }, "review_title": { "type": "string", "description": "Title of the review." }, "review_video": { "type": "string", "nullable": true, "description": "URL to a video attached to the review. Null when there is none." }, "helpful_votes": { "type": "integer", "nullable": true, "description": "Number of people who found the review helpful. Null when not shown." }, "review_author": { "type": "string", "description": "Display name of the reviewer." }, "review_images": { "type": "array", "items": { "type": "string" }, "description": "Photos attached to the review." }, "review_comment": { "type": "string", "description": "Full text of the review." }, "review_date_iso": { "type": "string", "nullable": true, "description": "Review date in ISO 8601 format (YYYY-MM-DD). Null when the date cannot be read." }, "review_language": { "type": "string", "nullable": true, "description": "Language code (ISO 639-1) of the review text. Omitted when it cannot be determined." }, "review_author_id": { "type": "string", "nullable": true, "description": "Author ID of the reviewer. Null when not shown." }, "is_different_asin": { "type": "boolean", "nullable": true, "description": "True when the review was written for a different ASIN than the requested one (another variant of the listing, or the product on another marketplace). Null when the reviewed ASIN is not shown." }, "review_author_url": { "type": "string", "nullable": true, "description": "Link to the reviewer's profile. Null when not shown." }, "review_star_rating": { "type": "string", "description": "Star rating given by the reviewer." }, "is_verified_purchase": { "type": "boolean", "description": "Whether Amazon marked it as a verified purchase." }, "review_author_avatar": { "type": "string", "description": "URL of the reviewer's avatar." }, "reviewed_product_asin": { "type": "string", "description": "ASIN the review is associated with." } } } }, "product_byline_link": { "type": "string", "description": "Primary link behind the byline." }, "product_description": { "type": "string", "nullable": true, "description": "Long-form product description." }, "product_information": { "type": "object", "properties": { "ASIN": { "type": "string", "description": "ASIN repeated in the product information block." }, "Units": { "type": "string", "description": "Unit measure if present." }, "Department": { "type": "string", "description": "Department/category designation." }, "Item Weight": { "type": "string", "description": "Item weight as listed." }, "Manufacturer": { "type": "string", "description": "Manufacturer or brand owner." }, "Capacity Total": { "type": "string", "description": "Total capacity specification if applicable." }, "Number Of Items": { "type": "string", "description": "Number of items included in the package." }, "Best Sellers Rank": { "type": "string", "description": "Best Sellers Rank string as shown." }, "Item model number": { "type": "string", "description": "Manufacturer model number." }, "Product Dimensions": { "type": "string", "description": "Dimensions as listed in product information." }, "Age Range Description": { "type": "string", "description": "Intended age range if provided." } } }, "product_num_ratings": { "type": "integer", "description": "Total number of ratings." }, "product_offers_link": { "type": "string", "nullable": true, "description": "Link to the product's full offer listing on Amazon. Null when not shown." }, "product_price_value": { "type": "number", "nullable": true, "description": "Numeric value of product_price, in `currency` units. Null when no price is shown." }, "product_star_rating": { "type": "string", "description": "Average star rating shown on the detail page." }, "rating_distribution": { "type": "object", "properties": { "1": { "type": "integer", "description": "Count of 1-star ratings." }, "2": { "type": "integer", "description": "Count of 2-star ratings." }, "3": { "type": "integer", "description": "Count of 3-star ratings." }, "4": { "type": "integer", "description": "Count of 4-star ratings." }, "5": { "type": "integer", "description": "Count of 5-star ratings." } } }, "product_availability": { "type": "string", "description": "Availability status text." }, "product_byline_links": { "type": "array", "items": { "type": "string" }, "description": "Links behind the byline (brand / author / store)." }, "user_uploaded_videos": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal identifier of the uploaded video." }, "asin": { "type": "string", "description": "ASIN associated with the user video." }, "title": { "type": "string", "description": "Title of the uploaded video." }, "video_url": { "type": "string", "description": "Playable URL of the uploaded video." }, "parent_asin": { "type": "string", "description": "Parent ASIN if the item is a variation." }, "public_name": { "type": "string", "description": "Public display name of the uploader." }, "vendor_code": { "type": "string", "description": "Vendor code if uploader is a vendor." }, "vendor_name": { "type": "string", "description": "Vendor name when applicable." }, "creator_type": { "type": "string", "description": "Creator type classification." }, "product_asin": { "type": "string", "description": "Product ASIN referenced by the video." }, "profile_link": { "type": "string", "description": "Link to the uploader's profile." }, "video_image_id": { "type": "string", "description": "Thumbnail image ID for the video." }, "video_previews": { "type": "string", "description": "Serialized preview renditions or URLs." }, "video_image_url": { "type": "string", "description": "URL of the video thumbnail image." }, "video_mime_type": { "type": "string", "description": "MIME type of the video file." }, "related_products": { "type": "string", "description": "Related products info as raw text/IDs." }, "profile_image_url": { "type": "string", "description": "Uploader profile image URL." }, "video_image_width": { "type": "string", "description": "Thumbnail width in pixels." }, "vendor_tracking_id": { "type": "string", "description": "Tracking ID used for vendor content." }, "video_image_height": { "type": "string", "description": "Thumbnail height in pixels." }, "video_image_extension": { "type": "string", "description": "Thumbnail file extension." }, "video_image_url_unchanged": { "type": "string", "description": "Original thumbnail URL without transformations." } } } }, "customer_review_media": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string", "description": "URL of the full-size photo or video." }, "review_id": { "type": "string", "nullable": true, "description": "ID of the review the media belongs to." }, "media_type": { "type": "string", "description": "Media type, e.g. image or video." }, "thumbnail_url": { "type": "string", "nullable": true, "description": "URL of the thumbnail." } } }, "nullable": true, "description": "Customer photos and videos from the product page's reviews gallery, with the review each one belongs to (the items shown on the product page). Null when not shown." }, "important_information": { "type": "object", "nullable": true, "description": "The product's Important information sections (e.g. safety information, ingredients, directions, legal disclaimer), keyed by section heading as shown on the page. Null when not shown.", "additionalProperties": { "type": "string" } }, "primary_delivery_time": { "type": "string", "description": "Primary estimated delivery date/time text." }, "all_product_variations": { "type": "object", "properties": { "B07KMB44J4": { "type": "object", "properties": { "size": { "type": "string", "description": "Size value for this variation." }, "color": { "type": "string", "description": "Color value for this variation." } } }, "B07KMBBK59": { "type": "object", "properties": { "size": { "type": "string", "description": "Size value for this variation." }, "color": { "type": "string", "description": "Color value for this variation." } } }, "B07KMBNGWV": { "type": "object", "properties": { "size": { "type": "string", "description": "Size value for this variation." }, "color": { "type": "string", "description": "Color value for this variation." } } }, "B07NJQL5M7": { "type": "object", "properties": { "size": { "type": "string", "description": "Size value for this variation." }, "color": { "type": "string", "description": "Color value for this variation." } } } } }, "maximum_order_quantity": { "type": "integer", "nullable": true, "description": "Maximum quantity of the featured offer that can be ordered at once. Null when not shown." }, "minimum_order_quantity": { "type": "integer", "nullable": true, "description": "Minimum quantity required per order if applicable. Null when the product has no minimum." }, "product_item_highlight": { "type": "string", "nullable": true, "description": "Amazon's Item Highlight attribute for the listing, a short summary of key details such as materials, use cases or compatibility. Amazon publishes it either as its own attribute or appended to the product title after a ' | ' separator, and both forms are returned here. Null when Amazon provides no highlight for the listing, or when the title contains more than one ' | ' separator, since the boundary between title and highlight cannot be determined reliably in that case." }, "product_original_price": { "type": "string", "nullable": true, "description": "Original list price before discounts." }, "product_photos_labeled": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string", "description": "URL of the product photo." }, "variant": { "type": "string", "nullable": true, "description": "Image position label, e.g. MAIN, PT01, BACK." } } }, "nullable": true, "description": "The same photos as product_photos, in the same order, each with its image position label (MAIN, PT01, PT02 and so on). Null when the labels are not available." }, "review_aspects_details": { "type": "array", "items": { "type": "object", "properties": { "aspect": { "type": "string", "description": "Aspect label, the same as the review_aspects key." }, "mentions": { "type": "integer", "nullable": true, "description": "Number of reviews that mention the aspect." }, "sentiment": { "type": "string", "description": "Overall sentiment for the aspect. Values: POSITIVE, MIXED, NEGATIVE." }, "negative_mentions": { "type": "integer", "nullable": true, "description": "Number of those mentions that are negative." }, "positive_mentions": { "type": "integer", "nullable": true, "description": "Number of those mentions that are positive." } } }, "nullable": true, "description": "Per-aspect review sentiment behind review_aspects: how many reviews mention each aspect and how many of those mentions are positive or negative. Null when not shown." }, "climate_pledge_friendly": { "type": "boolean", "description": "Whether the product is marked Climate Pledge Friendly." }, "product_price_max_value": { "type": "number", "nullable": true, "description": "Numeric upper end of the price range (product_price_max), in `currency` units, when the product shows a price range. Null otherwise." }, "frequently_bought_together": { "type": "array", "items": { "type": "object", "properties": { "asin": { "type": "string", "description": "ASIN of the item." }, "product_url": { "type": "string", "description": "Amazon product URL of the item." }, "product_photo": { "type": "string", "description": "URL of the item's photo." }, "product_price": { "type": "string", "description": "Price of the item." }, "product_title": { "type": "string", "description": "Title of the item as shown in the block." } } }, "description": "Products in the Frequently bought together block, starting with the requested product. Empty when not shown." }, "product_minimum_offer_price": { "type": "string", "nullable": true, "description": "Lowest offer price shown in the product page's other sellers box. Null when not shown." }, "product_original_price_value": { "type": "number", "nullable": true, "description": "Numeric value of product_original_price, in `currency` units. Null when no original price is shown." }, "product_variations_dimensions": { "type": "array", "items": { "type": "string" }, "description": "Dimensions the product varies on (Color, Size, Style, etc.)." }, "product_minimum_offer_condition": { "type": "string", "nullable": true, "description": "Offer condition the lowest offer price covers, e.g. NEW, or ALL when new and used or renewed offers are counted together." }, "product_minimum_offer_price_value": { "type": "number", "nullable": true, "description": "Numeric value of product_minimum_offer_price, in `currency` units." }, "frequently_bought_together_total_price": { "type": "string", "nullable": true, "description": "Total price shown for buying the Frequently bought together items together (default selection). Null when not shown or when an item's price is hidden." } } }, "status": { "type": "string", "description": "Overall request status." }, "parameters": { "type": "object", "properties": { "asin": { "type": "string", "description": "Requested Amazon ASIN." }, "country": { "type": "string", "description": "Amazon marketplace country code used for the request." }, "language": { "type": "string", "description": "Language used to fetch/parse the product page." }, "include_offers": { "type": "boolean", "description": "Whether the product offers were requested. Returned only when include_offers is sent." }, "delivery_zipcode": { "type": "string", "description": "Requested delivery zip code, normalized (trimmed, upper case). Returned only when delivery_zipcode is sent." } } }, "request_id": { "type": "string", "description": "Unique identifier of this request." } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "asin", "schema": { "type": "string" }, "example": "B07ZPKBL9V", "required": true, "description": "Product ASIN for which to get details. \n Supports batching of up to 10 ASINs in a single request, separated by comma. \n \n **Billing:** each ASIN is billed as a separate request, so a batch of 10 ASINs counts as 10 requests against the plan quota." }, { "in": "query", "name": "country", "schema": { "enum": [ "US", "AU", "BR", "CA", "CN", "FR", "DE", "IN", "IT", "MX", "NL", "SG", "ES", "TR", "AE", "GB", "JP", "SA", "PL", "SE", "BE", "EG", "ZA", "IE" ], "type": "string", "default": "US" }, "description": "Sets the Amazon domain, marketplace country, language and currency." }, { "in": "query", "name": "delivery_country", "schema": { "type": "string" }, "example": "NL", "description": "Delivery destination country (ISO 3166-1 alpha-2 code, e.g. `NL`). When set, delivery dates, shipping costs, availability and offers reflect delivery to this country instead of the marketplace's domestic delivery. Defaults to the marketplace country. \n Only specific `country` / `delivery_country` combinations are supported. Currently supported: `country` = `DE`, `FR`, `IT` or `ES` with `delivery_country` = `NL`. \n Other combinations return a 400 error. If you need another combination, contact us at support@openwebninja.com and we will look into adding it." }, { "in": "query", "name": "delivery_zipcode", "schema": { "type": "string" }, "description": "Postal / ZIP code within the `country` marketplace, in its usual format, used as the delivery address so delivery dates, costs and availability reflect it. \n `delivery_zipcode` in the response shows the zip code the data reflects, so it matches the requested one when it was applied. An invalid zip code returns a 400 error. Cannot be combined with a different `delivery_country`." }, { "in": "query", "name": "more_info_query", "schema": { "type": "string" }, "description": "A query to search and get more info about the product as part of Product Information, Customer Q&As, and Customer Reviews." }, { "in": "query", "name": "include_offers", "schema": { "type": "boolean", "default": false }, "description": "Also return the product's offers from all sellers as `product_offers`, with the same offer fields as the Product Offers endpoint (first page of offers, all conditions). When set, each ASIN is billed as 2 requests." }, { "in": "query", "name": "language", "schema": { "type": "string" }, "description": "The language of the results. In case not specified, results will be returned in the default domain language. \n\n **Supported languages per country:** \n `US`: en_US, es_US \n `AU`: en_AU \n `BR`: pt_BR \n `CA`: en_CA, fr_CA \n `FR`: fr_FR, en_GB \n `DE`: de_DE, en_GB, cs_CZ, nl_NL, pl_PL, tr_TR, da_DK \n `IN`: en_IN, hi_IN, ta_IN, te_IN, kn_IN, ml_IN, bn_IN, mr_IN \n `IT`: it_IT, en_GB \n `MX`: es_MX \n `NL`: nl_NL, en_GB \n `SG`: en_SG \n `ES`: es_ES, pt_PT, en_GB \n `TR`: tr_TR \n `AE`: en_AE, ar_AE \n `GB`: en_GB \n `JP`: ja_JP, en_US, zh_CN \n `SA`: ar_AE, en_AE \n `PL`: pl_PL \n `SE`: sv_SE, en_GB \n `BE`: fr_BE, nl_BE, en_GB \n `EG`: ar_AE, en_AE \n `ZA`: en_ZA \n `IE`: en_IE " }, { "in": "query", "name": "fields", "schema": { "type": "string" }, "description": "A comma separated list of product fields to include in the response (field projection). \n By default all fields are returned." } ], "description": "Get extensive Amazon product details and information available on the Amazon product page by asin, including title, price data, ratings data, photos, product details (brand, weight, package size, model, etc.) product variations (colors, sizes, flavors, etc), best sellers rank, review insights, buy box and FBA details, and many other data points. \n Here's an example product page: [https://www.amazon.com/dp/B0CMZFCQ6D](https://www.amazon.com/dp/B0CMZFCQ6D). \n Set `include_offers` to `true` to also get the product's offers from all sellers in the same response (billed as 2 requests per ASIN). \n \n **Billing:** each ASIN is billed as a separate request, so a batch of 10 ASINs counts as 10 requests against the plan quota.", "operationId": "realtime_amazon_data__get__product_details", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_5-N-bD-w4FEvDbPufA7rY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_JMX_MdcNKNvBSfEXsR78v" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_D1eKbJ9D0SJoHD3LLOLYI", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_WiAI6D9DA33xLudF2TJIh" } ], "x-zeroclick-services": [ "realtime-amazon-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-amazon-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-amazon-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-amazon-data/product-offers": { "get": { "summary": "Product Offers", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "asin": { "type": "string", "description": "The product's ASIN code" }, "country": { "type": "string", "description": "The country where the product is listed" }, "is_vine": { "type": "boolean", "description": "Indicates whether the review is part of the Vine program" }, "currency": { "type": "string", "description": "The currency in which prices are displayed" }, "delivery": { "type": "string", "description": "Shipping or delivery message" }, "is_prime": { "type": "boolean", "description": "Indicates Prime eligibility" }, "buy_boxes": { "type": "array", "items": { "type": "object", "properties": { "price": { "type": "string", "description": "The offer price" }, "is_fba": { "type": "boolean", "nullable": true, "description": "True when the offer is fulfilled by Amazon (FBA, or sold by Amazon), false when the seller fulfils it (including Easy Ship / Managed by Amazon offers). Null when not shown." }, "seller": { "type": "string", "description": "Name of the seller" }, "seller_id": { "type": "string", "description": "Unique identifier of the seller" }, "ships_from": { "type": "string", "description": "Where the offer ships from" }, "unit_price": { "type": "string", "nullable": true, "description": "The price per unit, when available" }, "seller_link": { "type": "string", "description": "URL to the seller's Amazon profile" }, "return_policy": { "type": "string", "nullable": true, "description": "The return policy for the offer" } } }, "description": "Additional Buy Box offers for the product, when available" }, "has_video": { "type": "boolean", "description": "True if the product includes a video" }, "review_id": { "type": "string", "description": "The unique identifier for the review" }, "category_id": { "type": "string", "description": "ID of the product category" }, "product_url": { "type": "string", "description": "URL of the product detail page" }, "review_date": { "type": "string", "description": "Date when the review was posted" }, "review_link": { "type": "string", "description": "Direct link to the review" }, "main_buy_box": { "type": "object", "nullable": true, "properties": { "price": { "type": "string", "description": "The Buy Box offer price" }, "is_fba": { "type": "boolean", "nullable": true, "description": "True when the offer is fulfilled by Amazon (FBA, or sold by Amazon), false when the seller fulfils it (including Easy Ship / Managed by Amazon offers). Null when not shown." }, "seller": { "type": "string", "description": "Name of the Buy Box seller" }, "seller_id": { "type": "string", "description": "Unique identifier of the Buy Box seller" }, "ships_from": { "type": "string", "description": "Where the Buy Box offer ships from" }, "unit_price": { "type": "string", "nullable": true, "description": "The price per unit, when available" }, "seller_link": { "type": "string", "description": "URL to the Buy Box seller's Amazon profile" }, "return_policy": { "type": "string", "nullable": true, "description": "The return policy for the Buy Box offer" } }, "description": "The featured Buy Box offer for the product" }, "product_slug": { "type": "string", "description": "URL-friendly version of the product title" }, "review_title": { "type": "string", "description": "Title of the user review" }, "sales_volume": { "type": "string", "description": "Indication of sales volume" }, "category_name": { "type": "string", "description": "Name of the product category" }, "customers_say": { "type": "string", "description": "A summary of customer feedback" }, "delivery_time": { "type": "string", "description": "Estimated delivery time for the offer" }, "product_photo": { "type": "string", "description": "Main photo of the product" }, "product_price": { "type": "string", "description": "The current price of the product" }, "product_title": { "type": "string", "description": "The title of the product" }, "review_author": { "type": "string", "description": "Name of the review's author" }, "delivery_price": { "type": "string", "description": "Price of delivery if applicable" }, "is_best_seller": { "type": "boolean", "description": "Indicates if the product is a best seller" }, "product_byline": { "type": "string", "description": "Text identifying the brand or seller" }, "product_offers": { "type": "array", "items": { "type": "object", "properties": { "is_fba": { "type": "boolean", "nullable": true, "description": "True when the offer is fulfilled by Amazon (FBA, or sold by Amazon), false when the seller fulfils it (including Easy Ship / Managed by Amazon offers)." }, "seller": { "type": "string", "description": "Name of the seller" }, "currency": { "type": "string", "description": "The currency in which the offer price is displayed" }, "seller_id": { "type": "string", "description": "Unique identifier of the seller" }, "ships_from": { "type": "string", "description": "Location from which the offer ships" }, "seller_link": { "type": "string", "description": "URL to the seller's Amazon profile" }, "delivery_time": { "type": "string", "nullable": true, "description": "Estimated delivery time for the offer" }, "product_price": { "type": "string", "description": "The offer price" }, "delivery_price": { "type": "string", "description": "Delivery price for the offer" }, "product_condition": { "type": "string", "description": "Condition of the offer (e.g., New, Refurbished, Used)" }, "seller_num_ratings": { "type": "integer", "nullable": true, "description": "Number of ratings the seller has received. Null for new sellers and for offers sold by Amazon." }, "seller_star_rating": { "type": "string", "nullable": true, "description": "The star rating of the seller" }, "product_original_price": { "type": "string", "nullable": true, "description": "The offer's original price before any discount" }, "seller_star_rating_info": { "type": "string", "nullable": true, "description": "Additional information about the seller's ratings" }, "seller_positive_ratings_percentage": { "type": "integer", "nullable": true, "description": "Percentage of the seller's ratings that are positive, over the period stated in seller_star_rating_info (usually the last 12 months). Null for new sellers and for offers sold by Amazon." } } }, "description": "List of offers for the product from different sellers. The first offer is the pinned offer returned by the Search endpoint." }, "review_comment": { "type": "string", "description": "The body text of the review" }, "variation_asin": { "type": "string", "description": "ASIN of a product variation" }, "variation_size": { "type": "string", "description": "Size or configuration of the product variation" }, "variation_color": { "type": "string", "description": "Color of the product variation" }, "category_path_id": { "type": "string", "description": "ID of the category in the hierarchy path" }, "is_amazon_choice": { "type": "boolean", "description": "Indicates if the product is an Amazon's Choice item" }, "product_condition": { "type": "string", "description": "Condition of the product offer (e.g., New, Used)" }, "category_path_link": { "type": "string", "description": "URL to the category" }, "category_path_name": { "type": "string", "description": "Name of the category in the hierarchy" }, "product_num_offers": { "type": "integer", "description": "Number of available offers for the product" }, "review_star_rating": { "type": "string", "description": "The star rating provided by the reviewer" }, "product_byline_link": { "type": "string", "description": "Link to the brand or seller's page" }, "product_description": { "type": "string", "description": "Detailed description of the product" }, "product_num_ratings": { "type": "integer", "description": "Total number of user ratings" }, "product_star_rating": { "type": "string", "description": "Average product rating as stars" }, "is_verified_purchase": { "type": "boolean", "description": "Indicates whether the reviewer purchased the product" }, "product_availability": { "type": "string", "description": "Availability status of the product" }, "review_author_avatar": { "type": "string", "description": "URL of the review author's avatar" }, "primary_delivery_time": { "type": "string", "description": "Estimated delivery time" }, "reviewed_product_asin": { "type": "string", "description": "The ASIN of the reviewed product" }, "product_original_price": { "type": "string", "nullable": true, "description": "The original price before any discount" }, "climate_pledge_friendly": { "type": "boolean", "description": "Indicates if the product is climate pledge friendly" } } }, "status": { "type": "string", "description": "The status of the API response" }, "parameters": { "type": "object", "properties": { "asin": { "type": "string", "description": "The Amazon Standard Identification Number" }, "page": { "type": "integer", "description": "The current page number of the paginated results" }, "limit": { "type": "integer", "description": "The number of results to return" }, "country": { "type": "string", "description": "The country code of the Amazon marketplace" }, "language": { "type": "string", "description": "The language of the content" } } }, "request_id": { "type": "string", "description": "A unique identifier for the request" } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "asin", "schema": { "type": "string" }, "example": "B09SM24S8C", "required": true, "description": "Product ASIN for which to get offers. \n Supports batching of up to 10 ASINs in a single request, separated by comma. \n \n **Billing:** each ASIN is billed as a separate request, so a batch of 10 ASINs counts as 10 requests against the plan quota." }, { "in": "query", "name": "country", "schema": { "enum": [ "US", "AU", "BR", "CA", "CN", "FR", "DE", "IN", "IT", "MX", "NL", "SG", "ES", "TR", "AE", "GB", "JP", "SA", "PL", "SE", "BE", "EG", "ZA", "IE" ], "type": "string", "default": "US" }, "description": "Sets the Amazon domain, marketplace country, language and currency." }, { "in": "query", "name": "delivery_country", "schema": { "type": "string" }, "example": "NL", "description": "Delivery destination country (ISO 3166-1 alpha-2 code, e.g. `NL`). When set, delivery dates, shipping costs, availability and offers reflect delivery to this country instead of the marketplace's domestic delivery. Defaults to the marketplace country. \n Only specific `country` / `delivery_country` combinations are supported. Currently supported: `country` = `DE`, `FR`, `IT` or `ES` with `delivery_country` = `NL`. \n Other combinations return a 400 error. If you need another combination, contact us at support@openwebninja.com and we will look into adding it." }, { "in": "query", "name": "delivery_zipcode", "schema": { "type": "string" }, "description": "Postal / ZIP code within the `country` marketplace, in its usual format, used as the delivery address so delivery dates, costs, availability and offers reflect it. An invalid zip code returns a 400 error. Cannot be combined with a different `delivery_country`." }, { "in": "query", "name": "product_condition", "schema": { "type": "string", "default": "NEW, USED_LIKE_NEW, USED_VERY_GOOD, USED_GOOD, USED_ACCEPTABLE" }, "description": "Find products in specific conditions, specified as a comma delimited list of the following values:" }, { "in": "query", "name": "delivery", "schema": { "enum": [ "PRIME_ELIGIBLE", "FREE_DELIVERY" ], "type": "string" }, "description": "Find products with specific delivery option, specified as a comma delimited list of the following values:" }, { "in": "query", "name": "limit", "schema": { "type": "integer", "default": 100 }, "description": "Maximum number of offers to return." }, { "in": "query", "name": "page", "schema": { "type": "integer", "default": 1 }, "description": "Results page to return." }, { "in": "query", "name": "language", "schema": { "type": "string" }, "description": "The language of the results. In case not specified, results will be returned in the default domain language. \n\n **Supported languages per country:** \n `US`: en_US, es_US \n `AU`: en_AU \n `BR`: pt_BR \n `CA`: en_CA, fr_CA \n `FR`: fr_FR, en_GB \n `DE`: de_DE, en_GB, cs_CZ, nl_NL, pl_PL, tr_TR, da_DK \n `IN`: en_IN, hi_IN, ta_IN, te_IN, kn_IN, ml_IN, bn_IN, mr_IN \n `IT`: it_IT, en_GB \n `MX`: es_MX \n `NL`: nl_NL, en_GB \n `SG`: en_SG \n `ES`: es_ES, pt_PT, en_GB \n `TR`: tr_TR \n `AE`: en_AE, ar_AE \n `GB`: en_GB \n `JP`: ja_JP, en_US, zh_CN \n `SA`: ar_AE, en_AE \n `PL`: pl_PL \n `SE`: sv_SE, en_GB \n `BE`: fr_BE, nl_BE, en_GB \n `EG`: ar_AE, en_AE \n `ZA`: en_ZA \n `IE`: en_IE " }, { "in": "query", "name": "fields", "schema": { "type": "string" }, "description": "A comma separated list of product fields to include in the response (field projection). \n By default all fields are returned." } ], "description": "Get all Amazon product details as available via the Product Details endpoint with an additional offers array containing product offers (The first offer in the array is the pinned offer returned by the Search endpoint). \n Supports pagination using the page and limit parameters. \n \n **Billing:** each ASIN is billed as a separate request, so a batch of 10 ASINs counts as 10 requests against the plan quota.", "operationId": "realtime_amazon_data__get__product_offers", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_5-N-bD-w4FEvDbPufA7rY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_JMX_MdcNKNvBSfEXsR78v" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_D1eKbJ9D0SJoHD3LLOLYI", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_WiAI6D9DA33xLudF2TJIh" } ], "x-zeroclick-services": [ "realtime-amazon-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-amazon-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-amazon-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-amazon-data/product-review-details": { "get": { "summary": "Product Review Details", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "country": { "type": "string", "nullable": true, "description": "Country code (ISO 3166-1 alpha-2) of the Amazon marketplace the review was written on. Omitted when it cannot be determined." }, "is_vine": { "type": "boolean", "description": "Indicates whether the review is part of the Amazon Vine program." }, "review_id": { "type": "string", "description": "Unique identifier of the returned review." }, "review_date": { "type": "string", "description": "Date when the review was posted." }, "review_link": { "type": "string", "description": "Direct URL to the review on Amazon." }, "review_title": { "type": "string", "description": "Title or headline of the review." }, "review_video": { "type": "string", "description": "Review video field, null when no video is attached." }, "helpful_votes": { "type": "integer", "nullable": true, "description": "Number of people who found the review helpful. Null when not shown." }, "review_author": { "type": "string", "description": "Display name of the review author." }, "review_images": { "type": "array", "items": { "type": "string" }, "description": "Photos attached to the review." }, "review_comment": { "type": "string", "description": "Full text content of the review." }, "review_date_iso": { "type": "string", "nullable": true, "description": "Review date in ISO 8601 format (YYYY-MM-DD). Null when the date cannot be read." }, "review_language": { "type": "string", "nullable": true, "description": "Language code (ISO 639-1) of the review text. Omitted when it cannot be determined." }, "review_author_id": { "type": "string", "description": "Internal Amazon identifier of the review author." }, "is_different_asin": { "type": "boolean", "nullable": true, "description": "True when the review was written for a different ASIN (another variant of the listing) than the product the review belongs to. Null when the reviewed ASIN is not shown." }, "review_author_url": { "type": "string", "description": "URL to the review author's Amazon profile." }, "review_star_rating": { "type": "string", "description": "Star rating given by the reviewer as text." }, "is_verified_purchase": { "type": "boolean", "description": "Indicates whether Amazon marked the review as a verified purchase." }, "review_author_avatar": { "type": "string", "description": "URL of the review author's avatar image." }, "reviewed_product_url": { "type": "string", "description": "URL of the product detail page for the reviewed item." }, "reviewed_product_asin": { "type": "string", "description": "ASIN of the product that was reviewed." }, "helpful_vote_statement": { "type": "string", "description": "Text describing how many users found the review helpful. Omitted when not shown." }, "reviewed_product_variant": { "type": "object", "properties": { "Size": { "type": "string", "description": "Size variant of the product that was reviewed." } } } } }, "status": { "type": "string", "description": "Overall status of the API request." }, "parameters": { "type": "object", "properties": { "country": { "type": "string", "description": "Country code of the Amazon marketplace for the review." }, "language": { "type": "string", "description": "Language code used to parse and return the review." }, "review_id": { "type": "string", "description": "The Amazon review ID used to fetch this review." } } }, "request_id": { "type": "string", "description": "Unique identifier assigned to this API request." } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "review_id", "schema": { "type": "string" }, "example": "RYRK6K6MMXB9C", "required": true, "description": "The id of the product review for which to get details." }, { "in": "query", "name": "cookie", "schema": { "type": "string" }, "required": true, "description": "A logged-in user cookie to use for fetching product reviews." }, { "in": "query", "name": "country", "schema": { "enum": [ "US", "AU", "BR", "CA", "CN", "FR", "DE", "IN", "IT", "MX", "NL", "SG", "ES", "TR", "AE", "GB", "JP", "SA", "PL", "SE", "BE", "EG", "ZA", "IE" ], "type": "string", "default": "US" }, "description": "Sets the Amazon domain, marketplace country, language and currency." }, { "in": "query", "name": "language", "schema": { "type": "string" }, "description": "The language of the results. In case not specified, results will be returned in the default domain language. \n\n **Supported languages per country:** \n `US`: en_US, es_US \n `AU`: en_AU \n `BR`: pt_BR \n `CA`: en_CA, fr_CA \n `FR`: fr_FR, en_GB \n `DE`: de_DE, en_GB, cs_CZ, nl_NL, pl_PL, tr_TR, da_DK \n `IN`: en_IN, hi_IN, ta_IN, te_IN, kn_IN, ml_IN, bn_IN, mr_IN \n `IT`: it_IT, en_GB \n `MX`: es_MX \n `NL`: nl_NL, en_GB \n `SG`: en_SG \n `ES`: es_ES, pt_PT, en_GB \n `TR`: tr_TR \n `AE`: en_AE, ar_AE \n `GB`: en_GB \n `JP`: ja_JP, en_US, zh_CN \n `SA`: ar_AE, en_AE \n `PL`: pl_PL \n `SE`: sv_SE, en_GB \n `BE`: fr_BE, nl_BE, en_GB \n `EG`: ar_AE, en_AE \n `ZA`: en_ZA \n `IE`: en_IE " }, { "in": "query", "name": "fields", "schema": { "type": "string" }, "description": "A comma separated list of product fields to include in the response (field projection). \n By default all fields are returned." } ], "description": "Get the details of a specific product review by id", "operationId": "realtime_amazon_data__get__product_review_details", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_5-N-bD-w4FEvDbPufA7rY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_JMX_MdcNKNvBSfEXsR78v" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_D1eKbJ9D0SJoHD3LLOLYI", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_WiAI6D9DA33xLudF2TJIh" } ], "x-zeroclick-services": [ "realtime-amazon-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-amazon-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-amazon-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-amazon-data/product-reviews": { "get": { "summary": "Product Reviews", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "asin": { "type": "string", "description": "ASIN of the product whose reviews are returned." }, "domain": { "type": "string", "description": "Amazon domain corresponding to the marketplace." }, "country": { "type": "string", "description": "Country code of the marketplace from which reviews were collected." }, "reviews": { "type": "array", "items": { "type": "object", "properties": { "country": { "type": "string", "nullable": true, "description": "Country code (ISO 3166-1 alpha-2) of the Amazon marketplace the review was written on. Omitted when it cannot be determined." }, "is_vine": { "type": "boolean", "description": "Indicates whether the review is part of the Amazon Vine program." }, "review_id": { "type": "string", "description": "Unique identifier of the review on Amazon." }, "review_date": { "type": "string", "description": "Human-readable date string for when the review was posted." }, "review_link": { "type": "string", "description": "Direct URL to the review on Amazon." }, "review_title": { "type": "string", "description": "Title or headline of the review." }, "review_video": { "type": "string", "nullable": true, "description": "URL of a video attached to the review. Null when there is none." }, "helpful_votes": { "type": "integer", "nullable": true, "description": "Number of people who found the review helpful. Null when not shown." }, "review_author": { "type": "string", "description": "Display name of the review author." }, "review_images": { "type": "array", "items": { "type": "string" }, "description": "Photos attached to the review." }, "review_comment": { "type": "string", "description": "Full text content of the review." }, "review_date_iso": { "type": "string", "nullable": true, "description": "Review date in ISO 8601 format (YYYY-MM-DD). Null when the date cannot be read." }, "review_language": { "type": "string", "nullable": true, "description": "Language code (ISO 639-1) of the review text. Omitted when it cannot be determined." }, "review_author_id": { "type": "string", "description": "Internal Amazon identifier of the review author." }, "is_different_asin": { "type": "boolean", "nullable": true, "description": "True when the review was written for a different ASIN than the requested one (another variant of the listing, or the product on another marketplace). Null when the reviewed ASIN is not shown." }, "review_author_url": { "type": "string", "description": "URL to the review author's Amazon profile." }, "review_star_rating": { "type": "string", "description": "Star rating given by the reviewer as a string." }, "is_verified_purchase": { "type": "boolean", "description": "Indicates whether the review is marked as a verified purchase." }, "review_author_avatar": { "type": "string", "description": "URL of the review author's avatar image." }, "reviewed_product_asin": { "type": "string", "description": "ASIN of the specific product/variation that was reviewed." }, "helpful_vote_statement": { "type": "string", "description": "Text describing how many users found the review helpful." }, "reviewed_product_variant": { "type": "object", "properties": { "Size": { "type": "string", "description": "Size option of the product variant reviewed." }, "Color": { "type": "string", "description": "Color of the product variant reviewed." }, "Product grade": { "type": "string", "description": "Condition or grading of the renewed/refurbished product." }, "Service provider": { "type": "string", "description": "Service provider or carrier associated with the device." } } } } }, "description": "Reviews for the product." }, "total_ratings": { "type": "integer", "description": "Total number of ratings for the product." }, "total_reviews": { "type": "integer", "description": "Total number of reviews matching the given filters." }, "rating_distribution": { "type": "object", "properties": { "1": { "type": "string", "description": "Percentage or count of 1-star ratings." }, "2": { "type": "string", "description": "Percentage or count of 2-star ratings." }, "3": { "type": "string", "description": "Percentage or count of 3-star ratings." }, "4": { "type": "string", "description": "Percentage or count of 4-star ratings." }, "5": { "type": "string", "description": "Percentage or count of 5-star ratings." } } } } }, "status": { "type": "string", "description": "Overall status of the API request." }, "parameters": { "type": "object", "properties": { "asin": { "type": "string", "description": "Amazon ASIN of the product whose reviews are requested." }, "page": { "type": "integer", "description": "Page number of the reviews to fetch." }, "country": { "type": "string", "description": "Country code of the Amazon marketplace." }, "sort_by": { "type": "string", "description": "Sorting method for the reviews (e.g., recent, top)." }, "language": { "type": "string", "description": "Language code used to parse and return review content." }, "star_rating": { "type": "string", "description": "Filter specifying which star rating(s) to include." }, "current_format_only": { "type": "boolean", "description": "Whether to restrict reviews to the currently selected product format/variation." }, "images_or_videos_only": { "type": "boolean", "description": "Whether to include only reviews that contain images or videos." }, "verified_purchases_only": { "type": "boolean", "description": "Whether to include only reviews marked as verified purchases." } } }, "request_id": { "type": "string", "description": "Unique identifier assigned to this API request." } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "asin", "schema": { "type": "string" }, "example": "B07ZPKN6YR", "required": true, "description": "Product asin for which to get reviews." }, { "in": "query", "name": "cookie", "schema": { "type": "string" }, "required": true, "description": "A logged-in user cookie to use for fetching product reviews. Include the following cookies for country=US: session-id, ubid-main, x-main, and at-main. For any other country: session-id, ubid-acb{country code}, x-acb{country code}, at-acb{country code}" }, { "in": "query", "name": "country", "schema": { "enum": [ "US", "AU", "BR", "CA", "CN", "FR", "DE", "IN", "IT", "MX", "NL", "SG", "ES", "TR", "AE", "GB", "JP", "SA", "PL", "SE", "BE", "EG", "ZA", "IE" ], "type": "string", "default": "US" }, "description": "Sets the Amazon domain, marketplace country, language and currency." }, { "in": "query", "name": "cursor", "schema": { "type": "string", "default": 1 }, "description": "A cursor used to retrieve the next set of results for pagination. The value for the next page is returned in the \"cursor\" response field." }, { "in": "query", "name": "sort_by", "schema": { "type": "string", "default": "TOP_REVIEWS" }, "description": "Return reviews in a specific sort order." }, { "in": "query", "name": "star_rating", "schema": { "enum": [ "ALL", "5_STARS", "4_STARS", "3_STARS", "2_STARS", "1_STARS", "POSITIVE", "CRITICAL" ], "type": "string", "default": "ALL" }, "description": "Only return reviews with a specific star rating or positive / negative sentiment." }, { "in": "query", "name": "verified_purchases_only", "schema": { "type": "boolean" }, "description": "Only return reviews by reviewers who made a verified purchase." }, { "in": "query", "name": "images_or_videos_only", "schema": { "type": "boolean" }, "description": "Only return reviews containing images and / or videos." }, { "in": "query", "name": "current_format_only", "schema": { "type": "boolean" }, "description": "Only return reviews of the current format (product variant - e.g. Color). \n By default reviews are returned for all product variants" }, { "in": "query", "name": "query", "schema": { "type": "string" }, "description": "Find reviews matching a search query." }, { "in": "query", "name": "language", "schema": { "type": "string" }, "description": "The language of the results. In case not specified, results will be returned in the default domain language. \n\n **Supported languages per country:** \n `US`: en_US, es_US \n `AU`: en_AU \n `BR`: pt_BR \n `CA`: en_CA, fr_CA \n `FR`: fr_FR, en_GB \n `DE`: de_DE, en_GB, cs_CZ, nl_NL, pl_PL, tr_TR, da_DK \n `IN`: en_IN, hi_IN, ta_IN, te_IN, kn_IN, ml_IN, bn_IN, mr_IN \n `IT`: it_IT, en_GB \n `MX`: es_MX \n `NL`: nl_NL, en_GB \n `SG`: en_SG \n `ES`: es_ES, pt_PT, en_GB \n `TR`: tr_TR \n `AE`: en_AE, ar_AE \n `GB`: en_GB \n `JP`: ja_JP, en_US, zh_CN \n `SA`: ar_AE, en_AE \n `PL`: pl_PL \n `SE`: sv_SE, en_GB \n `BE`: fr_BE, nl_BE, en_GB \n `EG`: ar_AE, en_AE \n `ZA`: en_ZA \n `IE`: en_IE " }, { "in": "query", "name": "fields", "schema": { "type": "string" }, "description": "A comma separated list of product fields to include in the response (field projection). \n By default all fields are returned." } ], "description": "Get and paginate through product reviews on Amazon. Each page contains up to 10 reviews.", "operationId": "realtime_amazon_data__get__product_reviews", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_5-N-bD-w4FEvDbPufA7rY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_JMX_MdcNKNvBSfEXsR78v" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_D1eKbJ9D0SJoHD3LLOLYI", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_WiAI6D9DA33xLudF2TJIh" } ], "x-zeroclick-services": [ "realtime-amazon-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-amazon-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-amazon-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-amazon-data/products-by-category": { "get": { "summary": "Products by Category", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "domain": { "type": "string", "description": "Domain or marketplace identifier" }, "country": { "type": "string", "description": "Country where the search was performed" }, "products": { "type": "array", "items": { "type": "object" }, "description": "List of products in the requested category." }, "total_products": { "type": "integer", "description": "Total number of products matching the query" } } }, "status": { "type": "string", "description": "The status of the API response" }, "parameters": { "type": "object", "properties": { "page": { "type": "integer", "description": "Current page number in pagination" }, "query": { "type": "string", "description": "The search query term" }, "country": { "type": "string", "description": "Country code for the search" }, "sort_by": { "type": "string", "description": "Sorting method for results" }, "is_prime": { "type": "boolean", "description": "Filter for Prime-eligible products" } } }, "request_id": { "type": "string", "description": "Unique identifier for the API request" } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "category_id", "schema": { "type": "string" }, "example": 2858778013, "required": true, "description": "The Amazon category for which to return results. \n The category ID can be obtained from the Amazon category results URL, for example: \n https://amazon.com/s?node=2858778013 - the Amazon Category ID is `2858778013`. \n Multiple category values can be separated by comma (e.g. categoryId1,categoryId2)." }, { "in": "query", "name": "page", "schema": { "type": "integer", "default": 1 }, "description": "Page to return." }, { "in": "query", "name": "country", "schema": { "enum": [ "US", "AU", "BR", "CA", "CN", "FR", "DE", "IN", "IT", "MX", "NL", "SG", "ES", "TR", "AE", "GB", "JP", "SA", "PL", "SE", "BE", "EG", "ZA", "IE" ], "type": "string", "default": "US" }, "description": "Sets the Amazon domain, marketplace country, language and currency." }, { "in": "query", "name": "delivery_country", "schema": { "type": "string" }, "example": "NL", "description": "Delivery destination country (ISO 3166-1 alpha-2 code, e.g. `NL`). When set, delivery dates, shipping costs, availability and offers reflect delivery to this country instead of the marketplace's domestic delivery. Defaults to the marketplace country. \n Only specific `country` / `delivery_country` combinations are supported. Currently supported: `country` = `DE`, `FR`, `IT` or `ES` with `delivery_country` = `NL`. \n Other combinations return a 400 error. If you need another combination, contact us at support@openwebninja.com and we will look into adding it." }, { "in": "query", "name": "delivery_zipcode", "schema": { "type": "string" }, "description": "Postal / ZIP code within the `country` marketplace, in its usual format, used as the delivery address so delivery dates, costs, availability and offers reflect it. An invalid zip code returns a 400 error. Cannot be combined with a different `delivery_country`." }, { "in": "query", "name": "sort_by", "schema": { "enum": [ "RELEVANCE", "LOWEST_PRICE", "HIGHEST_PRICE", "REVIEWS", "NEWEST", "BEST_SELLERS" ], "type": "string", "default": "RELEVANCE" }, "description": "Return the results in a specific sort order." }, { "in": "query", "name": "min_price", "schema": { "type": "number" }, "description": "Only return product offers with price greater than a certain value. \n Specified in the currency of the selected country. \n For example, in case `country=US`, a value of `105.34` means `$105.34`." }, { "in": "query", "name": "max_price", "schema": { "type": "integer" }, "description": "Only return product offers with price lower than a certain value. \n Specified in the currency of the selected country. \n For example, in case `country=US`, a value of `105.34` means `$105.34`." }, { "in": "query", "name": "product_condition", "schema": { "enum": [ "ALL", "NEW", "USED", "RENEWED", "COLLECTIBLE" ], "type": "string", "default": "ALL" }, "description": "Return products in a specific condition." }, { "in": "query", "name": "brand", "schema": { "type": "string" }, "description": "Find products with a specific brand. \n Multiple brands can be specified as a comma (,) separated list. \n The brand values can be seen from Amazon's search left filters panel, as seen here." }, { "in": "query", "name": "is_prime", "schema": { "type": "boolean", "default": false }, "description": "Only return prime products." }, { "in": "query", "name": "deals_and_discounts", "schema": { "enum": [ "NONE", "ALL_DISCOUNTS", "TODAYS_DEALS" ], "type": "string", "default": "NONE" }, "description": "Return deals and discounts in a specific condition." }, { "in": "query", "name": "four_stars_and_up", "schema": { "type": "boolean" }, "description": "Return product listings with ratings of 4 stars & up." }, { "in": "query", "name": "language", "schema": { "type": "string" }, "description": "The language of the results. In case not specified, results will be returned in the default domain language. \n\n **Supported languages per country:** \n `US`: en_US, es_US \n `AU`: en_AU \n `BR`: pt_BR \n `CA`: en_CA, fr_CA \n `FR`: fr_FR, en_GB \n `DE`: de_DE, en_GB, cs_CZ, nl_NL, pl_PL, tr_TR, da_DK \n `IN`: en_IN, hi_IN, ta_IN, te_IN, kn_IN, ml_IN, bn_IN, mr_IN \n `IT`: it_IT, en_GB \n `MX`: es_MX \n `NL`: nl_NL, en_GB \n `SG`: en_SG \n `ES`: es_ES, pt_PT, en_GB \n `TR`: tr_TR \n `AE`: en_AE, ar_AE \n `GB`: en_GB \n `JP`: ja_JP, en_US, zh_CN \n `SA`: ar_AE, en_AE \n `PL`: pl_PL \n `SE`: sv_SE, en_GB \n `BE`: fr_BE, nl_BE, en_GB \n `EG`: ar_AE, en_AE \n `ZA`: en_ZA \n `IE`: en_IE " }, { "in": "query", "name": "additional_filters", "schema": { "type": "string" }, "description": "Any filters available on the Amazon page but not part of this endpoint's parameters. \n The filter values can be extracted from the rh parameter in the Amazon search URL after applying the filter of interest on the Amazon search results page. \n Multiple filters are supported and can be separated by comma (,). \n For example, when searching for science books with the Paperback book format filter selected, the Amazon URL is: \n https://www.amazon.com/s?k=science+books&rh=p_n_feature_browse-bin%3A2656022011 \n and the rh parameter value is: \n `p_n_feature_browse-bin%3A2656022011` \n To filter for Paperback books, set the value of additional_parameters=p_n_feature_browse-bin%3A2656022011." }, { "in": "query", "name": "fields", "schema": { "type": "string" }, "description": "A comma separated list of product fields to include in the response (field projection). \n By default all fields are returned." } ], "description": "Get products & offers in a specific Amazon category with pagination support and multiple filters and options such as sort option, price range, product condition filter, and more.", "operationId": "realtime_amazon_data__get__products_by_category", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds__1fiQu9RHG0jaOVImz_2s", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_fMzoiFNl9X0S__Sj10MeV" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds_5fumgq7Dew7p7p505C6Vj", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_UDnMGDO2AU7l2pD7FR4rR" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_72qMF9r94Nlws9PyhMdQm", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_Y4vhW7SNsmRcmxb4fXsm8" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds_pt9NurvrIG0m5qHbodTXY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description" ], "revisionId": "sdrn_B6aXroJb6q7sAixORNC4V" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_vaNNaw5q29aKLh-qRSfR0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description" ], "revisionId": "sdrn_SrJ_OL_N_pZ70W8niC6g0" } ], "x-zeroclick-services": [ "realtime-amazon-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-amazon-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-amazon-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-amazon-data/promo-code-details": { "get": { "summary": "Promo Code Details", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "domain": { "type": "string", "description": "Amazon marketplace domain" }, "country": { "type": "string", "description": "Country where promotion is valid" }, "products": { "type": "array", "items": { "type": "object", "properties": { "asin": { "type": "string", "description": "Amazon Standard Identification Number" }, "product_url": { "type": "string", "description": "URL to the product page" }, "product_photo": { "type": "string", "description": "URL of the product image" }, "product_price": { "type": "string", "description": "Current price with promotion applied" }, "product_title": { "type": "string", "description": "Title of the product" }, "product_num_ratings": { "type": "string", "description": "Number of customer ratings" }, "product_star_rating": { "type": "string", "description": "Average customer rating" }, "product_availability": { "type": "string", "description": "Current stock availability status" } } } }, "promo_title": { "type": "string", "description": "Title of the promotion" }, "is_promo_available": { "type": "boolean", "description": "Whether the promotion is currently active" }, "discount_percentage": { "type": "integer", "description": "Percentage discount offered by the promotion" } } }, "status": { "type": "string", "description": "Status of the API response" }, "parameters": { "type": "object", "properties": { "country": { "type": "string", "description": "Country code for the promotion" }, "promo_code": { "type": "string", "description": "Promotion code to apply" } } }, "request_id": { "type": "string", "description": "Unique identifier for the API request" } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "promo_code", "schema": { "type": "string" }, "example": "AZDIA7AYE39P2", "required": true, "description": "Promo code for which to get products. \n The promo code can be extracted from the /promocode Amazon URL. \n For example the promo code for https://www.amazon.com/promocode/A31M10S4V50SOU is A31M10S4V50SOU." }, { "in": "query", "name": "country", "schema": { "enum": [ "US", "AU", "BR", "CA", "CN", "FR", "DE", "IN", "IT", "MX", "NL", "SG", "ES", "TR", "AE", "GB", "JP", "SA", "PL", "SE", "BE", "EG", "ZA", "IE" ], "type": "string", "default": "US" }, "description": "Sets the Amazon domain, marketplace country, language and currency." }, { "in": "query", "name": "delivery_country", "schema": { "type": "string" }, "example": "NL", "description": "Delivery destination country (ISO 3166-1 alpha-2 code, e.g. `NL`). When set, delivery dates, shipping costs, availability and offers reflect delivery to this country instead of the marketplace's domestic delivery. Defaults to the marketplace country. \n Only specific `country` / `delivery_country` combinations are supported. Currently supported: `country` = `DE`, `FR`, `IT` or `ES` with `delivery_country` = `NL`. \n Other combinations return a 400 error. If you need another combination, contact us at support@openwebninja.com and we will look into adding it." }, { "in": "query", "name": "delivery_zipcode", "schema": { "type": "string" }, "description": "Postal / ZIP code within the `country` marketplace, in its usual format, used as the delivery address so delivery dates, costs, availability and offers reflect it. An invalid zip code returns a 400 error. Cannot be combined with a different `delivery_country`." }, { "in": "query", "name": "language", "schema": { "type": "string" }, "description": "The language of the results. In case not specified, results will be returned in the default domain language. \n\n **Supported languages per country:** \n `US`: en_US, es_US \n `AU`: en_AU \n `BR`: pt_BR \n `CA`: en_CA, fr_CA \n `FR`: fr_FR, en_GB \n `DE`: de_DE, en_GB, cs_CZ, nl_NL, pl_PL, tr_TR, da_DK \n `IN`: en_IN, hi_IN, ta_IN, te_IN, kn_IN, ml_IN, bn_IN, mr_IN \n `IT`: it_IT, en_GB \n `MX`: es_MX \n `NL`: nl_NL, en_GB \n `SG`: en_SG \n `ES`: es_ES, pt_PT, en_GB \n `TR`: tr_TR \n `AE`: en_AE, ar_AE \n `GB`: en_GB \n `JP`: ja_JP, en_US, zh_CN \n `SA`: ar_AE, en_AE \n `PL`: pl_PL \n `SE`: sv_SE, en_GB \n `BE`: fr_BE, nl_BE, en_GB \n `EG`: ar_AE, en_AE \n `ZA`: en_ZA \n `IE`: en_IE " } ], "description": "Get the products offered by an Amazon promo code.", "operationId": "realtime_amazon_data__get__promo_code_details", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds__1fiQu9RHG0jaOVImz_2s", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_fMzoiFNl9X0S__Sj10MeV" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds_5fumgq7Dew7p7p505C6Vj", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_UDnMGDO2AU7l2pD7FR4rR" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_72qMF9r94Nlws9PyhMdQm", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_Y4vhW7SNsmRcmxb4fXsm8" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds_pt9NurvrIG0m5qHbodTXY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description" ], "revisionId": "sdrn_B6aXroJb6q7sAixORNC4V" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_vaNNaw5q29aKLh-qRSfR0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description" ], "revisionId": "sdrn_SrJ_OL_N_pZ70W8niC6g0" } ], "x-zeroclick-services": [ "realtime-amazon-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-amazon-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-amazon-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-amazon-data/scrape-by-url": { "get": { "summary": "Scrape By URL", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "asin": { "type": "string", "description": "Product ASIN (when page_type is product_details or product_reviews)." }, "html": { "type": "string", "description": "Raw HTML of the scraped page (only included when return_html=true)." }, "deals": { "type": "array", "items": { "type": "object" }, "description": "List of deals (when page_type is deals)." }, "domain": { "type": "string", "description": "Amazon domain used for the request." }, "country": { "type": "string", "description": "Marketplace country where the data was fetched." }, "currency": { "type": "string", "description": "Currency of the listed price." }, "is_prime": { "type": "boolean", "description": "Whether the product is eligible for Prime." }, "products": { "type": "array", "items": { "type": "object" }, "description": "List of products (when page_type is search, products_by_category, or seller_products)." }, "page_type": { "type": "string", "description": "The detected type of Amazon page. Determines the structure of the rest of the data object.\n**Possible values:** `product_details`, `product_reviews`, `deals`, `best_sellers`, `seller_profile`, `seller_products`, `haul`, `products_by_category`, `search`, `unknown`" }, "seller_id": { "type": "string", "description": "Seller identifier (when page_type is seller_profile or seller_products)." }, "product_url": { "type": "string", "description": "Canonical Amazon product URL." }, "top_reviews": { "type": "array", "items": { "type": "object" }, "description": "Top customer reviews from the product page." }, "best_sellers": { "type": "array", "items": { "type": "object" }, "description": "List of best seller products (when page_type is best_sellers)." }, "product_slug": { "type": "string", "description": "SEO-friendly slug derived from the product title." }, "sales_volume": { "type": "string", "description": "Sales velocity/volume label if present." }, "about_product": { "type": "array", "items": { "type": "string" }, "description": "List of bullet point descriptions from the product page." }, "product_photo": { "type": "string", "description": "URL of the main product image." }, "product_price": { "type": "string", "description": "Displayed current price (product_details page type)." }, "product_title": { "type": "string", "description": "Full product title as shown on Amazon (product_details page type)." }, "is_best_seller": { "type": "boolean", "description": "Whether the product is flagged as a Best Seller." }, "product_byline": { "type": "string", "description": "Byline text (e.g., brand/store attribution)." }, "product_photos": { "type": "array", "items": { "type": "string" }, "description": "List of product image URLs." }, "product_videos": { "type": "array", "items": { "type": "object" }, "description": "List of product video objects." }, "product_details": { "type": "object", "description": "Technical details / specifications of the product.", "additionalProperties": { "type": "string" } }, "is_amazon_choice": { "type": "boolean", "description": "Whether the product is marked as Amazon's Choice." }, "product_condition": { "type": "string", "description": "Product condition (New, Used, Renewed, etc.)." }, "product_num_offers": { "type": "integer", "description": "Count of available offers for this product." }, "top_reviews_global": { "type": "array", "items": { "type": "object" }, "description": "Top global customer reviews." }, "product_byline_link": { "type": "string", "description": "Primary link behind the byline." }, "product_description": { "type": "string", "description": "Long-form product description." }, "product_information": { "type": "object", "description": "Key-value pairs from the product information section.", "additionalProperties": { "type": "string" } }, "product_num_ratings": { "type": "integer", "description": "Total number of ratings." }, "product_star_rating": { "type": "string", "description": "Average star rating shown on the page." }, "rating_distribution": { "type": "object", "properties": { "1": { "type": "integer", "description": "Percentage of 1-star ratings." }, "2": { "type": "integer", "description": "Percentage of 2-star ratings." }, "3": { "type": "integer", "description": "Percentage of 3-star ratings." }, "4": { "type": "integer", "description": "Percentage of 4-star ratings." }, "5": { "type": "integer", "description": "Percentage of 5-star ratings." } } }, "product_availability": { "type": "string", "description": "Availability status text." }, "product_byline_links": { "type": "array", "items": { "type": "string" }, "description": "Links behind the byline (brand / author / store)." }, "product_original_price": { "type": "string", "description": "Original list price before discounts (product_details page type)." }, "climate_pledge_friendly": { "type": "boolean", "description": "Whether the product is marked Climate Pledge Friendly." } }, "description": "The scraped and parsed data. The structure varies based on the detected page_type. The page_type field is always present and indicates what kind of Amazon page was scraped. For a product page (page_type `product_details`) the data object has every field of the Product Details endpoint response (for example best_sellers_rank, review_aspects_details, main_buy_box and frequently_bought_together); only the main ones are listed below." }, "status": { "type": "string", "description": "The status of the response." }, "parameters": { "type": "object", "properties": { "url": { "type": "string", "description": "The Amazon URL that was scraped." }, "country": { "type": "string", "description": "Amazon marketplace country code used for the request." }, "language": { "type": "string", "description": "Language used to fetch/parse the page." } } }, "request_id": { "type": "string", "description": "A unique identifier for the request." } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "url", "schema": { "type": "string" }, "example": "https://www.amazon.com/dp/B0D1XD1ZV3", "required": true, "description": "The full Amazon URL to scrape. The API automatically detects the page type and returns the appropriate parsed data.\n\n **Supported page types:**\n - Product details (e.g. `https://www.amazon.com/dp/B0D1XD1ZV3`)\n - Product reviews (e.g. `https://www.amazon.com/product-reviews/B0D1XD1ZV3`)\n - Deals (e.g. `https://www.amazon.com/deals`)\n - Best sellers (e.g. `https://www.amazon.com/Best-Sellers/zgbs`)\n - Seller profile (e.g. `https://www.amazon.com/sp?seller=A1D09S7Q0OD6TH`)\n - Seller products\n - Search results\n - Amazon Haul" }, { "in": "query", "name": "country", "schema": { "enum": [ "US", "AU", "BR", "CA", "CN", "FR", "DE", "IN", "IT", "MX", "NL", "SG", "ES", "TR", "AE", "GB", "JP", "SA", "PL", "SE", "BE", "EG", "ZA", "IE" ], "type": "string", "default": "US" }, "description": "Sets the Amazon domain, marketplace country, language and currency." }, { "in": "query", "name": "delivery_country", "schema": { "type": "string" }, "example": "NL", "description": "Delivery destination country (ISO 3166-1 alpha-2 code, e.g. `NL`). When set, delivery dates, shipping costs, availability and offers reflect delivery to this country instead of the marketplace's domestic delivery. Defaults to the marketplace country. \n Only specific `country` / `delivery_country` combinations are supported. Currently supported: `country` = `DE`, `FR`, `IT` or `ES` with `delivery_country` = `NL`. \n Other combinations return a 400 error. If you need another combination, contact us at support@openwebninja.com and we will look into adding it." }, { "in": "query", "name": "delivery_zipcode", "schema": { "type": "string" }, "description": "Postal / ZIP code within the `country` marketplace, in its usual format, used as the delivery address so delivery dates, costs, availability and offers reflect it. An invalid zip code returns a 400 error. Cannot be combined with a different `delivery_country`." }, { "in": "query", "name": "language", "schema": { "type": "string" }, "description": "The language of the results. In case not specified, results will be returned in the default domain language.\n\n **Supported languages per country:**\n `US`: en_US, es_US\n `AU`: en_AU\n `BR`: pt_BR\n `CA`: en_CA, fr_CA\n `FR`: fr_FR, en_GB\n `DE`: de_DE, en_GB, cs_CZ, nl_NL, pl_PL, tr_TR, da_DK\n `IN`: en_IN, hi_IN, ta_IN, te_IN, kn_IN, ml_IN, bn_IN, mr_IN\n `IT`: it_IT, en_GB\n `MX`: es_MX\n `NL`: nl_NL, en_GB\n `SG`: en_SG\n `ES`: es_ES, pt_PT, en_GB\n `TR`: tr_TR\n `AE`: en_AE, ar_AE\n `GB`: en_GB\n `JP`: ja_JP, en_US, zh_CN\n `SA`: ar_AE, en_AE\n `PL`: pl_PL\n `SE`: sv_SE, en_GB\n `BE`: fr_BE, nl_BE, en_GB\n `EG`: ar_AE, en_AE\n `ZA`: en_ZA\n `IE`: en_IE" }, { "in": "query", "name": "cookie", "schema": { "type": "string" }, "description": "Custom cookie string to use when scraping the URL." }, { "in": "query", "name": "return_html", "schema": { "enum": [ "true", "false" ], "type": "string", "default": "false" }, "description": "Include the raw HTML of the scraped page in the response.\n**Default:** `false`" } ], "description": "Scrape any Amazon page by providing a full URL. The API automatically detects the page type (product details, product reviews, deals, best sellers, seller profile, seller products, search results, etc.) and returns parsed, structured data accordingly.", "operationId": "realtime_amazon_data__get__scrape_by_url", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds__1fiQu9RHG0jaOVImz_2s", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_fMzoiFNl9X0S__Sj10MeV" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds_5fumgq7Dew7p7p505C6Vj", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_UDnMGDO2AU7l2pD7FR4rR" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_72qMF9r94Nlws9PyhMdQm", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_Y4vhW7SNsmRcmxb4fXsm8" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds_pt9NurvrIG0m5qHbodTXY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description" ], "revisionId": "sdrn_B6aXroJb6q7sAixORNC4V" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_vaNNaw5q29aKLh-qRSfR0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description" ], "revisionId": "sdrn_SrJ_OL_N_pZ70W8niC6g0" } ], "x-zeroclick-services": [ "realtime-amazon-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-amazon-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-amazon-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-amazon-data/search": { "get": { "summary": "Product Search", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "domain": { "type": "string", "description": "Domain where the products are listed" }, "country": { "type": "string", "description": "Country where the search was performed" }, "products": { "type": "array", "items": { "type": "object" }, "description": "List of products matching the search query." }, "total_products": { "type": "integer", "description": "Total number of products matching the query" } } }, "status": { "type": "string", "description": "The status of the API response" }, "parameters": { "type": "object", "properties": { "page": { "type": "integer", "description": "Current page number in pagination" }, "query": { "type": "string", "description": "The search query string" }, "country": { "type": "string", "description": "Country code for the search" }, "sort_by": { "type": "string", "description": "Field to sort results by" }, "is_prime": { "type": "boolean", "description": "Filter for Prime-eligible products" } } }, "request_id": { "type": "string", "description": "Unique identifier for the API request" } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "query", "schema": { "type": "string" }, "example": "Phone", "required": true, "description": "Search query (supports both free-form text queries or a product asin)." }, { "in": "query", "name": "page", "schema": { "type": "integer", "default": 1 }, "description": "Results page to return." }, { "in": "query", "name": "country", "schema": { "enum": [ "US", "AU", "BR", "CA", "CN", "FR", "DE", "IN", "IT", "MX", "NL", "SG", "ES", "TR", "AE", "GB", "JP", "SA", "PL", "SE", "BE", "EG", "ZA", "IE" ], "type": "string", "default": "US" }, "description": "Sets the Amazon domain, marketplace country, language and currency." }, { "in": "query", "name": "delivery_country", "schema": { "type": "string" }, "example": "NL", "description": "Delivery destination country (ISO 3166-1 alpha-2 code, e.g. `NL`). When set, delivery dates, shipping costs, availability and offers reflect delivery to this country instead of the marketplace's domestic delivery. Defaults to the marketplace country. \n Only specific `country` / `delivery_country` combinations are supported. Currently supported: `country` = `DE`, `FR`, `IT` or `ES` with `delivery_country` = `NL`. \n Other combinations return a 400 error. If you need another combination, contact us at support@openwebninja.com and we will look into adding it." }, { "in": "query", "name": "delivery_zipcode", "schema": { "type": "string" }, "description": "Postal / ZIP code within the `country` marketplace, in its usual format, used as the delivery address so delivery dates, costs, availability and offers reflect it. An invalid zip code returns a 400 error. Cannot be combined with a different `delivery_country`." }, { "in": "query", "name": "sort_by", "schema": { "enum": [ "RELEVANCE", "LOWEST_PRICE", "HIGHEST_PRICE", "REVIEWS", "NEWEST", "BEST_SELLERS" ], "type": "string", "default": "RELEVANCE" }, "description": "Return the results in a specific sort order." }, { "in": "query", "name": "category_id", "schema": { "type": "string", "default": "aps (All Departments)" }, "description": "Find products in a specific category / department (e.g. computers-intl-ship). \n Use the Product Category List endpoint to get a list of valid categories and their ids for the country specified in the request. \n For numeric Amazon category IDs, use the category parameter instead." }, { "in": "query", "name": "category", "schema": { "type": "string" }, "description": "Filter by specific numeric Amazon category. \n The category ID can be obtained from the Amazon category results URL, for example: \n https://amazon.com/s?node=2858778013 - the Amazon Category ID is `2858778013`. \n Multiple category values can be separated by comma (e.g. categoryId1,categoryId2)." }, { "in": "query", "name": "min_price", "schema": { "type": "integer" }, "description": "Only return product offers with price greater than a certain value. \n Specified in the currency of the selected country. \n For example, in case `country=US`, a value of `105.34` means `$105.34`." }, { "in": "query", "name": "max_price", "schema": { "type": "integer" }, "description": "Only return product offers with price lower than a certain value. \n Specified in the currency of the selected country. \n For example, in case `country=US`, a value of `105.34` means `$105.34`." }, { "in": "query", "name": "product_condition", "schema": { "enum": [ "ALL", "NEW", "USED", "RENEWED", "COLLECTIBLE" ], "type": "string", "default": "ALL" }, "description": "Return products in a specific condition." }, { "in": "query", "name": "brand", "schema": { "type": "string" }, "description": "Find products with a specific brand. \n Multiple brands can be specified as a comma (,) separated list. \n The brand values can be seen from Amazon's search left filters panel, as seen here." }, { "in": "query", "name": "seller_id", "schema": { "type": "string" }, "description": "Find products sold by a specific seller (merchant). Multiple sellers can be specified as a comma (,) separated list." }, { "in": "query", "name": "is_prime", "schema": { "type": "boolean", "default": false }, "description": "Only return prime products." }, { "in": "query", "name": "deals_and_discounts", "schema": { "enum": [ "NONE", "ALL_DISCOUNTS", "TODAYS_DEALS" ], "type": "string", "default": "NONE" }, "description": "Return deals and discounts in a specific condition." }, { "in": "query", "name": "four_stars_and_up", "schema": { "type": "boolean" }, "description": "Return product listings with ratings of 4 stars & up." }, { "in": "query", "name": "language", "schema": { "type": "string" }, "description": "The language of the results. In case not specified, results will be returned in the default domain language. \n\n **Supported languages per country:** \n `US`: en_US, es_US \n `AU`: en_AU \n `BR`: pt_BR \n `CA`: en_CA, fr_CA \n `FR`: fr_FR, en_GB \n `DE`: de_DE, en_GB, cs_CZ, nl_NL, pl_PL, tr_TR, da_DK \n `IN`: en_IN, hi_IN, ta_IN, te_IN, kn_IN, ml_IN, bn_IN, mr_IN \n `IT`: it_IT, en_GB \n `MX`: es_MX \n `NL`: nl_NL, en_GB \n `SG`: en_SG \n `ES`: es_ES, pt_PT, en_GB \n `TR`: tr_TR \n `AE`: en_AE, ar_AE \n `GB`: en_GB \n `JP`: ja_JP, en_US, zh_CN \n `SA`: ar_AE, en_AE \n `PL`: pl_PL \n `SE`: sv_SE, en_GB \n `BE`: fr_BE, nl_BE, en_GB \n `EG`: ar_AE, en_AE \n `ZA`: en_ZA\n `IE`: en_IE" }, { "in": "query", "name": "additional_filters", "schema": { "type": "string" }, "description": "Any filters available on the Amazon page but not part of this endpoint's parameters. \n The filter values can be extracted from the rh parameter in the Amazon search URL after applying the filter of interest on the Amazon search results page. \n Multiple filters are supported and can be separated by comma (,). \n For example, when searching for science books with the Paperback book format filter selected, the Amazon URL is: \n https://www.amazon.com/s?k=science+books&rh=p_n_feature_browse-bin%3A2656022011 \n and the rh parameter value is: \n `p_n_feature_browse-bin%3A2656022011` \n To filter for Paperback books, set the value of additional_parameters=p_n_feature_browse-bin%3A2656022011." }, { "in": "query", "name": "fields", "schema": { "type": "string" }, "description": "A comma separated list of product fields to include in the response (field projection). \n By default all fields are returned." } ], "description": "Search for products & offers on Amazon with pagination support and multiple filters and options such as sort option, price range, product condition filter, and more.", "operationId": "realtime_amazon_data__get__search", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds__1fiQu9RHG0jaOVImz_2s", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_fMzoiFNl9X0S__Sj10MeV" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds_5fumgq7Dew7p7p505C6Vj", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_UDnMGDO2AU7l2pD7FR4rR" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_72qMF9r94Nlws9PyhMdQm", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_Y4vhW7SNsmRcmxb4fXsm8" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds_pt9NurvrIG0m5qHbodTXY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description" ], "revisionId": "sdrn_B6aXroJb6q7sAixORNC4V" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_vaNNaw5q29aKLh-qRSfR0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description" ], "revisionId": "sdrn_SrJ_OL_N_pZ70W8niC6g0" } ], "x-zeroclick-services": [ "realtime-amazon-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-amazon-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-amazon-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-amazon-data/seller-products": { "get": { "summary": "Seller Products", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "domain": { "type": "string", "description": "Amazon marketplace domain" }, "country": { "type": "string", "description": "Country where products are listed" }, "seller_id": { "type": "string", "description": "Unique identifier of the seller" }, "total_products": { "type": "integer", "description": "Total number of products available from seller" }, "seller_products": { "type": "array", "items": { "type": "object" }, "description": "List of products listed by the seller." } } }, "status": { "type": "string", "description": "Status of the API response" }, "parameters": { "type": "object", "properties": { "page": { "type": "integer", "description": "Current page number in pagination" }, "country": { "type": "string", "description": "Country code for the marketplace" }, "sort_by": { "type": "string", "description": "Sorting method for products" }, "seller_id": { "type": "string", "description": "Unique identifier of the seller" } } }, "request_id": { "type": "string", "description": "Unique identifier for the API request" } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "seller_id", "schema": { "type": "string" }, "example": "A02211013Q5HP3OMSZC7W", "required": true, "description": "The Amazon Seller ID for which to get seller product listings" }, { "in": "query", "name": "country", "schema": { "enum": [ "US", "AU", "BR", "CA", "CN", "FR", "DE", "IN", "IT", "MX", "NL", "SG", "ES", "TR", "AE", "GB", "JP", "SA", "PL", "SE", "BE", "EG", "ZA", "IE" ], "type": "string", "default": "US" }, "description": "Sets the Amazon domain, marketplace country, language and currency." }, { "in": "query", "name": "delivery_country", "schema": { "type": "string" }, "example": "NL", "description": "Delivery destination country (ISO 3166-1 alpha-2 code, e.g. `NL`). When set, delivery dates, shipping costs, availability and offers reflect delivery to this country instead of the marketplace's domestic delivery. Defaults to the marketplace country. \n Only specific `country` / `delivery_country` combinations are supported. Currently supported: `country` = `DE`, `FR`, `IT` or `ES` with `delivery_country` = `NL`. \n Other combinations return a 400 error. If you need another combination, contact us at support@openwebninja.com and we will look into adding it." }, { "in": "query", "name": "delivery_zipcode", "schema": { "type": "string" }, "description": "Postal / ZIP code within the `country` marketplace, in its usual format, used as the delivery address so delivery dates, costs, availability and offers reflect it. An invalid zip code returns a 400 error. Cannot be combined with a different `delivery_country`." }, { "in": "query", "name": "page", "schema": { "type": "integer", "default": 1 }, "description": "The page of seller products results to retrieve Seller products result page to retrieve." }, { "in": "query", "name": "sort_by", "schema": { "enum": [ "RELEVANCE", "LOWEST_PRICE", "HIGHEST_PRICE", "REVIEWS", "NEWEST", "BEST_SELLERS" ], "type": "string", "default": "RELEVANCE" }, "description": "Return the results in a specific sort order." }, { "in": "query", "name": "language", "schema": { "type": "string" }, "description": "The language of the results. In case not specified, results will be returned in the default domain language. \n\n **Supported languages per country:** \n `US`: en_US, es_US \n `AU`: en_AU \n `BR`: pt_BR \n `CA`: en_CA, fr_CA \n `FR`: fr_FR, en_GB \n `DE`: de_DE, en_GB, cs_CZ, nl_NL, pl_PL, tr_TR, da_DK \n `IN`: en_IN, hi_IN, ta_IN, te_IN, kn_IN, ml_IN, bn_IN, mr_IN \n `IT`: it_IT, en_GB \n `MX`: es_MX \n `NL`: nl_NL, en_GB \n `SG`: en_SG \n `ES`: es_ES, pt_PT, en_GB \n `TR`: tr_TR \n `AE`: en_AE, ar_AE \n `GB`: en_GB \n `JP`: ja_JP, en_US, zh_CN \n `SA`: ar_AE, en_AE \n `PL`: pl_PL \n `SE`: sv_SE, en_GB \n `BE`: fr_BE, nl_BE, en_GB \n `EG`: ar_AE, en_AE \n `ZA`: en_ZA \n `IE`: en_IE " }, { "in": "query", "name": "fields", "schema": { "type": "string" }, "description": "A comma separated list of seller product fields to include in the response (field projection). \n By default all fields are returned." } ], "description": "Get and paginate through the products sold by an Amazon Seller", "operationId": "realtime_amazon_data__get__seller_products", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds__1fiQu9RHG0jaOVImz_2s", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_fMzoiFNl9X0S__Sj10MeV" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds_5fumgq7Dew7p7p505C6Vj", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_UDnMGDO2AU7l2pD7FR4rR" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_72qMF9r94Nlws9PyhMdQm", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_Y4vhW7SNsmRcmxb4fXsm8" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds_pt9NurvrIG0m5qHbodTXY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description" ], "revisionId": "sdrn_B6aXroJb6q7sAixORNC4V" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_vaNNaw5q29aKLh-qRSfR0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description" ], "revisionId": "sdrn_SrJ_OL_N_pZ70W8niC6g0" } ], "x-zeroclick-services": [ "realtime-amazon-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-amazon-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-amazon-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-amazon-data/seller-profile": { "get": { "summary": "Seller Profile", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "logo": { "type": "string", "description": "URL to seller's logo image" }, "name": { "type": "string", "description": "Name of the seller" }, "phone": { "type": "string", "description": "Seller's contact phone number" }, "domain": { "type": "string", "description": "Amazon marketplace domain" }, "rating": { "type": "number", "description": "Average seller rating" }, "country": { "type": "string", "description": "Country where the seller operates" }, "seller_id": { "type": "string", "description": "Unique identifier for the seller" }, "store_link": { "type": "string", "description": "URL to seller's storefront" }, "seller_link": { "type": "string", "description": "URL to seller's profile page" }, "business_name": { "type": "string", "description": "Legal business name" }, "ratings_total": { "type": "integer", "description": "Total number of ratings received" }, "business_address": { "type": "string", "description": "Physical business address" }, "detailed_information": { "type": "string", "description": "Additional seller information" } } }, "status": { "type": "string", "description": "Status of the API response" }, "request_id": { "type": "string", "description": "Unique identifier for the API request" } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "seller_id", "schema": { "type": "string" }, "example": "A02211013Q5HP3OMSZC7W", "required": true, "description": "The Amazon Seller ID for which to get seller profile details" }, { "in": "query", "name": "country", "schema": { "enum": [ "US", "AU", "BR", "CA", "CN", "FR", "DE", "IN", "IT", "MX", "NL", "SG", "ES", "TR", "AE", "GB", "JP", "SA", "PL", "SE", "BE", "EG", "ZA", "IE" ], "type": "string", "default": "US" }, "description": "Sets the Amazon domain, marketplace country, language and currency." }, { "in": "query", "name": "language", "schema": { "type": "string" }, "description": "The language of the results. In case not specified, results will be returned in the default domain language. \n\n **Supported languages per country:** \n `US`: en_US, es_US \n `AU`: en_AU \n `BR`: pt_BR \n `CA`: en_CA, fr_CA \n `FR`: fr_FR, en_GB \n `DE`: de_DE, en_GB, cs_CZ, nl_NL, pl_PL, tr_TR, da_DK \n `IN`: en_IN, hi_IN, ta_IN, te_IN, kn_IN, ml_IN, bn_IN, mr_IN \n `IT`: it_IT, en_GB \n `MX`: es_MX \n `NL`: nl_NL, en_GB \n `SG`: en_SG \n `ES`: es_ES, pt_PT, en_GB \n `TR`: tr_TR \n `AE`: en_AE, ar_AE \n `GB`: en_GB \n `JP`: ja_JP, en_US, zh_CN \n `SA`: ar_AE, en_AE \n `PL`: pl_PL \n `SE`: sv_SE, en_GB \n `BE`: fr_BE, nl_BE, en_GB \n `EG`: ar_AE, en_AE \n `ZA`: en_ZA \n `IE`: en_IE " }, { "in": "query", "name": "fields", "schema": { "type": "string" }, "description": "A comma separated list of seller profile fields to include in the response (field projection). \n By default all fields are returned." } ], "description": "Get Amazon Seller profile details from the Amazon Seller profile page (e.g. https://www.amazon.com/sp?seller=A1D09S7Q0OD6TH).", "operationId": "realtime_amazon_data__get__seller_profile", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds__1fiQu9RHG0jaOVImz_2s", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_fMzoiFNl9X0S__Sj10MeV" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds_5fumgq7Dew7p7p505C6Vj", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_UDnMGDO2AU7l2pD7FR4rR" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_72qMF9r94Nlws9PyhMdQm", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_Y4vhW7SNsmRcmxb4fXsm8" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds_pt9NurvrIG0m5qHbodTXY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description" ], "revisionId": "sdrn_B6aXroJb6q7sAixORNC4V" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_vaNNaw5q29aKLh-qRSfR0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description" ], "revisionId": "sdrn_SrJ_OL_N_pZ70W8niC6g0" } ], "x-zeroclick-services": [ "realtime-amazon-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-amazon-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-amazon-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-amazon-data/seller-reviews": { "get": { "summary": "Seller Reviews", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "domain": { "type": "string", "description": "Amazon marketplace domain" }, "country": { "type": "string", "description": "Country where the seller operates" }, "seller_id": { "type": "string", "description": "Unique identifier for the seller" }, "has_next_page": { "type": "boolean", "description": "Indicates if there are more reviews available" }, "seller_reviews": { "type": "array", "items": { "type": "object", "properties": { "review_date": { "type": "string", "description": "Date when review was posted" }, "has_response": { "type": "boolean", "description": "Whether seller responded to the review" }, "review_author": { "type": "string", "description": "Name of the reviewer" }, "review_comment": { "type": "string", "description": "Text content of the review" }, "review_star_rating": { "type": "integer", "description": "Numeric rating given (1-5 stars)" } } } } } }, "status": { "type": "string", "description": "Status of the API response" }, "request_id": { "type": "string", "description": "Unique identifier for the API request" } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "seller_id", "schema": { "type": "string" }, "example": "A02211013Q5HP3OMSZC7W", "required": true, "description": "The Amazon Seller ID for which to get seller reviews" }, { "in": "query", "name": "country", "schema": { "enum": [ "US", "AU", "BR", "CA", "CN", "FR", "DE", "IN", "IT", "MX", "NL", "SG", "ES", "TR", "AE", "GB", "JP", "SA", "PL", "SE", "BE", "EG", "ZA", "IE" ], "type": "string", "default": "US" }, "description": "Sets the Amazon domain, marketplace country, language and currency." }, { "in": "query", "name": "star_rating", "schema": { "enum": [ "ALL", "5_STARS", "4_STARS", "3_STARS", "2_STARS", "1_STARS", "POSITIVE", "CRITICAL" ], "type": "string", "default": "ALL" }, "description": "Only return reviews with a specific star rating or positive / negative sentiment." }, { "in": "query", "name": "page", "schema": { "type": "integer", "default": 1 }, "description": "The page of seller feedback results to retrieve." }, { "in": "query", "name": "language", "schema": { "type": "string" }, "description": "The language of the results. In case not specified, results will be returned in the default domain language. \n\n **Supported languages per country:** \n `US`: en_US, es_US \n `AU`: en_AU \n `BR`: pt_BR \n `CA`: en_CA, fr_CA \n `FR`: fr_FR, en_GB \n `DE`: de_DE, en_GB, cs_CZ, nl_NL, pl_PL, tr_TR, da_DK \n `IN`: en_IN, hi_IN, ta_IN, te_IN, kn_IN, ml_IN, bn_IN, mr_IN \n `IT`: it_IT, en_GB \n `MX`: es_MX \n `NL`: nl_NL, en_GB \n `SG`: en_SG \n `ES`: es_ES, pt_PT, en_GB \n `TR`: tr_TR \n `AE`: en_AE, ar_AE \n `GB`: en_GB \n `JP`: ja_JP, en_US, zh_CN \n `SA`: ar_AE, en_AE \n `PL`: pl_PL \n `SE`: sv_SE, en_GB \n `BE`: fr_BE, nl_BE, en_GB \n `EG`: ar_AE, en_AE \n `ZA`: en_ZA \n `IE`: en_IE " }, { "in": "query", "name": "fields", "schema": { "type": "string" }, "description": "A comma separated list of seller review fields to include in the response (field projection). \n By default all fields are returned." } ], "description": "Get and paginate through Amazon Seller reviews / feedback as shown on the Seller profile page (e.g. https://www.amazon.com/sp?seller=A1D09S7Q0OD6TH). Each page contains up to 5 reviews.", "operationId": "realtime_amazon_data__get__seller_reviews", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds__1fiQu9RHG0jaOVImz_2s", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_fMzoiFNl9X0S__Sj10MeV" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds_5fumgq7Dew7p7p505C6Vj", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_UDnMGDO2AU7l2pD7FR4rR" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_72qMF9r94Nlws9PyhMdQm", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_Y4vhW7SNsmRcmxb4fXsm8" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds_pt9NurvrIG0m5qHbodTXY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description" ], "revisionId": "sdrn_B6aXroJb6q7sAixORNC4V" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_vaNNaw5q29aKLh-qRSfR0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description" ], "revisionId": "sdrn_SrJ_OL_N_pZ70W8niC6g0" } ], "x-zeroclick-services": [ "realtime-amazon-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-amazon-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-amazon-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-amazon-data/top-product-reviews": { "get": { "summary": "Top Product Reviews", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "asin": { "type": "string", "description": "ASIN of the product whose reviews are returned." }, "domain": { "type": "string", "description": "Amazon domain corresponding to the marketplace." }, "country": { "type": "string", "description": "Country code of the marketplace from which reviews were collected." }, "reviews": { "type": "array", "items": { "type": "object", "properties": { "country": { "type": "string", "nullable": true, "description": "Country code (ISO 3166-1 alpha-2) of the Amazon marketplace the review was written on. Omitted when it cannot be determined." }, "is_vine": { "type": "boolean", "description": "Indicates whether the review is part of the Amazon Vine program." }, "review_id": { "type": "string", "description": "Unique identifier of the review on Amazon." }, "review_date": { "type": "string", "description": "Human-readable date string for when the review was posted." }, "review_link": { "type": "string", "description": "Direct URL to the review on Amazon." }, "review_title": { "type": "string", "description": "Title or headline of the review." }, "review_video": { "type": "string", "nullable": true, "description": "Review video field which is null when no video is attached." }, "helpful_votes": { "type": "integer", "nullable": true, "description": "Number of people who found the review helpful. Null when not shown." }, "review_author": { "type": "string", "description": "Display name of the review author." }, "review_images": { "type": "array", "items": { "type": "string" }, "description": "Photos attached to the review." }, "review_comment": { "type": "string", "description": "Full text content of the review." }, "review_date_iso": { "type": "string", "nullable": true, "description": "Review date in ISO 8601 format (YYYY-MM-DD). Null when the date cannot be read." }, "review_language": { "type": "string", "nullable": true, "description": "Language code (ISO 639-1) of the review text. Omitted when it cannot be determined." }, "review_author_id": { "type": "string", "description": "Internal Amazon identifier of the review author." }, "is_different_asin": { "type": "boolean", "nullable": true, "description": "True when the review was written for a different ASIN than the requested one (another variant of the listing, or the product on another marketplace). Null when the reviewed ASIN is not shown." }, "review_author_url": { "type": "string", "description": "URL to the review author's Amazon profile." }, "review_star_rating": { "type": "string", "description": "Star rating given by the reviewer as a string." }, "is_verified_purchase": { "type": "boolean", "description": "Indicates whether the review is marked as a verified purchase." }, "review_author_avatar": { "type": "string", "description": "URL of the review author's avatar image." }, "reviewed_product_asin": { "type": "string", "description": "ASIN of the specific product/variation that was reviewed." }, "helpful_vote_statement": { "type": "string", "description": "Text describing how many users found the review helpful." }, "reviewed_product_variant": { "type": "object", "properties": { "Size": { "type": "string", "description": "Size option of the product variant reviewed." }, "Color": { "type": "string", "description": "Color of the product variant reviewed." }, "Product grade": { "type": "string", "description": "Condition or grading of the renewed/refurbished product." }, "Service provider": { "type": "string", "description": "Service provider or carrier associated with the device." } } } } } }, "rating_distribution": { "type": "object", "properties": { "1": { "type": "integer", "description": "Count or percentage of 1-star ratings." }, "2": { "type": "integer", "description": "Count or percentage of 2-star ratings." }, "3": { "type": "integer", "description": "Count or percentage of 3-star ratings." }, "4": { "type": "integer", "description": "Count or percentage of 4-star ratings." }, "5": { "type": "integer", "description": "Count or percentage of 5-star ratings." } } } } }, "status": { "type": "string", "description": "Overall status of the API request." }, "parameters": { "type": "object", "properties": { "asin": { "type": "string", "description": "Amazon ASIN of the product whose reviews are requested." }, "country": { "type": "string", "description": "Country code of the Amazon marketplace." }, "language": { "type": "string", "description": "Locale/language used to fetch and format review content." } } }, "request_id": { "type": "string", "description": "Unique identifier assigned to this API request." } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "asin", "schema": { "type": "string" }, "example": "B07ZPKN6YR", "required": true, "description": "Product asin for which to get reviews." }, { "in": "query", "name": "country", "schema": { "enum": [ "US", "AU", "BR", "CA", "CN", "FR", "DE", "IN", "IT", "MX", "NL", "SG", "ES", "TR", "AE", "GB", "JP", "SA", "PL", "SE", "BE", "EG", "ZA", "IE" ], "type": "string", "default": "US" }, "description": "Sets the Amazon domain, marketplace country, language and currency." }, { "in": "query", "name": "fields", "schema": { "type": "string" }, "description": "A comma separated list of product fields to include in the response (field projection). \n By default all fields are returned." }, { "in": "query", "name": "language", "schema": { "type": "string" }, "description": "The language of the results. In case not specified, results will be returned in the default domain language. \n\n **Supported languages per country:** \n `US`: en_US, es_US \n `AU`: en_AU \n `BR`: pt_BR \n `CA`: en_CA, fr_CA \n `FR`: fr_FR, en_GB \n `DE`: de_DE, en_GB, cs_CZ, nl_NL, pl_PL, tr_TR, da_DK \n `IN`: en_IN, hi_IN, ta_IN, te_IN, kn_IN, ml_IN, bn_IN, mr_IN \n `IT`: it_IT, en_GB \n `MX`: es_MX \n `NL`: nl_NL, en_GB \n `SG`: en_SG \n `ES`: es_ES, pt_PT, en_GB \n `TR`: tr_TR \n `AE`: en_AE, ar_AE \n `GB`: en_GB \n `JP`: ja_JP, en_US, zh_CN \n `SA`: ar_AE, en_AE \n `PL`: pl_PL \n `SE`: sv_SE, en_GB \n `BE`: fr_BE, nl_BE, en_GB \n `EG`: ar_AE, en_AE \n `ZA`: en_ZA \n `IE`: en_IE " } ], "description": "Get top product reviews by ASIN from the Amazon product details page.", "operationId": "realtime_amazon_data__get__top_product_reviews", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds__1fiQu9RHG0jaOVImz_2s", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_fMzoiFNl9X0S__Sj10MeV" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds_5fumgq7Dew7p7p505C6Vj", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_UDnMGDO2AU7l2pD7FR4rR" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_72qMF9r94Nlws9PyhMdQm", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_Y4vhW7SNsmRcmxb4fXsm8" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds_pt9NurvrIG0m5qHbodTXY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description" ], "revisionId": "sdrn_B6aXroJb6q7sAixORNC4V" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_vaNNaw5q29aKLh-qRSfR0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description" ], "revisionId": "sdrn_SrJ_OL_N_pZ70W8niC6g0" } ], "x-zeroclick-services": [ "realtime-amazon-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-amazon-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-amazon-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-bing-jobs-data/job-details": { "get": { "summary": "Job Details", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "request_id", "parameters", "data" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_5cadede568158cae_ref1" }, "description": "The resolved jobs, in the order their ids were supplied. Ids that do not resolve are omitted, so this array can be shorter than the id list." }, "status": { "enum": [ "OK" ], "type": "string", "description": "Always `OK` on a successful response." }, "parameters": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_5cadede568158cae_ref0" }, "request_id": { "type": "string", "description": "Unique id for this request, for tracing and support." } } } } }, "description": "The requested jobs, in the order the ids were supplied." }, "400": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_5cadede568158cae_ref4" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." }, "404": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_5cadede568158cae_ref8" }, "429": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_5cadede568158cae_ref9" }, "500": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_5cadede568158cae_ref10" }, "503": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_5cadede568158cae_ref11" } }, "parameters": [ { "in": "query", "name": "job_id", "schema": { "type": "string", "example": "YmluZzotNDYyNDU5MzAzLlJldHJv" }, "example": "YmluZzotNDYyNDU5MzAzLlJldHJv", "required": true, "description": "Job Id of the job for which to get details. Batching of up to 20 Job Ids is supported by\nseparating multiple Job Ids by comma (,). The raw `job_uid` is also accepted. Each Job Id\nin a batch counts as one request." }, { "in": "query", "name": "country", "schema": { "type": "string", "default": "us" }, "required": false, "description": "Country code of the country the job was searched in, see ISO 3166-1 alpha-2. It is the\nfallback for `job_country` when the job location names no country.\n\n**Default:** `us`" }, { "in": "query", "name": "language", "schema": { "type": "string" }, "required": false, "description": "Language code sent to Bing with the request, see ISO 639-1. Leave empty to use the\nprimary language of `country`." }, { "in": "query", "name": "fields", "schema": { "type": "string" }, "required": false, "description": "Comma-separated projection over the job object, for example\n`job_title,job_description,job_apply_link`. `job_id` and `job_title` are always\nincluded, and every returned field can be selected. The search-only keys\n(`job_position`, `job_bing_company_id`, `job_bing_title_id`) are accepted and ignored,\nso one field list works on both endpoints. An unknown field name is a 400." } ], "description": "Full details for up to 20 Bing job postings in one call, fetched concurrently, including\nthe complete job description and the decoded apply links of every board carrying the\nposting.\n\n**AI-extracted fields.** Each job is passed through the same AI enrichment as JSearch\n`/job-details`, which adds `work_arrangement`, `seniority_level`,\n`required_experience_years`, `education_required`, `visa_sponsorship`,\n`relocation_required`, `relocation_assistance`, `contract_duration`, `start_date`,\n`required_technologies`, `preferred_technologies`, `methodologies`, `industry`,\n`job_function`, `has_management_responsibilities`, `ai_ml_involved`, `benefits_extended`\nand `soft_skills`, and fills `job_min_salary`, `job_max_salary`, `job_salary_period`,\n`job_city` and `job_state` where Bing left them empty. Results are cached for 7 days per\njob. Enrichment is best-effort: if it fails, the job is returned without those fields.\n\n`job_benefits_strings` is the full benefit list from the detail page; `/search` reports the\nsame list for the same job. `job_bing_company_id`, `job_bing_title_id` and `job_position`\nare search-only.\n\nAn id this API did not mint, or a posting Bing no longer serves, is omitted from the array\nwhile the rest of the batch resolves normally.\n\n**Billing:** one request per requested id, including ids that do not resolve, so the cost\nof a call is predictable before you make it.", "operationId": "realtime_bing_jobs_data__Job_Details", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds__1fiQu9RHG0jaOVImz_2s", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_fMzoiFNl9X0S__Sj10MeV" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds_5fumgq7Dew7p7p505C6Vj", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_UDnMGDO2AU7l2pD7FR4rR" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_72qMF9r94Nlws9PyhMdQm", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_Y4vhW7SNsmRcmxb4fXsm8" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds_pt9NurvrIG0m5qHbodTXY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description" ], "revisionId": "sdrn_B6aXroJb6q7sAixORNC4V" }, { "gaps": [ "Missing explicit parameter documentation in provided text; inferred job_id based on standard API patterns." ], "pages": [], "sourceId": "sds_QN3ukfHdtXTOIp_KXoTb_", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_fqMlN4jSZ8jNeUn6Wv8Vq" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_vaNNaw5q29aKLh-qRSfR0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description" ], "revisionId": "sdrn_SrJ_OL_N_pZ70W8niC6g0" } ], "x-zeroclick-services": [ "realtime-bing-jobs-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-bing-jobs-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-bing-jobs-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-bing-jobs-data/search": { "get": { "summary": "Search Jobs", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "request_id", "parameters", "data" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_5c14de8d6e9d3e66_ref1" }, "description": "Matching jobs in Bing's ranking order, de-duplicated by `job_id`. Empty when Bing has no matching jobs." }, "status": { "enum": [ "OK" ], "type": "string", "description": "Always `OK` on a successful response." }, "parameters": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_5c14de8d6e9d3e66_ref0" }, "request_id": { "type": "string", "description": "Unique id for this request, for tracing and support." } } } } }, "description": "Matching jobs." }, "400": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_5c14de8d6e9d3e66_ref4" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." }, "404": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_5c14de8d6e9d3e66_ref8" }, "429": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_5c14de8d6e9d3e66_ref9" }, "500": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_5c14de8d6e9d3e66_ref10" }, "503": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_5c14de8d6e9d3e66_ref11" } }, "parameters": [ { "in": "query", "name": "query", "schema": { "type": "string", "example": "developer jobs in new york" }, "example": "developer jobs in new york", "required": true, "description": "Free-form job search query. Include the job title and location, for example\n`developer jobs in new york`: Bing's jobs vertical is keyed off natural language, and a\nbare keyword drifts toward unrelated postings. Exactly one `query` is accepted; a second\none is a 400." }, { "in": "query", "name": "location", "schema": { "type": "string" }, "required": false, "description": "Free-text location, for example `New York, NY`. Appended to the `query` text, since\nBing builds its own location filter from coordinates. Putting the location inside\n`query` works the same way." }, { "in": "query", "name": "page", "schema": { "type": "integer", "default": 1, "maximum": 50, "minimum": 1 }, "required": false, "description": "Page to return (each page includes up to 10 results). `page` + `num_pages` must stay\nwithin page 50. Every request walks Bing's results from the start, so deeper pages take\nlonger.\n\n**Default:** `1`\n\n**Allowed values:** `1-50`" }, { "in": "query", "name": "num_pages", "schema": { "type": "integer", "default": 1, "maximum": 20, "minimum": 1 }, "required": false, "description": "Number of pages to return, starting from `page`, merged and de-duplicated by `job_id`.\n`page` + `num_pages` must stay within page 50. Each page of up to 10 results returned\nconsumes one request credit.\n\n**Default:** `1`\n\n**Allowed values:** `1-20`" }, { "in": "query", "name": "country", "schema": { "type": "string", "default": "us" }, "required": false, "description": "Country code of the country from which to return job postings, see ISO 3166-1\nalpha-2. It selects Bing's national job index, so to search for developer jobs in\nBerlin, send `country=de`.\n\n**Default:** `us`" }, { "in": "query", "name": "language", "schema": { "type": "string" }, "required": false, "description": "Language code for Bing's interface language, see ISO 639-1. Leave empty to use the\nprimary language of `country`. With `en`, the word *jobs* is appended to a query that\ndoes not already contain *job*." }, { "in": "query", "name": "date_posted", "schema": { "enum": [ "all", "today", "3days", "week", "month" ], "type": "string", "default": "all" }, "required": false, "description": "Find jobs posted within the time you specify. `today`, `3days` and `week` are Bing's own\ndate filter. `month` has no Bing equivalent, since Bing's widest window is 7 days, so it\nis sent unfiltered and returns a superset.\n\n**Default:** `all`\n\n**Allowed values:** `all`, `today`, `3days`, `week`, `month`" }, { "in": "query", "name": "employment_types", "schema": { "enum": [ "FULLTIME", "CONTRACTOR", "PARTTIME", "INTERN" ], "type": "string" }, "required": false, "description": "Find jobs of particular employment types, specified as a comma delimited list.\n`FULLTIME`, `CONTRACTOR` and `PARTTIME` are filtered by Bing. `INTERN` has no Bing\nfilter and is enforced locally on the type Bing states. An unknown value is a 400.\n\n**Allowed values:** `FULLTIME`, `CONTRACTOR`, `PARTTIME`, `INTERN`" }, { "in": "query", "name": "work_from_home", "schema": { "type": "boolean", "default": false }, "required": false, "description": "Only return work from home / remote jobs. Applied by Bing's own remote filter.\n\n**Default:** `false`" }, { "in": "query", "name": "radius", "schema": { "type": "number", "maximum": 10000, "minimum": 0 }, "required": false, "description": "Return jobs within a certain distance from the location in `query` or `location`, in\nkm. Bing honours only a 10 / 20 / 30 / 40 mile menu, so the value is converted to miles\nand snapped to the nearest: 32 km becomes 20 miles." }, { "in": "query", "name": "exclude_job_publishers", "schema": { "type": "string" }, "required": false, "description": "Exclude jobs published by specific publishers, as a comma separated list, for example\n`LinkedIn,Indeed`. Bing has no publisher filter, so this is applied after fetching,\ncase-insensitively and as a substring match against `job_publisher` and every\n`job_publishers` entry. A page can then return fewer than 10 jobs." }, { "in": "query", "name": "include_descriptions", "schema": { "type": "boolean", "default": true }, "required": false, "description": "Whether to include the full job description and apply links. Bing search results carry\nneither, so each job's detail page is fetched in parallel, capped at 100 jobs per\nrequest. Set to `false` for a faster listing-only response. The detail fetches are not\nbilled.\n\n**Default:** `true`" }, { "in": "query", "name": "fields", "schema": { "type": "string" }, "required": false, "description": "Comma-separated projection over the job object, for example\n`job_title,employer_name,job_apply_link`. `job_id` and `job_title` are always included.\nEvery field this endpoint returns can be selected, including `job_location`,\n`job_posted_at`, `job_publishers`, `job_employment_types`, `job_benefits_strings`,\n`job_normalized_title` and `job_position`. An unknown field name is a 400." } ], "description": "Search Bing's jobs vertical, with `date_posted`, `employment_types`, `work_from_home`,\n`radius` and `exclude_job_publishers` filters.\n\n**Query style matters.** Bing's vertical is keyed off natural language, so include the\nrole and the location in `query` (`developer jobs in new york`). A bare keyword drifts\ntoward unrelated postings. When `language` is `en` and the query does not already contain\n*job*, the word *jobs* is appended automatically.\n\n**`include_descriptions` defaults to `true`.** Bing's search cards carry no description and\nno apply link, so for every result the job's detail page is fetched in parallel and\n`job_description`, `job_apply_link`, `apply_options` and `employer_logo` are filled from it,\ncapped at 100 jobs per request. `job_benefits_strings` is taken from the detail page\nwhenever it parses, because the card shows only the first few chips and closes the row with\na *+N* overflow token, so `/search` and `/job-details` report the same benefits for the\nsame `job_id`. Measured on a\n10-job page: 5.7 seconds and 69 KB with descriptions, 1.8 seconds and 13 KB with\n`include_descriptions=false`.\n\n**Pagination** is offset-based via `page` / `num_pages`, 10 jobs per page. Results merged\nacross `num_pages` are de-duplicated by `job_id`. Every request walks Bing's result list\nfrom the start, so deeper pages take longer, and the walk stops once Bing starts repeating\npostings already returned.\n\n**End of results.** The response has no `has_more` flag. A call returning fewer than\n`num_pages` x 10 jobs has reached the end of Bing's results, unless\n`exclude_job_publishers` removed some or a later Bing page could not be fetched, in which\ncase the pages already gathered are returned. Bing's ranking drifts slightly between\nrequests, so two separate page requests can share a few ids.\n\n**Reliability.** The first Bing page is fetched from several exits concurrently and the\nfullest answer wins, because Bing serves its *no jobs* page to some exits for a query\nother exits answer normally. An empty `data` array therefore means Bing genuinely had no\nmatches; a failure to reach Bing is a `503`, and is not billed.\n\n**Billing:** one request per page of 10 jobs returned, and at least one, so\n`Requests` = 1 + (pages returned - 1), counted before `exclude_job_publishers` is applied.\nThe detail fetches behind `include_descriptions` are not billed. Both counts are visible in\nthe `X-RapidAPI-Billing` header.", "operationId": "realtime_bing_jobs_data__Search_Jobs", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds__1fiQu9RHG0jaOVImz_2s", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_fMzoiFNl9X0S__Sj10MeV" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds_5fumgq7Dew7p7p505C6Vj", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_UDnMGDO2AU7l2pD7FR4rR" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_72qMF9r94Nlws9PyhMdQm", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_Y4vhW7SNsmRcmxb4fXsm8" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds_pt9NurvrIG0m5qHbodTXY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description" ], "revisionId": "sdrn_B6aXroJb6q7sAixORNC4V" }, { "gaps": [ "Missing explicit parameter documentation in provided text; inferred query and location based on standard API patterns." ], "pages": [], "sourceId": "sds_QN3ukfHdtXTOIp_KXoTb_", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_fqMlN4jSZ8jNeUn6Wv8Vq" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_vaNNaw5q29aKLh-qRSfR0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description" ], "revisionId": "sdrn_SrJ_OL_N_pZ70W8niC6g0" } ], "x-zeroclick-services": [ "realtime-bing-jobs-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-bing-jobs-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-bing-jobs-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-bing-search-data/images": { "get": { "summary": "Image Search", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "request_id", "parameters", "data" ], "properties": { "data": { "type": "object", "required": [ "images" ], "properties": { "images": { "type": "array", "items": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_d41aad9c952cdb08_ref1" }, "description": "Matching images in Bing's ranking order, de-duplicated by `id`. Empty when Bing has no matching images or the list has ended." } } }, "status": { "enum": [ "OK" ], "type": "string", "description": "Always `OK` on a successful response." }, "parameters": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_d41aad9c952cdb08_ref0" }, "request_id": { "type": "string", "description": "Unique id for this request, for tracing and support." } } } } }, "description": "Matching images." }, "400": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_d41aad9c952cdb08_ref2" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." }, "404": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_d41aad9c952cdb08_ref6" }, "429": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_d41aad9c952cdb08_ref7" }, "500": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_d41aad9c952cdb08_ref8" }, "503": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_d41aad9c952cdb08_ref9" } }, "parameters": [ { "in": "query", "name": "query", "schema": { "type": "string", "example": "golden retriever puppy" }, "example": "golden retriever puppy", "required": true, "description": "Search query, as you would type it on Bing Images.\n\n**Examples:**\n\n`golden retriever puppy`\n\n`eiffel tower at night`" }, { "in": "query", "name": "page", "schema": { "type": "integer", "default": 1, "maximum": 16, "minimum": 1 }, "required": false, "description": "Page to return (each page includes up to 35 images). Bing's image list ends at about\n550 results.\n\n**Default:** `1`\n\n**Allowed values:** `1-16`" }, { "in": "query", "name": "country", "schema": { "type": "string", "default": "us" }, "required": false, "description": "Country code of the country to search from, see ISO 3166-1 alpha-2. It sets Bing's\nmarket, which reorders and localises the results.\n\n**Default:** `us`" }, { "in": "query", "name": "language", "schema": { "type": "string", "default": "en" }, "required": false, "description": "Language code for Bing's interface language, see ISO 639-1.\n\n**Default:** `en`" }, { "in": "query", "name": "size", "schema": { "enum": [ "any", "small", "medium", "large", "wallpaper" ], "type": "string", "default": "any" }, "required": false, "description": "Find images of a specific size.\n\n**Default:** `any`\n\n**Allowed values:** `any`, `small`, `medium`, `large`, `wallpaper`" }, { "in": "query", "name": "color", "schema": { "enum": [ "any", "full", "grayscale", "red", "orange", "yellow", "green", "teal", "blue", "purple", "pink", "brown", "black", "gray", "white" ], "type": "string", "default": "any" }, "required": false, "description": "Find images with a specific dominant color. `full` returns color images only and\n`grayscale` black and white images only.\n\n**Default:** `any`\n\n**Allowed values:** `any`, `full`, `grayscale`, `red`, `orange`, `yellow`, `green`,\n`teal`, `blue`, `purple`, `pink`, `brown`, `black`, `gray`, `white`" }, { "in": "query", "name": "type", "schema": { "enum": [ "any", "photo", "clipart", "lineart", "animated", "transparent" ], "type": "string", "default": "any" }, "required": false, "description": "Find images of a specific type. `animated` returns animated GIFs and `transparent`\nimages with a transparent background.\n\n**Default:** `any`\n\n**Allowed values:** `any`, `photo`, `clipart`, `lineart`, `animated`, `transparent`" }, { "in": "query", "name": "aspect_ratio", "schema": { "enum": [ "any", "square", "wide", "tall" ], "type": "string", "default": "any" }, "required": false, "description": "Find images with a specific aspect ratio.\n\n**Default:** `any`\n\n**Allowed values:** `any`, `square`, `wide`, `tall`" }, { "in": "query", "name": "people", "schema": { "enum": [ "any", "face", "portrait" ], "type": "string", "default": "any" }, "required": false, "description": "Find images of people: `face` for close-ups of a face, `portrait` for head and\nshoulders.\n\n**Default:** `any`\n\n**Allowed values:** `any`, `face`, `portrait`" }, { "in": "query", "name": "time_period", "schema": { "enum": [ "any", "last_day", "last_week", "last_month", "last_year" ], "type": "string", "default": "any" }, "required": false, "description": "Find images from a specific time period, as Bing dates them.\n\n**Default:** `any`\n\n**Allowed values:** `any`, `last_day`, `last_week`, `last_month`, `last_year`" }, { "in": "query", "name": "usage_rights", "schema": { "enum": [ "any", "creative_commons", "public_domain", "free_to_share", "free_to_share_commercially", "free_to_modify", "free_to_modify_commercially" ], "type": "string", "default": "any" }, "required": false, "description": "Find images with specific license / usage rights, as Bing classifies them.\n`public_domain` and `creative_commons` return largely the same images, as do the two\n`_commercially` values.\n\n**Default:** `any`\n\n**Allowed values:** `any`, `creative_commons`, `public_domain`, `free_to_share`,\n`free_to_share_commercially`, `free_to_modify`, `free_to_modify_commercially`" }, { "in": "query", "name": "safe_search", "schema": { "enum": [ "off", "moderate", "strict" ], "type": "string", "default": "off" }, "required": false, "description": "How Bing filters adult content in the results.\n\n**Default:** `off`\n\n**Allowed values:** `off`, `moderate`, `strict`" } ], "description": "Search Bing Images, with Bing's own `size`, `color`, `type`, `aspect_ratio`, `people`,\n`time_period`, `usage_rights` and `safe_search` filters. Filters combine freely, for\nexample `color=red&aspect_ratio=wide`.\n\nEach image comes with its full-size URL and dimensions, a Bing-hosted thumbnail, its\ndominant color and the page it was found on.\n\n**Pagination.** Up to 35 images per page, up to page 16. Bing's image list ends at about\n550 results, and `position` is Bing's own rank in that list, so page 2 starts at 36.\nNeighbouring pages can share a few images.\n\n**Billing:** one request per call.", "operationId": "realtime_bing_search_data__Image_Search", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds__1fiQu9RHG0jaOVImz_2s", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_fMzoiFNl9X0S__Sj10MeV" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_1IfgtOxqP1q4cHvJ7VyPY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description" ], "revisionId": "sdrn_mb4oPKVX4C1sgk5EHzdxz" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_5hlhZJYspBPaHxKN7OhqJ", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_3lrPg3Nc0kbMzAAAdVFHe" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_72qMF9r94Nlws9PyhMdQm", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_Y4vhW7SNsmRcmxb4fXsm8" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds_pt9NurvrIG0m5qHbodTXY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description" ], "revisionId": "sdrn_B6aXroJb6q7sAixORNC4V" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_vaNNaw5q29aKLh-qRSfR0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description" ], "revisionId": "sdrn_SrJ_OL_N_pZ70W8niC6g0" } ], "x-zeroclick-services": [ "realtime-bing-search-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-bing-search-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-bing-search-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-bing-search-data/maps": { "get": { "summary": "Maps Search", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "request_id", "parameters", "data" ], "properties": { "data": { "type": "object", "required": [ "places" ], "properties": { "places": { "type": "array", "items": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_a9550f97ff1c0555_ref1" }, "description": "Matching places in Bing's order, de-duplicated by `place_id`. Empty when Bing Maps found no match." } } }, "status": { "enum": [ "OK" ], "type": "string", "description": "Always `OK` on a successful response." }, "parameters": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_a9550f97ff1c0555_ref0" }, "request_id": { "type": "string", "description": "Unique id for this request, for tracing and support." } } } } }, "description": "Matching places." }, "400": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_a9550f97ff1c0555_ref2" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." }, "404": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_a9550f97ff1c0555_ref6" }, "429": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_a9550f97ff1c0555_ref7" }, "500": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_a9550f97ff1c0555_ref8" }, "503": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_a9550f97ff1c0555_ref9" } }, "parameters": [ { "in": "query", "name": "query", "schema": { "type": "string", "example": "coffee new york" }, "example": "coffee new york", "required": true, "description": "Search query, as you would type it on Bing Maps, including the location, unless `lat`\nand `lng` are set. A query with neither is centred on a default city.\n\n**Examples:**\n\n`coffee new york`\n\n`dentist 10001`\n\n`eiffel tower`" }, { "in": "query", "name": "limit", "schema": { "type": "integer", "default": 20, "maximum": 50, "minimum": 1 }, "required": false, "description": "Maximum number of places to return per page.\n\n**Default:** `20`\n\n**Allowed values:** `1-50`" }, { "in": "query", "name": "page", "schema": { "type": "integer", "default": 1, "minimum": 1 }, "required": false, "description": "Page to return, of `limit` places each. `page` x `limit` must stay within 100, so with\n`limit=20` the last page is 5.\n\n**Default:** `1`" }, { "in": "query", "name": "country", "schema": { "type": "string", "default": "us" }, "required": false, "description": "Country code of the country to search from, see ISO 3166-1 alpha-2. It sets Bing's\nmarket.\n\n**Default:** `us`" }, { "in": "query", "name": "language", "schema": { "type": "string", "default": "en" }, "required": false, "description": "Language code for Bing's interface language, see ISO 639-1. It sets the language of\n`opening_status`.\n\n**Default:** `en`" }, { "in": "query", "name": "lat", "schema": { "type": "number", "maximum": 90, "minimum": -90 }, "required": false, "description": "Latitude of the point to centre the search on. Use together with `lng`.\n\n**Example:** `34.0522`" }, { "in": "query", "name": "lng", "schema": { "type": "number", "maximum": 180, "minimum": -180 }, "required": false, "description": "Longitude of the point to centre the search on. Use together with `lat`.\n\n**Example:** `-118.2437`" } ], "description": "Search Bing Maps for local places: businesses, restaurants, hotels, landmarks and\naddresses.\n\nEach place comes with its address and coordinates, phone number, website, category,\nrating with its source (Yelp, Tripadvisor and others), current opening status and\nservice options such as dine-in or delivery.\n\n**Location.** Always give the search a location: inside `query` (`coffee in new york`),\nor as `lat` and `lng` to centre it on a point. A query with neither is centred on a\ndefault city. A query naming a single place, such as a landmark, returns that one place.\n\n**Pagination.** `limit` places per page, up to 50. Bing's local list for a query holds\nabout 40 to 70 places, so `page` x `limit` can reach 100 at most. Neighbouring pages can\nshare a few places.\n\n**Billing:** one request per call.", "operationId": "realtime_bing_search_data__Maps_Search", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds__1fiQu9RHG0jaOVImz_2s", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_fMzoiFNl9X0S__Sj10MeV" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_1IfgtOxqP1q4cHvJ7VyPY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description" ], "revisionId": "sdrn_mb4oPKVX4C1sgk5EHzdxz" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_5hlhZJYspBPaHxKN7OhqJ", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_3lrPg3Nc0kbMzAAAdVFHe" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_72qMF9r94Nlws9PyhMdQm", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_Y4vhW7SNsmRcmxb4fXsm8" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds_pt9NurvrIG0m5qHbodTXY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description" ], "revisionId": "sdrn_B6aXroJb6q7sAixORNC4V" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_vaNNaw5q29aKLh-qRSfR0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description" ], "revisionId": "sdrn_SrJ_OL_N_pZ70W8niC6g0" } ], "x-zeroclick-services": [ "realtime-bing-search-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-bing-search-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-bing-search-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-bing-search-data/news": { "get": { "summary": "News Search", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "request_id", "parameters", "data" ], "properties": { "data": { "type": "object", "required": [ "news" ], "properties": { "news": { "type": "array", "items": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_edaf982f6e6fa993_ref1" }, "description": "Matching articles in Bing's order, de-duplicated by `link`. Empty when Bing has no matching articles or the list has ended." } } }, "status": { "enum": [ "OK" ], "type": "string", "description": "Always `OK` on a successful response." }, "parameters": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_edaf982f6e6fa993_ref0" }, "request_id": { "type": "string", "description": "Unique id for this request, for tracing and support." } } } } }, "description": "Matching news articles." }, "400": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_edaf982f6e6fa993_ref2" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." }, "404": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_edaf982f6e6fa993_ref6" }, "429": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_edaf982f6e6fa993_ref7" }, "500": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_edaf982f6e6fa993_ref8" }, "503": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_edaf982f6e6fa993_ref9" } }, "parameters": [ { "in": "query", "name": "query", "schema": { "type": "string", "example": "nvidia" }, "example": "nvidia", "required": true, "description": "Search query, as you would type it on Bing News.\n\n**Examples:**\n\n`nvidia`\n\n`climate change`" }, { "in": "query", "name": "page", "schema": { "type": "integer", "default": 1, "maximum": 20, "minimum": 1 }, "required": false, "description": "Page to return (each page includes up to 10 articles).\n\n**Default:** `1`\n\n**Allowed values:** `1-20`" }, { "in": "query", "name": "country", "schema": { "type": "string", "default": "us" }, "required": false, "description": "Country code of the country to search from, see ISO 3166-1 alpha-2. It sets Bing's\nnews market, which selects local publishers.\n\n**Default:** `us`" }, { "in": "query", "name": "language", "schema": { "type": "string", "default": "en" }, "required": false, "description": "Language code for Bing's interface language, see ISO 639-1. It sets the language of\n`published_date`.\n\n**Default:** `en`" }, { "in": "query", "name": "sort_by", "schema": { "enum": [ "RELEVANCE", "DATE" ], "type": "string", "default": "RELEVANCE" }, "required": false, "description": "Return the articles in a specific sort order: `DATE` lists the newest first. Applied\nby Bing.\n\n**Default:** `RELEVANCE`\n\n**Allowed values:** `RELEVANCE`, `DATE`" }, { "in": "query", "name": "time_period", "schema": { "enum": [ "any", "last_hour", "last_day", "last_week", "last_month" ], "type": "string", "default": "any" }, "required": false, "description": "Find articles published within a specific time period. Applied by Bing, and combines\nwith `sort_by`.\n\n**Default:** `any`\n\n**Allowed values:** `any`, `last_hour`, `last_day`, `last_week`, `last_month`" } ], "description": "Search Bing News for articles from publishers worldwide, sorted by relevance or by date,\nwith Bing's own `time_period` filter.\n\nEach article comes with its link, snippet, publisher name and logo, thumbnail and\npublication time, both as Bing prints it and as an ISO 8601 datetime.\n\n**Pagination.** Up to 10 articles per page, up to page 20. A broad query returns about\n190 articles and a narrow one fewer. Pages past the end of the list can repeat its last\narticles, and neighbouring pages can share an article.\n\n**Billing:** one request per call.", "operationId": "realtime_bing_search_data__News_Search", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds__1fiQu9RHG0jaOVImz_2s", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_fMzoiFNl9X0S__Sj10MeV" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_1IfgtOxqP1q4cHvJ7VyPY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description" ], "revisionId": "sdrn_mb4oPKVX4C1sgk5EHzdxz" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_5hlhZJYspBPaHxKN7OhqJ", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_3lrPg3Nc0kbMzAAAdVFHe" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_72qMF9r94Nlws9PyhMdQm", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_Y4vhW7SNsmRcmxb4fXsm8" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds_pt9NurvrIG0m5qHbodTXY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description" ], "revisionId": "sdrn_B6aXroJb6q7sAixORNC4V" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_vaNNaw5q29aKLh-qRSfR0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description" ], "revisionId": "sdrn_SrJ_OL_N_pZ70W8niC6g0" } ], "x-zeroclick-services": [ "realtime-bing-search-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-bing-search-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-bing-search-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-bing-search-data/product-details": { "get": { "summary": "Product Details", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "request_id", "parameters", "data" ], "properties": { "data": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_d3d8531f0bbfc66c_ref1" }, "status": { "enum": [ "OK" ], "type": "string", "description": "Always `OK` on a successful response." }, "parameters": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_d3d8531f0bbfc66c_ref0" }, "request_id": { "type": "string", "description": "Unique id for this request, for tracing and support." } } } } }, "description": "The product." }, "400": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_d3d8531f0bbfc66c_ref7" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." }, "404": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_d3d8531f0bbfc66c_ref11" }, "429": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_d3d8531f0bbfc66c_ref12" }, "500": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_d3d8531f0bbfc66c_ref13" }, "503": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_d3d8531f0bbfc66c_ref14" } }, "parameters": [ { "in": "query", "name": "product_id", "schema": { "type": "string", "example": "MXx1c3wxN3wzfDA3MDc4NjJEN0FEQkU2NTY3OEFBMzIyQzkwNEJCQUMyfDQyODcwMDgwOTA3OXxjb2ZmZWUgbWFrZXI" }, "example": "MXx1c3wxN3wzfDA3MDc4NjJEN0FEQkU2NTY3OEFBMzIyQzkwNEJCQUMyfDQyODcwMDgwOTA3OXxjb2ZmZWUgbWFrZXI", "required": true, "description": "Product id of the product to get details for, as returned in `product_id` by the\n`/shopping` endpoint." }, { "in": "query", "name": "country", "schema": { "type": "string" }, "required": false, "description": "Country code of the market to load the product on, see ISO 3166-1 alpha-2. Leave empty\nto use the market the `product_id` was found on." }, { "in": "query", "name": "language", "schema": { "type": "string", "default": "en" }, "required": false, "description": "Language code for Bing's interface language, see ISO 639-1. It sets the language of\n`review_summary`, `review_pros` and `review_cons`.\n\n**Default:** `en`" } ], "description": "Full Bing Shopping product page for a product returned by `/shopping`, addressed by its\n`product_id`.\n\nReturns the product's description, photos and specifications, its variants (color,\nstorage and so on), Bing's review insights (rating, star distribution, review highlights,\nan AI-written review summary, pros and cons) and every store offering it, with price,\nshipping and a direct link to the store's product page.\n\n**Market.** A product belongs to the market it was found on, so `country` defaults to the\nmarket inside the `product_id`. `language` sets the language of Bing's review summary,\npros and cons, which Bing writes for some products only in the market's own language.\n\n**Not found.** A product Bing no longer lists returns a 404.\n\n**Billing:** one request per call.", "operationId": "realtime_bing_search_data__Product_Details", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds__1fiQu9RHG0jaOVImz_2s", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_fMzoiFNl9X0S__Sj10MeV" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_1IfgtOxqP1q4cHvJ7VyPY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description" ], "revisionId": "sdrn_mb4oPKVX4C1sgk5EHzdxz" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_5hlhZJYspBPaHxKN7OhqJ", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_3lrPg3Nc0kbMzAAAdVFHe" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_72qMF9r94Nlws9PyhMdQm", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_Y4vhW7SNsmRcmxb4fXsm8" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds_pt9NurvrIG0m5qHbodTXY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description" ], "revisionId": "sdrn_B6aXroJb6q7sAixORNC4V" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_vaNNaw5q29aKLh-qRSfR0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description" ], "revisionId": "sdrn_SrJ_OL_N_pZ70W8niC6g0" } ], "x-zeroclick-services": [ "realtime-bing-search-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-bing-search-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-bing-search-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-bing-search-data/search": { "get": { "summary": "Search", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "request_id", "parameters", "data" ], "properties": { "data": { "type": "object", "required": [ "total_organic_results", "organic_results" ], "properties": { "organic_results": { "type": "array", "items": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_14dad9422cc64658_ref1" }, "description": "Organic results of Bing's first results page, in Bing's order, de-duplicated by `link`. Empty when Bing has no matching results." }, "total_organic_results": { "type": "integer", "nullable": true, "description": "Bing's estimate of the total number of results, when its page shows one." } } }, "status": { "enum": [ "OK" ], "type": "string", "description": "Always `OK` on a successful response." }, "parameters": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_14dad9422cc64658_ref0" }, "request_id": { "type": "string", "description": "Unique id for this request, for tracing and support." } } } } }, "description": "Matching web results." }, "400": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_14dad9422cc64658_ref2" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." }, "404": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_14dad9422cc64658_ref6" }, "429": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_14dad9422cc64658_ref7" }, "500": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_14dad9422cc64658_ref8" }, "503": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_14dad9422cc64658_ref9" } }, "parameters": [ { "in": "query", "name": "query", "schema": { "type": "string", "example": "how to make sourdough bread" }, "example": "how to make sourdough bread", "required": true, "description": "Search query, as you would type it on Bing.\n\n**Examples:**\n\n`how to make sourdough bread`\n\n`nvidia stock`" }, { "in": "query", "name": "country", "schema": { "type": "string", "default": "us" }, "required": false, "description": "Country code of the country to search from, see ISO 3166-1 alpha-2. It sets Bing's\nmarket.\n\n**Default:** `us`" }, { "in": "query", "name": "language", "schema": { "type": "string", "default": "en" }, "required": false, "description": "Language code for Bing's interface language, see ISO 639-1.\n\n**Default:** `en`" }, { "in": "query", "name": "time_period", "schema": { "enum": [ "any", "last_day", "last_week", "last_month", "last_year" ], "type": "string", "default": "any" }, "required": false, "description": "Find pages Bing dates within a specific time period. Applied by Bing's own date\nfilter.\n\n**Default:** `any`\n\n**Allowed values:** `any`, `last_day`, `last_week`, `last_month`, `last_year`" }, { "in": "query", "name": "safe_search", "schema": { "enum": [ "off", "moderate", "strict" ], "type": "string", "default": "off" }, "required": false, "description": "How Bing filters adult content in the results.\n\n**Default:** `off`\n\n**Allowed values:** `off`, `moderate`, `strict`" } ], "description": "Search Bing's web results, with Bing's own `time_period` and `safe_search` filters.\n\nReturns the organic results of Bing's first results page, up to 10, each with its title,\nlink, displayed URL, site name, snippet and date, plus Bing's estimated result count.\n\n**Links.** Bing's click-tracking redirect is unwrapped, so `link` is the publisher's own\nURL. Video results (YouTube, TikTok) link to Bing's video viewer.\n\n**Billing:** one request per call.", "operationId": "realtime_bing_search_data__Search", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds__1fiQu9RHG0jaOVImz_2s", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_fMzoiFNl9X0S__Sj10MeV" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_1IfgtOxqP1q4cHvJ7VyPY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description" ], "revisionId": "sdrn_mb4oPKVX4C1sgk5EHzdxz" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_5hlhZJYspBPaHxKN7OhqJ", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_3lrPg3Nc0kbMzAAAdVFHe" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_72qMF9r94Nlws9PyhMdQm", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_Y4vhW7SNsmRcmxb4fXsm8" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds_pt9NurvrIG0m5qHbodTXY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description" ], "revisionId": "sdrn_B6aXroJb6q7sAixORNC4V" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_vaNNaw5q29aKLh-qRSfR0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description" ], "revisionId": "sdrn_SrJ_OL_N_pZ70W8niC6g0" } ], "x-zeroclick-services": [ "realtime-bing-search-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-bing-search-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-bing-search-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-bing-search-data/shopping": { "get": { "summary": "Shopping Search", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "request_id", "parameters", "data" ], "properties": { "data": { "type": "object", "required": [ "products", "sponsored_products" ], "properties": { "products": { "type": "array", "items": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_f8c1ecbcc7206917_ref1" }, "description": "Products from Bing's main product grid, in Bing's order, de-duplicated by `offer_id`. Empty when Bing has no matching products or the page is past the end." }, "sponsored_products": { "type": "array", "items": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_f8c1ecbcc7206917_ref1" }, "description": "Products from Bing's paid product grid, with `sponsored: true`. Filled on markets where Bing renders one. On some markets, such as Japan, Brazil and Canada, it is often the only grid, and `products` is empty." } } }, "status": { "enum": [ "OK" ], "type": "string", "description": "Always `OK` on a successful response." }, "parameters": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_f8c1ecbcc7206917_ref0" }, "request_id": { "type": "string", "description": "Unique id for this request, for tracing and support." } } } } }, "description": "Matching products." }, "400": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_f8c1ecbcc7206917_ref2" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." }, "404": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_f8c1ecbcc7206917_ref6" }, "429": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_f8c1ecbcc7206917_ref7" }, "500": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_f8c1ecbcc7206917_ref8" }, "503": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_f8c1ecbcc7206917_ref9" } }, "parameters": [ { "in": "query", "name": "query", "schema": { "type": "string", "example": "coffee maker" }, "example": "coffee maker", "required": true, "description": "Search query, as you would type it on Bing Shopping.\n\n**Examples:**\n\n`coffee maker`\n\n`nike running shoes`" }, { "in": "query", "name": "page", "schema": { "type": "integer", "default": 1, "maximum": 9, "minimum": 1 }, "required": false, "description": "Page to return (each page includes up to 36 products, or 20 on Bing's list layout).\nBing serves up to about 180 products per query.\n\n**Default:** `1`\n\n**Allowed values:** `1-9`" }, { "in": "query", "name": "country", "schema": { "type": "string", "default": "us" }, "required": false, "description": "Country code of the market to search, see ISO 3166-1 alpha-2. It sets the stores,\nprices and currency of the results.\n\n**Default:** `us`" }, { "in": "query", "name": "language", "schema": { "type": "string", "default": "en" }, "required": false, "description": "Language code for Bing's interface language, see ISO 639-1. Use `en` or the market's\nown language.\n\n**Default:** `en`" }, { "in": "query", "name": "sort_by", "schema": { "enum": [ "BEST_MATCH", "LOWEST_PRICE", "HIGHEST_PRICE" ], "type": "string", "default": "BEST_MATCH" }, "required": false, "description": "Return the products in a specific sort order. Applied by Bing.\n\n**Default:** `BEST_MATCH`\n\n**Allowed values:** `BEST_MATCH`, `LOWEST_PRICE`, `HIGHEST_PRICE`" }, { "in": "query", "name": "min_price", "schema": { "type": "number", "minimum": 0 }, "required": false, "description": "Only return products priced at or above this value (`extracted_price`), in the\ncurrency of `country`. Applied by Bing where it supports price filtering, otherwise to\neach page of results; a page with no product in the range returns 404." }, { "in": "query", "name": "max_price", "schema": { "type": "number", "minimum": 0 }, "required": false, "description": "Only return products priced at or below this value (`extracted_price`), in the\ncurrency of `country`. Applied by Bing where it supports price filtering, otherwise to\neach page of results; a page with no product in the range returns 404." } ], "description": "Search Bing Shopping for products across stores, with Bing's own price sort and price\nrange filters.\n\nEach product carries its price as displayed and parsed, sale and shipping badges, rating,\nthe store and its product page, and a `product_id` to pass to `/product-details`.\nProducts from Bing's paid product grid are returned separately, in `sponsored_products`.\nOn some markets, such as Japan, Brazil and Canada, Bing often shows only that grid.\n\n**Pagination.** Bing serves up to about 180 products per query. Most markets show 36\nproducts per page, so pages 1 to 5 hold results; markets and queries where Bing uses its\nlist layout show 20 per page, up to page 9. A page past the end returns a `200` with\nempty arrays.\n\n**Market and language.** `country` sets the stores, prices and currency. Bing Shopping\nserves `language=en` and the market's own language; a combination it does not serve,\nsuch as `country=us&language=es`, returns a 400, as does a country without Bing Shopping.\n\n**Billing:** one request per call.", "operationId": "realtime_bing_search_data__Shopping_Search", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds__1fiQu9RHG0jaOVImz_2s", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_fMzoiFNl9X0S__Sj10MeV" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_1IfgtOxqP1q4cHvJ7VyPY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description" ], "revisionId": "sdrn_mb4oPKVX4C1sgk5EHzdxz" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_5hlhZJYspBPaHxKN7OhqJ", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_3lrPg3Nc0kbMzAAAdVFHe" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_72qMF9r94Nlws9PyhMdQm", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_Y4vhW7SNsmRcmxb4fXsm8" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds_pt9NurvrIG0m5qHbodTXY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description" ], "revisionId": "sdrn_B6aXroJb6q7sAixORNC4V" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_vaNNaw5q29aKLh-qRSfR0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description" ], "revisionId": "sdrn_SrJ_OL_N_pZ70W8niC6g0" } ], "x-zeroclick-services": [ "realtime-bing-search-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-bing-search-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-bing-search-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-bing-search-data/videos": { "get": { "summary": "Video Search", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "request_id", "parameters", "data" ], "properties": { "data": { "type": "object", "required": [ "videos" ], "properties": { "videos": { "type": "array", "items": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_b2b84a70e24d2a2c_ref1" }, "description": "Matching videos in Bing's ranking order, de-duplicated by `id`. Empty when Bing has no matching videos or the list has ended." } } }, "status": { "enum": [ "OK" ], "type": "string", "description": "Always `OK` on a successful response." }, "parameters": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_b2b84a70e24d2a2c_ref0" }, "request_id": { "type": "string", "description": "Unique id for this request, for tracing and support." } } } } }, "description": "Matching videos." }, "400": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_b2b84a70e24d2a2c_ref2" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." }, "404": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_b2b84a70e24d2a2c_ref6" }, "429": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_b2b84a70e24d2a2c_ref7" }, "500": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_b2b84a70e24d2a2c_ref8" }, "503": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_b2b84a70e24d2a2c_ref9" } }, "parameters": [ { "in": "query", "name": "query", "schema": { "type": "string", "example": "python tutorial for beginners" }, "example": "python tutorial for beginners", "required": true, "description": "Search query, as you would type it on Bing Videos.\n\n**Examples:**\n\n`python tutorial for beginners`\n\n`kubernetes operator tutorial`" }, { "in": "query", "name": "page", "schema": { "type": "integer", "default": 1, "maximum": 4, "minimum": 1 }, "required": false, "description": "Page to return (each page includes up to 35 videos). Bing's video list ends at 140\nresults.\n\n**Default:** `1`\n\n**Allowed values:** `1-4`" }, { "in": "query", "name": "country", "schema": { "type": "string", "default": "us" }, "required": false, "description": "Country code of the country to search from, see ISO 3166-1 alpha-2. It sets Bing's\nmarket, which reorders and localises the results.\n\n**Default:** `us`" }, { "in": "query", "name": "language", "schema": { "type": "string", "default": "en" }, "required": false, "description": "Language code for Bing's interface language, see ISO 639-1. It sets the language of\n`views_text` and `published_date`; `published_datetime_utc` is parsed for `en`.\n\n**Default:** `en`" }, { "in": "query", "name": "duration", "schema": { "enum": [ "any", "short", "medium", "long" ], "type": "string", "default": "any" }, "required": false, "description": "Find videos of a specific length: `short` is under 5 minutes, `medium` 5 to 20\nminutes and `long` over 20 minutes, as Bing buckets them.\n\n**Default:** `any`\n\n**Allowed values:** `any`, `short`, `medium`, `long`" }, { "in": "query", "name": "time_period", "schema": { "enum": [ "any", "last_day", "last_week", "last_month", "last_year" ], "type": "string", "default": "any" }, "required": false, "description": "Find videos published within a specific time period.\n\n**Default:** `any`\n\n**Allowed values:** `any`, `last_day`, `last_week`, `last_month`, `last_year`" }, { "in": "query", "name": "source_site", "schema": { "type": "string" }, "required": false, "description": "Only return videos hosted on this site, as a domain name, for example `youtube.com`,\n`tiktok.com`, `dailymotion.com` or `vimeo.com`. A full URL is reduced to its domain.\nA site with no videos on Bing returns an empty list." }, { "in": "query", "name": "safe_search", "schema": { "enum": [ "off", "moderate", "strict" ], "type": "string", "default": "off" }, "required": false, "description": "How Bing filters adult content in the results.\n\n**Default:** `off`\n\n**Allowed values:** `off`, `moderate`, `strict`" } ], "description": "Search Bing Videos across YouTube, TikTok, Dailymotion, Vimeo and every other site Bing\nindexes, with Bing's own `duration`, `time_period`, `source_site` and `safe_search`\nfilters. Filters combine freely, for example `duration=short&time_period=last_month`.\n\nEach video comes with its link, platform and channel, duration, view count and\npublication date, both as Bing prints them and parsed.\n\n**Pagination.** Up to 35 videos per page, up to page 4: Bing's video list ends at 140\nresults. Page 1 usually holds 30. Neighbouring pages can share a few videos.\n\n**Billing:** one request per call.", "operationId": "realtime_bing_search_data__Video_Search", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds__1fiQu9RHG0jaOVImz_2s", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_fMzoiFNl9X0S__Sj10MeV" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_1IfgtOxqP1q4cHvJ7VyPY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description" ], "revisionId": "sdrn_mb4oPKVX4C1sgk5EHzdxz" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_5hlhZJYspBPaHxKN7OhqJ", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_3lrPg3Nc0kbMzAAAdVFHe" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_72qMF9r94Nlws9PyhMdQm", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_Y4vhW7SNsmRcmxb4fXsm8" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds_pt9NurvrIG0m5qHbodTXY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description" ], "revisionId": "sdrn_B6aXroJb6q7sAixORNC4V" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_vaNNaw5q29aKLh-qRSfR0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description" ], "revisionId": "sdrn_SrJ_OL_N_pZ70W8niC6g0" } ], "x-zeroclick-services": [ "realtime-bing-search-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-bing-search-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-bing-search-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-books-data/search": { "get": { "summary": "Search Books", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "required": [ "id", "title", "position", "rank" ], "properties": { "id": { "type": "string", "description": "Google Books volume ID for the book." }, "rank": { "type": "integer", "description": "Absolute rank across all pages returned (1-based)." }, "title": { "type": "string", "description": "Title of the book." }, "position": { "type": "integer", "description": "Position of the result within the page (1-based)." }, "subtitle": { "type": "string", "nullable": true, "description": "Subtitle line shown by Google Books (typically authors and publication year)." }, "view_url": { "type": "string", "nullable": true, "description": "URL of the Google Books page for the book." }, "image_url": { "type": "string", "nullable": true, "description": "Cover image URL for the book." }, "view_label": { "type": "string", "nullable": true, "description": "Label of the view available for the book (e.g. Preview, Full view). Omitted when no preview is available." }, "book_authors": { "type": "array", "items": { "type": "object", "required": [ "name" ], "properties": { "url": { "type": "string", "nullable": true, "description": "Google Books search URL filtering by this author." }, "name": { "type": "string", "description": "Author full name." } } }, "nullable": true, "description": "Authors of the book." }, "publication_year": { "type": "integer", "nullable": true, "description": "Year of publication." }, "book_more_editions_url": { "type": "string", "nullable": true, "description": "URL to view other editions of the book on Google Books." } } }, "description": "Array of book search results returned by the API." }, "status": { "type": "string", "description": "The status of the API response" }, "parameters": { "type": "object", "properties": { "query": { "type": "string", "description": "The search query parameter" }, "country": { "type": "string", "description": "Country code for localization" }, "language": { "type": "string", "description": "Language code for localization" }, "view_type": { "type": "string", "description": "Type of view requested" }, "document_type": { "type": "string", "description": "Type of document requested" } } }, "request_id": { "type": "string", "description": "Unique identifier for the API request" } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "query", "schema": { "type": "string", "example": "good thriller", "description": "Search query / keyword" }, "example": "good thriller", "required": true }, { "in": "query", "name": "page", "schema": { "type": "number", "default": 1, "description": "Results page to return (pagination / scrolling)." } }, { "in": "query", "name": "document_type", "schema": { "enum": [ "any", "books", "newspapers", "magazines" ], "type": "string", "default": "any" }, "description": "Find books of a specific type." }, { "in": "query", "name": "view_type", "schema": { "enum": [ "any", "preview_and_full_view", "full_view" ], "type": "string", "default": "any" }, "description": "Find books with a specific view type (preview / full)." }, { "in": "query", "name": "publication_year_from", "schema": { "type": "number", "description": "Find books published after a specific year (e.g. 1980)." } }, { "in": "query", "name": "publication_year_to", "schema": { "type": "number", "description": "Find books published before a specific year (e.g. 2013)." } }, { "in": "query", "name": "country", "schema": { "type": "string", "default": "us", "description": "The country for which to get trends, specified as a 2-letter country code - see ISO 3166." } }, { "in": "query", "name": "language", "schema": { "type": "string", "default": "en", "description": "The language to use for the results, specified as a 2-letter language code (https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes)." } } ], "description": "Get real-time book search results from across the web with pagination and filtering support.", "operationId": "realtime_books_data__get__search", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds__1fiQu9RHG0jaOVImz_2s", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_fMzoiFNl9X0S__Sj10MeV" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_1IfgtOxqP1q4cHvJ7VyPY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description" ], "revisionId": "sdrn_mb4oPKVX4C1sgk5EHzdxz" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_5hlhZJYspBPaHxKN7OhqJ", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_3lrPg3Nc0kbMzAAAdVFHe" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_72qMF9r94Nlws9PyhMdQm", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_Y4vhW7SNsmRcmxb4fXsm8" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds_pt9NurvrIG0m5qHbodTXY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description" ], "revisionId": "sdrn_B6aXroJb6q7sAixORNC4V" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_vaNNaw5q29aKLh-qRSfR0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description" ], "revisionId": "sdrn_SrJ_OL_N_pZ70W8niC6g0" } ], "x-zeroclick-services": [ "realtime-books-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-books-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-books-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-costco-data/product-details": { "get": { "summary": "Product Details", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "required": [ "item_number", "item_name", "item_product_name", "id" ], "properties": { "id": { "type": "string", "description": "Internal identifier of the product (item id + locale)." }, "name": { "type": "string", "nullable": true, "description": "Product name." }, "image": { "type": "string", "nullable": true, "description": "Primary image URL." }, "images": { "type": "array", "items": { "type": "object", "properties": { "item_collateral_primaryimage": { "type": "string", "description": "Image URL." } } }, "nullable": true, "description": "Additional images of the product." }, "group_id": { "type": "string", "nullable": true, "description": "Costco product group identifier (groups variants of the same product)." }, "item_name": { "type": "string", "description": "Full product name including variant attributes (color, size)." }, "Brand_attr": { "type": "array", "items": { "type": "string", "description": "Brand name." }, "nullable": true, "description": "Brand attribute values." }, "Color_attr": { "type": "array", "items": { "type": "string", "description": "Color name." }, "nullable": true, "description": "Color attribute values." }, "description": { "type": "string", "nullable": true, "description": "Long product description." }, "item_number": { "type": "string", "description": "Costco item number (matches the `product_id` query parameter)." }, "content_type": { "type": "array", "items": { "type": "string", "description": "Content type." }, "nullable": true, "description": "Content type tags for the product (typically [\"product\"])." }, "hasSingleSku": { "type": "boolean", "nullable": true, "description": "Whether the product has a single SKU (no variants)." }, "isFutureDate": { "type": "boolean", "nullable": true, "description": "Whether the product start date is in the future." }, "item_buyable": { "type": "boolean", "nullable": true, "description": "Whether the product is currently buyable." }, "item_ratings": { "type": "number", "nullable": true, "description": "Average customer rating (numeric)." }, "maxSalePrice": { "type": "number", "nullable": true, "description": "Maximum sale price across variants." }, "minSalePrice": { "type": "number", "nullable": true, "description": "Minimum sale price across variants." }, "isItemInStock": { "type": "boolean", "nullable": true, "description": "Whether the item is currently in stock." }, "deliveryStatus": { "type": "string", "nullable": true, "description": "Delivery status label for the product." }, "item_startDate": { "type": "string", "nullable": true, "description": "ISO 8601 datetime the product was first listed." }, "categoryPath_ss": { "type": "array", "items": { "type": "string", "description": "Category path." }, "nullable": true, "description": "Category breadcrumb paths the product belongs to." }, "item_comparable": { "type": "boolean", "nullable": true, "description": "Whether the product is included in comparison tools." }, "item_searchable": { "type": "boolean", "nullable": true, "description": "Whether the product is searchable." }, "Online_Only_attr": { "type": "array", "items": { "type": "string", "description": "Label." }, "nullable": true, "description": "Online-only attribute labels." }, "item_member_only": { "type": "boolean", "nullable": true, "description": "Whether the product is restricted to Costco members." }, "Women_s_Size_attr": { "type": "array", "items": { "type": "string", "description": "Size." }, "nullable": true, "description": "Women's size attribute values, when applicable." }, "item_fsa_eligible": { "type": "boolean", "nullable": true, "description": "Whether the product is FSA-eligible." }, "item_product_name": { "type": "string", "description": "Product name without variant attributes." }, "item_rating_value": { "type": "array", "items": { "type": "string", "description": "Rating bucket label." }, "nullable": true, "description": "Rating-bucket facet labels the product belongs to." }, "item_review_count": { "type": "integer", "nullable": true, "description": "Number of customer reviews considered for `item_ratings`." }, "item_chdi_eligible": { "type": "boolean", "nullable": true, "description": "Whether the product is CHDI-eligible." }, "item_disponzeroinv": { "type": "boolean", "nullable": true, "description": "Whether the variant is displayed when out of stock." }, "item_as400_category": { "type": "string", "nullable": true, "description": "AS400 category code." }, "item_review_ratings": { "type": "string", "nullable": true, "description": "Average customer rating as a string." }, "item_variableweight": { "type": "boolean", "nullable": true, "description": "Whether the product has variable weight." }, "item_pill_attributes": { "type": "array", "items": { "type": "string", "description": "Pill attribute entry." }, "nullable": true, "description": "Pill / badge attributes shown on the product card (raw key|label pairs)." }, "item_product_buyable": { "type": "boolean", "nullable": true, "description": "Whether the product (any variant) is buyable." }, "Online_Only_attr_pill": { "type": "array", "items": { "type": "string", "description": "Pill label." }, "nullable": true, "description": "Online-only pill labels." }, "item_as400_department": { "type": "string", "nullable": true, "description": "AS400 department code." }, "item_image_swatchable": { "type": "boolean", "nullable": true, "description": "Whether the variant image supports color swatch switching." }, "item_status_published": { "type": "boolean", "nullable": true, "description": "Whether the variant is published." }, "item_link_fee_eligible": { "type": "string", "nullable": true, "description": "Whether the product is link-fee eligible. Values: 'true', 'false'." }, "item_short_description": { "type": "string", "nullable": true, "description": "Short product description including variant attributes." }, "deliverable_to_location": { "type": "boolean", "description": "Whether this product is available for delivery to the requested delivery_location. Only present when delivery_location was supplied and resolved. When false, the product exists but is not deliverable there, and the item_location_* fields describe an unscoped fallback lookup." }, "item_manufacturing_skus": { "type": "array", "items": { "type": "string", "description": "SKU." }, "nullable": true, "description": "Manufacturer SKUs / barcodes associated with the product." }, "item_product_comparable": { "type": "boolean", "nullable": true, "description": "Whether the product is comparable at the product level." }, "item_eligible_for_review": { "type": "string", "nullable": true, "description": "Whether the product is eligible for reviews. Values: 'true', 'false'." }, "item_location_itemNumber": { "type": "string", "nullable": true, "description": "Item number at the configured location." }, "item_program_eligibility": { "type": "array", "items": { "type": "string", "description": "Program tag." }, "nullable": true, "description": "Program eligibility tags (e.g. Standard, ShipIt, Google)." }, "delivery_location_applied": { "type": "boolean", "description": "Whether the requested delivery_location was applied to the lookup. Only present when delivery_location was supplied." }, "item_location_stockStatus": { "type": "string", "nullable": true, "description": "Stock status at the configured location." }, "item_product_review_count": { "type": "integer", "nullable": true, "description": "Number of customer reviews at the product level." }, "item_rating_average_value": { "type": "number", "nullable": true, "description": "Computed average rating value." }, "item_location_availability": { "type": "string", "nullable": true, "description": "Availability label at the configured location." }, "item_location_currencyCode": { "type": "string", "nullable": true, "description": "ISO 4217 currency code of the pricing." }, "item_product_primary_image": { "type": "string", "nullable": true, "description": "Primary product image URL." }, "item_collateral_primaryimage": { "type": "string", "nullable": true, "description": "Primary collateral image URL for the variant." }, "item_location_locationNumber": { "type": "string", "nullable": true, "description": "Identifier of the configured location used for pricing / availability." }, "item_product_review_eligible": { "type": "boolean", "nullable": true, "description": "Whether the product is eligible for customer reviews." }, "item_classification_itemclass": { "type": "string", "nullable": true, "description": "Item classification class (e.g. Standard)." }, "item_product_image_swatchable": { "type": "boolean", "nullable": true, "description": "Whether the product image supports color swatch switching." }, "item_product_status_published": { "type": "boolean", "nullable": true, "description": "Whether the product is published." }, "item_product_short_description": { "type": "string", "nullable": true, "description": "Short product description without variant attributes." }, "item_location_pricing_listPrice": { "type": "number", "nullable": true, "description": "List price for the configured location." }, "item_location_pricing_salePrice": { "type": "number", "nullable": true, "description": "Current sale price for the configured location." }, "item_product_marketing_features": { "type": "array", "items": { "type": "string", "description": "Feature bullet." }, "nullable": true, "description": "Marketing bullet features of the product." }, "item_product_price_in_cart_only": { "type": "string", "nullable": true, "description": "Whether the final price is only revealed in the cart. Values: '0', '1'." }, "item_product_marketing_statement": { "type": "string", "nullable": true, "description": "Marketing tagline shown for the product." }, "item_product_status_disponzeroinv": { "type": "boolean", "nullable": true, "description": "Whether the product is displayed when out of stock at the product level." }, "item_product_marketingcontent_keywords": { "type": "array", "items": { "type": "string", "description": "Keyword." }, "nullable": true, "description": "Marketing keywords tagged on the product." }, "item_location_pricing_pricePerUnit_price": { "type": "number", "nullable": true, "description": "Price per unit for the configured location." } }, "description": "The full Costco product object. Same field shape as items inside the /search endpoint's `products` array." }, "status": { "type": "string", "description": "The status of the API response" }, "parameters": { "type": "object", "properties": { "country": { "type": "string", "description": "The country code for localization" }, "language": { "type": "string", "description": "The language code for localization" }, "product_id": { "type": "string", "description": "The product / item id used to fetch the product details" }, "delivery_location": { "type": "string", "description": "The normalized delivery location the results were scoped to. Only present when delivery_location was supplied." } } }, "request_id": { "type": "string", "description": "A unique identifier for the API request" } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "product_id", "schema": { "type": "string" }, "example": "1660437", "required": true, "description": "The Costco product / item id to retrieve details for. You can find product item ids in the `item_number` field returned by the /search endpoint." }, { "in": "query", "name": "country", "schema": { "type": "string", "default": "US" }, "description": "The Costco country / domain to use. US or CA." }, { "in": "query", "name": "language", "schema": { "type": "string", "default": "en-US" }, "description": "The language to use for the results. Defaults to the first / major language in the specified country - en-US for country=US and en-CA for country=CA.\n Allowed values: en-US for US / en-CA or fr-CA for CA." }, { "in": "query", "name": "delivery_location", "schema": { "type": "string" }, "example": "M4V 2H7", "description": "Delivery location to scope results to, as a ZIP code for country=US (e.g. 98101) or a postal code for country=CA (e.g. M4V 2H7).\n Costco's catalog is fulfilled from location-specific distribution, grocery and pickup centers, so this affects which products are available, which node fulfills them (item_location_locationNumber), their stock status (item_location_availability) and the order quantity limits (item_location_fulfillment_restrictions_minQty / maxQty).\n Note that Costco list prices are national, so this does not change prices.\n When omitted, results are not scoped to any location." } ], "description": "Get the full details of a specific Costco product by its item id.", "operationId": "realtime_costco_data__get__product_details", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds__1fiQu9RHG0jaOVImz_2s", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_fMzoiFNl9X0S__Sj10MeV" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_1IfgtOxqP1q4cHvJ7VyPY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description" ], "revisionId": "sdrn_mb4oPKVX4C1sgk5EHzdxz" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_5hlhZJYspBPaHxKN7OhqJ", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_3lrPg3Nc0kbMzAAAdVFHe" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_72qMF9r94Nlws9PyhMdQm", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_Y4vhW7SNsmRcmxb4fXsm8" }, { "gaps": [ "Missing explicit parameter documentation in source text; inferred from standard API patterns." ], "pages": [], "sourceId": "sds_MV8gWtP36-RZn0HelHkbq", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_zsd2yxhBG769IpVFIUWRc" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds_pt9NurvrIG0m5qHbodTXY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description" ], "revisionId": "sdrn_B6aXroJb6q7sAixORNC4V" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_vaNNaw5q29aKLh-qRSfR0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description" ], "revisionId": "sdrn_SrJ_OL_N_pZ70W8niC6g0" } ], "x-zeroclick-services": [ "realtime-costco-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-costco-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-costco-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-costco-data/search": { "get": { "summary": "Search", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "filters": { "type": "object", "properties": { "item_category": { "type": "object", "properties": { "label": { "type": "string", "description": "Display label for the category facet" }, "facetKey": { "type": "string", "description": "Key identifying the category facet" }, "multiselect": { "type": "boolean", "description": "Indicates if multiple selections are allowed for this facet" }, "display_order": { "type": "integer", "description": "The order in which the facet is displayed" } } }, "item_rating_value": { "type": "object", "properties": { "label": { "type": "string", "description": "Display label for the rating facet" }, "facetKey": { "type": "string", "description": "Key identifying the rating facet" }, "multiselect": { "type": "boolean", "description": "Indicates if multiple selections are allowed for this facet" }, "display_order": { "type": "integer", "description": "The order in which the facet is displayed" } } }, "item_program_eligibility": { "type": "object", "properties": { "label": { "type": "string", "description": "Display label for the program eligibility facet" }, "facetKey": { "type": "string", "description": "Key identifying the program eligibility facet" }, "multiselect": { "type": "boolean", "description": "Indicates if multiple selections are allowed for this facet" }, "display_order": { "type": "integer", "description": "The order in which the facet is displayed" } } }, "item_location_availability": { "type": "object", "properties": { "label": { "type": "string", "description": "Display label for the availability facet" }, "facetKey": { "type": "string", "description": "Key identifying the availability facet" }, "multiselect": { "type": "boolean", "description": "Indicates if multiple selections are allowed for this facet" }, "display_order": { "type": "integer", "description": "The order in which the facet is displayed" } } }, "item_location_pricing_salePrice": { "type": "object", "properties": { "label": { "type": "string", "description": "Display label for the price facet" }, "facetKey": { "type": "string", "description": "Key identifying the price facet" }, "multiselect": { "type": "boolean", "description": "Indicates if multiple selections are allowed for this facet" }, "display_order": { "type": "integer", "description": "The order in which the facet is displayed" } } } } }, "total_products": { "type": "integer", "description": "The total number of products matching the query" }, "delivery_location_applied": { "type": "boolean", "description": "Whether the requested delivery_location was applied to the query. Only present when delivery_location was supplied. False means the location could not be resolved and unscoped results were returned instead." } } }, "status": { "type": "string", "description": "The status of the API response" }, "parameters": { "type": "object", "properties": { "query": { "type": "string", "description": "The search query used to fetch products" }, "start": { "type": "integer", "description": "The offset or index to start retrieving results from" }, "country": { "type": "string", "description": "The country code for localization" }, "language": { "type": "string", "description": "The language code for localization" }, "delivery_location": { "type": "string", "description": "The normalized delivery location the results were scoped to. Only present when delivery_location was supplied." } } }, "request_id": { "type": "string", "description": "A unique identifier for the API request" } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "query", "schema": { "type": "string" }, "example": "Nike", "required": true, "description": "Search query." }, { "in": "query", "name": "country", "schema": { "type": "string", "default": "US" }, "description": "The Costco country / domain to use. US or CA." }, { "in": "query", "name": "language", "schema": { "type": "string", "default": "en-US" }, "description": "The language to use for the results. Defaults to the first / major language in the specified country - en-US for country=US and en-CA for country=CA.\n Allowed values: en-US for US / en-CA or fr-CA for CA." }, { "in": "query", "name": "start", "schema": { "type": "number", "default": 0 }, "description": "Number of results to skip (offset)." }, { "in": "query", "name": "delivery_location", "schema": { "type": "string" }, "example": "98101", "description": "Delivery location to scope results to, as a ZIP code for country=US (e.g. 98101) or a postal code for country=CA (e.g. M4V 2H7).\n Costco's catalog is fulfilled from location-specific distribution, grocery and pickup centers, so this affects which products are available, which node fulfills them (item_location_locationNumber), their stock status (item_location_availability) and the order quantity limits (item_location_fulfillment_restrictions_minQty / maxQty).\n Note that Costco list prices are national, so this does not change prices.\n When omitted, results are not scoped to any location." } ], "description": "Search", "operationId": "realtime_costco_data__get__search", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds__1fiQu9RHG0jaOVImz_2s", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_fMzoiFNl9X0S__Sj10MeV" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_1IfgtOxqP1q4cHvJ7VyPY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description" ], "revisionId": "sdrn_mb4oPKVX4C1sgk5EHzdxz" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_5hlhZJYspBPaHxKN7OhqJ", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_3lrPg3Nc0kbMzAAAdVFHe" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_72qMF9r94Nlws9PyhMdQm", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_Y4vhW7SNsmRcmxb4fXsm8" }, { "gaps": [ "Missing explicit parameter documentation in source text; inferred from standard API patterns." ], "pages": [], "sourceId": "sds_MV8gWtP36-RZn0HelHkbq", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_zsd2yxhBG769IpVFIUWRc" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds_pt9NurvrIG0m5qHbodTXY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description" ], "revisionId": "sdrn_B6aXroJb6q7sAixORNC4V" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_vaNNaw5q29aKLh-qRSfR0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description" ], "revisionId": "sdrn_SrJ_OL_N_pZ70W8niC6g0" } ], "x-zeroclick-services": [ "realtime-costco-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-costco-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-costco-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/real-time-ebay-data/product-details": { "get": { "summary": "Product Details", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "mpn": { "type": "string" }, "upc": { "type": "string" }, "type": { "type": "string" }, "brand": { "type": "string" }, "color": { "type": "string" }, "model": { "type": "string" }, "price": { "type": "number" }, "title": { "type": "string" }, "images": { "type": "array", "items": { "type": "string" } }, "item_id": { "type": "string" }, "currency": { "type": "string" }, "discount": { "type": "string" }, "location": { "type": "string" }, "shipping": { "type": "string" }, "watchers": { "type": "integer" }, "condition": { "type": "string" }, "items_sold": { "type": "integer" }, "seller_url": { "type": "string" }, "breadcrumbs": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string" }, "name": { "type": "string" } } } }, "seller_name": { "type": "string" }, "return_policy": { "type": "string" }, "seller_joined": { "type": "string" }, "item_specifics": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "type": "string" } } } }, "original_price": { "type": "number" }, "description_url": { "type": "string" }, "seller_top_rated": { "type": "boolean" }, "delivery_estimate": { "type": "string" }, "seller_items_sold": { "type": "integer" }, "available_quantity": { "type": "integer" }, "seller_feedback_count": { "type": "integer" }, "seller_detailed_ratings": { "type": "object", "properties": { "communication": { "type": "number" }, "shipping_speed": { "type": "number" }, "accurate_description": { "type": "number" }, "reasonable_shipping_cost": { "type": "number" } } }, "seller_feedback_percentage": { "type": "number" } } }, "status": { "type": "string" }, "parameters": { "type": "object", "properties": { "domain": { "type": "string" }, "product_id": { "type": "string" } } }, "request_id": { "type": "string" } } } } }, "description": "Successful response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "product_id", "schema": { "type": "string" }, "example": "287062440001", "required": true, "description": "eBay item ID (numeric). Found in eBay listing URLs after `/itm/`.\n\n**Examples:**\n`287062440001`\n`266583210044`" }, { "in": "query", "name": "domain", "schema": { "type": "string", "default": "com" }, "description": "eBay domain to fetch from. Sets the marketplace country, language, and currency.\n\n**Default:** `com`\n\n**Allowed values:** `com, co.uk, com.au, de, ca, fr, it, es, at, ch, com.sg, com.my, ph, ie, pl, nl, be, com.hk, com.mx, com.br`" } ], "description": "Get comprehensive details for a single eBay listing including title, price, images, condition, seller information, seller ratings, item specifics, shipping, return policy, and breadcrumb navigation. Primary data source is LD+JSON structured data for stability, with CSS selectors as fallback. Ended listings are returned too, with `listing_ended: true` and `ended_at` (the end date as eBay shows it). eBay shows less for an ended listing (title, final price and photos), so most other fields are null; a removed listing answers 404.", "operationId": "realtime_ebay_data__Product_Details", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing full parameter list and response schema." ], "pages": [ 1 ], "sourceId": "sds__1fiQu9RHG0jaOVImz_2s", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_fMzoiFNl9X0S__Sj10MeV" }, { "gaps": [ "Missing full parameter list and response schema" ], "pages": [], "sourceId": "sds_1IfgtOxqP1q4cHvJ7VyPY", "authority": "supplemental", "conflicts": [ "/summary", "/description", "/operationId" ], "revisionId": "sdrn_mb4oPKVX4C1sgk5EHzdxz" }, { "gaps": [ "Missing full parameter list and response schema." ], "pages": [], "sourceId": "sds_72qMF9r94Nlws9PyhMdQm", "authority": "supplemental", "conflicts": [ "/summary", "/description", "/operationId" ], "revisionId": "sdrn_Y4vhW7SNsmRcmxb4fXsm8" }, { "gaps": [ "Missing response schema." ], "pages": [], "sourceId": "sds_G0U8VUwSzsI5a3e1H5DC1", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_YNvYe3cGaeWzpXoXqMHAs" }, { "gaps": [ "Missing full parameter list and response schema" ], "pages": [ 1 ], "sourceId": "sds_MAxJPNBPJFwSKQLj1M1dr", "authority": "supplemental", "conflicts": [ "/summary", "/description", "/operationId" ], "revisionId": "sdrn_QFW9HQumx231aOJCusPx0" }, { "gaps": [ "No documentation provided for response schema." ], "pages": [], "sourceId": "sds_qhTee9rhe4IsP9VM8R0Jx", "authority": "supplemental", "conflicts": [ "/summary", "/description", "/operationId" ], "revisionId": "sdrn_n1Qua5iIILpqbVggnqZhR" }, { "gaps": [ "No documentation provided for parameters or response schema." ], "pages": [], "sourceId": "sds_rT9_GyymiamliAo644CKz", "authority": "supplemental", "conflicts": [ "/summary", "/description", "/operationId" ], "revisionId": "sdrn_PfyiCRgYUBzYaNQGBu0of" }, { "gaps": [ "Missing response schema" ], "pages": [ 1 ], "sourceId": "sds_wvqPOTBJ3ELhy96dsub_l", "authority": "supplemental", "conflicts": [ "/summary", "/description", "/operationId" ], "revisionId": "sdrn_f7m9IOfd1EwYpLs8JZOMM" } ], "x-zeroclick-services": [ "real-time-ebay-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "real-time-ebay-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "real-time-ebay-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/real-time-ebay-data/products-by-category": { "get": { "summary": "Products by Category", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "brands": { "type": "array", "items": { "type": "string" } }, "products": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string" }, "image": { "type": "string" }, "price": { "type": "number" }, "title": { "type": "string" }, "item_id": { "type": "string" }, "currency": { "type": "string" }, "discount": {}, "location": { "type": "string" }, "position": { "type": "integer" }, "shipping": { "type": "string" }, "condition": { "type": "string" }, "seller_name": { "type": "string" }, "free_returns": { "type": "boolean" }, "buying_format": { "type": "string" }, "original_price": {}, "seller_top_rated": { "type": "boolean" }, "seller_feedback_count": { "type": "integer" }, "seller_feedback_percentage": { "type": "number" } } } }, "current_page": { "type": "integer" }, "category_name": { "type": "string" }, "subcategories": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string" }, "name": { "type": "string" } } } }, "total_results": { "type": "integer" }, "results_per_page": { "type": "integer" }, "related_categories": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string" }, "name": { "type": "string" } } } } } }, "status": { "type": "string" }, "parameters": { "type": "object", "properties": { "page": { "type": "integer" }, "query": { "type": "string" }, "domain": { "type": "string" }, "category_id": { "type": "string" } } }, "request_id": { "type": "string" } } } } }, "description": "Successful response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "category_id", "schema": { "type": "string" }, "example": "9355", "required": true, "description": "eBay category ID. You can find category IDs in eBay URLs (e.g., `9355` for Cell Phones & Smartphones, `175672` for Laptops & Netbooks, `11450` for Clothing).\n\n**Examples:**\n`9355`\n`175672`\n`11450`" }, { "in": "query", "name": "query", "schema": { "type": "string" }, "description": "Search keywords within the category. Highly recommended for reliable results — without a query, eBay returns a browse page with limited server-rendered data.\n\n**Examples:**\n`samsung galaxy`\n`gaming laptop`" }, { "in": "query", "name": "page", "schema": { "type": "integer", "default": 1, "maximum": 100, "minimum": 1 }, "description": "Page number to return (each page includes up to 60 results).\n\n**Allowed values:** `1-100`" }, { "in": "query", "name": "domain", "schema": { "type": "string", "default": "com" }, "description": "eBay domain to search. Sets the marketplace country, language, and currency.\n\n**Default:** `com`\n\n**Allowed values:** `com, co.uk, com.au, de, ca, fr, it, es, at, ch, com.sg, com.my, ph, ie, pl, nl, be, com.hk, com.mx, com.br`" }, { "in": "query", "name": "sort_by", "schema": { "enum": [ "BEST_MATCH", "ENDING_SOONEST", "NEWLY_LISTED", "PRICE_LOWEST", "PRICE_HIGHEST" ], "type": "string", "default": "BEST_MATCH" }, "description": "Sort order for results.\n\n**Default:** `BEST_MATCH`" }, { "in": "query", "name": "condition", "schema": { "type": "string" }, "description": "Filter by item condition. Supports comma-separated values for multiple conditions.\n\n**Allowed values:** `new, used, open_box, refurbished, for_parts`" }, { "in": "query", "name": "buying_format", "schema": { "enum": [ "buy_it_now", "auction", "accepts_offers" ], "type": "string" }, "description": "Filter by buying format.\n\n**Allowed values:** `buy_it_now, auction, accepts_offers`" }, { "in": "query", "name": "show_only", "schema": { "type": "string" }, "description": "Filter results by one or more listing attributes. Accepts a comma-separated list of values like `free_returns`, `deals_and_savings`, `returns_accepted`, `authorized_seller`, `sold_items`, `completed_items`, `free_shipping`, `local_pickup`. Example: `sold_items,completed_items`. Note: `sold_items` and `completed_items` work without a cookie, and the optional `cookie` parameter adds seller details to those results." }, { "in": "query", "name": "min_price", "schema": { "type": "number" }, "description": "Only return products with price greater than this value. Specified in the currency of the selected domain." }, { "in": "query", "name": "max_price", "schema": { "type": "number" }, "description": "Only return products with price less than this value. Specified in the currency of the selected domain." }, { "in": "query", "name": "aspects", "schema": { "type": "string" }, "description": "Filter by category-specific item aspects from eBay's left-side filter panel (Brand, Model, Storage Capacity, Network, Color, etc.). Pass a JSON-encoded array of `{name, value}` objects. `value` can be a single string or an array of strings (multiple values are OR-joined within the same aspect).\n\nAspect names must match eBay's filter labels exactly. Aspects are scoped to the `category_id` you pass. The category determines which aspects are available. Common examples include: `Brand`, `Model`, `Storage Capacity`, `Network`, `Lock Status`, `Color`, `RAM`, `Screen Size`, `Operating System`, `Material`, `Size`, `Type`, `Features`.\n\n**Limit:** up to 20 aspect entries per request.\n\n**Examples:**\n`[{\"name\":\"Brand\",\"value\":\"Samsung\"}]`\n`[{\"name\":\"Storage Capacity\",\"value\":[\"128 GB\",\"256 GB\"]}]`\n`[{\"name\":\"Brand\",\"value\":\"Samsung\"},{\"name\":\"Color\",\"value\":\"Black\"}]`" }, { "in": "query", "name": "cookie", "schema": { "type": "string" }, "required": false, "description": "Optional. Only used for **sold** and **completed** listings (`show_only=sold_items` / `completed_items`), ignored everywhere else.\n\nSold and completed listings are returned **without** a cookie: 60 results per page with the sale price, currency, sale date (`caption`), condition, shipping, location and images. On those results `seller_name`, `seller_feedback_count` and `seller_feedback_percentage` are `null` unless you pass your own eBay session cookie, which populates them on every result.\n\nPaste the cookie header from a browser signed in to eBay, e.g. `name=value; name2=value2`. It must belong to the same marketplace as `domain`. If it stops working, because it expired, was signed out elsewhere, or belongs to another marketplace, the request returns 503 telling you to replace it rather than silently falling back. It is never logged or returned in the response.\n\nMore details: https://www.openwebninja.com/blog/how-to-get-ebay-sold-and-completed-listings" } ], "description": "Browse eBay products within a specific category. Works best with a `query` parameter — without it, eBay serves a JavaScript-rendered browse page and results may be limited (0-24 products). With `query`, returns full search results filtered by category (up to 60 products per page).", "operationId": "realtime_ebay_data__Products_by_Category", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing full parameter list and response schema" ], "pages": [], "sourceId": "sds_1IfgtOxqP1q4cHvJ7VyPY", "authority": "supplemental", "conflicts": [ "/summary", "/description", "/operationId" ], "revisionId": "sdrn_mb4oPKVX4C1sgk5EHzdxz" }, { "gaps": [ "Missing full parameter list and response schema." ], "pages": [], "sourceId": "sds_72qMF9r94Nlws9PyhMdQm", "authority": "supplemental", "conflicts": [ "/summary", "/description", "/operationId" ], "revisionId": "sdrn_Y4vhW7SNsmRcmxb4fXsm8" }, { "gaps": [ "No documentation provided for response schema." ], "pages": [], "sourceId": "sds_qhTee9rhe4IsP9VM8R0Jx", "authority": "supplemental", "conflicts": [ "/summary", "/description", "/operationId" ], "revisionId": "sdrn_n1Qua5iIILpqbVggnqZhR" }, { "gaps": [ "No documentation provided for parameters or response schema." ], "pages": [], "sourceId": "sds_rT9_GyymiamliAo644CKz", "authority": "supplemental", "conflicts": [ "/summary", "/description", "/operationId" ], "revisionId": "sdrn_PfyiCRgYUBzYaNQGBu0of" }, { "gaps": [ "Missing response schema" ], "pages": [ 1 ], "sourceId": "sds_wvqPOTBJ3ELhy96dsub_l", "authority": "supplemental", "conflicts": [ "/summary", "/description", "/operationId" ], "revisionId": "sdrn_f7m9IOfd1EwYpLs8JZOMM" } ], "x-zeroclick-services": [ "real-time-ebay-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "real-time-ebay-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "real-time-ebay-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/real-time-ebay-data/search": { "get": { "summary": "Product Search", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "products": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string" }, "image": { "type": "string" }, "price": { "type": "number" }, "title": { "type": "string" }, "rating": { "type": "number" }, "item_id": { "type": "string" }, "currency": { "type": "string" }, "discount": { "type": "string" }, "location": { "type": "string" }, "position": { "type": "integer" }, "shipping": { "type": "string" }, "watchers": {}, "bid_count": {}, "condition": { "type": "string" }, "time_left": {}, "items_sold": { "type": "integer" }, "seller_name": { "type": "string" }, "free_returns": { "type": "boolean" }, "is_sponsored": { "type": "boolean" }, "review_count": { "type": "integer" }, "buying_format": { "type": "string" }, "original_price": { "type": "number" }, "seller_top_rated": { "type": "boolean" }, "seller_feedback_count": { "type": "integer" }, "seller_feedback_percentage": { "type": "number" } } } }, "current_page": { "type": "integer" }, "total_results": { "type": "integer" }, "related_searches": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string" }, "query": { "type": "string" } } } }, "results_per_page": { "type": "integer" } } }, "status": { "type": "string" }, "parameters": { "type": "object", "properties": { "page": { "type": "integer" }, "query": { "type": "string" }, "domain": { "type": "string" }, "sort_by": { "type": "string" } } }, "request_id": { "type": "string" } } } } }, "description": "Successful response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "query", "schema": { "type": "string" }, "example": "iphone 15", "required": true, "description": "Search keywords.\n\n**Examples:**\n`iphone 15 pro max`\n`nintendo switch oled`\n`vintage rolex submariner`" }, { "in": "query", "name": "page", "schema": { "type": "integer", "default": 1, "maximum": 100, "minimum": 1 }, "description": "Page number to return (each page includes up to 60 results).\n\n**Allowed values:** `1-100`" }, { "in": "query", "name": "domain", "schema": { "type": "string", "default": "com" }, "description": "eBay domain to search. Sets the marketplace country, language, and currency.\n\n**Default:** `com`\n\n**Allowed values:** `com, co.uk, com.au, de, ca, fr, it, es, at, ch, com.sg, com.my, ph, ie, pl, nl, be, com.hk, com.mx, com.br`" }, { "in": "query", "name": "sort_by", "schema": { "enum": [ "BEST_MATCH", "ENDING_SOONEST", "NEWLY_LISTED", "PRICE_LOWEST", "PRICE_HIGHEST" ], "type": "string", "default": "BEST_MATCH" }, "description": "Sort order for results.\n\n**Default:** `BEST_MATCH`" }, { "in": "query", "name": "condition", "schema": { "type": "string" }, "description": "Filter by item condition. Supports comma-separated values for multiple conditions.\n\n**Allowed values:** `new, used, open_box, refurbished, for_parts`\n\n**Examples:**\n`new`\n`used,refurbished`" }, { "in": "query", "name": "buying_format", "schema": { "enum": [ "buy_it_now", "auction", "accepts_offers" ], "type": "string" }, "description": "Filter by buying format.\n\n**Allowed values:** `buy_it_now, auction, accepts_offers`" }, { "in": "query", "name": "show_only", "schema": { "type": "string" }, "description": "Filter results by one or more listing attributes. Accepts a comma-separated list of values like `free_returns`, `deals_and_savings`, `returns_accepted`, `authorized_seller`, `sold_items`, `completed_items`, `free_shipping`, `local_pickup`. Example: `sold_items,completed_items`. Note: `sold_items` and `completed_items` work without a cookie, and the optional `cookie` parameter adds seller details to those results." }, { "in": "query", "name": "min_price", "schema": { "type": "number" }, "description": "Only return products with price greater than this value. Specified in the currency of the selected domain." }, { "in": "query", "name": "max_price", "schema": { "type": "number" }, "description": "Only return products with price less than this value. Specified in the currency of the selected domain." }, { "in": "query", "name": "aspects", "schema": { "type": "string" }, "description": "Filter by category-specific item aspects from eBay's left-side filter panel (Brand, Model, Storage Capacity, Network, Color, etc.). Pass a JSON-encoded array of `{name, value}` objects. `value` can be a single string or an array of strings (multiple values are OR-joined within the same aspect).\n\nAspect names must match eBay's filter labels exactly. Available aspect names depend on the item category. Common examples include: `Brand`, `Model`, `Storage Capacity`, `Network`, `Lock Status`, `Color`, `RAM`, `Screen Size`, `Operating System`, `Material`, `Size`, `Type`, `Features`.\n\n**Limit:** up to 20 aspect entries per request.\n\n**Examples:**\n`[{\"name\":\"Brand\",\"value\":\"Apple\"}]`\n`[{\"name\":\"Storage Capacity\",\"value\":[\"128 GB\",\"256 GB\"]}]`\n`[{\"name\":\"Model\",\"value\":\"Samsung Galaxy A02s\"},{\"name\":\"Network\",\"value\":\"Unlocked\"}]`" }, { "in": "query", "name": "cookie", "schema": { "type": "string" }, "required": false, "description": "Optional. Only used for **sold** and **completed** listings (`show_only=sold_items` / `completed_items`), ignored everywhere else.\n\nSold and completed listings are returned **without** a cookie: 60 results per page with the sale price, currency, sale date (`caption`), condition, shipping, location and images. On those results `seller_name`, `seller_feedback_count` and `seller_feedback_percentage` are `null` unless you pass your own eBay session cookie, which populates them on every result.\n\nPaste the cookie header from a browser signed in to eBay, e.g. `name=value; name2=value2`. It must belong to the same marketplace as `domain`. If it stops working, because it expired, was signed out elsewhere, or belongs to another marketplace, the request returns 503 telling you to replace it rather than silently falling back. It is never logged or returned in the response.\n\nMore details: https://www.openwebninja.com/blog/how-to-get-ebay-sold-and-completed-listings" } ], "description": "Search eBay products by keyword. Returns up to 60 products per page with pricing, seller info, shipping details, and more. Supports filters for condition, buying format, price range, and sort order.", "operationId": "realtime_ebay_data__Product_Search", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing response schema" ], "pages": [ 1 ], "sourceId": "sds_wvqPOTBJ3ELhy96dsub_l", "authority": "supplemental", "conflicts": [ "/summary", "/parameters/query/q", "/description", "/operationId" ], "revisionId": "sdrn_f7m9IOfd1EwYpLs8JZOMM" } ], "x-zeroclick-services": [ "real-time-ebay-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "real-time-ebay-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "real-time-ebay-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/real-time-ebay-data/seller-feedback": { "get": { "summary": "Seller Feedback", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "topics": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "value": {} } } }, "reviews": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "string" }, "author": { "type": "string" }, "rating": { "type": "string" }, "comment": { "type": "string" }, "has_images": { "type": "boolean" }, "feedback_id": { "type": "string" }, "verified_purchase": { "type": "boolean" } } } }, "seller_id": { "type": "string" }, "product_id": { "type": "string" }, "total_pages": { "type": "integer" }, "current_page": { "type": "integer" }, "total_reviews": { "type": "integer" } } }, "status": { "type": "string" }, "parameters": { "type": "object", "properties": { "page": { "type": "integer" }, "domain": { "type": "string" }, "seller_id": { "type": "string" }, "product_id": { "type": "string" } } }, "request_id": { "type": "string" } } } } }, "description": "Successful response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "seller_id", "schema": { "type": "string" }, "example": "wireless-source", "required": true, "description": "The eBay user ID of the seller.\n\nThis must be the user ID, not the store name. The two are often different: the store at `ebay.com/str/wirelesssource` belongs to the user ID `wireless-source`. The `seller_name` value returned by the Search and Products by Category endpoints is the user ID, so it can be passed straight into this parameter. A seller profile lives at `ebay.com/usr/`.\n\n**Examples:**\n`wireless-source`\n`thrift.books`\n`musicmagpie`" }, { "in": "query", "name": "product_id", "schema": { "type": "string" }, "description": "eBay item ID to filter feedback for a specific product. Optional — if omitted, returns all feedback for the seller.\n\n**Examples:**\n`287062440001`" }, { "in": "query", "name": "page", "schema": { "type": "integer", "default": 1, "maximum": 100, "minimum": 1 }, "description": "Page number to return (each page includes up to 25 reviews).\n\n**Allowed values:** `1-100`" }, { "in": "query", "name": "domain", "schema": { "type": "string", "default": "com" }, "description": "eBay domain to fetch from. Sets the marketplace country and language.\n\n**Default:** `com`\n\n**Allowed values:** `com, co.uk, com.au, de, ca, fr, it, es, at, ch, com.sg, com.my, ph, ie, pl, nl, be, com.hk, com.mx, com.br`" } ], "description": "Get seller feedback and reviews for an eBay seller. Returns structured feedback data with ratings, comments, verified purchase status, item titles, and pagination.\n\nUse `seller_id` to get all feedback for a seller, or combine with `product_id` to filter feedback for a specific item.", "operationId": "realtime_ebay_data__Seller_Feedback", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing response schema" ], "pages": [ 1 ], "sourceId": "sds_wvqPOTBJ3ELhy96dsub_l", "authority": "supplemental", "conflicts": [ "/summary", "/description", "/operationId" ], "revisionId": "sdrn_f7m9IOfd1EwYpLs8JZOMM" } ], "x-zeroclick-services": [ "real-time-ebay-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "real-time-ebay-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "real-time-ebay-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-events-data/event-details": { "get": { "summary": "Event Details", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "date": { "type": "string", "nullable": true, "description": "Google's date label for the event as shown to users." }, "link": { "type": "string", "nullable": true, "description": "URL of the event on the source publisher." }, "name": { "type": "string", "nullable": false, "description": "Name / title of the event." }, "price": { "type": "string", "nullable": true, "description": "Ticket price as shown by Google (e.g. $19). Null when the source publishes no price." }, "venue": { "type": "object", "nullable": true, "properties": { "cid": { "type": "string", "nullable": true, "description": "Google Maps CID of the venue." }, "city": { "type": "string", "nullable": true, "description": "City of the venue." }, "name": { "type": "string", "nullable": true, "description": "Name of the venue." }, "hours": { "type": "string", "nullable": true, "description": "Current opening status of the venue as shown by Google." }, "photo": { "type": "string", "nullable": true, "description": "Photo URL of the venue." }, "state": { "type": "string", "nullable": true, "description": "State / region of the venue." }, "rating": { "type": "number", "nullable": true, "description": "Average Google rating of the venue (0-5)." }, "street": { "type": "string", "nullable": true, "description": "Street name of the venue address." }, "country": { "type": "string", "nullable": true, "description": "ISO 3166-1 alpha-2 country code of the venue." }, "subtype": { "type": "string", "nullable": true, "description": "Primary venue subtype (Google Maps category)." }, "summary": { "type": "string", "nullable": true, "description": "Google's short venue description." }, "website": { "type": "string", "nullable": true, "description": "Website of the venue." }, "zipcode": { "type": "string", "nullable": true, "description": "Postal / zip code of the venue." }, "district": { "type": "string", "nullable": true, "description": "District / neighborhood of the venue." }, "latitude": { "type": "number", "nullable": true, "description": "Latitude coordinate of the venue." }, "map_link": { "type": "string", "nullable": true, "description": "Google Maps page of the venue." }, "subtypes": { "type": "array", "items": { "type": "string", "description": "A single venue subtype label." }, "nullable": true, "description": "All venue subtype labels from Google Maps." }, "timezone": { "type": "string", "nullable": true, "description": "IANA timezone of the venue." }, "google_id": { "type": "string", "nullable": true, "description": "Google place ID of the venue." }, "longitude": { "type": "number", "nullable": true, "description": "Longitude coordinate of the venue." }, "google_mid": { "type": "string", "nullable": true, "description": "Google Knowledge Graph MID of the venue." }, "price_range": { "type": "string", "nullable": true, "description": "Venue price range (the venue's, not the event's)." }, "full_address": { "type": "string", "nullable": true, "description": "Full postal address of the venue." }, "phone_number": { "type": "string", "nullable": true, "description": "Phone number of the venue." }, "review_count": { "type": "integer", "nullable": true, "description": "Number of Google reviews for the venue." }, "street_number": { "type": "string", "nullable": true, "description": "Street number of the venue address." } }, "description": "Venue details where the event takes place." }, "is_free": { "type": "boolean", "nullable": true, "description": "False for a priced event, null when no price is published, true when Google labels the event as free." }, "category": { "type": "string", "nullable": true, "description": "Google's one-line category label for the event." }, "end_time": { "type": "string", "nullable": true, "description": "Event end datetime in the venue local timezone (YYYY-MM-DD HH:MM:SS)." }, "event_id": { "type": "string", "description": "Temporary opaque token identifying this result, for use with /event-details. Google can invalidate it at any time, in which case /event-details returns 404 and the search should be re-run. For a permanent identifier use entity_id. Long value, truncated in the example." }, "language": { "type": "string", "nullable": true, "description": "ISO 639-1 language code of the event details (echoes the language parameter)." }, "position": { "type": "integer", "nullable": true, "description": "Rank of the event in Google's list (1-10)." }, "entity_id": { "type": "string", "nullable": true, "description": "Google's entity id of the event (Knowledge Graph mid). Permanent: identical whatever query surfaced the event, so use it as the deduplication / indexing key." }, "map_image": { "type": "string", "nullable": true, "description": "URL of a static Google Maps tile of the venue location." }, "publisher": { "type": "string", "nullable": true, "description": "Name of the source publisher hosting the event listing." }, "thumbnail": { "type": "string", "nullable": true, "description": "URL of the event's thumbnail image." }, "info_links": { "type": "array", "items": { "type": "object", "required": [ "source", "link" ], "properties": { "link": { "type": "string", "nullable": false, "description": "URL of the info page on the source." }, "source": { "type": "string", "nullable": false, "description": "Name of the source." } } }, "nullable": true, "description": "Additional informational links about the event, when Google shows one." }, "is_virtual": { "type": "boolean", "description": "Echoes the is_virtual parameter." }, "start_time": { "type": "string", "nullable": true, "description": "Event start datetime in the venue local timezone (YYYY-MM-DD HH:MM:SS)." }, "description": { "type": "string", "nullable": true, "description": "Short description of the event." }, "end_time_utc": { "type": "string", "nullable": true, "description": "Event end datetime in UTC (YYYY-MM-DD HH:MM:SS)." }, "ticket_links": { "type": "array", "items": { "type": "object", "required": [ "source", "link" ], "properties": { "link": { "type": "string", "nullable": false, "description": "URL of the event on the source." }, "source": { "type": "string", "nullable": false, "description": "Name of the source." }, "fav_icon": { "type": "string", "nullable": true, "description": "Favicon URL of the source." } } }, "nullable": true, "description": "Ticket / event page link on the source publisher." }, "calendar_link": { "type": "string", "nullable": true, "description": "Add to Google Calendar URL, includes start, end and timezone." }, "start_time_utc": { "type": "string", "nullable": true, "description": "Event start datetime in UTC (YYYY-MM-DD HH:MM:SS)." }, "directions_link": { "type": "string", "nullable": true, "description": "Google Maps directions URL to the venue. Long value, truncated in the example." }, "publisher_domain": { "type": "string", "nullable": true, "description": "Domain of the source publisher." }, "publisher_favicon": { "type": "string", "nullable": true, "description": "URL of the source publisher's favicon." }, "date_human_readable": { "type": "string", "nullable": true, "description": "Human-readable event start date and time as displayed by Google." }, "end_time_precision_sec": { "type": "integer", "nullable": true, "description": "Always null: Google no longer provides time precision. Kept for backward compatibility." }, "start_time_precision_sec": { "type": "integer", "nullable": true, "description": "Always null: Google no longer provides time precision. Kept for backward compatibility." } }, "description": "The event object. Same fields as a /search-events result. The Google list labels (position, category, date) are null on this endpoint." }, "status": { "type": "string", "description": "The status of the response" }, "parameters": { "type": "object", "properties": { "event_id": { "type": "string", "description": "The ID of the requested event. Long value, truncated in the example." } } }, "request_id": { "type": "string", "description": "A unique identifier for the request" } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "event_id", "schema": { "type": "string", "example": "eyJmYyI6IkVyY0hDdmNHUVVwcFZEUjBURzB3UTBGdmExcFlk..." }, "example": "eyJmYyI6IkVyY0hDdmNHUVVwcFZEUjBURzB3UTBGdmExcFlk...", "required": true, "description": "The ID of the event to fetch (i.e. event_id field of an event from a recent /search-events response). Long opaque value, truncated in the example." } ], "description": "Get the details of a specific event by Event ID (i.e. *event_id* field of an event returned by /search-events). The event_id is a temporary token: when Google stops honouring it, this endpoint returns 404 and the search should be re-run. Note that /search-events already returns the full details for every event, so most integrations do not need this endpoint.", "operationId": "realtime_events_data__get__event_details", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" } ], "x-zeroclick-services": [ "realtime-events-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-events-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-events-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-events-data/search-events": { "get": { "summary": "Search Events", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "required": [ "event_id", "name" ], "properties": { "date": { "type": "string", "nullable": true, "description": "Google's date label for the event as shown to users." }, "link": { "type": "string", "nullable": true, "description": "URL of the event on the source publisher." }, "name": { "type": "string", "nullable": false, "description": "Name / title of the event." }, "price": { "type": "string", "nullable": true, "description": "Ticket price as shown by Google (e.g. $19). Null when the source publishes no price." }, "venue": { "type": "object", "nullable": true, "properties": { "cid": { "type": "string", "nullable": true, "description": "Google Maps CID of the venue." }, "city": { "type": "string", "nullable": true, "description": "City of the venue." }, "name": { "type": "string", "nullable": true, "description": "Name of the venue." }, "hours": { "type": "string", "nullable": true, "description": "Current opening status of the venue as shown by Google." }, "photo": { "type": "string", "nullable": true, "description": "Photo URL of the venue." }, "state": { "type": "string", "nullable": true, "description": "State / region of the venue." }, "rating": { "type": "number", "nullable": true, "description": "Average Google rating of the venue (0-5)." }, "street": { "type": "string", "nullable": true, "description": "Street name of the venue address." }, "country": { "type": "string", "nullable": true, "description": "ISO 3166-1 alpha-2 country code of the venue." }, "subtype": { "type": "string", "nullable": true, "description": "Primary venue subtype (Google Maps category)." }, "summary": { "type": "string", "nullable": true, "description": "Google's short venue description." }, "website": { "type": "string", "nullable": true, "description": "Website of the venue." }, "zipcode": { "type": "string", "nullable": true, "description": "Postal / zip code of the venue." }, "district": { "type": "string", "nullable": true, "description": "District / neighborhood of the venue." }, "latitude": { "type": "number", "nullable": true, "description": "Latitude coordinate of the venue." }, "map_link": { "type": "string", "nullable": true, "description": "Google Maps page of the venue." }, "subtypes": { "type": "array", "items": { "type": "string", "description": "A single venue subtype label." }, "nullable": true, "description": "All venue subtype labels from Google Maps." }, "timezone": { "type": "string", "nullable": true, "description": "IANA timezone of the venue." }, "google_id": { "type": "string", "nullable": true, "description": "Google place ID of the venue." }, "longitude": { "type": "number", "nullable": true, "description": "Longitude coordinate of the venue." }, "google_mid": { "type": "string", "nullable": true, "description": "Google Knowledge Graph MID of the venue." }, "price_range": { "type": "string", "nullable": true, "description": "Venue price range (the venue's, not the event's)." }, "full_address": { "type": "string", "nullable": true, "description": "Full postal address of the venue." }, "phone_number": { "type": "string", "nullable": true, "description": "Phone number of the venue." }, "review_count": { "type": "integer", "nullable": true, "description": "Number of Google reviews for the venue." }, "street_number": { "type": "string", "nullable": true, "description": "Street number of the venue address." } }, "description": "Venue details where the event takes place." }, "is_free": { "type": "boolean", "nullable": true, "description": "False for a priced event, null when no price is published, true when Google labels the event as free." }, "category": { "type": "string", "nullable": true, "description": "Google's one-line category label for the event." }, "end_time": { "type": "string", "nullable": true, "description": "Event end datetime in the venue local timezone (YYYY-MM-DD HH:MM:SS)." }, "event_id": { "type": "string", "description": "Temporary opaque token identifying this result, for use with /event-details. Google can invalidate it at any time, in which case /event-details returns 404 and the search should be re-run. For a permanent identifier use entity_id. Long value, truncated in the example." }, "language": { "type": "string", "nullable": true, "description": "ISO 639-1 language code of the event details (echoes the language parameter)." }, "position": { "type": "integer", "nullable": true, "description": "Rank of the event in Google's list (1-10)." }, "entity_id": { "type": "string", "nullable": true, "description": "Google's entity id of the event (Knowledge Graph mid). Permanent: identical whatever query surfaced the event, so use it as the deduplication / indexing key." }, "map_image": { "type": "string", "nullable": true, "description": "URL of a static Google Maps tile of the venue location." }, "publisher": { "type": "string", "nullable": true, "description": "Name of the source publisher hosting the event listing." }, "thumbnail": { "type": "string", "nullable": true, "description": "URL of the event's thumbnail image." }, "info_links": { "type": "array", "items": { "type": "object", "required": [ "source", "link" ], "properties": { "link": { "type": "string", "nullable": false, "description": "URL of the info page on the source." }, "source": { "type": "string", "nullable": false, "description": "Name of the source." } } }, "nullable": true, "description": "Additional informational links about the event, when Google shows one." }, "is_virtual": { "type": "boolean", "description": "Echoes the is_virtual parameter." }, "start_time": { "type": "string", "nullable": true, "description": "Event start datetime in the venue local timezone (YYYY-MM-DD HH:MM:SS)." }, "description": { "type": "string", "nullable": true, "description": "Short description of the event." }, "end_time_utc": { "type": "string", "nullable": true, "description": "Event end datetime in UTC (YYYY-MM-DD HH:MM:SS)." }, "ticket_links": { "type": "array", "items": { "type": "object", "required": [ "source", "link" ], "properties": { "link": { "type": "string", "nullable": false, "description": "URL of the event on the source." }, "source": { "type": "string", "nullable": false, "description": "Name of the source." }, "fav_icon": { "type": "string", "nullable": true, "description": "Favicon URL of the source." } } }, "nullable": true, "description": "Ticket / event page link on the source publisher." }, "calendar_link": { "type": "string", "nullable": true, "description": "Add to Google Calendar URL, includes start, end and timezone." }, "start_time_utc": { "type": "string", "nullable": true, "description": "Event start datetime in UTC (YYYY-MM-DD HH:MM:SS)." }, "directions_link": { "type": "string", "nullable": true, "description": "Google Maps directions URL to the venue. Long value, truncated in the example." }, "publisher_domain": { "type": "string", "nullable": true, "description": "Domain of the source publisher." }, "publisher_favicon": { "type": "string", "nullable": true, "description": "URL of the source publisher's favicon." }, "date_human_readable": { "type": "string", "nullable": true, "description": "Human-readable event start date and time as displayed by Google." }, "end_time_precision_sec": { "type": "integer", "nullable": true, "description": "Always null: Google no longer provides time precision. Kept for backward compatibility." }, "start_time_precision_sec": { "type": "integer", "nullable": true, "description": "Always null: Google no longer provides time precision. Kept for backward compatibility." } } }, "description": "Array of event results, in the order Google shows them (up to 10)." }, "status": { "type": "string", "description": "The status of the response" }, "parameters": { "type": "object", "properties": { "date": { "type": "string", "description": "The date parameter." }, "query": { "type": "string", "description": "The search query parameter." }, "is_virtual": { "type": "boolean", "description": "The is_virtual parameter, echoed when provided." } } }, "request_id": { "type": "string", "description": "A unique identifier for the request" } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "query", "schema": { "type": "string", "example": "Concerts in San-Francisco" }, "example": "Concerts in San-Francisco", "required": true, "description": "Search query / keyword. Phrase it like an events search (e.g. *events in austin*, *concerts in new york this weekend*)." }, { "in": "query", "name": "date", "schema": { "enum": [ "any", "today", "tomorrow", "week", "weekend", "next_week", "month", "next_month" ], "type": "string", "default": "any" }, "description": "Return events in a certain date / time period. Google no longer offers a date filter, so this acts as a query hint: the matching words (e.g. *this weekend*) are added to the query. It steers results but does not guarantee them." }, { "in": "query", "name": "is_virtual", "schema": { "type": "boolean", "default": false }, "description": "Prefer virtual / online events. Google no longer offers an online-events filter, so this acts as a query hint (the word *online* is added to the query). It steers results but does not guarantee them." } ], "description": "Search for local and online events in real-time, as shown on Google's Events feature inside Google Search results. Use an event-style query (e.g. *events in austin* or *concerts in new york this weekend*): Google only renders events for queries it reads as an events search, so a plain query may return an empty list. Google shows a fixed set of up to 10 events per query.", "operationId": "realtime_events_data__get__search_events", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" } ], "x-zeroclick-services": [ "realtime-events-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-events-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-events-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-finance-data/company-balance-sheet": { "get": { "summary": "Company Balance Sheet", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "Type of financial data (e.g., balance_sheet)" }, "period": { "type": "string", "description": "Reporting period (e.g., quarterly/annual)" }, "symbol": { "type": "string", "description": "Stock ticker symbol" }, "balance_sheet": { "type": "array", "items": { "type": "object", "properties": { "day": { "type": "integer", "description": "Day of the financial record" }, "date": { "type": "string", "description": "Date of the financial record (YYYY-MM-DD)" }, "year": { "type": "integer", "description": "Year of the financial record" }, "month": { "type": "integer", "description": "Month of the financial record" }, "currency": { "type": "string", "description": "Currency used for financial values" }, "total_assets": { "type": "integer", "description": "Sum of all assets" }, "total_equity": { "type": "integer", "description": "Total shareholders' equity" }, "price_to_book": { "type": "number", "description": "Price-to-book ratio" }, "total_liabilities": { "type": "integer", "description": "Sum of all liabilities" }, "shares_outstanding": { "type": "integer", "description": "Number of outstanding shares" }, "return_on_assets_percent": { "type": "number", "description": "Return on assets (ROA) percentage" }, "return_on_capital_percent": { "type": "number", "description": "Return on capital (ROC) percentage" }, "cash_and_short_term_investments": { "type": "integer", "description": "Total cash and liquid investments" } } } } } }, "status": { "type": "string", "description": "Status of the API response (e.g., success/error)" }, "request_id": { "type": "string", "description": "Unique identifier for the API request" } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "symbol", "schema": { "type": "string" }, "example": "AAPL:NASDAQ", "required": true, "description": "Stock symbol (ticker)." }, { "in": "query", "name": "period", "schema": { "type": "string" }, "description": "Period for which to get company's income statement." }, { "in": "query", "name": "language", "schema": { "type": "string", "default": "en", "description": "The language to use for the results, specified as a 2-letter language code - see ISO 639-1." } } ], "description": "Get public company's quarterly or annual balance sheet. Supports the stock type only.", "operationId": "realtime_finance_data__get__company_balance_sheet", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" } ], "x-zeroclick-services": [ "realtime-finance-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-finance-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-finance-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-finance-data/company-cash-flow": { "get": { "summary": "Company Cash Flow", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "Type of financial data" }, "period": { "type": "string", "description": "The reporting period for the cash flow data" }, "symbol": { "type": "string", "description": "The stock ticker symbol" }, "cash_flow": { "type": "array", "items": { "type": "object", "properties": { "day": { "type": "integer", "description": "The day of the cash flow record" }, "date": { "type": "string", "description": "The date of the cash flow record" }, "year": { "type": "integer", "description": "The year of the cash flow record" }, "month": { "type": "integer", "description": "The month of the cash flow record" }, "currency": { "type": "string", "description": "The currency used for all monetary values" }, "net_income": { "type": "integer", "description": "The net income amount" }, "free_cash_flow": { "type": "integer", "description": "Free cash flow available" }, "net_change_in_cash": { "type": "integer", "description": "Net change in cash position" }, "cash_from_financing": { "type": "integer", "description": "Cash from financing activities" }, "cash_from_investing": { "type": "integer", "description": "Cash used in investing activities" }, "cash_from_operations": { "type": "integer", "description": "Cash generated from operating activities" } } } } } }, "status": { "type": "string", "description": "The status of the API response" }, "request_id": { "type": "string", "description": "Unique identifier for the API request" } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "symbol", "schema": { "type": "string" }, "example": "AAPL:NASDAQ", "required": true, "description": "Stock symbol (ticker)." }, { "in": "query", "name": "period", "schema": { "type": "string" }, "description": "Period for which to get company's income statement." }, { "in": "query", "name": "language", "schema": { "type": "string", "default": "en", "description": "The language to use for the results, specified as a 2-letter language code - see ISO 639-1." } } ], "description": "Get public company's quarterly or annual cash flow information. Supports the stock type only.", "operationId": "realtime_finance_data__get__company_cash_flow", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" } ], "x-zeroclick-services": [ "realtime-finance-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-finance-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-finance-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-finance-data/company-income-statement": { "get": { "summary": "Company Income Statement", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "Type of financial data" }, "period": { "type": "string", "description": "Time period covered by the data" }, "symbol": { "type": "string", "description": "The stock symbol/ticker" }, "income_statement": { "type": "array", "items": { "type": "object", "properties": { "day": { "type": "integer", "description": "Day of the financial record" }, "date": { "type": "string", "description": "Date of the financial record" }, "year": { "type": "integer", "description": "Year of the financial record" }, "month": { "type": "integer", "description": "Month of the financial record" }, "EBITDA": { "type": "integer", "description": "Earnings before interest, taxes, depreciation and amortization" }, "revenue": { "type": "integer", "description": "Total revenue amount" }, "currency": { "type": "string", "description": "Currency used in the financial values" }, "net_income": { "type": "integer", "description": "Net income amount" }, "net_profit_margin": { "type": "number", "description": "Net profit margin percentage" }, "operating_expense": { "type": "integer", "description": "Total operating expenses" }, "earnings_per_share": { "type": "number", "description": "Earnings per share value" }, "effective_tax_rate_percent": { "type": "number", "description": "Effective tax rate percentage" } } } } } }, "status": { "type": "string", "description": "The status of the API response" }, "request_id": { "type": "string", "description": "Unique identifier for the API request" } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "symbol", "schema": { "type": "string" }, "example": "AAPL:NASDAQ", "required": true, "description": "Stock symbol (ticker)." }, { "in": "query", "name": "period", "schema": { "type": "string" }, "description": "Period for which to get company's income statement." }, { "in": "query", "name": "language", "schema": { "type": "string", "default": "en", "description": "The language to use for the results, specified as a 2-letter language code - see ISO 639-1." } } ], "description": "Get public company's quarterly or annual income statement. Supports the stock type only.", "operationId": "realtime_finance_data__get__company_income_statement", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" } ], "x-zeroclick-services": [ "realtime-finance-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-finance-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-finance-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-finance-data/currency-exchange-rate": { "get": { "summary": "Currency Exchange Rate", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "Type of exchange rate data" }, "to_symbol": { "type": "string", "description": "Currency symbol being converted to" }, "from_symbol": { "type": "string", "description": "Currency symbol being converted from" }, "exchange_rate": { "type": "number", "description": "Current exchange rate" }, "previous_close": { "type": "number", "description": "Previous closing exchange rate" }, "last_update_utc": { "type": "string", "description": "Timestamp of last update in UTC" } } }, "status": { "type": "string", "description": "Status of the API response" }, "request_id": { "type": "string", "description": "Unique identifier for the request" } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "from_symbol", "schema": { "type": "string", "description": "A 3-Letter currency code / symbol (ISO 4217) to convert." }, "example": "USD", "required": true }, { "in": "query", "name": "to_symbol", "schema": { "type": "string", "description": "A 3-Letter currency code / symbol (ISO 4217) to convert to." }, "example": "EUR", "required": true }, { "in": "query", "name": "language", "schema": { "type": "string", "default": "en", "description": "The language to use for the results, specified as a 2-letter language code - see ISO 639-1." } } ], "description": "Get currency / forex or crypto exchange rates.", "operationId": "realtime_finance_data__get__currency_exchange_rate", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" } ], "x-zeroclick-services": [ "realtime-finance-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-finance-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-finance-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-finance-data/currency-news": { "get": { "summary": "Currency News", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "news": { "type": "array", "items": { "type": "object", "properties": { "source": { "type": "string", "description": "News source/publisher" }, "article_url": { "type": "string", "description": "URL to the full article" }, "article_title": { "type": "string", "description": "Title of the news article" }, "post_time_utc": { "type": "string", "description": "Publication timestamp in UTC" }, "article_photo_url": { "type": "string", "description": "URL to the article's featured image" } } } }, "type": { "type": "string", "description": "Type of news data" }, "to_symbol": { "type": "string", "description": "Target symbol for comparison" }, "from_symbol": { "type": "string", "description": "Source symbol (currency/crypto/stock)" } } }, "status": { "type": "string", "description": "Status of the API response" }, "request_id": { "type": "string", "description": "Unique identifier for the API request" } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "from_symbol", "schema": { "type": "string", "description": "A 3-Letter currency code / symbol (ISO 4217)." }, "example": "USD", "required": true }, { "in": "query", "name": "to_symbol", "schema": { "type": "string", "description": "A 3-Letter currency code / symbol (ISO 4217)." }, "example": "EUR", "required": true }, { "in": "query", "name": "language", "schema": { "type": "string", "default": "en", "description": "The language to use for the results, specified as a 2-letter language code - see ISO 639-1." } } ], "description": "Get the latest news related to a specific currency / forex or crypto.", "operationId": "realtime_finance_data__get__currency_news", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" } ], "x-zeroclick-services": [ "realtime-finance-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-finance-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-finance-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-finance-data/currency-time-series": { "get": { "summary": "Currency Time Series", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "Type of exchange rate data" }, "period": { "type": "string", "description": "Time period covered by the time series" }, "to_symbol": { "type": "string", "description": "Target currency symbol for conversion" }, "from_symbol": { "type": "string", "description": "Base currency symbol for conversion" }, "time_series": { "type": "object", "description": "Historical exchange rate data keyed by timestamp. Each value is an exchange-rate snapshot at that timestamp.", "additionalProperties": { "type": "object", "properties": { "change": { "type": "number", "description": "Absolute change from the previous close at this timestamp." }, "exchange_rate": { "type": "number", "description": "Exchange rate at this timestamp." }, "change_percent": { "type": "number", "description": "Percent change from the previous close at this timestamp." } } } }, "interval_sec": { "type": "integer", "description": "Time interval between data points in seconds" }, "exchange_rate": { "type": "number", "description": "Current exchange rate value" }, "previous_close": { "type": "number", "description": "Previous closing exchange rate" }, "utc_offset_sec": { "type": "integer", "description": "UTC offset in seconds for time series data" }, "last_update_utc": { "type": "string", "description": "Timestamp of last update in UTC format" } } }, "status": { "type": "string", "description": "Status of the API response" }, "request_id": { "type": "string", "description": "Unique identifier for the API request" } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "from_symbol", "schema": { "type": "string", "description": "A 3-Letter currency code / symbol (ISO 4217) to convert." }, "example": "USD", "required": true }, { "in": "query", "name": "to_symbol", "schema": { "type": "string", "description": "A 3-Letter currency code / symbol (ISO 4217) to convert to." }, "example": "EUR", "required": true }, { "in": "query", "name": "period", "schema": { "type": "string", "description": "Period for which to return time series and key events. \n\n **Periods:** \n `1D - 1 day` \n `5D - 5 days` \n `1M - 1 month` \n `6M - 6 months` \n `YTD - year-to-date` \n `1Y - 1 year` \n `5Y - 5 years` \n `MAX - all times` " } }, { "in": "query", "name": "language", "schema": { "type": "string", "default": "en", "description": "The language to use for the results, specified as a 2-letter language code - see ISO 639-1." } } ], "description": "Get forex time series for the following periods: 1 day, 5 days, 1 month, 6 months, year-to-date, 1 year, 5 years and all times (max).", "operationId": "realtime_finance_data__get__currency_time_series", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" } ], "x-zeroclick-services": [ "realtime-finance-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-finance-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-finance-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-finance-data/market-trends": { "get": { "summary": "Market Trends", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "news": { "type": "array", "items": { "type": "object", "properties": { "source": { "type": "string", "description": "Name of the news source" }, "article_url": { "type": "string", "description": "URL to the full news article" }, "article_title": { "type": "string", "description": "Title of the news article" }, "post_time_utc": { "type": "string", "description": "Publication time in UTC" }, "stocks_in_news": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Display name of the asset." }, "type": { "type": "string", "description": "Asset type. Values include: stock, index, mutualfund, etf, currency, crypto." }, "price": { "type": "number", "description": "Last traded price in the asset's quote currency." }, "change": { "type": "number", "description": "Absolute price change from the previous close." }, "symbol": { "type": "string", "description": "Ticker symbol including its exchange suffix." }, "timezone": { "type": "string", "description": "IANA timezone of the exchange." }, "google_mid": { "type": "string", "description": "Google Knowledge Graph machine ID for the asset." }, "exchange_open": { "type": "string", "description": "Local datetime when the exchange next opens." }, "change_percent": { "type": "number", "description": "Percent change from the previous close." }, "exchange_close": { "type": "string", "description": "Local datetime when the exchange next closes." }, "previous_close": { "type": "number", "description": "Previous closing price." }, "utc_offset_sec": { "type": "integer", "description": "UTC offset of the exchange's timezone, in seconds." }, "last_update_utc": { "type": "string", "description": "Datetime of the last price update in UTC." } } }, "description": "Tickers mentioned in this article, with current snapshot quotes." }, "article_photo_url": { "type": "string", "description": "URL to the article's featured image" } } } }, "trends": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Display name of the asset." }, "type": { "type": "string", "description": "Asset type. Values include: stock, index, mutualfund, etf, currency, crypto." }, "price": { "type": "number", "description": "Last traded price in the asset's quote currency." }, "change": { "type": "number", "description": "Absolute price change from the previous close." }, "symbol": { "type": "string", "description": "Ticker symbol including its exchange suffix." }, "timezone": { "type": "string", "description": "IANA timezone of the exchange." }, "google_mid": { "type": "string", "description": "Google Knowledge Graph machine ID for the asset." }, "exchange_open": { "type": "string", "description": "Local datetime when the exchange next opens." }, "change_percent": { "type": "number", "description": "Percent change from the previous close." }, "exchange_close": { "type": "string", "description": "Local datetime when the exchange next closes." }, "previous_close": { "type": "number", "description": "Previous closing price." }, "utc_offset_sec": { "type": "integer", "description": "UTC offset of the exchange's timezone, in seconds." }, "last_update_utc": { "type": "string", "description": "Datetime of the last price update in UTC." } } }, "description": "Top assets for the requested trend type (e.g. Most Active, Gainers, Losers, Crypto, Currencies, Climate Leaders)." } } }, "status": { "type": "string", "description": "The status of the API response" }, "request_id": { "type": "string", "description": "Unique identifier for the API request" } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "trend_type", "schema": { "enum": [ "MARKET_INDEXES", "MOST_ACTIVE", "GAINERS", "LOSERS", "CRYPTO", "CURRENCIES", "CLIMATE_LEADERS" ], "type": "string" }, "example": "MARKET_INDEXES", "required": true, "description": "Trend type." }, { "in": "query", "name": "country", "schema": { "type": "string", "default": "us", "description": "The country for which to get trends, specified as a 2-letter country code - see ISO 3166." } }, { "in": "query", "name": "language", "schema": { "type": "string", "default": "en", "description": "The language to use for the results, specified as a 2-letter language code - see ISO 639-1." } } ], "description": "Get the latest market trends and relevant news. Supported trends: Most Active, Gainers, Losers, Crypto, Currencies and Climate Leaders.", "operationId": "realtime_finance_data__get__market_trends", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" } ], "x-zeroclick-services": [ "realtime-finance-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-finance-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-finance-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-finance-data/search": { "get": { "summary": "Search", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "ETF": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "ETF name" }, "type": { "type": "string", "description": "Type of financial instrument" }, "price": { "type": "number", "description": "Current price" }, "change": { "type": "number", "description": "Price change from previous close" }, "symbol": { "type": "string", "description": "ETF ticker symbol" }, "google_mid": { "type": "string", "description": "Google market identifier" }, "change_percent": { "type": "number", "description": "Percentage price change from previous close" }, "previous_close": { "type": "number", "description": "Previous closing price" }, "last_update_utc": { "type": "string", "description": "Timestamp of last update in UTC" } } } }, "index": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Index name" }, "type": { "type": "string", "description": "Type of financial instrument" }, "price": { "type": "number", "description": "Current price" }, "change": { "type": "number", "description": "Price change from previous close" }, "symbol": { "type": "string", "description": "Index ticker symbol" }, "timezone": { "type": "string", "description": "Exchange timezone" }, "google_mid": { "type": "string", "description": "Google market identifier" }, "exchange_open": { "type": "string", "description": "Exchange opening time" }, "change_percent": { "type": "number", "description": "Percentage price change from previous close" }, "exchange_close": { "type": "string", "description": "Exchange closing time" }, "previous_close": { "type": "number", "description": "Previous closing price" }, "utc_offset_sec": { "type": "integer", "description": "UTC offset in seconds" }, "last_update_utc": { "type": "string", "description": "Timestamp of last update in UTC" } } } }, "stock": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Company name" }, "type": { "type": "string", "description": "Type of financial instrument" }, "price": { "type": "number", "description": "Current price" }, "change": { "type": "number", "description": "Price change from previous close" }, "symbol": { "type": "string", "description": "Stock ticker symbol" }, "currency": { "type": "string", "description": "Currency of the price" }, "exchange": { "type": "string", "description": "Stock exchange identifier" }, "timezone": { "type": "string", "description": "Exchange timezone" }, "google_mid": { "type": "string", "description": "Google market identifier" }, "country_code": { "type": "string", "description": "Country code where stock is listed" }, "exchange_open": { "type": "string", "description": "Exchange opening time" }, "change_percent": { "type": "number", "description": "Percentage price change from previous close" }, "exchange_close": { "type": "string", "description": "Exchange closing time" }, "previous_close": { "type": "number", "description": "Previous closing price" }, "utc_offset_sec": { "type": "integer", "description": "UTC offset in seconds" }, "last_update_utc": { "type": "string", "description": "Timestamp of last update in UTC" } } } }, "currency": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "Type of financial instrument" }, "to_symbol": { "type": "string", "description": "Target currency code" }, "google_mid": { "type": "string", "description": "Google market identifier" }, "from_symbol": { "type": "string", "description": "Source currency code" }, "exchange_rate": { "type": "number", "description": "Current exchange rate" }, "previous_close": { "type": "number", "description": "Previous closing exchange rate" }, "last_update_utc": { "type": "string", "description": "Timestamp of last update in UTC" }, "to_currency_name": { "type": "string", "description": "Target currency name" }, "from_currency_name": { "type": "string", "description": "Source currency name" } } } }, "mutual_fund": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Mutual fund name" }, "type": { "type": "string", "description": "Type of financial instrument" }, "price": { "type": "number", "description": "Current price" }, "change": { "type": "number", "description": "Price change from previous close" }, "symbol": { "type": "string", "description": "Mutual fund ticker symbol" }, "currency": { "type": "string", "description": "Currency of the price" }, "google_mid": { "type": "string", "description": "Google market identifier" }, "change_percent": { "type": "number", "description": "Percentage price change from previous close" }, "previous_close": { "type": "number", "description": "Previous closing price" }, "last_update_utc": { "type": "string", "description": "Timestamp of last update in UTC" } } } } } }, "status": { "type": "string", "description": "The status of the API response" }, "request_id": { "type": "string", "description": "Unique identifier for the API request" } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "query", "schema": { "type": "string" }, "example": "apple", "required": true, "description": "Free-form search query." }, { "in": "query", "name": "language", "schema": { "type": "string", "default": "en", "description": "The language to use for the results, specified as a 2-letter language code - see ISO 639-1." } } ], "description": "Find stocks, indices, mutual funds, futures, currency / forex / crypto using a free-form query or symbol as seen on Google Finance - https://www.google.com/finance.", "operationId": "realtime_finance_data__get__search", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" } ], "x-zeroclick-services": [ "realtime-finance-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-finance-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-finance-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-finance-data/stock-news": { "get": { "summary": "Stock News", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "news": { "type": "array", "items": { "type": "object", "properties": { "source": { "type": "string", "description": "Name of the news source" }, "article_url": { "type": "string", "description": "URL to the full news article" }, "article_title": { "type": "string", "description": "Title of the news article" }, "post_time_utc": { "type": "string", "description": "Publication time in UTC" }, "article_photo_url": { "type": "string", "description": "URL to the article's featured image" } } } }, "type": { "type": "string", "description": "Type of financial instrument" }, "symbol": { "type": "string", "description": "Stock ticker symbol" } } }, "status": { "type": "string", "description": "Status of the API response" }, "request_id": { "type": "string", "description": "Unique identifier for the API request" } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "symbol", "schema": { "type": "string" }, "example": "AAPL:NASDAQ", "required": true, "description": "Stock symbol (ticker)." }, { "in": "query", "name": "language", "schema": { "type": "string", "default": "en", "description": "The language to use for the results, specified as a 2-letter language code - see ISO 639-1." } } ], "description": "Get the latest news related to a specific stock. Supports all stock types: stock, index, mutual fund and futures.", "operationId": "realtime_finance_data__get__stock_news", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing explicit parameter definitions in source text" ], "pages": [ 1 ], "sourceId": "sds_D1eKbJ9D0SJoHD3LLOLYI", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_WiAI6D9DA33xLudF2TJIh" } ], "x-zeroclick-services": [ "realtime-finance-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-finance-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-finance-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-finance-data/stock-overview": { "get": { "summary": "Stock / Company Overview", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "low": { "type": "number", "description": "Today's lowest price" }, "high": { "type": "number", "description": "Today's highest price" }, "name": { "type": "string", "description": "Company name" }, "open": { "type": "number", "description": "Today's opening price" }, "type": { "type": "string", "description": "Type of financial instrument" }, "about": { "type": "string", "description": "Brief company description" }, "price": { "type": "number", "description": "Current trading price" }, "change": { "type": "number", "description": "Price change from previous close" }, "symbol": { "type": "string", "description": "Stock ticker symbol" }, "volume": { "type": "integer", "description": "Today's trading volume" }, "currency": { "type": "string", "description": "Currency of the price" }, "exchange": { "type": "string", "description": "Stock exchange identifier" }, "timezone": { "type": "string", "description": "Exchange timezone" }, "year_low": { "type": "number", "description": "52-week low price" }, "year_high": { "type": "number", "description": "52-week high price" }, "avg_volume": { "type": "integer", "description": "Average trading volume" }, "google_mid": { "type": "string", "description": "Google Knowledge Graph ID" }, "company_ceo": { "type": "string", "description": "Company CEO name" }, "company_city": { "type": "string", "description": "Company headquarters city" }, "country_code": { "type": "string", "description": "Country code where stock is listed" }, "company_state": { "type": "string", "description": "Company headquarters state" }, "exchange_open": { "type": "string", "description": "Exchange opening time" }, "wikipedia_url": { "type": "string", "description": "URL to Wikipedia page" }, "change_percent": { "type": "number", "description": "Percentage price change from previous close" }, "company_sector": { "type": "string", "description": "Company sector classification" }, "exchange_close": { "type": "string", "description": "Exchange closing time" }, "previous_close": { "type": "number", "description": "Previous closing price" }, "utc_offset_sec": { "type": "integer", "description": "UTC offset in seconds" }, "company_cdp_url": { "type": "string", "description": "URL to CDP profile" }, "company_country": { "type": "string", "description": "Company headquarters country" }, "company_website": { "type": "string", "description": "URL of company website" }, "last_update_utc": { "type": "string", "description": "Timestamp of last update in UTC" }, "company_industry": { "type": "string", "description": "Company industry classification" }, "company_pe_ratio": { "type": "number", "description": "Price-to-earnings ratio" }, "primary_exchange": { "type": "string", "description": "Primary stock exchange" }, "company_cdp_score": { "type": "string", "description": "Carbon Disclosure Project score" }, "company_employees": { "type": "integer", "description": "Number of company employees" }, "company_market_cap": { "type": "number", "description": "Company market capitalization" }, "pre_or_post_market": { "type": "number", "description": "Current pre/post-market price" }, "company_country_code": { "type": "string", "description": "Company headquarters country code" }, "company_founded_date": { "type": "string", "description": "Company founding date" }, "company_dividend_yield": { "type": "number", "description": "Dividend yield percentage" }, "company_street_address": { "type": "string", "description": "Company street address" }, "pre_or_post_market_change": { "type": "number", "description": "Pre/post-market price change" }, "pre_or_post_market_change_percent": { "type": "number", "description": "Percentage pre/post-market price change" } } }, "status": { "type": "string", "description": "Status of the API response" }, "request_id": { "type": "string", "description": "Unique identifier for the API request" } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "symbol", "schema": { "type": "string" }, "example": "AAPL:NASDAQ", "required": true, "description": "Stock symbol (ticker)." }, { "in": "query", "name": "language", "schema": { "type": "string", "default": "en", "description": "The language to use for the results, specified as a 2-letter language code - see ISO 639-1." } } ], "description": "Get stock / public company details. Supports all stock types: stock, index, mutual fund and futures. Returns company details for the stock type.", "operationId": "realtime_finance_data__get__stock_overview", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing explicit parameter definitions in source text" ], "pages": [ 1 ], "sourceId": "sds_D1eKbJ9D0SJoHD3LLOLYI", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_WiAI6D9DA33xLudF2TJIh" } ], "x-zeroclick-services": [ "realtime-finance-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-finance-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-finance-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-finance-data/stock-quote": { "get": { "summary": "Stock Quote", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "low": { "type": "number", "description": "Lowest price during the current trading day" }, "high": { "type": "number", "description": "Highest price during the current trading day" }, "name": { "type": "string", "description": "Company name" }, "open": { "type": "number", "description": "Opening price for the current trading day" }, "type": { "type": "string", "description": "Type of financial instrument" }, "price": { "type": "number", "description": "Current trading price" }, "change": { "type": "number", "description": "Price change from previous close" }, "symbol": { "type": "string", "description": "Stock ticker symbol" }, "volume": { "type": "integer", "description": "Trading volume for the current day" }, "change_percent": { "type": "number", "description": "Percentage price change from previous close" }, "previous_close": { "type": "number", "description": "Closing price from previous trading day" }, "last_update_utc": { "type": "string", "description": "Timestamp of last price update in UTC" }, "pre_or_post_market": { "type": "number", "description": "Current pre-market or post-market price" }, "pre_or_post_market_change": { "type": "number", "description": "Price change in pre/post market trading" }, "pre_or_post_market_change_percent": { "type": "number", "description": "Percentage price change in pre/post market trading" } } }, "status": { "type": "string", "description": "Status of the API response" }, "request_id": { "type": "string", "description": "Unique identifier for the request" } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "symbol", "schema": { "type": "string" }, "example": "AAPL:NASDAQ", "required": true, "description": "Stock symbol / ticker, specified with or without exchange symbol. \n \n **Batching:** up to 100 symbols are supported in a single request (separated by comma, as shown in the 2nd example above). \n \n **Note:** every 10 symbols will be charged as a single request - for example, sending 78 symbols will be counted & charged as 8 requests." }, { "in": "query", "name": "language", "schema": { "type": "string", "default": "en", "description": "The language to use for the results, specified as a 2-letter language code - see ISO 639-1." } } ], "description": "Get stock market quote. Supports all stock types: stock, index, mutual fund and futures.", "operationId": "realtime_finance_data__get__stock_quote", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing explicit parameter definitions in source text" ], "pages": [ 1 ], "sourceId": "sds_D1eKbJ9D0SJoHD3LLOLYI", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_WiAI6D9DA33xLudF2TJIh" } ], "x-zeroclick-services": [ "realtime-finance-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-finance-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-finance-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-finance-data/stock-quote-yahoo-finance": { "get": { "summary": "Stock Quote (Yahu Finance)", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Full name of the company/asset" }, "type": { "type": "string", "description": "Type of financial instrument" }, "price": { "type": "number", "description": "Current trading price" }, "change": { "type": "number", "description": "Price change from previous close" }, "symbol": { "type": "string", "description": "Ticker symbol of the asset" }, "volume": { "type": "integer", "description": "Trading volume for the day" }, "day_low": { "type": "number", "description": "Lowest price of the day" }, "currency": { "type": "string", "description": "Currency of the price values" }, "day_high": { "type": "number", "description": "Highest price of the day" }, "exchange": { "type": "string", "description": "Stock exchange where traded" }, "year_low": { "type": "number", "description": "52-week low price" }, "tradeable": { "type": "boolean", "description": "Whether the asset is tradeable" }, "year_high": { "type": "number", "description": "52-week high price" }, "market_state": { "type": "string", "description": "Current market state (open/closed/etc)" }, "change_percent": { "type": "number", "description": "Percentage price change" }, "previous_close": { "type": "number", "description": "Previous closing price" }, "crypto_tradeable": { "type": "boolean", "description": "Whether the asset is a tradeable cryptocurrency" }, "exchange_timezone": { "type": "string", "description": "Exchange timezone name" }, "full_exchange_name": { "type": "string", "description": "Full name of the exchange" }, "exchange_timezone_short": { "type": "string", "description": "Abbreviated timezone name" }, "exchange_timezone_utc_offset_sec": { "type": "integer", "description": "UTC offset in seconds" } } } }, "status": { "type": "string", "description": "Status of the API response" }, "request_id": { "type": "string", "description": "Unique identifier for the API request" } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "symbol", "schema": { "type": "string", "description": "Stock symbol / ticker. Up to 100 symbols are supported in a single request (separated by comma). \n\n **Examples:** \n *AAPL* \n *MSFT,AMZN* \n \n **Note:** Every 10 symbols will be charged as a single request - for example, sending 78 symbols will be counted as 8 requests." }, "example": "AAPL", "required": true } ], "description": "Get stock market quote by stock symbol/ticker from Yahu Finance.", "operationId": "realtime_finance_data__get__stock_quote_yahoo_finance", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing explicit parameter definitions in source text" ], "pages": [ 1 ], "sourceId": "sds_D1eKbJ9D0SJoHD3LLOLYI", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_WiAI6D9DA33xLudF2TJIh" } ], "x-zeroclick-services": [ "realtime-finance-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-finance-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-finance-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-finance-data/stock-time-series": { "get": { "summary": "Stock Time Series", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "Type of financial instrument" }, "price": { "type": "number", "description": "Current trading price" }, "change": { "type": "number", "description": "Price change from previous close" }, "period": { "type": "string", "description": "Time period covered by the data" }, "symbol": { "type": "string", "description": "Stock ticker symbol" }, "key_events": { "type": "array", "items": { "type": "string" }, "description": "Significant market events relevant to this asset over the requested period. Empty when no events are reported." }, "time_series": { "type": "object", "description": "Historical price data keyed by timestamp. Each value is a price snapshot at that timestamp.", "additionalProperties": { "type": "object", "properties": { "price": { "type": "number", "description": "Price at this timestamp." }, "change": { "type": "number", "description": "Absolute change from the previous close at this timestamp." }, "volume": { "type": "integer", "description": "Traded volume during this interval." }, "change_percent": { "type": "number", "description": "Percent change from the previous close at this timestamp." } } } }, "interval_sec": { "type": "integer", "description": "Time interval between data points in seconds" }, "change_percent": { "type": "number", "description": "Percentage price change from previous close" }, "previous_close": { "type": "number", "description": "Previous closing price" }, "utc_offset_sec": { "type": "integer", "description": "UTC offset in seconds for the exchange timezone" }, "last_update_utc": { "type": "string", "description": "Timestamp of last price update in UTC" }, "pre_or_post_market": { "type": "number", "description": "Pre-market or post-market price" }, "pre_or_post_market_change": { "type": "number", "description": "Price change in pre/post market trading" }, "pre_or_post_market_change_percent": { "type": "number", "description": "Percentage price change in pre/post market trading" } } }, "status": { "type": "string", "description": "Status of the API response" }, "request_id": { "type": "string", "description": "Unique identifier for the API request" } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "symbol", "schema": { "type": "string" }, "example": "AAPL:NASDAQ", "required": true, "description": "Stock symbol (ticker)." }, { "in": "query", "name": "period", "schema": { "type": "string", "description": "Period for which to return time series and key events. \n\n **Periods:** \n `1D - 1 day` \n `5D - 5 days` \n `1M - 1 month` \n `6M - 6 months` \n `YTD - year-to-date` \n `1Y - 1 year` \n `5Y - 5 years` \n `MAX - all times` " } }, { "in": "query", "name": "language", "schema": { "type": "string", "default": "en", "description": "The language to use for the results, specified as a 2-letter language code - see ISO 639-1." } } ], "description": "Get stock time series and key news events for the following periods: \n 1 day, 5 days, 1 month, 6 months, year-to-date, 1 year, 5 years and all times (max). \n In addition, the endpoints returns the key news events that affected the stock prices in the specified period. \n Supports all stock types: stock, index, mutual fund and futures.", "operationId": "realtime_finance_data__get__stock_time_series", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing explicit parameter definitions in source text" ], "pages": [ 1 ], "sourceId": "sds_D1eKbJ9D0SJoHD3LLOLYI", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_WiAI6D9DA33xLudF2TJIh" } ], "x-zeroclick-services": [ "realtime-finance-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-finance-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-finance-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-finance-data/stock-time-series-yahoo-finance": { "get": { "summary": "Stock Time Series (Yahu Finance)", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "Type of financial instrument" }, "price": { "type": "number", "description": "Current trading price" }, "change": { "type": "number", "description": "Price change from previous close" }, "period": { "type": "string", "description": "Time period covered by the time series" }, "symbol": { "type": "string", "description": "Ticker symbol of the asset" }, "volume": { "type": "integer", "description": "Trading volume for the day" }, "day_low": { "type": "number", "description": "Lowest price of the day" }, "currency": { "type": "string", "description": "Currency of the price values" }, "day_high": { "type": "number", "description": "Highest price of the day" }, "exchange": { "type": "string", "description": "Stock exchange where traded" }, "interval": { "type": "string", "description": "Time interval between data points" }, "year_low": { "type": "number", "description": "52-week low price" }, "year_high": { "type": "number", "description": "52-week high price" }, "time_series": { "type": "array", "items": { "type": "object", "properties": { "low": { "type": "number", "description": "Lowest price during this interval." }, "high": { "type": "number", "description": "Highest price during this interval." }, "open": { "type": "number", "description": "Open price for this interval." }, "close": { "type": "number", "description": "Close price for this interval." }, "change": { "type": "number", "description": "Absolute price change during this interval." }, "volume": { "type": "integer", "description": "Traded volume during this interval." }, "datetime": { "type": "string", "description": "Timestamp of the data point, in the exchange's local timezone." }, "change_percent": { "type": "number", "description": "Percent price change during this interval." } } }, "description": "OHLCV data points for the requested period and interval." }, "change_percent": { "type": "number", "description": "Percentage price change" }, "previous_close": { "type": "number", "description": "Previous closing price" }, "exchange_timezone": { "type": "string", "description": "Exchange timezone name" }, "full_exchange_name": { "type": "string", "description": "Full name of the exchange" }, "exchange_timezone_short": { "type": "string", "description": "Abbreviated timezone name" }, "exchange_timezone_utc_offset_sec": { "type": "integer", "description": "UTC offset in seconds" } } }, "status": { "type": "string", "description": "Status of the API response" }, "request_id": { "type": "string", "description": "Unique identifier for the API request" } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "symbol", "schema": { "type": "string" }, "example": "AAPL", "required": true, "description": "Stock symbol / ticker." }, { "in": "query", "name": "period", "schema": { "type": "string", "description": "Period for which to return time series and key events. \n\n **Periods:** \n `1D - 1 day` \n `5D - 5 days` \n `1M - 1 month` \n `6M - 6 months` \n `YTD - year-to-date` \n `1Y - 1 year` \n `5Y - 5 years` \n `MAX - all times` " } } ], "description": "Get stock time series by stock symbol/ticker from Yahu Finance.", "operationId": "realtime_finance_data__get__stock_time_series_yahoo_finance", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing explicit parameter definitions in source text" ], "pages": [ 1 ], "sourceId": "sds_D1eKbJ9D0SJoHD3LLOLYI", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_WiAI6D9DA33xLudF2TJIh" } ], "x-zeroclick-services": [ "realtime-finance-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-finance-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-finance-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-forums-search/search": { "get": { "summary": "Search Forums", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string", "description": "The URL of the search result" }, "rank": { "type": "integer", "description": "The rank of the search result" }, "title": { "type": "string", "description": "The title of the search result" }, "source": { "type": "string", "description": "The source of the search result" }, "snippet": { "type": "string", "description": "A short snippet from the search result" }, "position": { "type": "integer", "description": "The position of the search result in the list" } } } }, "status": { "type": "string", "description": "The status of the response" }, "parameters": { "type": "object", "properties": { "query": { "type": "string", "description": "The search query string" }, "start": { "type": "integer", "description": "The starting index of the search results" } } }, "request_id": { "type": "string", "description": "A unique identifier for the request" } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "query", "schema": { "type": "string" }, "example": "iphone pro", "required": true, "description": "Search query" }, { "in": "query", "name": "time", "schema": { "enum": [ "any", "hour", "day", "week", "month", "year" ], "type": "string", "default": "any" }, "description": "Return results published in a specific time range." }, { "in": "query", "name": "start", "schema": { "type": "integer", "default": 0 }, "description": "Number of results to skip (for pagination)." }, { "in": "query", "name": "country", "schema": { "type": "string", "default": "us" }, "description": "The country / region for which to make the query (Google's gl parameter). Allowed values: 2-letter country code, see ISO 3166-1 alpha-2." }, { "in": "query", "name": "language", "schema": { "type": "string", "default": "en" }, "description": "The language to use for the search (Google's hl parameter). Allowed values: 2-letter country code, see ISO 639-1 alpha-2." } ], "description": "Search in Discussions and Forums across the web. This endpoint returns the results returned when using the Forums tab on Google Search.", "operationId": "realtime_forums_search__get__search", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing explicit parameter definitions for query, language, location, or pagination in the provided text." ], "pages": [ 1 ], "sourceId": "sds_5hlhZJYspBPaHxKN7OhqJ", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_3lrPg3Nc0kbMzAAAdVFHe" }, { "gaps": [ "Missing explicit parameter definitions in source text" ], "pages": [ 1 ], "sourceId": "sds_D1eKbJ9D0SJoHD3LLOLYI", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_WiAI6D9DA33xLudF2TJIh" } ], "x-zeroclick-services": [ "realtime-forums-search" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-forums-search", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-forums-search", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-glassdoor-data/company-interviews": { "get": { "summary": "Company Interviews", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "interviews": { "type": "array", "items": { "type": "object" }, "description": "The list of interview records returned for the request." }, "page_count": { "type": "integer", "description": "The total number of pages available for the filtered results." }, "total_count": { "type": "integer", "description": "The total number of interview records available." }, "current_page": { "type": "integer", "description": "The current page number in the paginated results." }, "filtered_count": { "type": "integer", "description": "The number of interview records matching the applied filters." }, "newest_review_date": { "type": "string", "description": "The date of the newest interview review in the result set." }, "interview_difficulty": { "type": "number", "description": "The average interview difficulty score." }, "interview_question_count": { "type": "integer", "description": "The total number of interview questions collected in the results." }, "interview_experience_counts": { "type": "object", "properties": { "NEUTRAL": { "type": "integer", "description": "The number of interviews reported as neutral experiences." }, "NEGATIVE": { "type": "integer", "description": "The number of interviews reported as negative experiences." }, "POSITIVE": { "type": "integer", "description": "The number of interviews reported as positive experiences." } } }, "interview_obtained_channel_counts": { "type": "object", "properties": { "OTHER": { "type": "integer", "description": "The number of interviews obtained through other channels." }, "COLLEGE": { "type": "integer", "description": "The number of interviews obtained through college recruiting." }, "IN_PERSON": { "type": "integer", "description": "The number of interviews obtained through in-person contact." }, "RECRUITER": { "type": "integer", "description": "The number of interviews obtained through a recruiter." }, "APPLIED_ONLINE": { "type": "integer", "description": "The number of interviews obtained by applying online." }, "STAFFING_AGENCY": { "type": "integer", "description": "The number of interviews obtained through a staffing agency." }, "EMPLOYEE_REFERRAL": { "type": "integer", "description": "The number of interviews obtained through employee referrals." } } } } }, "status": { "type": "string", "description": "The status of the API response." }, "parameters": { "type": "object", "properties": { "page": { "type": "integer", "description": "The page number of interview results to return." }, "sort": { "type": "string", "description": "The sorting method applied to the interview results." }, "domain": { "type": "string", "description": "The Glassdoor domain or locale used for the request." }, "location_type": { "type": "string", "description": "The location scope used to filter interview results." }, "received_offer_only": { "type": "boolean", "description": "Whether to include only interviews where an offer was received." } } }, "request_id": { "type": "string", "description": "A unique identifier for this request." } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "company_id", "schema": { "type": "string", "example": "1138" }, "example": "1138", "required": true, "description": "Company ID" }, { "in": "query", "name": "page", "schema": { "type": "number", "default": 1 }, "description": "The reviews page to return (each page includes up to 10 results)." }, { "in": "query", "name": "page_size", "schema": { "type": "number", "default": 10, "maximum": 100, "minimum": 1 }, "description": "Maximum interview results to return in each page. \n Important note: when page > 1000, only 5 items are returned per page (higher page_size values are overridden) - this is due to Glassdoor's behavior." }, { "in": "query", "name": "sort", "schema": { "enum": [ "POPULAR", "MOST_RECENT", "OLDEST", "EASIEST", "MOST_DIFFICULT" ], "type": "string", "default": "POPULAR" }, "description": "Return interviews in a specific sort order." }, { "in": "query", "name": "job_function", "schema": { "enum": [ "ANY", "ADMINISTRATIVE", "ARTS_AND_DESIGN", "BUSINESS", "CONSULTING", "CUSTOMER_SERVICES_AND_SUPPORT", "EDUCATION", "ENGINEERING", "FINANCE_AND_ACCOUNTING", "HEALTHCARE", "HUMAN_RESOURCES", "INFORMATION_TECHNOLOGY", "LEGAL", "MARKETING", "MEDIA_AND_COMMUNICATIONS", "MILITARY_AND_PROTECTIVE_SERVICES", "OPERATIONS", "OTHER", "PRODUCT_AND_PROJECT_MANAGEMENT", "RESEARCH_AND_SCIENCE", "RETAIL_AND_FOOD_SERVICES", "SALES", "SKILLED_LABOR_AND_MANUFACTURING", "TRANSPORTATION" ], "type": "string", "default": "ANY" }, "description": "Return interviews for a specific job function." }, { "in": "query", "name": "job_title", "schema": { "type": "string", "description": "Return interviews with job title matching a search query" } }, { "in": "query", "name": "location", "schema": { "type": "string", "description": "The location for which to get interviews (e.g. San-Francisco)." } }, { "in": "query", "name": "location_type", "schema": { "enum": [ "ANY", "CITY", "STATE", "COUNTRY" ], "type": "string", "default": "ANY" }, "description": "Specify the type of the location you are looking to get salary estimation for additional accuracy." }, { "in": "query", "name": "received_offer_only", "schema": { "type": "boolean", "description": "Only return interviews that resulted in an offer to the candidate" } }, { "in": "query", "name": "domain", "schema": { "enum": [ "www.glassdoor.com", "www.glassdoor.co.uk", "www.glassdoor.com.ar", "www.glassdoor.com.au", "www.glassdoor.be", "www.glassdoor.be", "www.glassdoor.com.br", "www.glassdoor.ca", "www.glassdoor.ca", "www.glassdoor.de", "www.glassdoor.es", "www.glassdoor.fr", "www.glassdoor.com.hk", "www.glassdoor.co.in", "www.glassdoor.ie", "www.glassdoor.it", "www.glassdoor.com.mx", "www.glassdoor.nl", "www.glassdoor.co.nz", "www.glassdoor.at", "de.glassdoor.ch", "www.glassdoor.sg", "fr.glassdoor.ch" ], "type": "string", "default": "www.glassdoor.com" }, "description": "The Glassdoor domain to use." } ], "description": "Get interviews made by the company, including questions, difficulty, outcome, and more data about interviews.", "operationId": "realtime_glassdoor_data__get__company_interviews", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing explicit parameter definitions in source text" ], "pages": [ 1 ], "sourceId": "sds_D1eKbJ9D0SJoHD3LLOLYI", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/company", "/description", "/operationId" ], "revisionId": "sdrn_WiAI6D9DA33xLudF2TJIh" } ], "x-zeroclick-services": [ "realtime-glassdoor-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-glassdoor-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-glassdoor-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-glassdoor-data/company-jobs": { "get": { "summary": "Company Jobs", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "total_count": { "type": "integer", "description": "Total number of job listings found" } } }, "status": { "type": "string", "description": "The status of the API response" }, "parameters": { "type": "object", "properties": { "page": { "type": "integer", "description": "The page number of paginated job results" }, "sort": { "type": "string", "description": "The sorting method applied to the job listings" }, "domain": { "type": "string", "description": "The job board domain being queried" }, "max_age_days": { "type": "integer", "description": "The maximum age in days of the job listings to return" }, "location_type": { "type": "string", "description": "The type of job location filter applied" } } }, "request_id": { "type": "string", "description": "A unique identifier for the API request" } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "company_id", "schema": { "type": "string", "default": 1138, "example": "1138" }, "example": "1138", "required": true, "description": "Glassdoor company ID or name (e.g. 9079 / e.g. Amazon)" }, { "in": "query", "name": "page", "schema": { "type": "integer", "default": 1 }, "description": "The page to return (each page includes up to 10 job listings)." }, { "in": "query", "name": "sort", "schema": { "enum": [ "MOST_RELEVANT", "MOST_RECENT" ], "type": "string", "default": "MOST_RELEVANT" }, "description": "Return reviews in a specific sort order." }, { "in": "query", "name": "job_function", "schema": { "enum": [ "ANY", "ADMINISTRATIVE", "ARTS_AND_DESIGN", "BUSINESS", "CONSULTING", "CUSTOMER_SERVICES_AND_SUPPORT", "EDUCATION", "ENGINEERING", "FINANCE_AND_ACCOUNTING", "HEALTHCARE", "HUMAN_RESOURCES", "INFORMATION_TECHNOLOGY", "LEGAL", "MARKETING", "MEDIA_AND_COMMUNICATIONS", "MILITARY_AND_PROTECTIVE_SERVICES", "OPERATIONS", "OTHER", "PRODUCT_AND_PROJECT_MANAGEMENT", "RESEARCH_AND_SCIENCE", "RETAIL_AND_FOOD_SERVICES", "SALES", "SKILLED_LABOR_AND_MANUFACTURING", "TRANSPORTATION" ], "type": "string", "default": "ANY" }, "description": "Return interviews for a specific job function." }, { "in": "query", "name": "location", "schema": { "type": "string" }, "description": "The location for which to get interviews (e.g. San-Francisco)." }, { "in": "query", "name": "location_type", "schema": { "enum": [ "ANY", "CITY", "STATE", "COUNTRY" ], "type": "string", "default": "ANY" }, "description": "Specify the type of the location you are looking to get salary estimation for additional accuracy." }, { "in": "query", "name": "max_age_days", "schema": { "type": "number", "default": 0, "maximum": 1000, "minimum": 0, "description": "Specify the maximum age of jobs to return in days (e.g. jobs posted in the last max_age_days days). By default, returns jobs posted anytime." } }, { "in": "query", "name": "domain", "schema": { "enum": [ "www.glassdoor.com", "www.glassdoor.co.uk", "www.glassdoor.com.ar", "www.glassdoor.com.au", "www.glassdoor.be", "www.glassdoor.be", "www.glassdoor.com.br", "www.glassdoor.ca", "www.glassdoor.ca", "www.glassdoor.de", "www.glassdoor.es", "www.glassdoor.fr", "www.glassdoor.com.hk", "www.glassdoor.co.in", "www.glassdoor.ie", "www.glassdoor.it", "www.glassdoor.com.mx", "www.glassdoor.nl", "www.glassdoor.co.nz", "www.glassdoor.at", "de.glassdoor.ch", "www.glassdoor.sg", "fr.glassdoor.ch" ], "type": "string", "default": "www.glassdoor.com" }, "description": "The Glassdoor domain to use." } ], "description": "Get jobs posted by a specific company with filtering support and additional options available on Glassdoor.", "operationId": "realtime_glassdoor_data__get__company_jobs", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing explicit parameter definitions in source text" ], "pages": [ 1 ], "sourceId": "sds_D1eKbJ9D0SJoHD3LLOLYI", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/company", "/description", "/operationId" ], "revisionId": "sdrn_WiAI6D9DA33xLudF2TJIh" } ], "x-zeroclick-services": [ "realtime-glassdoor-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-glassdoor-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-glassdoor-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-glassdoor-data/company-overview": { "get": { "summary": "Company Overview", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "ceo": { "type": "string", "description": "Name of the company's CEO" }, "logo": { "type": "string", "description": "URL to the company logo image" }, "name": { "type": "string", "description": "The name of the company" }, "stock": { "type": "string", "description": "Stock symbol of the company, if public" }, "rating": { "type": "number", "description": "Average company rating" }, "revenue": { "type": "string", "description": "Annual revenue description" }, "website": { "type": "string", "description": "Official website of the company" }, "faq_link": { "type": "string", "description": "URL to the company's FAQ section" }, "industry": { "type": "string", "description": "Industry in which the company operates" }, "job_count": { "type": "integer", "description": "Total number of job postings available" }, "jobs_link": { "type": "string", "description": "URL to the company's jobs page" }, "ceo_rating": { "type": "number", "description": "Rating of the CEO" }, "company_id": { "type": "integer", "description": "The numeric ID of the company" }, "company_link": { "type": "string", "description": "URL to the company profile" }, "company_size": { "type": "string", "description": "Description of company size (e.g. 1001-5000 employees)" }, "company_type": { "type": "string", "description": "Type of the company (e.g. Private, Public)" }, "review_count": { "type": "integer", "description": "Number of reviews for the company" }, "reviews_link": { "type": "string", "description": "URL to the company's reviews page" }, "salary_count": { "type": "integer", "description": "Number of salary entries submitted" }, "year_founded": { "type": "integer", "description": "The year the company was founded" }, "company_description": { "type": "string", "description": "Brief description of the company" }, "company_size_category": { "type": "string", "description": "Category of company size" }, "headquarters_location": { "type": "string", "description": "Headquarters location of the company" }, "business_outlook_rating": { "type": "number", "description": "Rating for future business outlook" }, "senior_management_rating": { "type": "number", "description": "Rating for senior management" }, "work_life_balance_rating": { "type": "number", "description": "Rating for work-life balance" }, "culture_and_values_rating": { "type": "number", "description": "Rating for culture and values" }, "recommend_to_friend_rating": { "type": "number", "description": "Likelihood of recommending company to a friend" }, "career_opportunities_rating": { "type": "number", "description": "Rating for career opportunities" }, "diversity_and_inclusion_rating": { "type": "number", "description": "Rating for diversity and inclusion" }, "compensation_and_benefits_rating": { "type": "number", "description": "Rating for compensation and benefits" } } }, "status": { "type": "string", "description": "The status of the API response" }, "parameters": { "type": "object", "properties": { "company_id": { "type": "string", "description": "The unique identifier of the company" } } }, "request_id": { "type": "string", "description": "Unique identifier for the request" } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "company_id", "schema": { "type": "string", "example": "1138" }, "example": "1138", "required": true, "description": "Glassdoor company ID" }, { "in": "query", "name": "domain", "schema": { "enum": [ "www.glassdoor.com", "www.glassdoor.co.uk", "www.glassdoor.com.ar", "www.glassdoor.com.au", "www.glassdoor.be", "www.glassdoor.be", "www.glassdoor.com.br", "www.glassdoor.ca", "www.glassdoor.ca", "www.glassdoor.de", "www.glassdoor.es", "www.glassdoor.fr", "www.glassdoor.com.hk", "www.glassdoor.co.in", "www.glassdoor.ie", "www.glassdoor.it", "www.glassdoor.com.mx", "www.glassdoor.nl", "www.glassdoor.co.nz", "www.glassdoor.at", "de.glassdoor.ch", "www.glassdoor.sg", "fr.glassdoor.ch" ], "type": "string", "default": "www.glassdoor.com" }, "description": "The Glassdoor domain to use." } ], "description": "Get company (employer) overview/details from Glassdoor (e.g. https://www.glassdoor.com/Overview/Working-at-Apple-EI_IE1138.11,16.htm).", "operationId": "realtime_glassdoor_data__get__company_overview", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing explicit parameter definitions in source text" ], "pages": [ 1 ], "sourceId": "sds_D1eKbJ9D0SJoHD3LLOLYI", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/company", "/description", "/operationId" ], "revisionId": "sdrn_WiAI6D9DA33xLudF2TJIh" } ], "x-zeroclick-services": [ "realtime-glassdoor-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-glassdoor-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-glassdoor-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-glassdoor-data/company-reviews": { "get": { "summary": "Company Reviews", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "rating": { "type": "number", "description": "Average rating based on reviews" }, "page_count": { "type": "integer", "description": "Total number of pages available" }, "review_count": { "type": "integer", "description": "Total number of reviews" }, "rated_review_count": { "type": "integer", "description": "Number of reviews that contain ratings" }, "filtered_review_count": { "type": "integer", "description": "Number of reviews after filtering" } } }, "status": { "type": "string", "description": "The status of the API response" }, "parameters": { "type": "object", "properties": { "page": { "type": "integer", "description": "The current page number of the results" }, "sort": { "type": "string", "description": "The sorting criteria applied to the reviews" }, "language": { "type": "string", "description": "The language used for the reviews" }, "company_id": { "type": "string", "description": "The unique identifier of the company" }, "extended_rating_data": { "type": "boolean", "description": "Whether extended rating details are included" }, "only_current_employees": { "type": "boolean", "description": "Whether to include only reviews from current employees" } } }, "request_id": { "type": "string", "description": "A unique identifier for the request" } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "company_id", "schema": { "type": "string", "default": 9079, "example": "9079" }, "example": "9079", "required": true, "description": "Glassdoor company ID." }, { "in": "query", "name": "page", "schema": { "type": "integer", "default": 1 }, "description": "The reviews page to return (each page includes up to 10 results)." }, { "in": "query", "name": "sort", "schema": { "enum": [ "POPULAR", "MOST_RECENT", "HIGHEST_RATING", "LOWEST_RATING" ], "type": "string", "default": "POPULAR" }, "description": "Return reviews in a specific sort order." }, { "in": "query", "name": "query", "schema": { "type": "string", "description": "Return reviews matching a search query" } }, { "in": "query", "name": "language", "schema": { "enum": [ "en", "fr", "nl", "de", "pt", "es", "it" ], "type": "string", "default": "en" }, "description": "Return reviews written in a specific language." }, { "in": "query", "name": "employment_statuses", "schema": { "enum": [ "REGULAR", "INTERN", "PART_TIME", "CONTRACT", "FREELANCE" ], "type": "string" }, "description": "Return reviews written by employees with a specific job type." }, { "in": "query", "name": "only_current_employees", "schema": { "type": "string", "default": false, "description": "Only return reviews written by current employees (at the time of writing)." } }, { "in": "query", "name": "extended_rating_data", "schema": { "type": "boolean", "default": false, "description": "Include extended company rating data such as rating breakdown and rating distributions." } }, { "in": "query", "name": "domain", "schema": { "enum": [ "www.glassdoor.com", "www.glassdoor.co.uk", "www.glassdoor.com.ar", "www.glassdoor.com.au", "www.glassdoor.be", "www.glassdoor.be", "www.glassdoor.com.br", "www.glassdoor.ca", "www.glassdoor.ca", "www.glassdoor.de", "www.glassdoor.es", "www.glassdoor.fr", "www.glassdoor.com.hk", "www.glassdoor.co.in", "www.glassdoor.ie", "www.glassdoor.it", "www.glassdoor.com.mx", "www.glassdoor.nl", "www.glassdoor.co.nz", "www.glassdoor.at", "de.glassdoor.ch", "www.glassdoor.sg", "fr.glassdoor.ch" ], "type": "string", "default": "www.glassdoor.com" }, "description": "The Glassdoor domain to use." } ], "description": "Get company (employer) reviews from Glassdoor, with filters, sort option, and pagination support.", "operationId": "realtime_glassdoor_data__get__company_reviews", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing query parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds_2EOeqrIsWKjYBjoNIGwV0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_ds2DI_Xad11MCFdnoGvH0" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_MV8gWtP36-RZn0HelHkbq", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_zsd2yxhBG769IpVFIUWRc" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_qhTee9rhe4IsP9VM8R0Jx", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_n1Qua5iIILpqbVggnqZhR" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_QN3ukfHdtXTOIp_KXoTb_", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description" ], "revisionId": "sdrn_fqMlN4jSZ8jNeUn6Wv8Vq" }, { "gaps": [ "Missing full schema definition for response body" ], "pages": [ 1 ], "sourceId": "sds_t1I2lol_F5DgGpe13n3Xt", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_OBuPoRSMenxSJ1CM3zwbN" }, { "gaps": [ "Missing query parameters for company identification" ], "pages": [ 1 ], "sourceId": "sds_ZS-xdAQ0s8auc1LcI7Ooo", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_7knEBvR-UUuEvVL1C_QLq" } ], "x-zeroclick-services": [ "realtime-glassdoor-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-glassdoor-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-glassdoor-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-glassdoor-data/company-salaries": { "get": { "summary": "Company Salaries", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "location": { "type": "string", "description": "Location for the salary data" }, "job_title": { "type": "string", "description": "Job title for which salary data is provided" }, "company_id": { "type": "integer", "description": "Unique identifier for the company" }, "confidence": { "type": "string", "description": "Confidence level in the salary data" }, "max_salary": { "type": "number", "description": "Maximum total salary for the position" }, "min_salary": { "type": "number", "description": "Minimum total salary for the position" }, "company_name": { "type": "string", "description": "Name of the company" }, "salary_count": { "type": "integer", "description": "Number of salary data points used" }, "median_salary": { "type": "number", "description": "Median total salary for the position" }, "salary_period": { "type": "string", "description": "Time period for the salary figures" }, "max_base_salary": { "type": "number", "description": "Maximum base salary for the position" }, "min_base_salary": { "type": "number", "description": "Minimum base salary for the position" }, "salary_currency": { "type": "string", "description": "Currency in which salary is reported" }, "max_additional_pay": { "type": "number", "description": "Maximum additional compensation for the position" }, "median_base_salary": { "type": "number", "description": "Median base salary for the position" }, "min_additional_pay": { "type": "number", "description": "Minimum additional compensation for the position" }, "median_additional_pay": { "type": "number", "description": "Median additional compensation for the position" } } }, "status": { "type": "string", "description": "Status of the API request" }, "parameters": { "type": "object", "properties": { "job_title": { "type": "string", "description": "Job title for the salary query" }, "company_id": { "type": "integer", "description": "Unique identifier for the company" }, "location_type": { "type": "string", "description": "Type of location for the salary data" } } }, "request_id": { "type": "string", "description": "Unique identifier for the request" } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "company_id", "schema": { "type": "string", "example": "1138" }, "example": "1138", "required": true, "description": "Company ID" }, { "in": "query", "name": "job_title", "schema": { "type": "string", "example": "software developer" }, "example": "software developer", "required": true, "description": "The job title for which to get salary estimation." }, { "in": "query", "name": "location", "schema": { "type": "string" }, "description": "The location for which to get salary estimation (e.g. San-Francisco)." }, { "in": "query", "name": "location_type", "schema": { "enum": [ "ANY", "CITY", "STATE", "COUNTRY" ], "type": "string", "default": "ANY" }, "description": "Specify the type of the location you are looking to get salary estimation for additional accuracy." }, { "in": "query", "name": "years_of_experience", "schema": { "enum": [ "ALL", "LESS_THAN_ONE", "ONE_TO_THREE", "FOUR_TO_SIX", "SEVEN_TO_NINE", "TEN_TO_FOURTEEN", "ABOVE_FIFTEEN" ], "type": "string", "default": "ALL" }, "description": "Get job estimation for a specific experience level range (years)." }, { "in": "query", "name": "domain", "schema": { "enum": [ "www.glassdoor.com", "www.glassdoor.co.uk", "www.glassdoor.com.ar", "www.glassdoor.com.au", "www.glassdoor.be", "www.glassdoor.be", "www.glassdoor.com.br", "www.glassdoor.ca", "www.glassdoor.ca", "www.glassdoor.de", "www.glassdoor.es", "www.glassdoor.fr", "www.glassdoor.com.hk", "www.glassdoor.co.in", "www.glassdoor.ie", "www.glassdoor.it", "www.glassdoor.com.mx", "www.glassdoor.nl", "www.glassdoor.co.nz", "www.glassdoor.at", "de.glassdoor.ch", "www.glassdoor.sg", "fr.glassdoor.ch" ], "type": "string", "default": "www.glassdoor.com" }, "description": "The Glassdoor domain to use." } ], "description": "Get salary estimation in a specific company by job title and location (optional).", "operationId": "realtime_glassdoor_data__get__company_salaries", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing query parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds_2EOeqrIsWKjYBjoNIGwV0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_ds2DI_Xad11MCFdnoGvH0" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_MV8gWtP36-RZn0HelHkbq", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_zsd2yxhBG769IpVFIUWRc" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_qhTee9rhe4IsP9VM8R0Jx", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_n1Qua5iIILpqbVggnqZhR" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_QN3ukfHdtXTOIp_KXoTb_", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description" ], "revisionId": "sdrn_fqMlN4jSZ8jNeUn6Wv8Vq" }, { "gaps": [ "Missing full schema definition for response body" ], "pages": [ 1 ], "sourceId": "sds_t1I2lol_F5DgGpe13n3Xt", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_OBuPoRSMenxSJ1CM3zwbN" }, { "gaps": [ "Missing query parameters for company identification" ], "pages": [ 1 ], "sourceId": "sds_ZS-xdAQ0s8auc1LcI7Ooo", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_7knEBvR-UUuEvVL1C_QLq" } ], "x-zeroclick-services": [ "realtime-glassdoor-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-glassdoor-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-glassdoor-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-glassdoor-data/company-salaries-v2": { "get": { "summary": "Company Salaries v2", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "location": { "type": "string", "description": "Human-readable location label for the salary data." }, "salaries": { "type": "array", "items": { "type": "object", "properties": { "job_title": { "type": "string", "description": "Job title for which the salary statistics apply." }, "max_salary": { "type": "number", "description": "Maximum total salary reported for this job title." }, "min_salary": { "type": "number", "description": "Minimum total salary reported for this job title." }, "job_title_id": { "type": "integer", "description": "Glassdoor internal identifier for the job title." }, "salary_count": { "type": "integer", "minimum": 0, "description": "Number of salary reports for this job title." }, "median_salary": { "type": "number", "description": "Median total salary reported for this job title." }, "salary_period": { "enum": [ "YEAR", "MONTH", "HOUR", "WEEK" ], "type": "string", "description": "Time period over which the salary values are calculated." }, "max_cash_bonus": { "type": "number", "description": "Maximum cash bonus reported." }, "min_cash_bonus": { "type": "number", "description": "Minimum cash bonus reported." }, "max_base_salary": { "type": "number", "description": "Maximum base salary component reported." }, "max_stock_bonus": { "type": "number", "description": "Maximum stock-based bonus reported." }, "min_base_salary": { "type": "number", "description": "Minimum base salary component reported." }, "min_stock_bonus": { "type": "number", "description": "Minimum stock-based bonus reported." }, "salary_currency": { "type": "string", "maxLength": 3, "minLength": 3, "description": "ISO 4217 currency code used for the salary figures." }, "median_cash_bonus": { "type": "number", "description": "Median cash bonus reported." }, "max_additional_pay": { "type": "number", "description": "Maximum additional pay (bonus, stock, etc.) reported." }, "median_base_salary": { "type": "number", "description": "Median base salary component reported." }, "median_stock_bonus": { "type": "number", "description": "Median stock-based bonus reported." }, "min_additional_pay": { "type": "number", "description": "Minimum additional pay (bonus, stock, etc.) reported." }, "median_additional_pay": { "type": "number", "description": "Median additional pay (bonus, stock, etc.) reported." } } } }, "num_pages": { "type": "integer", "minimum": 0, "description": "Total number of pages available for the given filters." }, "company_id": { "type": "integer", "description": "Glassdoor internal company identifier." }, "most_recent": { "type": "string", "format": "date-time", "description": "Timestamp of the most recent salary data point." }, "job_title_count": { "type": "integer", "minimum": 0, "description": "Total number of distinct job titles with salary data." } } }, "status": { "type": "string", "description": "Overall status of the API request." }, "parameters": { "type": "object", "required": [ "domain", "location", "location_type", "page", "sort" ], "properties": { "page": { "type": "integer", "minimum": 1, "description": "Page number of the salary results being returned." }, "sort": { "type": "string", "description": "Sorting method used for the salary results." }, "domain": { "type": "string", "description": "Glassdoor domain used as the data source." }, "location": { "type": "string", "description": "Location string used to filter salary data." }, "location_type": { "type": "string", "description": "Type of location filter applied (e.g., ANY, CITY, REGION)." } } }, "request_id": { "type": "string", "format": "uuid", "description": "Unique identifier assigned to this API request." } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "company_id", "schema": { "type": "string", "example": "1138" }, "example": "1138", "required": true, "description": "Glassdoor company ID or name (e.g. 9079 / e.g. Amazon)" }, { "in": "query", "name": "location", "schema": { "type": "string" }, "description": "The location for which to get salary estimation (e.g. San Francisco)." }, { "in": "query", "name": "location_type", "schema": { "enum": [ "ANY", "CITY", "STATE", "COUNTRY" ], "type": "string", "default": "ANY" }, "description": "Specify the type of the location you are looking to get salary estimation for additional accuracy." }, { "in": "query", "name": "job_title", "schema": { "type": "string" }, "description": "The job title for which to get salary estimation" }, { "in": "query", "name": "page", "schema": { "type": "number", "default": 1 }, "description": "The salaries page to return (each page includes up to 10 results)." }, { "in": "query", "name": "sort", "schema": { "enum": [ "MOST_SALARIES", "HIGH_TO_LOW", "MOST_RECENT" ], "type": "string", "default": "MOST_SALARIES" }, "description": "Return salaries in a specific sort order." }, { "in": "query", "name": "domain", "schema": { "enum": [ "www.glassdoor.com", "www.glassdoor.co.uk", "www.glassdoor.com.ar", "www.glassdoor.com.au", "www.glassdoor.be", "www.glassdoor.be", "www.glassdoor.com.br", "www.glassdoor.ca", "www.glassdoor.ca", "www.glassdoor.de", "www.glassdoor.es", "www.glassdoor.fr", "www.glassdoor.com.hk", "www.glassdoor.co.in", "www.glassdoor.ie", "www.glassdoor.it", "www.glassdoor.com.mx", "www.glassdoor.nl", "www.glassdoor.co.nz", "www.glassdoor.at", "de.glassdoor.ch", "www.glassdoor.sg", "fr.glassdoor.ch" ], "type": "string", "default": "www.glassdoor.com" }, "description": "The Glassdoor domain to use." } ], "description": "Get and Search Company Data, Jobs, Employer Reviews, Salaries, Interviews, and More from Glassdoor in Real-Time (unofficial API).", "operationId": "realtime_glassdoor_data__get__company_salaries_v2", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing query parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds_2EOeqrIsWKjYBjoNIGwV0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_ds2DI_Xad11MCFdnoGvH0" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_MV8gWtP36-RZn0HelHkbq", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_zsd2yxhBG769IpVFIUWRc" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_qhTee9rhe4IsP9VM8R0Jx", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_n1Qua5iIILpqbVggnqZhR" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_QN3ukfHdtXTOIp_KXoTb_", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description" ], "revisionId": "sdrn_fqMlN4jSZ8jNeUn6Wv8Vq" }, { "gaps": [ "Missing query parameters for company identification" ], "pages": [ 1 ], "sourceId": "sds_ZS-xdAQ0s8auc1LcI7Ooo", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_7knEBvR-UUuEvVL1C_QLq" } ], "x-zeroclick-services": [ "realtime-glassdoor-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-glassdoor-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-glassdoor-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-glassdoor-data/company-search": { "get": { "summary": "Company Search", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "required": [ "company_id", "name", "company_link" ], "properties": { "ceo": { "type": "string", "nullable": true, "description": "Name of the company's CEO." }, "logo": { "type": "string", "nullable": true, "description": "URL to the company logo image." }, "name": { "type": "string", "description": "Company name." }, "stock": { "type": "string", "nullable": true, "description": "Stock ticker, when the company is publicly traded." }, "rating": { "type": "number", "nullable": true, "description": "Average Glassdoor rating of the company (0-5)." }, "revenue": { "type": "string", "nullable": true, "description": "Annual revenue bracket." }, "website": { "type": "string", "nullable": true, "description": "Company website." }, "faq_link": { "type": "string", "nullable": true, "description": "URL of the company's Glassdoor FAQ page." }, "industry": { "type": "string", "nullable": true, "description": "Industry the company operates in." }, "job_count": { "type": "integer", "nullable": true, "description": "Number of open job postings for the company on Glassdoor." }, "jobs_link": { "type": "string", "nullable": true, "description": "URL of the company's Glassdoor jobs page." }, "ceo_rating": { "type": "number", "nullable": true, "description": "Approval rating of the CEO (0-1 share approving)." }, "company_id": { "type": "integer", "description": "Glassdoor numeric employer ID." }, "competitors": { "type": "array", "items": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "integer", "description": "Glassdoor numeric ID of the competitor." }, "name": { "type": "string", "description": "Competitor company name." } } }, "nullable": true, "description": "Competitor companies as listed on Glassdoor." }, "company_link": { "type": "string", "description": "Canonical URL of the company overview page on Glassdoor." }, "company_size": { "type": "string", "nullable": true, "description": "Glassdoor company size bucket label." }, "company_type": { "type": "string", "nullable": true, "description": "Glassdoor company ownership type label (e.g. Company - Private, Company - Public, Government, Unknown)." }, "review_count": { "type": "integer", "nullable": true, "description": "Total number of Glassdoor reviews for the company." }, "reviews_link": { "type": "string", "nullable": true, "description": "URL of the company's Glassdoor reviews page." }, "salary_count": { "type": "integer", "nullable": true, "description": "Number of salary entries submitted for the company." }, "year_founded": { "type": "integer", "nullable": true, "description": "Year the company was founded." }, "office_locations": { "type": "array", "items": { "type": "object", "properties": { "city": { "type": "string", "nullable": true, "description": "City of the office location." }, "country": { "type": "string", "nullable": true, "description": "Country of the office location." } } }, "nullable": true, "description": "Office locations of the company." }, "company_description": { "type": "string", "nullable": true, "description": "Brief description of the company." }, "company_size_category": { "type": "string", "nullable": true, "description": "Company size category. Values: SMALL, MEDIUM, LARGE, UNKNOWN." }, "headquarters_location": { "type": "string", "nullable": true, "description": "Company headquarters location." }, "business_outlook_rating": { "type": "number", "nullable": true, "description": "Rating for business outlook (0-1 share recommending positive outlook, or 0-5 score depending on field)." }, "senior_management_rating": { "type": "number", "nullable": true, "description": "Rating for senior management (0-5)." }, "work_life_balance_rating": { "type": "number", "nullable": true, "description": "Rating for work-life balance (0-5)." }, "culture_and_values_rating": { "type": "number", "nullable": true, "description": "Rating for culture and values (0-5)." }, "best_places_to_work_awards": { "type": "array", "items": { "type": "object", "required": [ "time_period", "rank" ], "properties": { "rank": { "type": "integer", "description": "Rank achieved in the Best Places to Work list." }, "time_period": { "type": "string", "description": "Time period the award covers (typically a year)." } } }, "nullable": true, "description": "Best Places to Work awards received by the company." }, "recommend_to_friend_rating": { "type": "number", "nullable": true, "description": "Share of reviewers recommending the company to a friend (0-1)." }, "career_opportunities_rating": { "type": "number", "nullable": true, "description": "Rating for career opportunities (0-5)." }, "diversity_and_inclusion_rating": { "type": "number", "nullable": true, "description": "Rating for diversity and inclusion (0-5)." }, "compensation_and_benefits_rating": { "type": "number", "nullable": true, "description": "Rating for compensation and benefits (0-5)." } } }, "description": "Matching company (employer) records on Glassdoor." }, "status": { "type": "string", "description": "The status of the API response" }, "parameters": { "type": "object", "properties": { "limit": { "type": "integer", "description": "The maximum number of results to return" }, "query": { "type": "string", "description": "The search query string" } } }, "request_id": { "type": "string", "description": "A unique identifier for the request" } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "query", "schema": { "type": "string", "example": "goo" }, "example": "goo", "required": true, "description": "Search query or Company ID" }, { "in": "query", "name": "limit", "schema": { "type": "number", "default": 10, "maximum": 100, "minimum": 1 }, "description": "Maximum number of results to return." }, { "in": "query", "name": "domain", "schema": { "enum": [ "www.glassdoor.com", "www.glassdoor.co.uk", "www.glassdoor.com.ar", "www.glassdoor.com.au", "www.glassdoor.be", "www.glassdoor.be", "www.glassdoor.com.br", "www.glassdoor.ca", "www.glassdoor.ca", "www.glassdoor.de", "www.glassdoor.es", "www.glassdoor.fr", "www.glassdoor.com.hk", "www.glassdoor.co.in", "www.glassdoor.ie", "www.glassdoor.it", "www.glassdoor.com.mx", "www.glassdoor.nl", "www.glassdoor.co.nz", "www.glassdoor.at", "de.glassdoor.ch", "www.glassdoor.sg", "fr.glassdoor.ch" ], "type": "string", "default": "www.glassdoor.com" }, "description": "The Glassdoor domain to use." } ], "description": "Search for companies (employers) on Glassdoor.", "operationId": "realtime_glassdoor_data__get__company_search", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing query parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds_2EOeqrIsWKjYBjoNIGwV0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_ds2DI_Xad11MCFdnoGvH0" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_MV8gWtP36-RZn0HelHkbq", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_zsd2yxhBG769IpVFIUWRc" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_qhTee9rhe4IsP9VM8R0Jx", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_n1Qua5iIILpqbVggnqZhR" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_QN3ukfHdtXTOIp_KXoTb_", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description" ], "revisionId": "sdrn_fqMlN4jSZ8jNeUn6Wv8Vq" }, { "gaps": [ "Missing full schema definition for response body" ], "pages": [ 1 ], "sourceId": "sds_t1I2lol_F5DgGpe13n3Xt", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_OBuPoRSMenxSJ1CM3zwbN" }, { "gaps": [ "Missing query parameters for search" ], "pages": [ 1 ], "sourceId": "sds_ZS-xdAQ0s8auc1LcI7Ooo", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_7knEBvR-UUuEvVL1C_QLq" } ], "x-zeroclick-services": [ "realtime-glassdoor-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-glassdoor-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-glassdoor-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-glassdoor-data/job-search": { "get": { "summary": "Job Search", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "type": "object" }, "description": "Array of matching job postings." }, "cursor": { "type": "string", "description": "Opaque cursor token for fetching the next page." }, "total_count": { "type": "integer", "description": "Total number of matching jobs." } } }, "status": { "type": "string", "description": "Overall request status." }, "parameters": { "type": "object", "properties": { "page": { "type": "integer", "description": "Results page index starting at 1." }, "limit": { "type": "integer", "description": "Maximum number of jobs returned per page." }, "query": { "type": "string", "description": "Free-text job search query." }, "domain": { "type": "string", "description": "Source domain or job board targeted." }, "location": { "type": "string", "description": "Location used to filter jobs." }, "date_posted": { "type": "string", "description": "Time frame the results were restricted to." }, "remote_only": { "type": "boolean", "description": "Whether to include only remote roles." }, "location_type": { "type": "string", "description": "Type of location filter (e.g., city, region, country)." }, "easy_apply_only": { "type": "boolean", "description": "Whether to include only easy-apply jobs." }, "min_company_rating": { "type": "string", "description": "Minimum employer rating threshold." } } }, "request_id": { "type": "string", "description": "Unique identifier for this request." } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "query", "schema": { "type": "string", "example": "front end developer" }, "example": "front end developer", "required": true }, { "in": "query", "name": "location", "schema": { "type": "string", "example": "new york" }, "example": "new york", "required": true }, { "in": "query", "name": "location_type", "schema": { "enum": [ "ANY", "CITY", "STATE", "COUNTRY" ], "type": "string", "default": "ANY" }, "description": "Specify the type of the location you are looking to get salary estimation for additional accuracy." }, { "in": "query", "name": "limit", "schema": { "type": "number", "default": 10, "maximum": 100, "minimum": 1 }, "description": "The maximum number of results to return in a single response. If not specified, a default value is used. Use with cursor to paginate through larger result sets." }, { "in": "query", "name": "cursor", "schema": { "type": "string", "description": "A pagination token returned in the API response. Pass this value into the next request to retrieve the following page of job results. If omitted, the first page is returned." } }, { "in": "query", "name": "easy_apply_only", "schema": { "type": "boolean" }, "description": "Only return jobs with easy apply." }, { "in": "query", "name": "remote_only", "schema": { "type": "string", "description": "Only return remote jobs." } }, { "in": "query", "name": "date_posted", "schema": { "enum": [ "all", "today", "3days", "week", "2weeks", "month" ], "type": "string", "default": "all" }, "description": "Only return jobs posted within the specified time frame, as available in the Date Posted filter on Glassdoor." }, { "in": "query", "name": "min_company_rating", "schema": { "type": "string", "description": "Minimum job employer company rating." } }, { "in": "query", "name": "domain", "schema": { "enum": [ "www.glassdoor.com", "www.glassdoor.co.uk", "www.glassdoor.com.ar", "www.glassdoor.com.au", "www.glassdoor.be", "www.glassdoor.be", "www.glassdoor.com.br", "www.glassdoor.ca", "www.glassdoor.ca", "www.glassdoor.de", "www.glassdoor.es", "www.glassdoor.fr", "www.glassdoor.com.hk", "www.glassdoor.co.in", "www.glassdoor.ie", "www.glassdoor.it", "www.glassdoor.com.mx", "www.glassdoor.nl", "www.glassdoor.co.nz", "www.glassdoor.at", "de.glassdoor.ch", "www.glassdoor.sg", "fr.glassdoor.ch" ], "type": "string", "default": "www.glassdoor.com" }, "description": "The Glassdoor domain to use." } ], "description": "Search for jobs with various filters and options as available on https://www.glassdoor.com/Job/index.htm.", "operationId": "realtime_glassdoor_data__get__job_search", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing query parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds_2EOeqrIsWKjYBjoNIGwV0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_ds2DI_Xad11MCFdnoGvH0" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_MV8gWtP36-RZn0HelHkbq", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_zsd2yxhBG769IpVFIUWRc" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_qhTee9rhe4IsP9VM8R0Jx", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_n1Qua5iIILpqbVggnqZhR" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_QN3ukfHdtXTOIp_KXoTb_", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description" ], "revisionId": "sdrn_fqMlN4jSZ8jNeUn6Wv8Vq" }, { "gaps": [ "Missing full schema definition for response body" ], "pages": [ 1 ], "sourceId": "sds_t1I2lol_F5DgGpe13n3Xt", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_OBuPoRSMenxSJ1CM3zwbN" }, { "gaps": [ "Missing query parameters for search" ], "pages": [ 1 ], "sourceId": "sds_ZS-xdAQ0s8auc1LcI7Ooo", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_7knEBvR-UUuEvVL1C_QLq" } ], "x-zeroclick-services": [ "realtime-glassdoor-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-glassdoor-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-glassdoor-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-glassdoor-data/salary-estimation": { "get": { "summary": "Salary Estimate", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "link": { "type": "string", "description": "URL to view more detailed salary information" }, "location": { "type": "string", "description": "Full location name for the salary data" }, "job_title": { "type": "string", "description": "Job title for the salary data" }, "confidence": { "type": "string", "description": "Confidence level in the salary data accuracy" }, "max_salary": { "type": "number", "description": "Maximum total compensation amount" }, "min_salary": { "type": "number", "description": "Minimum total compensation amount" }, "salary_count": { "type": "integer", "description": "Number of salary data points included" }, "median_salary": { "type": "number", "description": "Median total compensation amount" }, "salary_period": { "type": "string", "description": "Time period for the salary amounts" }, "max_base_salary": { "type": "number", "description": "Maximum base salary amount" }, "min_base_salary": { "type": "number", "description": "Minimum base salary amount" }, "salary_currency": { "type": "string", "description": "Currency code for the salary amounts" }, "max_additional_pay": { "type": "number", "description": "Maximum additional pay amount" }, "median_base_salary": { "type": "number", "description": "Median base salary amount" }, "min_additional_pay": { "type": "number", "description": "Minimum additional pay amount" }, "salaries_updated_at": { "type": "string", "description": "Timestamp when salary data was last updated" }, "median_additional_pay": { "type": "number", "description": "Median additional pay amount" } } }, "status": { "type": "string", "description": "Status of the API response" }, "parameters": { "type": "object", "properties": { "domain": { "type": "string", "description": "Domain from which data was sourced" }, "location": { "type": "string", "description": "Location used in the search query" }, "job_title": { "type": "string", "description": "Job title used in the search query" }, "location_type": { "type": "string", "description": "Type of location search parameter" }, "years_of_experience": { "type": "string", "description": "Years of experience filter used in query" } } }, "request_id": { "type": "string", "description": "Unique identifier for the request" } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "job_title", "schema": { "type": "string", "example": "software developer" }, "example": "software developer", "required": true, "description": "The job title for which to get salary estimation (e.g. marketing assistant)." }, { "in": "query", "name": "location", "schema": { "type": "string", "example": "new york" }, "example": "new york", "required": true, "description": "The location for which to get salary estimation (e.g. san-francisco, us)." }, { "in": "query", "name": "location_type", "schema": { "enum": [ "ANY", "CITY", "STATE", "COUNTRY" ], "type": "string", "default": "ANY" }, "description": "Specify the type of the location you are looking to get salary estimation for additional accuracy." }, { "in": "query", "name": "years_of_experience", "schema": { "enum": [ "ALL", "LESS_THAN_ONE", "ONE_TO_THREE", "FOUR_TO_SIX", "SEVEN_TO_NINE", "TEN_TO_FOURTEEN", "ABOVE_FIFTEEN" ], "type": "string", "default": "ALL" }, "description": "Get job estimation for a specific experience level range (years)." }, { "in": "query", "name": "domain", "schema": { "enum": [ "www.glassdoor.com", "www.glassdoor.co.uk", "www.glassdoor.com.ar", "www.glassdoor.com.au", "www.glassdoor.be", "www.glassdoor.be", "www.glassdoor.com.br", "www.glassdoor.ca", "www.glassdoor.ca", "www.glassdoor.de", "www.glassdoor.es", "www.glassdoor.fr", "www.glassdoor.com.hk", "www.glassdoor.co.in", "www.glassdoor.ie", "www.glassdoor.it", "www.glassdoor.com.mx", "www.glassdoor.nl", "www.glassdoor.co.nz", "www.glassdoor.at", "de.glassdoor.ch", "www.glassdoor.sg", "fr.glassdoor.ch" ], "type": "string", "default": "www.glassdoor.com" }, "description": "The Glassdoor domain to use." } ], "description": "Get salary estimates by job title and location.", "operationId": "realtime_glassdoor_data__get__salary_estimation", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing query parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds_2EOeqrIsWKjYBjoNIGwV0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_ds2DI_Xad11MCFdnoGvH0" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_MV8gWtP36-RZn0HelHkbq", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_zsd2yxhBG769IpVFIUWRc" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_qhTee9rhe4IsP9VM8R0Jx", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_n1Qua5iIILpqbVggnqZhR" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_QN3ukfHdtXTOIp_KXoTb_", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description" ], "revisionId": "sdrn_fqMlN4jSZ8jNeUn6Wv8Vq" }, { "gaps": [ "Missing query parameters for estimation" ], "pages": [ 1 ], "sourceId": "sds_ZS-xdAQ0s8auc1LcI7Ooo", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_7knEBvR-UUuEvVL1C_QLq" } ], "x-zeroclick-services": [ "realtime-glassdoor-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-glassdoor-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-glassdoor-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-homedepot-data/item-lookup": { "get": { "summary": "Item Lookup", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_44607288241e2156_ref0" } } }, "description": "Successful response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "search", "schema": { "type": "string" }, "example": "DCD800B", "required": true, "description": "The manufacturer model number or Home Depot internet (item) number to look up.\n\n**Examples:**\n- DCD800B\n- 300569432\n- 0033287225422" }, { "in": "query", "name": "page", "schema": { "type": "integer", "default": 1, "maximum": 30, "minimum": 1 }, "description": "Page to return.\n\n**Allowed values:** `1-30`" }, { "in": "query", "name": "items_per_page", "schema": { "type": "integer", "default": 24, "maximum": 48, "minimum": 1 }, "description": "Number of products to return per page.\n\n**Allowed values:** `1-48`" }, { "in": "query", "name": "store_id", "schema": { "type": "string" }, "description": "Home Depot store number used to localize pricing, inventory, and pickup availability.\n\n**Example:** `121`" }, { "in": "query", "name": "zipcode", "schema": { "type": "string" }, "description": "5-digit US zip code used to localize delivery options and pricing.\n\n**Example:** `30301`" } ], "description": "Look up Home Depot products by manufacturer model number or Home Depot internet (item) number. Useful for resolving a known model/SKU to a product. Returns the same product structure as Search.", "operationId": "realtime_homedepot_data__Item_Lookup", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing query parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds_2EOeqrIsWKjYBjoNIGwV0", "authority": "supplemental", "conflicts": [ "/summary", "/description", "/operationId" ], "revisionId": "sdrn_ds2DI_Xad11MCFdnoGvH0" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_MV8gWtP36-RZn0HelHkbq", "authority": "supplemental", "conflicts": [ "/summary", "/description", "/operationId" ], "revisionId": "sdrn_zsd2yxhBG769IpVFIUWRc" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_qhTee9rhe4IsP9VM8R0Jx", "authority": "supplemental", "conflicts": [ "/summary", "/description", "/operationId" ], "revisionId": "sdrn_n1Qua5iIILpqbVggnqZhR" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_QN3ukfHdtXTOIp_KXoTb_", "authority": "supplemental", "conflicts": [ "/summary", "/description" ], "revisionId": "sdrn_fqMlN4jSZ8jNeUn6Wv8Vq" }, { "gaps": [ "Missing query parameters for item identification" ], "pages": [ 1 ], "sourceId": "sds_ZS-xdAQ0s8auc1LcI7Ooo", "authority": "supplemental", "conflicts": [ "/summary", "/description", "/operationId" ], "revisionId": "sdrn_7knEBvR-UUuEvVL1C_QLq" } ], "x-zeroclick-services": [ "realtime-homedepot-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-homedepot-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-homedepot-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-homedepot-data/product-details": { "get": { "summary": "Product Details", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_4cc5291d5f1e29dd_ref0" } } }, "description": "Successful response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "item_id", "schema": { "type": "string" }, "example": "343492587", "required": true, "description": "The Home Depot internet number (item id) of the product. Either `item_id` or `url` is required. The item id appears at the end of product page URLs and in Search / Item Lookup results.\n\n**Examples:**\n- 326680222\n- 204279858" }, { "in": "query", "name": "url", "schema": { "type": "string" }, "description": "Full Home Depot product page URL. Used as an alternative to `item_id`; the item id is extracted from the URL. Either `item_id` or `url` is required.\n\n**Example:** `https://www.homedepot.com/p/RYOBI-ONE-18V-Cordless-Drill-Driver-Kit-PCL201K1/326680222`" }, { "in": "query", "name": "store_id", "schema": { "type": "string" }, "description": "Home Depot store number used to localize pricing, inventory, and pickup availability.\n\n**Example:** `121`" }, { "in": "query", "name": "zipcode", "schema": { "type": "string" }, "description": "5-digit US zip code used to localize delivery options and pricing.\n\n**Example:** `30301`" } ], "description": "Get full details for a single Home Depot product by its internet (item) number or product URL, including description, highlights, images, videos, pricing, rating, specifications, dimensions, key features, fulfillment, and more.", "operationId": "realtime_homedepot_data__Product_Details", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing query parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds_2EOeqrIsWKjYBjoNIGwV0", "authority": "supplemental", "conflicts": [ "/summary", "/description", "/operationId" ], "revisionId": "sdrn_ds2DI_Xad11MCFdnoGvH0" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_MV8gWtP36-RZn0HelHkbq", "authority": "supplemental", "conflicts": [ "/summary", "/description", "/operationId" ], "revisionId": "sdrn_zsd2yxhBG769IpVFIUWRc" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_qhTee9rhe4IsP9VM8R0Jx", "authority": "supplemental", "conflicts": [ "/summary", "/description", "/operationId" ], "revisionId": "sdrn_n1Qua5iIILpqbVggnqZhR" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_QN3ukfHdtXTOIp_KXoTb_", "authority": "supplemental", "conflicts": [ "/summary", "/description" ], "revisionId": "sdrn_fqMlN4jSZ8jNeUn6Wv8Vq" }, { "gaps": [ "Missing query parameters for product identification" ], "pages": [ 1 ], "sourceId": "sds_ZS-xdAQ0s8auc1LcI7Ooo", "authority": "supplemental", "conflicts": [ "/summary", "/description", "/operationId" ], "revisionId": "sdrn_7knEBvR-UUuEvVL1C_QLq" } ], "x-zeroclick-services": [ "realtime-homedepot-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-homedepot-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-homedepot-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-homedepot-data/product-reviews": { "get": { "summary": "Product Reviews", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_c31636a96b1a678b_ref0" } } }, "description": "Successful response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "item_id", "schema": { "type": "string" }, "example": "300569432", "required": true, "description": "The Home Depot internet number (item id) of the product to return reviews for.\n\n**Examples:**\n- 300569432\n- 326680222" }, { "in": "query", "name": "page", "schema": { "type": "integer", "default": 1, "maximum": 51, "minimum": 1 }, "description": "Page to return.\n\n**Allowed values:** `1-51`" }, { "in": "query", "name": "items_per_page", "schema": { "type": "integer", "default": 20, "maximum": 100, "minimum": 1 }, "description": "Number of reviews to return per page.\n\n**Allowed values:** `1-100`" }, { "in": "query", "name": "sort_by", "schema": { "enum": [ "helpful", "newest", "oldest", "photos_first", "highest_rating", "lowest_rating", "relevance" ], "type": "string", "default": "helpful" }, "description": "Return the reviews in a specific sort order." }, { "in": "query", "name": "rating", "schema": { "type": "integer", "maximum": 5, "minimum": 1 }, "description": "Only return reviews with a specific star rating.\n\n**Allowed values:** `1-5`" }, { "in": "query", "name": "verified_only", "schema": { "type": "boolean", "default": false }, "description": "Only return reviews written by verified purchasers." }, { "in": "query", "name": "search_text", "schema": { "type": "string" }, "description": "Only return reviews whose text contains the given keyword(s).\n\n**Example:** `easy to use`" } ], "description": "Get paginated customer reviews for a Home Depot product by its internet (item) number. Returns review text, rating, author, verified-purchaser status, photos, merchant responses, and product-level rating statistics with a full 1-5 star histogram.", "operationId": "realtime_homedepot_data__Product_Reviews", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing query parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds_2EOeqrIsWKjYBjoNIGwV0", "authority": "supplemental", "conflicts": [ "/summary", "/description", "/operationId" ], "revisionId": "sdrn_ds2DI_Xad11MCFdnoGvH0" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_MV8gWtP36-RZn0HelHkbq", "authority": "supplemental", "conflicts": [ "/summary", "/description", "/operationId" ], "revisionId": "sdrn_zsd2yxhBG769IpVFIUWRc" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_qhTee9rhe4IsP9VM8R0Jx", "authority": "supplemental", "conflicts": [ "/summary", "/description", "/operationId" ], "revisionId": "sdrn_n1Qua5iIILpqbVggnqZhR" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_QN3ukfHdtXTOIp_KXoTb_", "authority": "supplemental", "conflicts": [ "/summary", "/description" ], "revisionId": "sdrn_fqMlN4jSZ8jNeUn6Wv8Vq" }, { "gaps": [ "Missing query parameters for product identification" ], "pages": [ 1 ], "sourceId": "sds_ZS-xdAQ0s8auc1LcI7Ooo", "authority": "supplemental", "conflicts": [ "/summary", "/description", "/operationId" ], "revisionId": "sdrn_7knEBvR-UUuEvVL1C_QLq" } ], "x-zeroclick-services": [ "realtime-homedepot-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-homedepot-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-homedepot-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-homedepot-data/products-by-category": { "get": { "summary": "Products By Category", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_31f88892c8f25ad6_ref0" } } }, "description": "Successful response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "category_id", "schema": { "type": "string" }, "example": "5yc1vZc2bp", "required": true, "description": "Home Depot category id (navigation parameter) of the category to browse. Category ids appear in Home Depot category page URLs (the `N-...` segment) and in the `breadcrumbs` / `filters` of Search responses.\n\n**Examples:**\n- 5yc1vZc2bp\n- 5yc1vZc28b" }, { "in": "query", "name": "page", "schema": { "type": "integer", "default": 1, "maximum": 30, "minimum": 1 }, "description": "Page to return.\n\n**Allowed values:** `1-30`" }, { "in": "query", "name": "items_per_page", "schema": { "type": "integer", "default": 24, "maximum": 48, "minimum": 1 }, "description": "Number of products to return per page.\n\n**Allowed values:** `1-48`" }, { "in": "query", "name": "store_id", "schema": { "type": "string" }, "description": "Home Depot store number used to localize pricing, inventory, and pickup availability.\n\n**Example:** `121`" }, { "in": "query", "name": "zipcode", "schema": { "type": "string" }, "description": "5-digit US zip code used to localize delivery options and pricing.\n\n**Example:** `30301`" }, { "in": "query", "name": "sort_by", "schema": { "enum": [ "best_match", "top_sellers", "top_rated", "price_low_to_high", "price_high_to_low", "newest" ], "type": "string", "default": "best_match" }, "description": "Return the results in a specific sort order." }, { "in": "query", "name": "min_price", "schema": { "type": "number" }, "description": "Only return products with a price greater than or equal to this value (in USD)." }, { "in": "query", "name": "max_price", "schema": { "type": "number" }, "description": "Only return products with a price less than or equal to this value (in USD)." }, { "in": "query", "name": "brand", "schema": { "type": "string" }, "description": "Only return products of a specific brand.\n\n**Examples:**\n- DEWALT\n- Milwaukee\n- RYOBI" }, { "in": "query", "name": "in_stock", "schema": { "type": "boolean", "default": false }, "description": "Only return products that are currently in stock / fulfillable." } ], "description": "Browse all Home Depot products within a specific category. Supports pagination, sorting, price-range, brand, and in-stock filters, and store/zip localization. Returns the same product structure as Search.", "operationId": "realtime_homedepot_data__Products_By_Category", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing query parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds_2EOeqrIsWKjYBjoNIGwV0", "authority": "supplemental", "conflicts": [ "/summary", "/description", "/operationId" ], "revisionId": "sdrn_ds2DI_Xad11MCFdnoGvH0" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_MV8gWtP36-RZn0HelHkbq", "authority": "supplemental", "conflicts": [ "/summary", "/description", "/operationId" ], "revisionId": "sdrn_zsd2yxhBG769IpVFIUWRc" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_qhTee9rhe4IsP9VM8R0Jx", "authority": "supplemental", "conflicts": [ "/summary", "/description", "/operationId" ], "revisionId": "sdrn_n1Qua5iIILpqbVggnqZhR" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_QN3ukfHdtXTOIp_KXoTb_", "authority": "supplemental", "conflicts": [ "/summary", "/description" ], "revisionId": "sdrn_fqMlN4jSZ8jNeUn6Wv8Vq" }, { "gaps": [ "Missing query parameters for category identification" ], "pages": [ 1 ], "sourceId": "sds_ZS-xdAQ0s8auc1LcI7Ooo", "authority": "supplemental", "conflicts": [ "/summary", "/description", "/operationId" ], "revisionId": "sdrn_7knEBvR-UUuEvVL1C_QLq" } ], "x-zeroclick-services": [ "realtime-homedepot-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-homedepot-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-homedepot-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-homedepot-data/search": { "get": { "summary": "Search", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_dedb39e1cfebac02_ref0" } } }, "description": "Successful response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "query", "schema": { "type": "string" }, "example": "drill", "required": true, "description": "Free-form product search query (keyword search).\n\n**Examples:**\n- drill\n- cordless impact driver\n- kitchen faucet" }, { "in": "query", "name": "page", "schema": { "type": "integer", "default": 1, "maximum": 30, "minimum": 1 }, "description": "Page to return.\n\n**Allowed values:** `1-30`" }, { "in": "query", "name": "items_per_page", "schema": { "type": "integer", "default": 24, "maximum": 48, "minimum": 1 }, "description": "Number of products to return per page.\n\n**Allowed values:** `1-48`" }, { "in": "query", "name": "store_id", "schema": { "type": "string" }, "description": "Home Depot store number used to localize pricing, inventory, and pickup availability.\n\n**Example:** `121`" }, { "in": "query", "name": "zipcode", "schema": { "type": "string" }, "description": "5-digit US zip code used to localize delivery options and pricing.\n\n**Example:** `30301`" }, { "in": "query", "name": "sort_by", "schema": { "enum": [ "best_match", "top_sellers", "top_rated", "price_low_to_high", "price_high_to_low", "newest" ], "type": "string", "default": "best_match" }, "description": "Return the results in a specific sort order." }, { "in": "query", "name": "min_price", "schema": { "type": "number" }, "description": "Only return products with a price greater than or equal to this value (in USD)." }, { "in": "query", "name": "max_price", "schema": { "type": "number" }, "description": "Only return products with a price less than or equal to this value (in USD)." }, { "in": "query", "name": "brand", "schema": { "type": "string" }, "description": "Only return products of a specific brand.\n\n**Examples:**\n- DEWALT\n- Milwaukee\n- RYOBI" }, { "in": "query", "name": "in_stock", "schema": { "type": "boolean", "default": false }, "description": "Only return products that are currently in stock / fulfillable." } ], "description": "Search for all Home Depot products by keyword. Supports pagination, sorting (best match, top sellers, top rated, price, newest), price-range, brand, and in-stock filters, and store/zip localization for pricing and fulfillment.", "operationId": "realtime_homedepot_data__Search", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing query parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds_2EOeqrIsWKjYBjoNIGwV0", "authority": "supplemental", "conflicts": [ "/summary", "/description", "/operationId" ], "revisionId": "sdrn_ds2DI_Xad11MCFdnoGvH0" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_MV8gWtP36-RZn0HelHkbq", "authority": "supplemental", "conflicts": [ "/summary", "/description", "/operationId" ], "revisionId": "sdrn_zsd2yxhBG769IpVFIUWRc" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_pt9NurvrIG0m5qHbodTXY", "authority": "supplemental", "conflicts": [ "/summary", "/description", "/operationId" ], "revisionId": "sdrn_B6aXroJb6q7sAixORNC4V" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_qhTee9rhe4IsP9VM8R0Jx", "authority": "supplemental", "conflicts": [ "/summary", "/description", "/operationId" ], "revisionId": "sdrn_n1Qua5iIILpqbVggnqZhR" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_QIFfeTcLDOFoTiC9diV0b", "authority": "supplemental", "conflicts": [ "/summary", "/description", "/operationId" ], "revisionId": "sdrn_1pOKvi_ZPvz0xrF_bUbDr" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_QN3ukfHdtXTOIp_KXoTb_", "authority": "supplemental", "conflicts": [ "/summary", "/description" ], "revisionId": "sdrn_fqMlN4jSZ8jNeUn6Wv8Vq" }, { "gaps": [ "Missing parameters, requestBody, and response schema details." ], "pages": [], "sourceId": "sds_ROjpin-1soeCivIbZLub5", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_WrJX2U_i26_CRY3Hi0cz4" }, { "gaps": [ "Missing query parameters for search" ], "pages": [ 1 ], "sourceId": "sds_ZS-xdAQ0s8auc1LcI7Ooo", "authority": "supplemental", "conflicts": [ "/summary", "/description", "/operationId" ], "revisionId": "sdrn_7knEBvR-UUuEvVL1C_QLq" } ], "x-zeroclick-services": [ "realtime-homedepot-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-homedepot-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-homedepot-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-image-search/search": { "get": { "summary": "Search Images", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the image." }, "url": { "type": "string", "description": "The direct URL of the image." }, "rank": { "type": "integer", "description": "The rank score of the image in relevance." }, "size": { "type": "string", "description": "The file size of the image." }, "title": { "type": "string", "description": "The title or alt text of the image." }, "width": { "type": "integer", "description": "The width of the image in pixels." }, "height": { "type": "integer", "description": "The height of the image in pixels." }, "source": { "type": "string", "description": "The name of the source site." }, "position": { "type": "integer", "description": "The position of the image in the search results." }, "source_url": { "type": "string", "description": "The URL of the source site." }, "source_domain": { "type": "string", "description": "The domain of the source website." }, "thumbnail_url": { "type": "string", "description": "The URL of the thumbnail image." }, "thumbnail_width": { "type": "integer", "description": "The width of the thumbnail in pixels." }, "background_color": { "type": "string", "description": "The background color of the image." }, "thumbnail_height": { "type": "integer", "description": "The height of the thumbnail in pixels." } } } }, "status": { "type": "string", "description": "The status of the API response." }, "parameters": { "type": "object", "properties": { "size": { "type": "string", "description": "The image size filter used in the search." }, "time": { "type": "string", "description": "The time filter applied to the search." }, "type": { "type": "string", "description": "The image type filter applied." }, "color": { "type": "string", "description": "The color filter used in the search." }, "query": { "type": "string", "description": "The search query used for the image search." }, "region": { "type": "string", "description": "The region in which the search was performed." }, "file_type": { "type": "string", "description": "The file type filter applied to the images." }, "safe_search": { "type": "string", "description": "Indicates whether safe search was enabled." }, "aspect_ratio": { "type": "string", "description": "The aspect ratio filter used in the search." }, "usage_rights": { "type": "string", "description": "The usage rights filter applied to the search." } } }, "request_id": { "type": "string", "description": "Unique identifier for the API request." } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "query", "schema": { "type": "string", "example": "beach" }, "example": "beach", "required": true, "description": "Search query / keyword" }, { "in": "query", "name": "limit", "schema": { "type": "integer", "default": 10, "maximum": 100, "minimum": 1 }, "description": "Maximum number of results to return." }, { "in": "query", "name": "size", "schema": { "enum": [ "any", "large", "medium", "icon", "400x300_and_more", "640x480_and_more", "800x600_and_more", "1024x768_and_more", "2mp_and_more", "4mp_and_more", "6mp_and_more", "8mp_and_more", "10mp_and_more", "12mp_and_more", "15mp_and_more", "20mp_and_more", "40mp_and_more", "70mp_and_more" ], "type": "string", "default": "any" }, "description": "Find images of a specific size." }, { "in": "query", "name": "color", "schema": { "enum": [ "any", "red", "orange", "yellow", "green", "teal", "blue", "purple", "pink", "white", "gray", "black", "brown", "full", "transparent", "grayscale" ], "type": "string", "default": "any" }, "description": "Find images with a specific dominant color." }, { "in": "query", "name": "type", "schema": { "enum": [ "any", "face", "photo", "clipart", "lineart", "animated" ], "type": "string", "default": "any" }, "description": "Find images of a specific type." }, { "in": "query", "name": "time", "schema": { "enum": [ "any", "day", "week", "month", "year" ], "type": "string", "default": "any" }, "description": "Find images last updated in a specific time range." }, { "in": "query", "name": "usage_rights", "schema": { "enum": [ "any", "creative_commons", "commercial" ], "type": "string", "default": "any" }, "description": "Find images with specific usage rights / license / copyright." }, { "in": "query", "name": "file_type", "schema": { "enum": [ "any", "jpg", "jpeg", "png", "gif", "svg", "webp", "ico", "raw" ], "type": "string", "default": "any" }, "description": "Find images of a specific format / file type." }, { "in": "query", "name": "aspect_ratio", "schema": { "enum": [ "any", "tall", "square", "wide", "panoramic" ], "type": "string", "default": "any" }, "description": "Find images with a specific aspect ratio." }, { "in": "query", "name": "country", "schema": { "type": "string" }, "description": "Find images published in a specific country / region. Allowed values: 2-letter country code, see ISO 3166-1 alpha-2." }, { "in": "query", "name": "safe_search", "schema": { "enum": [ "off", "blur", "on" ], "type": "string", "default": "blur" }, "description": "How to show explicit content in your search results, like sexual activity and graphic violence." }, { "in": "query", "name": "region", "schema": { "type": "string", "default": "us" }, "description": "The country / region from which to make the query. Allowed values: 2-letter country code, see ISO 3166-1 alpha-2." }, { "in": "query", "name": "fields", "schema": { "type": "string" }, "description": "A comma separated list of image fields to include in the response (field projection). By default all fields are returned." } ], "description": "Get real-time image search results from across the web. Supports all Google Images search filters.", "operationId": "realtime_image_search__get__search", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing query parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds_2EOeqrIsWKjYBjoNIGwV0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_ds2DI_Xad11MCFdnoGvH0" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_MV8gWtP36-RZn0HelHkbq", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_zsd2yxhBG769IpVFIUWRc" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_pt9NurvrIG0m5qHbodTXY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_B6aXroJb6q7sAixORNC4V" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_qhTee9rhe4IsP9VM8R0Jx", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_n1Qua5iIILpqbVggnqZhR" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_QIFfeTcLDOFoTiC9diV0b", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_1pOKvi_ZPvz0xrF_bUbDr" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_QN3ukfHdtXTOIp_KXoTb_", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description" ], "revisionId": "sdrn_fqMlN4jSZ8jNeUn6Wv8Vq" }, { "gaps": [ "Missing parameters, requestBody, and response schema details." ], "pages": [], "sourceId": "sds_ROjpin-1soeCivIbZLub5", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_WrJX2U_i26_CRY3Hi0cz4" }, { "gaps": [ "Missing query parameters for search" ], "pages": [ 1 ], "sourceId": "sds_ZS-xdAQ0s8auc1LcI7Ooo", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_7knEBvR-UUuEvVL1C_QLq" } ], "x-zeroclick-services": [ "realtime-image-search" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-image-search", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-image-search", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-indeed-data/company-reviews": { "get": { "summary": "Company Reviews", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "request_id", "parameters", "data" ], "properties": { "data": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_941e3589215dbcf8_ref1" }, "status": { "enum": [ "OK" ], "type": "string" }, "parameters": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_941e3589215dbcf8_ref0" }, "request_id": { "type": "string" } } } } }, "description": "The company, its aggregate ratings, and one or more pages of reviews." }, "400": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_941e3589215dbcf8_ref5" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_941e3589215dbcf8_ref6" } } }, "description": "No Indeed company page exists for the supplied `company`.\n" }, "429": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_941e3589215dbcf8_ref9" }, "500": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_941e3589215dbcf8_ref10" }, "503": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_941e3589215dbcf8_ref11" } }, "parameters": [ { "in": "query", "name": "company", "schema": { "type": "string" }, "example": "Lutron-Electronics", "required": true, "description": "The company, as an Indeed `/cmp` slug (`Lutron-Electronics`), a full or relative `/cmp` URL,\nor a free-text name. Slugs and URLs are free; `job_indeed_company_page_url` works directly.\nA free-text name is resolved through Indeed's company search and billed as one extra\nrequest. An unknown slug returns a 404 error.\n" }, { "in": "query", "name": "page", "schema": { "type": "integer", "default": 1, "maximum": 100, "minimum": 1 }, "required": false, "description": "1-based page number. 20 reviews per page. Values above 100 are clamped to 100." }, { "in": "query", "name": "num_pages", "schema": { "type": "integer", "default": 1, "maximum": 10, "minimum": 1 }, "required": false, "description": "How many consecutive pages to fetch and concatenate, starting at `page`. Values above\n10 are clamped to 10 - a page costs ~2.9 s at the measured median, and the Lambda\nbudget is 90 s.\n" }, { "in": "query", "name": "sort", "schema": { "enum": [ "relevance", "helpfulness", "rating_desc", "rating_asc" ], "type": "string", "default": "relevance" }, "required": false, "description": "Review ordering, applied by Indeed. `relevance` (default) is Indeed's own order, which is\nalready newest-first. `helpfulness` puts most-helpful first. `rating_desc` and `rating_asc`\nsort by star rating. There is no date value: Indeed accepts one but ignores it, and\n`relevance` is already date order.\n" }, { "in": "query", "name": "country", "schema": { "type": "string" }, "required": false, "description": "Which country's reviews to return (Indeed's `fcountry`), as a 2-letter code, or `ALL`\nfor every country.\n\nThis is **not** the proxy exit market. Indeed's default view is already scoped to\nUS, which is why `company_review_count` and `company_filtered_review_count` normally\ndiffer.\n" }, { "in": "query", "name": "location", "schema": { "type": "string" }, "required": false, "description": "Narrow to one location within the selected country, in Indeed's own format (`Coopersburg,\nPA`). **Requires a 2-letter `country`.** Indeed ignores this filter without one, so\nsending it alone returns a 400 error.\n" }, { "in": "query", "name": "topic", "schema": { "enum": [ "wlbalance", "paybenefits", "jobsecadv", "mgmt", "culture" ], "type": "string" }, "required": false, "description": "Return only reviews that discuss one topic. The ids and their per-company review\ncounts and ratings are returned in `company_review_topics`. A value outside this set\nis silently ignored by Indeed, so it is rejected with a 400 here.\n" }, { "in": "query", "name": "job_title", "schema": { "type": "string" }, "required": false, "description": "Return only reviews written by people with this job title." }, { "in": "query", "name": "text", "schema": { "type": "string" }, "required": false, "description": "Full-text search within the company's reviews." } ], "description": "Employee reviews for one company, with its overall rating, the five category ratings\nand the 1-5 star distribution.\n\nPass a job's `job_indeed_company_page_url` straight through as `company` to go from a\njob to its employer's reviews in one hop.\n\n**Transport.** The same one the job endpoints use - `curl_cffi` with Chrome\nimpersonation over the datacenter proxy ladder, anonymous throughout. Burn-tested\n2026-09-11: 20 sequential requests across 10 companies and 3 page\noffsets returned 20/20 HTTP 200 with parsed reviews, median 2.86 s (min 1.74 s,\nmax 5.79 s). Unlike Indeed's job SERP, this surface has **no page-2 sign-in wall** -\n`start=240` was verified to return genuine page 13 anonymously.\n\n**Envelope.** `data` is an OBJECT: company identity and aggregates alongside a\n`reviews` array, mirroring Real-Time Amazon Data's `/product-reviews`.\n\n**Two review counts, and they differ.** Indeed's default view is scoped to one country.\n`company_review_count` is every review the company has; `company_filtered_review_count`\nis how many the current filters can page through. Pass `country=ALL` to make them equal.\n\n**Paging past the end.** Indeed silently serves **page 1 again** for a `start` well past\nthe last page (verified: `start=300`, `500`, `1000` all returned page 1's exact review\nids on a 260-review company). Those rows are detected via the page number Indeed echoes\nand **discarded** - you get an empty `reviews` array and `parameters.page_past_last:\ntrue`.\n\n**Billing.** `Requests` counts one per upstream reviews page of 20, plus one more when\n`company` was a free-text name that had to be resolved to a slug.\n", "operationId": "realtime_indeed_data__Company_Reviews", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing query parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds_2EOeqrIsWKjYBjoNIGwV0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_ds2DI_Xad11MCFdnoGvH0" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_MV8gWtP36-RZn0HelHkbq", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_zsd2yxhBG769IpVFIUWRc" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_pt9NurvrIG0m5qHbodTXY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_B6aXroJb6q7sAixORNC4V" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_qhTee9rhe4IsP9VM8R0Jx", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_n1Qua5iIILpqbVggnqZhR" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_QIFfeTcLDOFoTiC9diV0b", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_1pOKvi_ZPvz0xrF_bUbDr" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_QN3ukfHdtXTOIp_KXoTb_", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description" ], "revisionId": "sdrn_fqMlN4jSZ8jNeUn6Wv8Vq" }, { "gaps": [ "Missing parameters, requestBody, and response schema details." ], "pages": [], "sourceId": "sds_ROjpin-1soeCivIbZLub5", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_WrJX2U_i26_CRY3Hi0cz4" }, { "gaps": [ "Missing full schema definition for response body" ], "pages": [ 1 ], "sourceId": "sds_t1I2lol_F5DgGpe13n3Xt", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/company_id", "/description", "/operationId" ], "revisionId": "sdrn_OBuPoRSMenxSJ1CM3zwbN" }, { "gaps": [ "Missing query parameters for company identification" ], "pages": [ 1 ], "sourceId": "sds_ZS-xdAQ0s8auc1LcI7Ooo", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_7knEBvR-UUuEvVL1C_QLq" } ], "x-zeroclick-services": [ "realtime-indeed-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-indeed-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-indeed-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-indeed-data/job-details": { "get": { "summary": "Job Details", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "request_id", "parameters", "data" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_91efb1241ec59088_ref1" } }, "status": { "enum": [ "OK" ], "type": "string" }, "parameters": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_91efb1241ec59088_ref0" }, "request_id": { "type": "string" } } } } }, "description": "The requested jobs, in request order, minus any that could not be resolved." }, "400": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_91efb1241ec59088_ref4" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." }, "429": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_91efb1241ec59088_ref8" }, "500": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_91efb1241ec59088_ref9" }, "503": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_91efb1241ec59088_ref10" } }, "parameters": [ { "in": "query", "name": "job_id", "schema": { "type": "string" }, "example": "aW5kZWVkOjQ3NmU1ODZjZjJiOTFjNDY", "required": true, "description": "Comma-delimited list of up to 20 `job_id` values taken from a `/search` response.\nThe raw 16-hex `job_uid` is also accepted. An invalid/expired job id is omitted\nfrom the response array while the rest of the batch resolves normally.\n" }, { "in": "query", "name": "country", "schema": { "type": "string", "default": "us" }, "required": false, "description": "ISO 3166-1 alpha-2 market code." }, { "in": "query", "name": "language", "schema": { "type": "string" }, "required": false, "description": "ISO 639-1 language. Defaults to the primary language of `country`." }, { "in": "query", "name": "fields", "schema": { "type": "string" }, "required": false, "description": "Comma-delimited projection, as on `/search`." } ], "description": "Fetch full details for up to 20 jobs in a single request. Indeed resolves the whole\nbatch in one upstream call (measured: 5 jobs in 761 ms), so a multi-id request costs\nthe same as a single-id one.\n\nThe job objects returned here carry the same fields as `/search` results, with\n`job_position` null because the details surface has no notion of rank.\n", "operationId": "realtime_indeed_data__Job_Details", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing query parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds_2EOeqrIsWKjYBjoNIGwV0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_ds2DI_Xad11MCFdnoGvH0" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_MV8gWtP36-RZn0HelHkbq", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_zsd2yxhBG769IpVFIUWRc" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_pt9NurvrIG0m5qHbodTXY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_B6aXroJb6q7sAixORNC4V" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_qhTee9rhe4IsP9VM8R0Jx", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_n1Qua5iIILpqbVggnqZhR" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_QIFfeTcLDOFoTiC9diV0b", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_1pOKvi_ZPvz0xrF_bUbDr" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_QN3ukfHdtXTOIp_KXoTb_", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description" ], "revisionId": "sdrn_fqMlN4jSZ8jNeUn6Wv8Vq" }, { "gaps": [ "Missing parameters, requestBody, and response schema details." ], "pages": [], "sourceId": "sds_ROjpin-1soeCivIbZLub5", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_WrJX2U_i26_CRY3Hi0cz4" }, { "gaps": [ "Missing full schema definition for response body" ], "pages": [ 1 ], "sourceId": "sds_t1I2lol_F5DgGpe13n3Xt", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_OBuPoRSMenxSJ1CM3zwbN" }, { "gaps": [ "Missing query parameters for job identification" ], "pages": [ 1 ], "sourceId": "sds_ZS-xdAQ0s8auc1LcI7Ooo", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_7knEBvR-UUuEvVL1C_QLq" } ], "x-zeroclick-services": [ "realtime-indeed-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-indeed-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-indeed-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-indeed-data/search": { "get": { "summary": "Search Jobs", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "request_id", "parameters", "data" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_7bc4ac4354ea1318_ref1" }, "description": "Matching jobs, in Indeed's ranking order for the requested window." }, "status": { "enum": [ "OK" ], "type": "string" }, "parameters": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_7bc4ac4354ea1318_ref0" }, "request_id": { "type": "string" } } } } }, "description": "Matching jobs." }, "400": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_7bc4ac4354ea1318_ref4" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." }, "429": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_7bc4ac4354ea1318_ref8" }, "500": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_7bc4ac4354ea1318_ref9" }, "503": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_7bc4ac4354ea1318_ref10" } }, "parameters": [ { "in": "query", "name": "query", "schema": { "type": "string" }, "example": "software engineer", "required": true, "description": "Free-text search query, e.g. `software engineer`. Exactly one query per request;\na multi-valued `query` returns a 400 error.\n" }, { "in": "query", "name": "location", "schema": { "type": "string" }, "required": false, "description": "Where to search, in Indeed's own format, e.g. `New York, NY`, `London`,\n`Berlin`. Omit to search the whole market.\n" }, { "in": "query", "name": "page", "schema": { "type": "integer", "default": 1, "maximum": 50, "minimum": 1 }, "required": false, "description": "1-based page number. 10 jobs per page. Values above 50 are clamped to 50." }, { "in": "query", "name": "num_pages", "schema": { "type": "integer", "default": 1, "maximum": 50, "minimum": 1 }, "required": false, "description": "How many pages to return in one response. A full job runs about 12 KB,\nso beyond roughly 450 jobs the response is trimmed to fit the 6 MB limit and\n`parameters.response_truncated` is set. You are billed only for pages returned. Pass\n`fields` to keep a deep window intact.\n" }, { "in": "query", "name": "country", "schema": { "type": "string", "default": "us" }, "required": false, "description": "ISO 3166-1 alpha-2 market code. Sent to Indeed as a header, so any market is\nreachable regardless of the proxy exit country (verified US, GB, DE, CA, IN, AU).\n" }, { "in": "query", "name": "language", "schema": { "type": "string" }, "required": false, "description": "ISO 639-1 language. Defaults to the primary language of `country`." }, { "in": "query", "name": "date_posted", "schema": { "enum": [ "all", "today", "3days", "week", "month" ], "type": "string", "default": "all" }, "required": false, "description": "Only return jobs posted within this window. `all` (the default) applies no date\nfilter. Combined with any other filter, the date window is applied locally and can\nreturn fewer jobs than qualify; filter by date alone when you need every matching\njob.\n" }, { "in": "query", "name": "employment_types", "schema": { "enum": [ "FULLTIME", "CONTRACTOR", "PARTTIME", "INTERN" ], "type": "string" }, "required": false, "description": "Comma-delimited list. A job matches if it carries **any** of the given types.\nIndeed also tags Temporary and Seasonal, which have no enum member here and are\nvisible via `job_indeed_attributes`.\n" }, { "in": "query", "name": "experience_level", "schema": { "enum": [ "ENTRY_LEVEL", "MID_LEVEL", "SENIOR_LEVEL", "NO_EXPERIENCE" ], "type": "string" }, "required": false, "description": "Comma-delimited list of seniority levels. A job matches if it carries **any** of\nthem. Enforced against Indeed's own seniority tags.\n" }, { "in": "query", "name": "work_from_home", "schema": { "type": "boolean" }, "required": false, "description": "When `true`, return only jobs Indeed tags as Remote. Hybrid roles are excluded;\nsee `job_indeed_is_hybrid` on the job object.\n" }, { "in": "query", "name": "min_salary", "schema": { "type": "number", "minimum": 0 }, "required": false, "description": "Minimum **annual** salary. Applied to the salary the employer actually stated,\nannualised from `job_salary_period`. Jobs with no stated salary are excluded,\nbecause they cannot be asserted to qualify.\n" }, { "in": "query", "name": "max_salary", "schema": { "type": "number", "minimum": 0 }, "required": false, "description": "Maximum **annual** salary. Same semantics as `min_salary`." }, { "in": "query", "name": "radius", "schema": { "type": "number", "maximum": 10000, "minimum": 0 }, "required": false, "description": "Search radius around `location`, in **kilometres**. Passed through to Indeed\nexactly, so 2 returns jobs within 2 km. Values above 10000 are clamped.\n**Requires `location`** - Indeed applies a radius only around a location, so\nsending it alone returns a 400 error.\n" }, { "in": "query", "name": "exclude_job_publishers", "schema": { "type": "string" }, "required": false, "description": "Comma-delimited list of publishers to drop, matched case-insensitively against\n`job_publisher`. Applied locally; Indeed has no upstream equivalent.\n" }, { "in": "query", "name": "fields", "schema": { "type": "string" }, "required": false, "description": "Comma-delimited projection. Any key of the job object is valid; `job_id` and\n`job_title` are always included. An unknown field is a 400.\nAlso the mechanism for pulling a deep result set in one call - see `num_pages`.\n" } ], "description": "Search Indeed for jobs. Returns a flat array of job objects - the same envelope\nJSearch `/search` uses.\n\n**Pagination.** 10 jobs per page, with repeated postings removed. A broad query can\nretrieve roughly 850 to 965 unique jobs before Indeed's results run out and the response\ncomes back short; a narrow query runs out sooner. `page` and `num_pages` together reach\nat most job 990.\n", "operationId": "realtime_indeed_data__Search_Jobs", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing query parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds_2EOeqrIsWKjYBjoNIGwV0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_ds2DI_Xad11MCFdnoGvH0" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_MV8gWtP36-RZn0HelHkbq", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_zsd2yxhBG769IpVFIUWRc" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_pt9NurvrIG0m5qHbodTXY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_B6aXroJb6q7sAixORNC4V" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_qhTee9rhe4IsP9VM8R0Jx", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_n1Qua5iIILpqbVggnqZhR" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_QIFfeTcLDOFoTiC9diV0b", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_1pOKvi_ZPvz0xrF_bUbDr" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_QN3ukfHdtXTOIp_KXoTb_", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description" ], "revisionId": "sdrn_fqMlN4jSZ8jNeUn6Wv8Vq" }, { "gaps": [ "Missing parameters, requestBody, and response schema details." ], "pages": [], "sourceId": "sds_ROjpin-1soeCivIbZLub5", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_WrJX2U_i26_CRY3Hi0cz4" }, { "gaps": [ "Missing full schema definition for response body" ], "pages": [ 1 ], "sourceId": "sds_t1I2lol_F5DgGpe13n3Xt", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_OBuPoRSMenxSJ1CM3zwbN" }, { "gaps": [ "Missing query parameters for search" ], "pages": [ 1 ], "sourceId": "sds_ZS-xdAQ0s8auc1LcI7Ooo", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_7knEBvR-UUuEvVL1C_QLq" } ], "x-zeroclick-services": [ "realtime-indeed-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-indeed-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-indeed-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-lens-data/exact-matches": { "get": { "summary": "Exact Matches", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "string", "nullable": true, "description": "Relative publication date of the page (e.g. '2 years ago'), when known." }, "link": { "type": "string", "description": "Canonical URL of the page." }, "logo": { "type": "string", "nullable": true, "description": "Favicon URL for the source." }, "image": { "type": "string", "description": "Direct URL to the matched image on this page." }, "title": { "type": "string", "description": "Title of the page containing the matching image." }, "domain": { "type": "string", "description": "Domain of the source page." }, "image_width": { "type": "integer", "description": "Width of the matched image in pixels." }, "image_height": { "type": "integer", "description": "Height of the matched image in pixels." } } }, "description": "A list of pages that contain an exact match of the supplied image." }, "status": { "type": "string", "description": "The status of the API response" }, "parameters": { "type": "object", "properties": { "url": { "type": "string", "description": "The URL of the resource being queried" }, "limit": { "type": "integer", "description": "Maximum number of results to return" }, "safe_search": { "type": "string", "description": "Safe search filter level (e.g., off, medium, strict)" } } }, "request_id": { "type": "string", "description": "A unique identifier for the request" } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "url", "schema": { "type": "string" }, "example": "https://i.imgur.com/HBrB8p0.png", "required": true, "description": "URL of the image for which to find sources" }, { "in": "query", "name": "limit", "schema": { "type": "string", "default": 500, "maximum": 500, "minimum": 1 }, "description": "Maximum number of results to return." }, { "in": "query", "name": "safe_search", "schema": { "enum": [ "off", "blur" ], "type": "string", "default": "blur" }, "description": "How to show explicit content in your search results, like sexual activity and graphic violence." } ], "description": "Send an image URL and get the top 500 web pages with the same image (reverse image search). This endpoint implements the \"Exact Matches\" tab on Google Lens.", "operationId": "realtime_lens_data__get__exact_matches", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing query parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds_2EOeqrIsWKjYBjoNIGwV0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_ds2DI_Xad11MCFdnoGvH0" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_MV8gWtP36-RZn0HelHkbq", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_zsd2yxhBG769IpVFIUWRc" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_pt9NurvrIG0m5qHbodTXY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_B6aXroJb6q7sAixORNC4V" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_qhTee9rhe4IsP9VM8R0Jx", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_n1Qua5iIILpqbVggnqZhR" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_QIFfeTcLDOFoTiC9diV0b", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_1pOKvi_ZPvz0xrF_bUbDr" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_QN3ukfHdtXTOIp_KXoTb_", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description" ], "revisionId": "sdrn_fqMlN4jSZ8jNeUn6Wv8Vq" }, { "gaps": [ "Missing parameters, requestBody, and response schema details." ], "pages": [], "sourceId": "sds_ROjpin-1soeCivIbZLub5", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_WrJX2U_i26_CRY3Hi0cz4" }, { "gaps": [ "Missing query parameters for image identification" ], "pages": [ 1 ], "sourceId": "sds_ZS-xdAQ0s8auc1LcI7Ooo", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_7knEBvR-UUuEvVL1C_QLq" } ], "x-zeroclick-services": [ "realtime-lens-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-lens-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-lens-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-lens-data/object-detection": { "get": { "summary": "Object Detection", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "detection_count": { "type": "integer", "description": "Total number of objects detected in the image" } } }, "status": { "type": "string", "description": "The status of the API response" }, "parameters": { "type": "object", "properties": { "url": { "type": "string", "description": "The image URL used for the detection" }, "country": { "type": "string", "description": "Country code relevant to the detection context" }, "language": { "type": "string", "description": "Language code for localization" } } }, "request_id": { "type": "string", "description": "A unique identifier for the request" } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "url", "schema": { "type": "string" }, "example": "https://thumbs.dreamstime.com/b/giraffe-zebra-1533191.jpg", "required": true, "description": "URL of an image to perform Google Lens object detection." } ], "description": "Detect landmarks, places, plants, animals, products, and other objects in an image, including bounding boxes, labels / types and confidence score.", "operationId": "realtime_lens_data__get__object_detection", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing query parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds_2EOeqrIsWKjYBjoNIGwV0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_ds2DI_Xad11MCFdnoGvH0" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_MV8gWtP36-RZn0HelHkbq", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_zsd2yxhBG769IpVFIUWRc" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_pt9NurvrIG0m5qHbodTXY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_B6aXroJb6q7sAixORNC4V" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_qhTee9rhe4IsP9VM8R0Jx", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_n1Qua5iIILpqbVggnqZhR" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_QIFfeTcLDOFoTiC9diV0b", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_1pOKvi_ZPvz0xrF_bUbDr" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_QN3ukfHdtXTOIp_KXoTb_", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description" ], "revisionId": "sdrn_fqMlN4jSZ8jNeUn6Wv8Vq" }, { "gaps": [ "Missing parameters, requestBody, and response schema details." ], "pages": [], "sourceId": "sds_ROjpin-1soeCivIbZLub5", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_WrJX2U_i26_CRY3Hi0cz4" }, { "gaps": [ "Missing query parameters for image identification" ], "pages": [ 1 ], "sourceId": "sds_ZS-xdAQ0s8auc1LcI7Ooo", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_7knEBvR-UUuEvVL1C_QLq" } ], "x-zeroclick-services": [ "realtime-lens-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-lens-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-lens-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-lens-data/ocr": { "get": { "summary": "Image to Text", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "text": { "type": "string", "description": "The full extracted text content" }, "language": { "type": "string", "description": "The language of the extracted text" }, "paragraphs": { "type": "array", "items": { "type": "object", "properties": { "box": { "type": "object", "properties": { "top": { "type": "number", "description": "The y-coordinate of the top edge of the paragraph box" }, "left": { "type": "number", "description": "The x-coordinate of the left edge of the paragraph box" }, "width": { "type": "number", "description": "The width of the paragraph box" }, "height": { "type": "number", "description": "The height of the paragraph box" } } }, "sentences": { "type": "array", "items": { "type": "object", "properties": { "box": { "type": "object", "properties": { "top": { "type": "number", "description": "The y-coordinate of the top edge of the sentence box" }, "left": { "type": "number", "description": "The x-coordinate of the left edge of the sentence box" }, "width": { "type": "number", "description": "The width of the sentence box" }, "height": { "type": "number", "description": "The height of the sentence box" } } }, "words": { "type": "array", "items": { "type": "object", "properties": { "box": { "type": "object", "properties": { "top": { "type": "number", "description": "The y-coordinate of the top edge of the word box" }, "left": { "type": "number", "description": "The x-coordinate of the left edge of the word box" }, "width": { "type": "number", "description": "The width of the word box" }, "height": { "type": "number", "description": "The height of the word box" } } }, "word": { "type": "string", "description": "The individual word detected in the image" } } } } } } } } } } } }, "status": { "type": "string", "description": "The status of the API response" }, "parameters": { "type": "object", "properties": { "url": { "type": "string", "description": "The URL of the image being processed" }, "language": { "type": "string", "description": "Detected or specified language code" } } }, "request_id": { "type": "string", "description": "A unique identifier for the request" } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "url", "schema": { "type": "string" }, "example": "https://s3-us-west-2.amazonaws.com/courses-images/wp-content/uploads/sites/1844/2017/06/15213029/images-textwrap-topbottom.png", "required": true, "description": "URL of an image from which to extract text." }, { "in": "query", "name": "language", "schema": { "type": "string", "default": "en" }, "description": "Set the language of the results. Allowed values: 2-letter language code, see ISO 639-1." } ], "description": "Extract text from an image and get paragraph, sentence and word level text detections from Google Lens.", "operationId": "realtime_lens_data__get__ocr", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing query parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds_2EOeqrIsWKjYBjoNIGwV0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_ds2DI_Xad11MCFdnoGvH0" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_MV8gWtP36-RZn0HelHkbq", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_zsd2yxhBG769IpVFIUWRc" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_pt9NurvrIG0m5qHbodTXY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_B6aXroJb6q7sAixORNC4V" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_qhTee9rhe4IsP9VM8R0Jx", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_n1Qua5iIILpqbVggnqZhR" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_QIFfeTcLDOFoTiC9diV0b", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_1pOKvi_ZPvz0xrF_bUbDr" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_QN3ukfHdtXTOIp_KXoTb_", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description" ], "revisionId": "sdrn_fqMlN4jSZ8jNeUn6Wv8Vq" }, { "gaps": [ "Missing parameters, requestBody, and response schema details." ], "pages": [], "sourceId": "sds_ROjpin-1soeCivIbZLub5", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_WrJX2U_i26_CRY3Hi0cz4" }, { "gaps": [ "Missing query parameters for image identification" ], "pages": [ 1 ], "sourceId": "sds_ZS-xdAQ0s8auc1LcI7Ooo", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_7knEBvR-UUuEvVL1C_QLq" } ], "x-zeroclick-services": [ "realtime-lens-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-lens-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-lens-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-lens-data/search": { "get": { "summary": "Image Search", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "visual_matches": { "type": "array", "items": { "type": "object", "properties": { "link": { "type": "string", "description": "Canonical URL of the matched page." }, "image": { "type": "string", "description": "Direct URL to the matched full-size image." }, "title": { "type": "string", "description": "Title of the matched page." }, "rating": { "type": "number", "nullable": true, "description": "Average rating of the matched product, when surfaced." }, "source": { "type": "string", "description": "Domain of the source page." }, "reviews": { "type": "integer", "nullable": true, "description": "Number of reviews of the matched product, when surfaced." }, "position": { "type": "integer", "description": "1-based position of the match in the visual results list." }, "thumbnail": { "type": "string", "description": "Google-hosted thumbnail URL for the matched image." }, "image_width": { "type": "integer", "description": "Width of the matched image in pixels." }, "source_icon": { "type": "string", "nullable": true, "description": "Favicon URL for the source." }, "source_name": { "type": "string", "description": "Human-readable source name." }, "image_height": { "type": "integer", "description": "Height of the matched image in pixels." }, "thumbnail_width": { "type": "integer", "description": "Width of the thumbnail in pixels." }, "thumbnail_height": { "type": "integer", "description": "Height of the thumbnail in pixels." } } }, "description": "A list of visually similar matches found for the input image." }, "knowledge_graph": { "type": "array", "items": { "type": "object" }, "description": "Knowledge graph entities or cards returned for the visual search. Empty when no entity is identified." }, "organic_results": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string", "description": "The URL of the organic search result." }, "rank": { "type": "integer", "description": "The rank value assigned to the result." }, "title": { "type": "string", "description": "The title of the organic search result." }, "domain": { "type": "string", "description": "The domain of the result URL." }, "source": { "type": "string", "description": "The source name shown for the result." }, "snippet": { "type": "string", "description": "A short snippet describing the result content." }, "position": { "type": "integer", "description": "The position of the result in the organic results list." } } }, "description": "A list of organic web results related to the image." }, "related_searches": { "type": "array", "items": { "type": "object", "properties": { "query": { "type": "string", "description": "A related search query suggestion." }, "search_url": { "type": "string", "description": "A URL to run the related search query." } } }, "description": "A list of related search queries suggested for the image." } } }, "status": { "type": "string", "description": "The status of the API response." }, "parameters": { "type": "object", "properties": { "url": { "type": "string", "description": "The image URL used as input for the visual search request." }, "country": { "type": "string", "description": "The country code used to localize results." }, "language": { "type": "string", "description": "The language code used for the request." }, "safe_search": { "type": "string", "description": "The safe search setting applied to the results." } } }, "request_id": { "type": "string", "description": "A unique identifier for this request." } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "url", "schema": { "type": "string" }, "example": "https://i.imgur.com/HBrB8p0.png", "required": true, "description": "URL of an image with which to perform the search." }, { "in": "query", "name": "query", "schema": { "type": "string" }, "description": "Search query to further refine the results." }, { "in": "query", "name": "language", "schema": { "type": "string", "default": "en" }, "description": "Set the language of the results (Google's hl parameter). Allowed values: 2-letter language code, see ISO 639-1." }, { "in": "query", "name": "country", "schema": { "type": "string", "default": "us" }, "description": "Set the country for the search (Google's gl parameter). Allowed values: 2-letter country code, see ISO 3166." } ], "description": "Search image by url and get visual matches, knowledge graph, and products found on the web. \n See it in action on - [Google Lens](https://lens.google.com/uploadbyurl?url=https%3A%2F%2Fi.imgur.com%2FHBrB8p0.png).", "operationId": "realtime_lens_data__get__search", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing query parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds_2EOeqrIsWKjYBjoNIGwV0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_ds2DI_Xad11MCFdnoGvH0" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_MV8gWtP36-RZn0HelHkbq", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_zsd2yxhBG769IpVFIUWRc" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_pt9NurvrIG0m5qHbodTXY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_B6aXroJb6q7sAixORNC4V" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_qhTee9rhe4IsP9VM8R0Jx", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_n1Qua5iIILpqbVggnqZhR" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_QIFfeTcLDOFoTiC9diV0b", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_1pOKvi_ZPvz0xrF_bUbDr" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_QN3ukfHdtXTOIp_KXoTb_", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description" ], "revisionId": "sdrn_fqMlN4jSZ8jNeUn6Wv8Vq" }, { "gaps": [ "Missing parameters, requestBody, and response schema details." ], "pages": [], "sourceId": "sds_ROjpin-1soeCivIbZLub5", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_WrJX2U_i26_CRY3Hi0cz4" }, { "gaps": [ "Missing query parameters for search" ], "pages": [ 1 ], "sourceId": "sds_ZS-xdAQ0s8auc1LcI7Ooo", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_7knEBvR-UUuEvVL1C_QLq" } ], "x-zeroclick-services": [ "realtime-lens-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-lens-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-lens-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-lens-data/visual-matches": { "get": { "summary": "Visual Matches", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "link": { "type": "string", "description": "Canonical URL of the matched page." }, "image": { "type": "string", "description": "Direct URL to the matched full-size image." }, "title": { "type": "string", "description": "Title of the matched page." }, "source": { "type": "string", "description": "Domain of the source page." }, "position": { "type": "integer", "description": "1-based position of the match." }, "thumbnail": { "type": "string", "description": "Google-hosted thumbnail URL for the matched image." }, "image_width": { "type": "integer", "description": "Width of the matched image in pixels." }, "source_icon": { "type": "string", "nullable": true, "description": "Favicon URL for the source." }, "image_height": { "type": "integer", "description": "Height of the matched image in pixels." }, "thumbnail_width": { "type": "integer", "description": "Width of the thumbnail in pixels." }, "thumbnail_height": { "type": "integer", "description": "Height of the thumbnail in pixels." } } }, "description": "A list of visual matches found for the supplied image." }, "status": { "type": "string", "description": "The status of the response" }, "parameters": { "type": "object", "properties": { "url": { "type": "string", "description": "The image URL used for the query" }, "country": { "type": "string", "description": "The country code associated with the request" }, "language": { "type": "string", "description": "The language code used in the request" } } }, "request_id": { "type": "string", "description": "The unique identifier for this API request" } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "url", "schema": { "type": "string" }, "example": "https://i.imgur.com/HBrB8p0.png", "required": true, "description": "URL of an image for which to get visual matches." }, { "in": "query", "name": "query", "schema": { "type": "string" }, "description": "Search query to further refine the results." }, { "in": "query", "name": "language", "schema": { "type": "string", "default": "en" }, "description": "Set the language of the results (Google's hl parameter). Allowed values: 2-letter language code, see ISO 639-1." }, { "in": "query", "name": "country", "schema": { "type": "string", "default": "us" }, "description": "Set the country for the search (Google's gl parameter). Allowed values: 2-letter country code, see ISO 3166." } ], "description": "Get visual matches from the web for an image and optionally a query. This endpoint implements the \"Visual Matches\" on Google Lens.", "operationId": "realtime_lens_data__get__visual_matches", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing query parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds_2EOeqrIsWKjYBjoNIGwV0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_ds2DI_Xad11MCFdnoGvH0" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_MV8gWtP36-RZn0HelHkbq", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_zsd2yxhBG769IpVFIUWRc" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_pt9NurvrIG0m5qHbodTXY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_B6aXroJb6q7sAixORNC4V" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_qhTee9rhe4IsP9VM8R0Jx", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_n1Qua5iIILpqbVggnqZhR" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_QIFfeTcLDOFoTiC9diV0b", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_1pOKvi_ZPvz0xrF_bUbDr" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_QN3ukfHdtXTOIp_KXoTb_", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description" ], "revisionId": "sdrn_fqMlN4jSZ8jNeUn6Wv8Vq" }, { "gaps": [ "Missing parameters, requestBody, and response schema details." ], "pages": [], "sourceId": "sds_ROjpin-1soeCivIbZLub5", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_WrJX2U_i26_CRY3Hi0cz4" }, { "gaps": [ "Missing query parameters for image identification" ], "pages": [ 1 ], "sourceId": "sds_ZS-xdAQ0s8auc1LcI7Ooo", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_7knEBvR-UUuEvVL1C_QLq" } ], "x-zeroclick-services": [ "realtime-lens-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-lens-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-lens-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-linkedin-data/company-jobs": { "get": { "summary": "Company Jobs", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "request_id", "parameters", "data" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_bc35adccd8b7b722_ref1" } }, "status": { "enum": [ "OK" ], "type": "string" }, "parameters": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_bc35adccd8b7b722_ref0" }, "request_id": { "type": "string" } } } } }, "description": "OK" }, "400": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_bc35adccd8b7b722_ref3" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_bc35adccd8b7b722_ref4" } } }, "description": "No LinkedIn company page exists for a supplied `company` slug, or the route itself is unknown." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_bc35adccd8b7b722_ref4" } } }, "description": "A `company` slug lookup could not reach LinkedIn at all. Deliberately not a 404 — \"we could not ask\" must never be reported as \"no such company\"." } }, "parameters": [ { "in": "query", "name": "company_id", "schema": { "type": "string" }, "required": false, "description": "Comma-separated LinkedIn company ids (`f_C`), up to 10, OR'd together. Take the value from `job_linkedin_company_id` on any job. Either `company_id` or `company` is required; combined, the union is echoed as `parameters.company_ids_resolved`. Ordering is relevance, so a small company paired with a large one may miss page 1." }, { "in": "query", "name": "company", "schema": { "type": "string", "example": "microsoft" }, "example": "microsoft", "required": true, "description": "Comma-separated LinkedIn company vanity slugs or company page URLs, up to 10, resolved live to the ids `company_id` takes. `microsoft`, `/company/microsoft` and a full URL all work. Each slug costs **one extra billed request**. An unknown slug is a 404, and one bad slug fails the whole request." }, { "in": "query", "name": "query", "schema": { "type": "string" }, "required": false, "description": "Optional free-form keyword filter (LinkedIn's `keywords`) applied **within** the selected companies. Omit it to get the company's whole job list — verified live that `f_C` alone is a valid upstream request. Only one `query` is accepted; a second one is rejected with a 400 rather than silently ignored." }, { "in": "query", "name": "location", "schema": { "type": "string" }, "required": false, "description": "Free-text location. Works internationally with no geo id (\"London, United Kingdom\", \"Berlin, Germany\"). Mutually usable with `geo_id`, but `radius` only applies to `geo_id`." }, { "in": "query", "name": "geo_id", "schema": { "type": "string" }, "required": false, "description": "LinkedIn numeric geo id (e.g. `102571732` = New York City, `103644278` = United States). Required if you want `radius` to take effect. There is no geo-id lookup endpoint in this API yet — take the value from a `geoId=` parameter on a linkedin.com/jobs URL." }, { "in": "query", "name": "radius", "schema": { "type": "integer", "minimum": 1 }, "required": false, "description": "Search radius in **kilometres**, converted to the miles LinkedIn expects. Passed through continuously, not as a coarse menu. **Requires `geo_id`.** LinkedIn ignores `distance` with a free-text location, so `radius` without `geo_id` is rejected with a 400 rather than silently doing nothing." }, { "in": "query", "name": "date_posted", "schema": { "enum": [ "all", "today", "3days", "week", "month" ], "type": "string", "default": "all" }, "required": false, "description": "Freshness filter, applied by LinkedIn itself. Maps exactly onto LinkedIn's arbitrary-seconds window (`today` = 24 h, `3days` = 72 h, `week` = 7 d, `month` = 30 d) with no downgrade. `all` applies no filter." }, { "in": "query", "name": "employment_types", "schema": { "enum": [ "FULLTIME", "PARTTIME", "CONTRACTOR", "INTERN" ], "type": "string" }, "required": false, "description": "Comma-separated `FULLTIME`, `PARTTIME`, `CONTRACTOR`, `INTERN`. **Filtered by us, not by LinkedIn**, whose own job-type filter is ignored logged out. Forces `include_details` on and over-fetches up to 3x the requested pages (capped at 10), so expect fewer than `num_pages x 10` results and a higher `Requests` charge." }, { "in": "query", "name": "seniority_levels", "schema": { "enum": [ "Internship", "Entry level", "Associate", "Mid-Senior level", "Director", "Executive", "Not Applicable" ], "type": "string" }, "required": false, "description": "Comma-separated list of LinkedIn's own seniority vocabulary: `Internship`, `Entry level`, `Associate`, `Mid-Senior level`, `Director`, `Executive`, `Not Applicable`.\n **Enforced locally**, with the same cost and caveats as `employment_types`.\n Deliberately LinkedIn's vocabulary rather than a years-of-experience enum: there is\n no defensible mapping from \"Mid-Senior level\" to a year count." }, { "in": "query", "name": "remote_jobs_only", "schema": { "type": "boolean", "default": false }, "required": false, "description": "Return only jobs with an explicit remote marker. **Best-effort and low-recall**: LinkedIn's logged-out payload has no workplace-type field, so this matches a textual marker in the location or title. It under-returns and never over-returns, and most queries return few or no results with it set." }, { "in": "query", "name": "sort_by", "schema": { "enum": [ "relevance", "date" ], "type": "string", "default": "relevance" }, "required": false, "description": "`relevance` leaves LinkedIn's own ordering alone. `date` sorts **the jobs in this response** newest-first — it does not re-rank the result set upstream, because LinkedIn ignores its own `sortBy` on the logged-out surface. Combine with a larger `num_pages` for a more meaningful ordering, or with `date_posted` for real freshness control." }, { "in": "query", "name": "page", "schema": { "type": "integer", "default": 1, "maximum": 100, "minimum": 1 }, "required": false, "description": "1-based page number, 10 jobs per page. Capped at 100 by LinkedIn's 1000-result ceiling; `page + num_pages` may not cross it either." }, { "in": "query", "name": "num_pages", "schema": { "type": "integer", "default": 1, "maximum": 20, "minimum": 1 }, "required": false, "description": "How many consecutive pages to fetch and concatenate, starting at `page`. Values above 20 are rejected with a 400 rather than silently clamped." }, { "in": "query", "name": "include_details", "schema": { "type": "boolean", "default": true }, "required": false, "description": "Fetch each job's detail page to fill the fields a search card cannot carry (description, employment type, salary, seniority, function, industries, applicant count, company id). Set `false` for a card-only response that is roughly 3x faster. Forced on when a local filter is in use." }, { "in": "query", "name": "country", "schema": { "type": "string", "default": "us" }, "required": false, "description": "2-letter country code. Selects the proxy exit market and is the fallback for `job_country` when the posting's own location does not name a country. Geography is driven primarily by `location` / `geo_id`, not by this." }, { "in": "query", "name": "fields", "schema": { "type": "string" }, "required": false, "description": "Comma-separated projection over the job object. `job_id` and `job_title` are always included. An unknown field is a 400." } ], "description": "Every open LinkedIn job posting at one or more companies.\n\nThis is the **same search path** as `/search` with LinkedIn's `f_C` company filter populated — the same parser, the same fetch layer, the same job builder, the same 35-key superset contract and the same `job_id` codec. Every filter `/search` supports is supported here and composes with the company filter; that composition was verified live against `f_C=1035` (Microsoft), checking every card of every probe: `f_C` alone, `+ date_posted`, `+ location`, `+ geo_id` & `radius`, `+ query` and `+ page` each returned 10/10 jobs at the requested company.\n\n**Identifying a company.** Pass `company_id` (numeric, LinkedIn's own id — it is returned on every job as `job_linkedin_company_id`) or `company` (a vanity slug or company page URL, resolved live at the cost of one extra request). Both accept a comma-separated list of up to 10; ids and slugs may be mixed, and the union actually searched is echoed as `parameters.company_ids_resolved`.\n\n**Multiple companies are an OR**, not a round-robin. LinkedIn ranks the union by relevance, so a small company paired with a large one can be absent from page 1 entirely. The guarantee is that every job returned belongs to one of the requested companies — not that every requested company appears.\n\n**`query` is optional here**, unlike on `/search`: the company is the query. Supply it only to filter within the company's postings.\n\n**Pagination, `include_details`, local filters and billing behave exactly as on `/search`**, with one addition: each `company` slug resolution is billed as one request on top of the search pages.\n\n**A company with no open jobs returns an empty array**, and so does a numeric `company_id` that does not exist — LinkedIn answers both with the same empty page. Use `company` (the slug form) when you need a bad identifier to be an error instead.", "operationId": "realtime_linkedin_data__get__company_jobs", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_0prF_Y5BkmqQXtEQyheXN", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_Z5rvTt1qYfVU6DSLLxPnI" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_1_LX_FbWCA7U09K5zzV8z", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_1Y4Iq_rRp239QLf6anxmA" }, { "gaps": [ "Missing full parameter list and response schema" ], "pages": [ 1 ], "sourceId": "sds_5-N-bD-w4FEvDbPufA7rY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/company_id/required", "/description", "/operationId" ], "revisionId": "sdrn_JMX_MdcNKNvBSfEXsR78v" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_AtF5v_vXxTbq1wWfTbZ8p", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_xtbL3_JhQnAYS_6AQGDiQ" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_BowKpX7oIEvSZAa5G-8Cj", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_AlkJCvRexbLp1t3wre1uD" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_D1eKbJ9D0SJoHD3LLOLYI", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_WiAI6D9DA33xLudF2TJIh" }, { "gaps": [ "Missing detailed parameter schema and response structure" ], "pages": [ 1 ], "sourceId": "sds_FK2maa1cDe4qcElj5U3zU", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/company_id/required", "/description", "/operationId" ], "revisionId": "sdrn_gZ-rMsS0AnYbgxe2iW2Nm" }, { "gaps": [ "Missing parameter definitions and response schemas in documentation" ], "pages": [], "sourceId": "sds_fZv-ITvZDV87-KqyW2hgn", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/company_id/required", "/description", "/operationId" ], "revisionId": "sdrn_aohUeFTorAhUkoXJ0nrWa" }, { "gaps": [ "Missing explicit parameter definitions in documentation" ], "pages": [], "sourceId": "sds_jRl0O0t2JNWjX4MjQ_kC5", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/company_id/required", "/description", "/operationId" ], "revisionId": "sdrn_0KHmU6zKJBn3JfGQhhbYP" }, { "gaps": [ "Missing parameter details and response schema" ], "pages": [], "sourceId": "sds_UpX4G0QiFQ_cIhdwzu8pk", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/company_id/required", "/description", "/operationId" ], "revisionId": "sdrn_eR8hqN-7MniZX5AeOeQLh" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_wvqPOTBJ3ELhy96dsub_l", "authority": "supplemental", "conflicts": [ "/summary", "/description" ], "revisionId": "sdrn_f7m9IOfd1EwYpLs8JZOMM" } ], "x-zeroclick-services": [ "realtime-linkedin-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-linkedin-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-linkedin-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-linkedin-data/job-details": { "get": { "summary": "Job Details", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "request_id", "parameters", "data" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_cc9abe91a2846790_ref1" } }, "status": { "enum": [ "OK" ], "type": "string" }, "parameters": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_cc9abe91a2846790_ref0" }, "request_id": { "type": "string" } } } } }, "description": "OK" }, "400": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_cc9abe91a2846790_ref3" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." }, "404": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_cc9abe91a2846790_ref6" } }, "parameters": [ { "in": "query", "name": "job_id", "schema": { "type": "string", "example": "bGlua2VkaW46NDQ1MzY3MDk3Mw" }, "example": "bGlua2VkaW46NDQ1MzY3MDk3Mw", "required": true, "description": "Comma-separated list of up to 20 `job_id` values as returned by `/search`. Duplicates are collapsed before the cap is applied. The raw numeric LinkedIn posting id (`job_uid`) is also accepted." }, { "in": "query", "name": "country", "schema": { "type": "string", "default": "us" }, "required": false, "description": "2-letter country code; selects the proxy exit market." }, { "in": "query", "name": "fields", "schema": { "type": "string" }, "required": false, "description": "Comma-separated projection over the job object. `job_id` and `job_title` are always included. An unknown field is a 400." } ], "description": "Full details for up to 20 LinkedIn job postings in one call, fetched concurrently (bounded to 10 in flight).\n\nThe returned objects carry the same 35-key JSearch contract plus the LinkedIn extras. Two fields exist only on a search card and are therefore always `null` here: `job_position` (LinkedIn's absolute rank within a result set) and `job_posted_at_date` (the exact `datetime` attribute). On this surface the posting date is derived from LinkedIn's relative label (\"1 week ago\") and snapped to midnight UTC, so it can be off by a few days — `/search` is the authoritative source for the exact date.\n\nAn id this API did not mint, or a posting LinkedIn has taken down, is simply absent from the array. It is never an error and never a fabricated shell object.", "operationId": "realtime_linkedin_data__get__job_details", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_0prF_Y5BkmqQXtEQyheXN", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_Z5rvTt1qYfVU6DSLLxPnI" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_1_LX_FbWCA7U09K5zzV8z", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_1Y4Iq_rRp239QLf6anxmA" }, { "gaps": [ "Missing full parameter list and response schema" ], "pages": [ 1 ], "sourceId": "sds_5-N-bD-w4FEvDbPufA7rY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_JMX_MdcNKNvBSfEXsR78v" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_AtF5v_vXxTbq1wWfTbZ8p", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_xtbL3_JhQnAYS_6AQGDiQ" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_BowKpX7oIEvSZAa5G-8Cj", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_AlkJCvRexbLp1t3wre1uD" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_D1eKbJ9D0SJoHD3LLOLYI", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_WiAI6D9DA33xLudF2TJIh" }, { "gaps": [ "Missing detailed parameter schema and response structure" ], "pages": [ 1 ], "sourceId": "sds_FK2maa1cDe4qcElj5U3zU", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_gZ-rMsS0AnYbgxe2iW2Nm" }, { "gaps": [ "Missing parameter definitions and response schemas in documentation" ], "pages": [], "sourceId": "sds_fZv-ITvZDV87-KqyW2hgn", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_aohUeFTorAhUkoXJ0nrWa" }, { "gaps": [ "Missing explicit parameter definitions in documentation" ], "pages": [], "sourceId": "sds_jRl0O0t2JNWjX4MjQ_kC5", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_0KHmU6zKJBn3JfGQhhbYP" }, { "gaps": [ "Missing parameter details and response schema" ], "pages": [], "sourceId": "sds_UpX4G0QiFQ_cIhdwzu8pk", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_eR8hqN-7MniZX5AeOeQLh" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_wvqPOTBJ3ELhy96dsub_l", "authority": "supplemental", "conflicts": [ "/summary", "/description" ], "revisionId": "sdrn_f7m9IOfd1EwYpLs8JZOMM" } ], "x-zeroclick-services": [ "realtime-linkedin-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-linkedin-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-linkedin-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-linkedin-data/search": { "get": { "summary": "Search Jobs", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "request_id", "parameters", "data" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_dd1e400b60677987_ref1" } }, "status": { "enum": [ "OK" ], "type": "string" }, "parameters": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_dd1e400b60677987_ref0" }, "request_id": { "type": "string" } } } } }, "description": "OK" }, "400": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_dd1e400b60677987_ref3" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." }, "404": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_dd1e400b60677987_ref6" } }, "parameters": [ { "in": "query", "name": "query", "schema": { "type": "string", "example": "software engineer" }, "example": "software engineer", "required": true, "description": "Free-form job search query (LinkedIn's `keywords`). Only one `query` is accepted; a second one is rejected with a 400 rather than silently ignored." }, { "in": "query", "name": "location", "schema": { "type": "string" }, "required": false, "description": "Free-text location. Works internationally with no geo id (\"London, United Kingdom\", \"Berlin, Germany\"). Mutually usable with `geo_id`, but `radius` only applies to `geo_id`." }, { "in": "query", "name": "page", "schema": { "type": "integer", "default": 1, "maximum": 100, "minimum": 1 }, "required": false, "description": "1-based page number, 10 jobs per page. Capped at 100 by LinkedIn's 1000-result ceiling; `page + num_pages` may not cross it either." }, { "in": "query", "name": "num_pages", "schema": { "type": "integer", "default": 1, "maximum": 20, "minimum": 1 }, "required": false, "description": "How many consecutive pages to fetch and concatenate, starting at `page`. Values above 20 are rejected with a 400 rather than silently clamped." }, { "in": "query", "name": "geo_id", "schema": { "type": "string" }, "required": false, "description": "LinkedIn numeric geo id (e.g. `102571732` = New York City, `103644278` = United States). Required if you want `radius` to take effect. There is no geo-id lookup endpoint in this API yet — take the value from a `geoId=` parameter on a linkedin.com/jobs URL." }, { "in": "query", "name": "country", "schema": { "type": "string", "default": "us" }, "required": false, "description": "2-letter country code. Selects the proxy exit market and is the fallback for `job_country` when the posting's own location does not name a country. Geography is driven primarily by `location` / `geo_id`, not by this." }, { "in": "query", "name": "sort_by", "schema": { "enum": [ "relevance", "date" ], "type": "string", "default": "relevance" }, "required": false, "description": "`relevance` leaves LinkedIn's own ordering alone. `date` sorts **the jobs in this response** newest-first — it does not re-rank the result set upstream, because LinkedIn ignores its own `sortBy` on the logged-out surface. Combine with a larger `num_pages` for a more meaningful ordering, or with `date_posted` for real freshness control." }, { "in": "query", "name": "date_posted", "schema": { "enum": [ "all", "today", "3days", "week", "month" ], "type": "string", "default": "all" }, "required": false, "description": "Freshness filter, applied by LinkedIn itself. Maps exactly onto LinkedIn's arbitrary-seconds window (`today` = 24 h, `3days` = 72 h, `week` = 7 d, `month` = 30 d) with no downgrade. `all` applies no filter." }, { "in": "query", "name": "employment_types", "schema": { "enum": [ "FULLTIME", "PARTTIME", "CONTRACTOR", "INTERN" ], "type": "string" }, "required": false, "description": "Comma-separated `FULLTIME`, `PARTTIME`, `CONTRACTOR`, `INTERN`. **Filtered by us, not by LinkedIn**, whose own job-type filter is ignored logged out. Forces `include_details` on and over-fetches up to 3x the requested pages (capped at 10), so expect fewer than `num_pages x 10` results and a higher `Requests` charge." }, { "in": "query", "name": "seniority_levels", "schema": { "enum": [ "Internship", "Entry level", "Associate", "Mid-Senior level", "Director", "Executive", "Not Applicable" ], "type": "string" }, "required": false, "description": "Comma-separated list of LinkedIn's own seniority vocabulary: `Internship`, `Entry level`, `Associate`, `Mid-Senior level`, `Director`, `Executive`, `Not Applicable`.\n **Enforced locally**, with the same cost and caveats as `employment_types`.\n Deliberately LinkedIn's vocabulary rather than a years-of-experience enum: there is\n no defensible mapping from \"Mid-Senior level\" to a year count." }, { "in": "query", "name": "company_id", "schema": { "type": "string" }, "required": false, "description": "Restrict results to one LinkedIn company, by its numeric company id (LinkedIn's `f_C`). Applied by LinkedIn itself. The id of any employer in a result is returned as `job_linkedin_company_id`, so \"more jobs at this company\" is a single follow-up call." }, { "in": "query", "name": "remote_jobs_only", "schema": { "type": "boolean", "default": false }, "required": false, "description": "Return only jobs with an explicit remote marker. **Best-effort and low-recall**: LinkedIn's logged-out payload has no workplace-type field, so this matches a textual marker in the location or title. It under-returns and never over-returns, and most queries return few or no results with it set." }, { "in": "query", "name": "include_details", "schema": { "type": "boolean", "default": true }, "required": false, "description": "Fetch each job's detail page to fill the fields a search card cannot carry (description, employment type, salary, seniority, function, industries, applicant count, company id). Set `false` for a card-only response that is roughly 3x faster. Forced on when a local filter is in use." }, { "in": "query", "name": "radius", "schema": { "type": "integer", "minimum": 1 }, "required": false, "description": "Search radius in **kilometres**, converted to the miles LinkedIn expects. Passed through continuously, not as a coarse menu. **Requires `geo_id`.** LinkedIn ignores `distance` with a free-text location, so `radius` without `geo_id` is rejected with a 400 rather than silently doing nothing." }, { "in": "query", "name": "fields", "schema": { "type": "string" }, "required": false, "description": "Comma-separated projection over the job object. `job_id` and `job_title` are always included. An unknown field is a 400." } ], "description": "Search LinkedIn job postings.\n\n**Pagination** is offset-based via `page` / `num_pages`. Page size is fixed at 10 by LinkedIn. Unlike the Bing jobs source, LinkedIn does not repeat a posting across consecutive pages (measured: 300/300 unique ids over 30 contiguous pages), so `num_pages=N` returns exactly `N x 10` jobs up to the end of the result set.\n\n**`include_details` (default `true`)** issues one extra request per job, bounded to 10 concurrent and capped at 100 jobs per request. It is what fills `job_description`, `job_employment_type(s)`, salary, `job_seniority_level`, `job_function`, `job_industries`, `job_applicants_count` and `job_linkedin_company_id` — none of which exist on a search card. Set it to `false` for a ~3x faster, card-only response.\n\n**Knowing when to stop:** the response is a flat array, matching the JSearch `/search` envelope, so there is no `has_more` flag. A page that returns fewer than `num_pages x 10` jobs is the last one, as is `page` 100.\n\n**Billing:** `Requests` counts one per upstream page of 10 actually fetched. Using `employment_types`, `seniority_levels` or `remote_jobs_only` over-fetches up to 3x the requested pages (capped at 10) to refill the page after local filtering, and those extra pages are billed.", "operationId": "realtime_linkedin_data__get__search", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_0prF_Y5BkmqQXtEQyheXN", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_Z5rvTt1qYfVU6DSLLxPnI" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_1_LX_FbWCA7U09K5zzV8z", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_1Y4Iq_rRp239QLf6anxmA" }, { "gaps": [ "Missing full parameter list and response schema" ], "pages": [ 1 ], "sourceId": "sds_5-N-bD-w4FEvDbPufA7rY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_JMX_MdcNKNvBSfEXsR78v" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_AtF5v_vXxTbq1wWfTbZ8p", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_xtbL3_JhQnAYS_6AQGDiQ" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_BowKpX7oIEvSZAa5G-8Cj", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_AlkJCvRexbLp1t3wre1uD" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_D1eKbJ9D0SJoHD3LLOLYI", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_WiAI6D9DA33xLudF2TJIh" }, { "gaps": [ "Missing detailed parameter schema and response structure" ], "pages": [ 1 ], "sourceId": "sds_FK2maa1cDe4qcElj5U3zU", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_gZ-rMsS0AnYbgxe2iW2Nm" }, { "gaps": [ "Missing parameter definitions and response schemas in documentation" ], "pages": [], "sourceId": "sds_fZv-ITvZDV87-KqyW2hgn", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_aohUeFTorAhUkoXJ0nrWa" }, { "gaps": [ "Missing explicit parameter definitions in documentation" ], "pages": [], "sourceId": "sds_jRl0O0t2JNWjX4MjQ_kC5", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_0KHmU6zKJBn3JfGQhhbYP" }, { "gaps": [ "Missing parameter details and response schema" ], "pages": [], "sourceId": "sds_UpX4G0QiFQ_cIhdwzu8pk", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_eR8hqN-7MniZX5AeOeQLh" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_wvqPOTBJ3ELhy96dsub_l", "authority": "supplemental", "conflicts": [ "/summary", "/description" ], "revisionId": "sdrn_f7m9IOfd1EwYpLs8JZOMM" } ], "x-zeroclick-services": [ "realtime-linkedin-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-linkedin-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-linkedin-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-monster-data/company-jobs": { "get": { "summary": "Company Jobs", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "request_id", "parameters", "data" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_59a9ba9486dc2473_ref1" }, "description": "Open jobs at the requested employers, in Monster's relevance order over the union. Empty when no employer matched or none has open jobs." }, "status": { "enum": [ "OK" ], "type": "string", "description": "Always `OK` on a successful response." }, "parameters": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_59a9ba9486dc2473_ref0" }, "request_id": { "type": "string", "description": "Unique id for this request, for tracing and support." } } } } }, "description": "Open jobs at the requested employers." }, "400": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_59a9ba9486dc2473_ref3" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." }, "404": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_59a9ba9486dc2473_ref7" }, "429": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_59a9ba9486dc2473_ref8" }, "500": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_59a9ba9486dc2473_ref9" } }, "parameters": [ { "in": "query", "name": "company", "schema": { "type": "string", "example": "Genentech" }, "example": "Genentech", "required": true, "description": "Comma-separated list of up to 10 employer display names, as returned in\n`employer_name` on any job. A name containing a comma (`Acme, Inc.`) stays one\nemployer. Matching is substring: a misspelling returns nothing, a short name can\nreach longer employers.\n" }, { "in": "query", "name": "query", "schema": { "type": "string" }, "required": false, "description": "Optional free-form keyword filter applied WITHIN the selected employers. Omit it to\nbrowse an employer's whole open job list; the company is the constraint here. Exactly\none `query` is accepted; a second one is a 400.\n" }, { "in": "query", "name": "location", "schema": { "type": "string" }, "required": false, "description": "Free-text location, for example `New York, NY` or `London`. Optional: omit it and the\nsearch runs country-wide over `country`, which returns far more inventory than any\none city. Required if you pass `radius`.\n" }, { "in": "query", "name": "page", "schema": { "type": "integer", "default": 1, "maximum": 51, "minimum": 1 }, "required": false, "description": "1-based page to start from. Each page is 10 jobs. Capped at 51 by Monster's upstream\noffset ceiling of 500, and `page` + `num_pages` may not cross it either.\n\n**Default:** `1`\n\n**Allowed values:** `1-51`\n" }, { "in": "query", "name": "num_pages", "schema": { "type": "integer", "default": 1, "maximum": 20, "minimum": 1 }, "required": false, "description": "How many consecutive pages to fetch and concatenate, starting at `page`. Each page is\n10 jobs and one billed request. A value above 20 returns a 400 error.\n\n**Default:** `1`\n\n**Allowed values:** `1-20`\n" }, { "in": "query", "name": "country", "schema": { "type": "string", "default": "us" }, "required": false, "description": "2-letter country code. Selects both the Monster locale the search runs on and the\nmarket searched, and both matter: a country's own locale returned 1.35x to 6.9x the\ninventory `en-US` did.\n\n**Coverage.** `us`, `gb`, `ca`, `ie`, `fr`, `be`, `nl`, `es`, `se`, `ch`, `at`, `it`\nand `lu` each search their own Monster locale. Monster's index has no jobs at all for\n`de`, `au`, `nz`, `in`, `sg`, `hk`, `ph`, `my`, `mx` and `br`, so those return an empty\narray. Any other country is accepted and searched on the `en-US` locale.\n\n**Default:** `us`\n" }, { "in": "query", "name": "date_posted", "schema": { "enum": [ "all", "today", "3days", "week", "month" ], "type": "string", "default": "all" }, "required": false, "description": "Only return jobs posted within this window, applied by Monster server-side with no\ndowngrade. Monster filters on its own refresh date, so a returned job's\n`job_posted_at` can be older than the window. `all` sends no filter.\n\n**Default:** `all`\n\n**Allowed values:** `all`, `today`, `3days`, `week`, `month`\n" }, { "in": "query", "name": "employment_types", "schema": { "enum": [ "FULLTIME", "PARTTIME", "CONTRACTOR", "INTERN" ], "type": "string" }, "required": false, "description": "Comma-separated employment types. Applied by Monster server-side, and OR-ed: a job\nmatching any listed type is returned. An unrecognised value is a 400, because Monster\nitself rejects one.\n\n**Allowed values:** `FULLTIME`, `PARTTIME`, `CONTRACTOR`, `INTERN`\n" }, { "in": "query", "name": "radius", "schema": { "type": "integer", "maximum": 160, "minimum": 1 }, "required": false, "description": "Search radius around `location`, in KILOMETRES, converted to the miles Monster\nexpects. Requires `location`; Monster ignores a radius on a country-wide search, so\nthat combination is a 400. Past the maximum Monster returns nothing, so an\nout-of-range value is also a 400.\n\n**Allowed values:** `1-160`\n" }, { "in": "query", "name": "fields", "schema": { "type": "string" }, "required": false, "description": "Comma-separated projection over the job object, for example\n`job_title,employer_name,job_apply_link`. `job_id` and `job_title` are always\nincluded. An unknown field name is a 400.\n" } ], "description": "Every open Monster job posting at one or more employers.\n\nThis is the **same search path** as `/search` with Monster's `companyDisplayNames` filter\npopulated: the same fetch layer, the same parser, the same job builder, the same job\ncontract and the same `job_id` codec. `location`, `radius`, `country`, `date_posted`,\n`employment_types`, `page`, `num_pages` and `fields` all behave exactly as they do on\n`/search`.\n\n**Identifying an employer.** Monster publishes no company id, so the match is on the\nDISPLAY NAME, which is the string returned as `employer_name` on any job. `Genentech`\nworks, while a slug such as `genentech-inc`, a URL, or a misspelling returns nothing. It\nis a SUBSTRING match, so a short name also reaches longer employers containing it\n(`Lines` reaches `Melton Truck Lines` and `Florida Rock & Tank Lines`); pass the full\n`employer_name` and it behaves as an exact match. The company filter is what finds them:\n`query=Genentech` returned 0 rows where the company filter returned 7.\n\n**A comma inside a name is safe.** The list separator is a comma and most US employer\nnames end in one (`Cross Country Healthcare, Inc.`). A trailing fragment that is only a\ncorporate suffix is rejoined to the name before it, so `Cross Country Healthcare, Inc.`\nis one employer while `Genentech,Deloitte` is still two.\n\n**Multiple employers are an OR.** Monster ranks the union by relevance, so a small\nemployer paired with a large one can be absent from page 1 entirely. What is guaranteed\nis that every job returned belongs to one of the requested employers.\n\n**`query` is optional here**, unlike on `/search`: the employer is the constraint. So is\n`location`, so a caller can browse one employer country-wide.\n\n**`sort_by`, `remote_jobs_only` and `language` are ignored on this endpoint.** Use\n`/search` for those.\n\n**An employer with no open jobs returns an empty array**, and so does a name Monster does\nnot recognise. With no id to validate against, the two cases are indistinguishable.\n\n**Billing:** identical to `/search`. `Requests` counts one per upstream page of 10\nactually fetched.\n", "operationId": "realtime_monster_data__get__company_jobs", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_0prF_Y5BkmqQXtEQyheXN", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_Z5rvTt1qYfVU6DSLLxPnI" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_1_LX_FbWCA7U09K5zzV8z", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_1Y4Iq_rRp239QLf6anxmA" }, { "gaps": [ "Missing full parameter list and response schema" ], "pages": [ 1 ], "sourceId": "sds_5-N-bD-w4FEvDbPufA7rY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/company_id", "/description", "/operationId" ], "revisionId": "sdrn_JMX_MdcNKNvBSfEXsR78v" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_AtF5v_vXxTbq1wWfTbZ8p", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_xtbL3_JhQnAYS_6AQGDiQ" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_BowKpX7oIEvSZAa5G-8Cj", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_AlkJCvRexbLp1t3wre1uD" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_D1eKbJ9D0SJoHD3LLOLYI", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_WiAI6D9DA33xLudF2TJIh" }, { "gaps": [ "Missing detailed parameter schema and response structure" ], "pages": [ 1 ], "sourceId": "sds_FK2maa1cDe4qcElj5U3zU", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/company_id", "/description", "/operationId" ], "revisionId": "sdrn_gZ-rMsS0AnYbgxe2iW2Nm" }, { "gaps": [ "Missing parameter definitions and response schemas in documentation" ], "pages": [], "sourceId": "sds_fZv-ITvZDV87-KqyW2hgn", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/company_id", "/description", "/operationId" ], "revisionId": "sdrn_aohUeFTorAhUkoXJ0nrWa" }, { "gaps": [ "Missing explicit parameter definitions in documentation" ], "pages": [], "sourceId": "sds_jRl0O0t2JNWjX4MjQ_kC5", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/company_name", "/description", "/operationId" ], "revisionId": "sdrn_0KHmU6zKJBn3JfGQhhbYP" }, { "gaps": [ "Missing parameter details and response schema" ], "pages": [], "sourceId": "sds_UpX4G0QiFQ_cIhdwzu8pk", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/company_id", "/description", "/operationId" ], "revisionId": "sdrn_eR8hqN-7MniZX5AeOeQLh" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_wvqPOTBJ3ELhy96dsub_l", "authority": "supplemental", "conflicts": [ "/summary", "/description" ], "revisionId": "sdrn_f7m9IOfd1EwYpLs8JZOMM" } ], "x-zeroclick-services": [ "realtime-monster-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-monster-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-monster-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-monster-data/job-details": { "get": { "summary": "Job Details", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "request_id", "parameters", "data" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_7edaea634ecba4a7_ref1" }, "description": "The resolved jobs, in the order their ids were supplied. Ids Monster does not know are omitted, so this array can be shorter than the id list." }, "status": { "enum": [ "OK" ], "type": "string", "description": "Always `OK` on a successful response." }, "parameters": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_7edaea634ecba4a7_ref0" }, "request_id": { "type": "string", "description": "Unique id for this request, for tracing and support." } } } } }, "description": "The requested jobs, in the order the ids were supplied." }, "400": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_7edaea634ecba4a7_ref3" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." }, "404": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_7edaea634ecba4a7_ref7" }, "429": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_7edaea634ecba4a7_ref8" }, "500": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_7edaea634ecba4a7_ref9" } }, "parameters": [ { "in": "query", "name": "job_id", "schema": { "type": "string", "example": "bW9uc3RlcjplNzc2MTJmNS1iYjNiLTQ2NWUtYTk2NS00MzlhZjk0MDk0YmQ" }, "example": "bW9uc3RlcjplNzc2MTJmNS1iYjNiLTQ2NWUtYTk2NS00MzlhZjk0MDk0YmQ", "required": true, "description": "Comma-separated job ids from a `/search` response, up to 20 per request. Monster's own\n`job_uid`, a full `job_seo_id`, and a monster.com job URL are accepted too. Duplicates\nare collapsed before the cap applies.\n" }, { "in": "query", "name": "country", "schema": { "type": "string", "default": "us" }, "required": false, "description": "2-letter country code. Selects the Monster locale the detail lookup runs on, and is\nthe fallback for `job_country` when the posting itself names no country.\n\n**Default:** `us`\n" }, { "in": "query", "name": "fields", "schema": { "type": "string" }, "required": false, "description": "Comma-separated projection over the job object, for example\n`job_title,employer_name,job_apply_link`. `job_id` and `job_title` are always\nincluded. An unknown field name is a 400.\n" } ], "description": "Full detail for up to 20 Monster job postings in one call, fetched concurrently and\nbounded to 10 in flight.\n\n**This is a lookup.** A Monster search row already IS the detail object: description,\nsalary, coordinates and apply URL are all present on `/search`, and the detail endpoint\nreturns the same object. Use it to re-resolve ids you stored earlier.\n\nThree id shapes are accepted: the `job_id` this API mints, Monster's own `job_uid`, and a\nfull `job_seo_id` or a monster.com job URL containing one. Monster resolves the last two\nitself and returns a byte-identical posting either way.\n\nAn id Monster does not know, or a posting it has taken down, is omitted from the array\nwhile the rest of the batch resolves normally, and a request made entirely of foreign ids\nis a 200 with an empty array.\n\n**Billing:** `Requests` counts one per requested id, including ids that turn out to be\nunknown, so the cost of a call is predictable before you make it.\n", "operationId": "realtime_monster_data__get__job_details", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_0prF_Y5BkmqQXtEQyheXN", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_Z5rvTt1qYfVU6DSLLxPnI" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_1_LX_FbWCA7U09K5zzV8z", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_1Y4Iq_rRp239QLf6anxmA" }, { "gaps": [ "Missing full parameter list and response schema" ], "pages": [ 1 ], "sourceId": "sds_5-N-bD-w4FEvDbPufA7rY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_JMX_MdcNKNvBSfEXsR78v" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_AtF5v_vXxTbq1wWfTbZ8p", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_xtbL3_JhQnAYS_6AQGDiQ" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_BowKpX7oIEvSZAa5G-8Cj", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_AlkJCvRexbLp1t3wre1uD" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_D1eKbJ9D0SJoHD3LLOLYI", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_WiAI6D9DA33xLudF2TJIh" }, { "gaps": [ "Missing detailed parameter schema and response structure" ], "pages": [ 1 ], "sourceId": "sds_FK2maa1cDe4qcElj5U3zU", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_gZ-rMsS0AnYbgxe2iW2Nm" }, { "gaps": [ "Missing parameter definitions and response schemas in documentation" ], "pages": [], "sourceId": "sds_fZv-ITvZDV87-KqyW2hgn", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_aohUeFTorAhUkoXJ0nrWa" }, { "gaps": [ "Missing explicit parameter definitions in documentation" ], "pages": [], "sourceId": "sds_jRl0O0t2JNWjX4MjQ_kC5", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_0KHmU6zKJBn3JfGQhhbYP" }, { "gaps": [ "Missing parameter details and response schema" ], "pages": [], "sourceId": "sds_UpX4G0QiFQ_cIhdwzu8pk", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_eR8hqN-7MniZX5AeOeQLh" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_wvqPOTBJ3ELhy96dsub_l", "authority": "supplemental", "conflicts": [ "/summary", "/description" ], "revisionId": "sdrn_f7m9IOfd1EwYpLs8JZOMM" } ], "x-zeroclick-services": [ "realtime-monster-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-monster-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-monster-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-monster-data/search": { "get": { "summary": "Search Jobs", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "request_id", "parameters", "data" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_78715484d3239c04_ref1" }, "description": "Matching jobs, in Monster's ranking order for the requested window." }, "status": { "enum": [ "OK" ], "type": "string", "description": "Always `OK` on a successful response." }, "parameters": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_78715484d3239c04_ref0" }, "request_id": { "type": "string", "description": "Unique id for this request, for tracing and support." } } } } }, "description": "Matching jobs." }, "400": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_78715484d3239c04_ref3" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." }, "404": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_78715484d3239c04_ref7" }, "429": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_78715484d3239c04_ref8" }, "500": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_78715484d3239c04_ref9" } }, "parameters": [ { "in": "query", "name": "query", "schema": { "type": "string", "example": "software engineer" }, "example": "software engineer", "required": true, "description": "Free-form job search query, for example `software engineer` or `registered nurse`.\nRequired: Monster returns nothing for a search with no query, no location and no\ncompany. Exactly one `query` is accepted; a second one is a 400.\n" }, { "in": "query", "name": "location", "schema": { "type": "string" }, "required": false, "description": "Free-text location, for example `New York, NY` or `London`. Optional: omit it and the\nsearch runs country-wide over `country`, which returns far more inventory than any\none city. Required if you pass `radius`.\n" }, { "in": "query", "name": "page", "schema": { "type": "integer", "default": 1, "maximum": 51, "minimum": 1 }, "required": false, "description": "1-based page to start from. Each page is 10 jobs. Capped at 51 by Monster's upstream\noffset ceiling of 500, and `page` + `num_pages` may not cross it either.\n\n**Default:** `1`\n\n**Allowed values:** `1-51`\n" }, { "in": "query", "name": "num_pages", "schema": { "type": "integer", "default": 1, "maximum": 20, "minimum": 1 }, "required": false, "description": "How many consecutive pages to fetch and concatenate, starting at `page`. Each page is\n10 jobs and one billed request. A value above 20 returns a 400 error.\n\n**Default:** `1`\n\n**Allowed values:** `1-20`\n" }, { "in": "query", "name": "country", "schema": { "type": "string", "default": "us" }, "required": false, "description": "2-letter country code. Selects both the Monster locale the search runs on and the\nmarket searched, and both matter: a country's own locale returned 1.35x to 6.9x the\ninventory `en-US` did.\n\n**Coverage.** `us`, `gb`, `ca`, `ie`, `fr`, `be`, `nl`, `es`, `se`, `ch`, `at`, `it`\nand `lu` each search their own Monster locale. Monster's index has no jobs at all for\n`de`, `au`, `nz`, `in`, `sg`, `hk`, `ph`, `my`, `mx` and `br`, so those return an empty\narray. Any other country is accepted and searched on the `en-US` locale.\n\n**Default:** `us`\n" }, { "in": "query", "name": "language", "schema": { "type": "string" }, "required": false, "description": "The language your `query` text is written in, as an `xx-xx` code such as `en-us` or\n`fr-fr`. It picks Monster's keyword analyser, so the postings come back in whatever\nlanguage Monster published them. Omitted, Monster derives it from `country`. A\nmalformed code is a 400.\n" }, { "in": "query", "name": "sort_by", "schema": { "enum": [ "relevance", "date" ], "type": "string", "default": "relevance" }, "required": false, "description": "`relevance` leaves Monster's own ordering alone. `date` sorts the jobs in THIS\nresponse newest-first, applied locally because Monster ignores its own `orderBy`.\nPair it with `date_posted` for real freshness control.\n\n**Default:** `relevance`\n\n**Allowed values:** `relevance`, `date`\n" }, { "in": "query", "name": "date_posted", "schema": { "enum": [ "all", "today", "3days", "week", "month" ], "type": "string", "default": "all" }, "required": false, "description": "Only return jobs posted within this window, applied by Monster server-side with no\ndowngrade. Monster filters on its own refresh date, so a returned job's\n`job_posted_at` can be older than the window. `all` sends no filter.\n\n**Default:** `all`\n\n**Allowed values:** `all`, `today`, `3days`, `week`, `month`\n" }, { "in": "query", "name": "employment_types", "schema": { "enum": [ "FULLTIME", "PARTTIME", "CONTRACTOR", "INTERN" ], "type": "string" }, "required": false, "description": "Comma-separated employment types. Applied by Monster server-side, and OR-ed: a job\nmatching any listed type is returned. An unrecognised value is a 400, because Monster\nitself rejects one.\n\n**Allowed values:** `FULLTIME`, `PARTTIME`, `CONTRACTOR`, `INTERN`\n" }, { "in": "query", "name": "remote_jobs_only", "schema": { "type": "boolean", "default": false }, "required": false, "description": "Return only remote jobs. On its own this is a real Monster filter. Combined with\n`employment_types` it becomes a local filter, because Monster ORs the two upstream:\nit then under-returns, keeping only jobs Monster explicitly marks remote, and costs\nextra billed pages.\n\n**Default:** `false`\n" }, { "in": "query", "name": "radius", "schema": { "type": "integer", "maximum": 160, "minimum": 1 }, "required": false, "description": "Search radius around `location`, in KILOMETRES, converted to the miles Monster\nexpects. Requires `location`; Monster ignores a radius on a country-wide search, so\nthat combination is a 400. Past the maximum Monster returns nothing, so an\nout-of-range value is also a 400.\n\n**Allowed values:** `1-160`\n" }, { "in": "query", "name": "fields", "schema": { "type": "string" }, "required": false, "description": "Comma-separated projection over the job object, for example\n`job_title,employer_name,job_apply_link`. `job_id` and `job_title` are always\nincluded. An unknown field name is a 400.\n" } ], "description": "Search Monster job postings by keyword, with the filters Monster honors server-side:\n`location` with a kilometre `radius`, `country`, `date_posted` and `employment_types`.\n\n**A search row already carries the whole job.** Description, salary, coordinates and the\napply URL are all on the search response.\n\n**Pagination** is offset-based via `page` / `num_pages`, 10 jobs per page. Pages are\nchained upstream: a full walk of the retrievable window at Monster's own maximum page\nsize returned 550 rows, 550 unique ids and zero duplicates.\n\n**Retrieval ceiling: 510 postings per query.** Monster serves nothing past an upstream\noffset of 500 and does so silently, with a 200 and an empty array, so `page` is capped\nat 51 and `page` + `num_pages` may not cross it. This is independent of the much larger\nestimated total Monster reports internally for the same query.\n\n**Knowing when to stop:** the response is a flat array of jobs, and page 51 is the\nlast page. Short pages do occur inside the window, so a page of fewer than 10 jobs is\nstill a page in the middle of it.\n\n**Billing:** `Requests` counts one per upstream page of 10 actually fetched. Two things\nadd to it, and both are visible in the `X-RapidAPI-Billing` header.\nAny `page` above 1 costs **one extra request**: Monster ignores the offset on the first\ncall of a new search and serves the head of the list, so a deep start has to pin the\nresult set with a tiny lookup before it can page into it. That is one extra request no\nmatter how deep you start. And combining `remote_jobs_only` with `employment_types`\nover-fetches up to 3x the requested pages (capped at 10) to refill the page after local\nfiltering, and those extra pages are billed too.\n", "operationId": "realtime_monster_data__get__search", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_0prF_Y5BkmqQXtEQyheXN", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_Z5rvTt1qYfVU6DSLLxPnI" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_1_LX_FbWCA7U09K5zzV8z", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_1Y4Iq_rRp239QLf6anxmA" }, { "gaps": [ "Missing full parameter list and response schema" ], "pages": [ 1 ], "sourceId": "sds_5-N-bD-w4FEvDbPufA7rY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_JMX_MdcNKNvBSfEXsR78v" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_AtF5v_vXxTbq1wWfTbZ8p", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_xtbL3_JhQnAYS_6AQGDiQ" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_BowKpX7oIEvSZAa5G-8Cj", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_AlkJCvRexbLp1t3wre1uD" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_D1eKbJ9D0SJoHD3LLOLYI", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_WiAI6D9DA33xLudF2TJIh" }, { "gaps": [ "Missing detailed parameter schema and response structure" ], "pages": [ 1 ], "sourceId": "sds_FK2maa1cDe4qcElj5U3zU", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_gZ-rMsS0AnYbgxe2iW2Nm" }, { "gaps": [ "Missing parameter definitions and response schemas in documentation" ], "pages": [], "sourceId": "sds_fZv-ITvZDV87-KqyW2hgn", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_aohUeFTorAhUkoXJ0nrWa" }, { "gaps": [ "Missing explicit parameter definitions in documentation" ], "pages": [], "sourceId": "sds_jRl0O0t2JNWjX4MjQ_kC5", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_0KHmU6zKJBn3JfGQhhbYP" }, { "gaps": [ "Missing parameter details and response schema" ], "pages": [], "sourceId": "sds_UpX4G0QiFQ_cIhdwzu8pk", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_eR8hqN-7MniZX5AeOeQLh" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_wvqPOTBJ3ELhy96dsub_l", "authority": "supplemental", "conflicts": [ "/summary", "/description" ], "revisionId": "sdrn_f7m9IOfd1EwYpLs8JZOMM" } ], "x-zeroclick-services": [ "realtime-monster-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-monster-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-monster-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-news-data/full-story-coverage": { "get": { "summary": "Full Story Coverage", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "top_news": { "type": "array", "items": { "type": "object", "properties": { "link": { "type": "string", "description": "The URL to the full news article" }, "title": { "type": "string", "description": "The title of the news article" }, "snippet": { "type": "string", "description": "A short excerpt from the news article" }, "photo_url": { "type": "string", "description": "URL of the article's main photo" }, "source_url": { "type": "string", "description": "URL of the news source" }, "source_name": { "type": "string", "description": "Name of the news source" }, "thumbnail_url": { "type": "string", "description": "URL of the article's thumbnail image" }, "source_logo_url": { "type": "string", "description": "URL of the news source's logo" }, "source_favicon_url": { "type": "string", "description": "URL of the news source's favicon" }, "source_publication_id": { "type": "string", "description": "Unique identifier of the news source publication" }, "published_datetime_utc": { "type": "string", "description": "Publication date and time in UTC format" } } } }, "all_articles": { "type": "array", "items": { "type": "object" }, "description": "Full list of news articles covering the story across publishers." }, "twitter_posts": { "type": "array", "items": { "type": "object", "properties": { "link": { "type": "string", "description": "URL to the Twitter post" }, "photo": { "type": "string", "description": "URL of any photo attached to the tweet" }, "post_id": { "type": "string", "description": "Unique identifier of the Twitter post" }, "snippet": { "type": "string", "description": "A short excerpt from the Twitter post" }, "post_datetime_utc": { "type": "string", "description": "Date and time of the tweet in UTC format" }, "post_author_picture": { "type": "string", "description": "URL of the author's profile picture" }, "post_author_username": { "type": "string", "description": "Twitter username of the post author" } } } } } }, "status": { "type": "string", "description": "The status of the response" }, "request_id": { "type": "string", "description": "A unique identifier for the request" } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "story", "schema": { "type": "string", "example": "CAAqNggKIjBDQklTSGpvSmMzUnZjbmt0TXpZd1NoRUtEd2pzbFA3X0N4RjlDUlpVVnhudXBpZ0FQAQ" }, "example": "CAAqNggKIjBDQklTSGpvSmMzUnZjbmt0TXpZd1NoRUtEd2pzbFA3X0N4RjlDUlpVVnhudXBpZ0FQAQ", "required": true, "description": "The Story ID for which to get full coverage. \n Story IDs are returned for news articles with sub_articles from any of the endpoint returning news articles. \n In addition, Story IDs can be obtained from a News Story URL as it appears after the stories/path part (e.g. /stories/CAAqNggKIjBDQklTSGpvSmMzUnZjbmt0TXpZd1NoRUtEd2pzbFA3X0N4RjlDUlpVVnhudXBpZ0FQAQ) after navigating to an article's Full Coverage." }, { "in": "query", "name": "sort", "schema": { "enum": [ "RELEVANCE", "DATE" ], "type": "string" }, "description": "Return articles (i.e. all_articles list) in a specific sort order." } ], "description": "Get the full story coverage, including all sub articles, top news, and posts from X (formerly Twitter).", "operationId": "realtime_news_data__get__full_story_coverage", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_0prF_Y5BkmqQXtEQyheXN", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_Z5rvTt1qYfVU6DSLLxPnI" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_1_LX_FbWCA7U09K5zzV8z", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_1Y4Iq_rRp239QLf6anxmA" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_AtF5v_vXxTbq1wWfTbZ8p", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_xtbL3_JhQnAYS_6AQGDiQ" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_BowKpX7oIEvSZAa5G-8Cj", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_AlkJCvRexbLp1t3wre1uD" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_D1eKbJ9D0SJoHD3LLOLYI", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_WiAI6D9DA33xLudF2TJIh" }, { "gaps": [ "Missing parameter definitions and response schemas in documentation" ], "pages": [], "sourceId": "sds_fZv-ITvZDV87-KqyW2hgn", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/story_id", "/description", "/operationId" ], "revisionId": "sdrn_aohUeFTorAhUkoXJ0nrWa" }, { "gaps": [ "Missing explicit parameter definitions in documentation" ], "pages": [], "sourceId": "sds_jRl0O0t2JNWjX4MjQ_kC5", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/story_id", "/description", "/operationId" ], "revisionId": "sdrn_0KHmU6zKJBn3JfGQhhbYP" }, { "gaps": [ "Missing parameter details and response schema" ], "pages": [], "sourceId": "sds_UpX4G0QiFQ_cIhdwzu8pk", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/story_id", "/description", "/operationId" ], "revisionId": "sdrn_eR8hqN-7MniZX5AeOeQLh" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_wvqPOTBJ3ELhy96dsub_l", "authority": "supplemental", "conflicts": [ "/summary", "/description" ], "revisionId": "sdrn_f7m9IOfd1EwYpLs8JZOMM" } ], "x-zeroclick-services": [ "realtime-news-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-news-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-news-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-news-data/language-list": { "get": { "summary": "Language List", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "lang": { "type": "string", "description": "The language associated with the data entry" }, "name": { "type": "string", "description": "The name associated with the data entry" } } }, "description": "A list of data objects" }, "status": { "type": "string", "description": "The status of the response" }, "request_id": { "type": "string", "description": "A unique identifier for the request" } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "country", "schema": { "type": "string", "example": "us" }, "example": "us", "required": true, "description": "Country code of the country to get languages for. See all available country codes." } ], "description": "Get valid languages for a country code, to be used with all other APIs.", "operationId": "realtime_news_data__get__language_list", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_0prF_Y5BkmqQXtEQyheXN", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_Z5rvTt1qYfVU6DSLLxPnI" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_1_LX_FbWCA7U09K5zzV8z", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_1Y4Iq_rRp239QLf6anxmA" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_AtF5v_vXxTbq1wWfTbZ8p", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_xtbL3_JhQnAYS_6AQGDiQ" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_BowKpX7oIEvSZAa5G-8Cj", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_AlkJCvRexbLp1t3wre1uD" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_D1eKbJ9D0SJoHD3LLOLYI", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_WiAI6D9DA33xLudF2TJIh" }, { "gaps": [ "Missing response schemas in documentation" ], "pages": [], "sourceId": "sds_fZv-ITvZDV87-KqyW2hgn", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_aohUeFTorAhUkoXJ0nrWa" }, { "gaps": [], "pages": [], "sourceId": "sds_jRl0O0t2JNWjX4MjQ_kC5", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_0KHmU6zKJBn3JfGQhhbYP" }, { "gaps": [ "Missing response schema" ], "pages": [], "sourceId": "sds_UpX4G0QiFQ_cIhdwzu8pk", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_eR8hqN-7MniZX5AeOeQLh" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_wvqPOTBJ3ELhy96dsub_l", "authority": "supplemental", "conflicts": [ "/summary", "/description" ], "revisionId": "sdrn_f7m9IOfd1EwYpLs8JZOMM" } ], "x-zeroclick-services": [ "realtime-news-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-news-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-news-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-news-data/local-headlines": { "get": { "summary": "Local Headlines (Geo)", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "required": [ "title", "link" ], "properties": { "link": { "type": "string", "description": "Canonical URL of the article." }, "title": { "type": "string", "description": "Headline of the news article." }, "authors": { "type": "array", "items": { "type": "string", "description": "A single author name." }, "nullable": true, "description": "Author names credited on the article." }, "snippet": { "type": "string", "nullable": true, "description": "Short excerpt of the article body." }, "photo_url": { "type": "string", "nullable": true, "description": "URL of the article's lead image." }, "source_url": { "type": "string", "nullable": true, "description": "Homepage URL of the source publisher." }, "source_name": { "type": "string", "nullable": true, "description": "Publisher name of the source." }, "thumbnail_url": { "type": "string", "nullable": true, "description": "URL of the article's thumbnail image." }, "related_topics": { "type": "array", "items": { "type": "object", "required": [ "topic_id", "topic_name" ], "properties": { "topic_id": { "type": "string", "description": "Google News topic ID." }, "topic_name": { "type": "string", "description": "Topic display name." } } }, "nullable": true, "description": "Related Google News topics surfaced for the article." }, "source_logo_url": { "type": "string", "nullable": true, "description": "URL of the source publisher's logo." }, "source_favicon_url": { "type": "string", "nullable": true, "description": "URL of the source publisher's favicon." }, "source_publication_id": { "type": "string", "nullable": true, "description": "Google News publication ID of the source." }, "published_datetime_utc": { "type": "string", "nullable": true, "description": "ISO 8601 UTC datetime of original publication." } } }, "description": "Local headline news articles for the requested locale." }, "status": { "type": "string", "description": "The status of the response." }, "request_id": { "type": "string", "description": "A unique identifier for the request." } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "query", "schema": { "type": "string", "example": "New York" }, "example": "New York", "required": true, "description": "Area, city or country to fetch news for (e.g. London)." }, { "in": "query", "name": "country", "schema": { "type": "string", "default": "us" }, "description": "Country code. See all available country codes." }, { "in": "query", "name": "language", "schema": { "type": "string", "default": "en" }, "description": "The language to use for the results, specified as a 2-letter language code - see ISO 639-1 alpha-2." }, { "in": "query", "name": "limit", "schema": { "type": "integer", "default": 500, "maximum": 500, "minimum": 1 }, "description": "Maximum number of news articles to return." } ], "description": "Get local, geo based headlines.", "operationId": "realtime_news_data__get__local_headlines", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_0prF_Y5BkmqQXtEQyheXN", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_Z5rvTt1qYfVU6DSLLxPnI" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_1_LX_FbWCA7U09K5zzV8z", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_1Y4Iq_rRp239QLf6anxmA" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_AtF5v_vXxTbq1wWfTbZ8p", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_xtbL3_JhQnAYS_6AQGDiQ" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_BowKpX7oIEvSZAa5G-8Cj", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_AlkJCvRexbLp1t3wre1uD" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_D1eKbJ9D0SJoHD3LLOLYI", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_WiAI6D9DA33xLudF2TJIh" }, { "gaps": [ "Missing parameter definitions and response schemas in documentation" ], "pages": [], "sourceId": "sds_fZv-ITvZDV87-KqyW2hgn", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/location", "/description", "/operationId" ], "revisionId": "sdrn_aohUeFTorAhUkoXJ0nrWa" }, { "gaps": [ "Missing explicit parameter definitions in documentation" ], "pages": [], "sourceId": "sds_jRl0O0t2JNWjX4MjQ_kC5", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/location", "/description", "/operationId" ], "revisionId": "sdrn_0KHmU6zKJBn3JfGQhhbYP" }, { "gaps": [ "Missing parameter details and response schema" ], "pages": [], "sourceId": "sds_UpX4G0QiFQ_cIhdwzu8pk", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/location", "/description", "/operationId" ], "revisionId": "sdrn_eR8hqN-7MniZX5AeOeQLh" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_wvqPOTBJ3ELhy96dsub_l", "authority": "supplemental", "conflicts": [ "/summary", "/description" ], "revisionId": "sdrn_f7m9IOfd1EwYpLs8JZOMM" } ], "x-zeroclick-services": [ "realtime-news-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-news-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-news-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-news-data/search": { "get": { "summary": "Search", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "required": [ "title", "link" ], "properties": { "link": { "type": "string", "description": "Canonical URL of the article." }, "title": { "type": "string", "description": "Headline of the news article." }, "authors": { "type": "array", "items": { "type": "string", "description": "A single author name." }, "nullable": true, "description": "Author names credited on the article." }, "snippet": { "type": "string", "nullable": true, "description": "Short excerpt of the article body." }, "photo_url": { "type": "string", "nullable": true, "description": "URL of the article's lead image." }, "source_url": { "type": "string", "nullable": true, "description": "Homepage URL of the source publisher." }, "source_name": { "type": "string", "nullable": true, "description": "Publisher name of the source." }, "thumbnail_url": { "type": "string", "nullable": true, "description": "URL of the article's thumbnail image." }, "related_topics": { "type": "array", "items": { "type": "object", "required": [ "topic_id", "topic_name" ], "properties": { "topic_id": { "type": "string", "description": "Google News topic ID." }, "topic_name": { "type": "string", "description": "Topic display name." } } }, "nullable": true, "description": "Related Google News topics surfaced for the article." }, "source_logo_url": { "type": "string", "nullable": true, "description": "URL of the source publisher's logo." }, "source_favicon_url": { "type": "string", "nullable": true, "description": "URL of the source publisher's favicon." }, "source_publication_id": { "type": "string", "nullable": true, "description": "Google News publication ID of the source." }, "published_datetime_utc": { "type": "string", "nullable": true, "description": "ISO 8601 UTC datetime of original publication." } } }, "description": "News article results matching the search query." }, "status": { "type": "string", "description": "The status of the response." }, "request_id": { "type": "string", "description": "A unique identifier for the request." } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "query", "schema": { "type": "string", "example": "Elon Musk" }, "example": "Elon Musk", "required": true, "description": "Search query for which to get news." }, { "in": "query", "name": "limit", "schema": { "type": "integer", "default": 10, "maximum": 500, "minimum": 1 }, "description": "Maximum number of news articles to return." }, { "in": "query", "name": "time_published", "schema": { "type": "string", "default": "anytime" }, "description": "Find news articles published in a specific time range." }, { "in": "query", "name": "source", "schema": { "type": "string" }, "description": "Domain of the source from which to return news articles." }, { "in": "query", "name": "country", "schema": { "type": "string", "default": "us" }, "description": "Country code. See all available country codes." }, { "in": "query", "name": "language", "schema": { "type": "string", "default": "en" }, "description": "The language to use for the results, specified as a 2-letter language code - see ISO 639-1 alpha-2." } ], "description": "Search news articles by query with an option to limit the results to a specific time range.", "operationId": "realtime_news_data__get__search", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_0prF_Y5BkmqQXtEQyheXN", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_Z5rvTt1qYfVU6DSLLxPnI" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_1_LX_FbWCA7U09K5zzV8z", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_1Y4Iq_rRp239QLf6anxmA" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_AtF5v_vXxTbq1wWfTbZ8p", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_xtbL3_JhQnAYS_6AQGDiQ" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_BowKpX7oIEvSZAa5G-8Cj", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_AlkJCvRexbLp1t3wre1uD" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_D1eKbJ9D0SJoHD3LLOLYI", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_WiAI6D9DA33xLudF2TJIh" }, { "gaps": [ "Missing parameter definitions and response schemas in documentation" ], "pages": [], "sourceId": "sds_fZv-ITvZDV87-KqyW2hgn", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_aohUeFTorAhUkoXJ0nrWa" }, { "gaps": [ "Missing explicit parameter definitions in documentation" ], "pages": [], "sourceId": "sds_jRl0O0t2JNWjX4MjQ_kC5", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_0KHmU6zKJBn3JfGQhhbYP" }, { "gaps": [ "Missing parameter details and response schema" ], "pages": [], "sourceId": "sds_UpX4G0QiFQ_cIhdwzu8pk", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_eR8hqN-7MniZX5AeOeQLh" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_wvqPOTBJ3ELhy96dsub_l", "authority": "supplemental", "conflicts": [ "/summary", "/description" ], "revisionId": "sdrn_f7m9IOfd1EwYpLs8JZOMM" } ], "x-zeroclick-services": [ "realtime-news-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-news-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-news-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-news-data/top-headlines": { "get": { "summary": "Top Headlines", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "required": [ "title", "link" ], "properties": { "link": { "type": "string", "description": "Canonical URL of the article." }, "title": { "type": "string", "description": "Headline of the news article." }, "authors": { "type": "array", "items": { "type": "string", "description": "A single author name." }, "nullable": true, "description": "Author names credited on the article." }, "snippet": { "type": "string", "nullable": true, "description": "Short excerpt of the article body." }, "photo_url": { "type": "string", "nullable": true, "description": "URL of the article's lead image." }, "source_url": { "type": "string", "nullable": true, "description": "Homepage URL of the source publisher." }, "source_name": { "type": "string", "nullable": true, "description": "Publisher name of the source." }, "sub_articles": { "type": "array", "items": { "type": "object", "required": [ "title", "link" ], "properties": { "link": { "type": "string", "description": "Canonical URL of the sub-article." }, "title": { "type": "string", "description": "Headline of the sub-article." }, "authors": { "type": "array", "items": { "type": "string", "description": "A single sub-article author name." }, "nullable": true, "description": "Author names credited on the sub-article." }, "photo_url": { "type": "string", "nullable": true, "description": "URL of the sub-article's lead image." }, "source_url": { "type": "string", "nullable": true, "description": "Homepage URL of the sub-article's source publisher." }, "source_name": { "type": "string", "nullable": true, "description": "Publisher name of the sub-article's source." }, "thumbnail_url": { "type": "string", "nullable": true, "description": "URL of the sub-article's thumbnail image." }, "related_topics": { "type": "array", "items": { "type": "object", "required": [ "topic_id", "topic_name" ], "properties": { "topic_id": { "type": "string", "description": "Google News topic ID." }, "topic_name": { "type": "string", "description": "Topic display name." } } }, "nullable": true, "description": "Related Google News topics for the sub-article." }, "source_logo_url": { "type": "string", "nullable": true, "description": "URL of the sub-article source's logo." }, "source_favicon_url": { "type": "string", "nullable": true, "description": "URL of the sub-article source's favicon." }, "source_publication_id": { "type": "string", "nullable": true, "description": "Google News publication ID of the sub-article source." }, "published_datetime_utc": { "type": "string", "nullable": true, "description": "ISO 8601 UTC datetime of the sub-article's publication." } } }, "nullable": true, "description": "Related sub-articles that Google News groups with this headline." }, "thumbnail_url": { "type": "string", "nullable": true, "description": "URL of the article's thumbnail image." }, "related_topics": { "type": "array", "items": { "type": "object", "required": [ "topic_id", "topic_name" ], "properties": { "topic_id": { "type": "string", "description": "Google News topic ID." }, "topic_name": { "type": "string", "description": "Topic display name." } } }, "nullable": true, "description": "Related Google News topics surfaced for the article." }, "source_logo_url": { "type": "string", "nullable": true, "description": "URL of the source publisher's logo." }, "source_favicon_url": { "type": "string", "nullable": true, "description": "URL of the source publisher's favicon." }, "source_publication_id": { "type": "string", "nullable": true, "description": "Google News publication ID of the source." }, "published_datetime_utc": { "type": "string", "nullable": true, "description": "ISO 8601 UTC datetime of original publication." } } }, "description": "Top headline news articles for the requested country / language." }, "status": { "type": "string", "description": "The status of the response" }, "request_id": { "type": "string", "description": "A unique identifier for the request" } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "limit", "schema": { "type": "integer", "default": 500, "maximum": 500, "minimum": 1 }, "description": "Maximum number of news articles to return." }, { "in": "query", "name": "country", "schema": { "type": "string" }, "description": "Country code. See all available country codes. Default: US" }, { "in": "query", "name": "language", "schema": { "type": "string", "default": "en" }, "description": "The language to use for the results, specified as a 2-letter language code - see ISO 639-1 alpha-2." } ], "description": "Get the latest news headlines/top stories for a country.", "operationId": "realtime_news_data__get__top_headlines", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_1_LX_FbWCA7U09K5zzV8z", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_1Y4Iq_rRp239QLf6anxmA" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_AtF5v_vXxTbq1wWfTbZ8p", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_xtbL3_JhQnAYS_6AQGDiQ" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_BowKpX7oIEvSZAa5G-8Cj", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_AlkJCvRexbLp1t3wre1uD" }, { "gaps": [], "pages": [], "sourceId": "sds_jRl0O0t2JNWjX4MjQ_kC5", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_0KHmU6zKJBn3JfGQhhbYP" }, { "gaps": [ "Missing response schema" ], "pages": [], "sourceId": "sds_UpX4G0QiFQ_cIhdwzu8pk", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_eR8hqN-7MniZX5AeOeQLh" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_wvqPOTBJ3ELhy96dsub_l", "authority": "supplemental", "conflicts": [ "/summary", "/description" ], "revisionId": "sdrn_f7m9IOfd1EwYpLs8JZOMM" } ], "x-zeroclick-services": [ "realtime-news-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-news-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-news-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-news-data/topic-headlines": { "get": { "summary": "Topic Headlines", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "required": [ "title", "link" ], "properties": { "link": { "type": "string", "description": "Canonical URL of the article." }, "title": { "type": "string", "description": "Headline of the news article." }, "authors": { "type": "array", "items": { "type": "string", "description": "A single author name." }, "nullable": true, "description": "Author names credited on the article." }, "snippet": { "type": "string", "nullable": true, "description": "Short excerpt of the article body." }, "photo_url": { "type": "string", "nullable": true, "description": "URL of the article's lead image." }, "source_url": { "type": "string", "nullable": true, "description": "Homepage URL of the source publisher." }, "source_name": { "type": "string", "nullable": true, "description": "Publisher name of the source." }, "sub_articles": { "type": "array", "items": { "type": "object", "required": [ "title", "link" ], "properties": { "link": { "type": "string", "description": "Canonical URL of the sub-article." }, "title": { "type": "string", "description": "Headline of the sub-article." }, "photo_url": { "type": "string", "nullable": true, "description": "URL of the sub-article's lead image." }, "thumbnail_url": { "type": "string", "nullable": true, "description": "URL of the sub-article's thumbnail image." }, "published_datetime_utc": { "type": "string", "nullable": true, "description": "ISO 8601 UTC datetime of the sub-article's publication." } } }, "nullable": true, "description": "Related sub-articles that Google News groups with this headline." }, "thumbnail_url": { "type": "string", "nullable": true, "description": "URL of the article's thumbnail image." }, "related_topics": { "type": "array", "items": { "type": "object", "required": [ "topic_id", "topic_name" ], "properties": { "topic_id": { "type": "string", "description": "Google News topic ID." }, "topic_name": { "type": "string", "description": "Topic display name." } } }, "nullable": true, "description": "Related Google News topics surfaced for the article." }, "source_logo_url": { "type": "string", "nullable": true, "description": "URL of the source publisher's logo." }, "source_favicon_url": { "type": "string", "nullable": true, "description": "URL of the source publisher's favicon." }, "source_publication_id": { "type": "string", "nullable": true, "description": "Google News publication ID of the source." }, "published_datetime_utc": { "type": "string", "nullable": true, "description": "ISO 8601 UTC datetime of original publication." } } }, "description": "News article results for the requested topic." }, "status": { "type": "string", "description": "The status of the response" }, "request_id": { "type": "string", "description": "A unique identifier for the request" } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "topic", "schema": { "enum": [ "WORLD", "NATIONAL", "BUSINESS", "TECHNOLOGY", "ENTERTAINMENT", "SPORTS", "SCIENCE", "HEALTH" ], "type": "string", "example": "WORLD" }, "example": "WORLD", "required": true, "description": "Topic or publication for which to get news headlines. \n In addition, topic / publication IDs are also accepted and can be taken from a News topic URL as it appears after the topics/ or publications/ path part (e.g. Football Topic - /topics/CAAqJQgKIh9DQkFTRVFvSUwyMHZNREoyZURRU0JXVnVMVWRDS0FBUAE)." }, { "in": "query", "name": "limit", "schema": { "type": "integer", "default": 500, "maximum": 500, "minimum": 1 }, "description": "Maximum number of news articles to return." }, { "in": "query", "name": "country", "schema": { "type": "string", "default": "us" }, "description": "Country code. See all available country codes." }, { "in": "query", "name": "language", "schema": { "type": "string", "default": "en" }, "description": "The language to use for the results, specified as a 2-letter language code - see ISO 639-1 alpha-2." } ], "description": "Get the latest news headlines for a topic (World, Sports, Technology, etc) or publication (e.g. CNN, BBC, etc).", "operationId": "realtime_news_data__get__topic_headlines", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_1_LX_FbWCA7U09K5zzV8z", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_1Y4Iq_rRp239QLf6anxmA" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_AtF5v_vXxTbq1wWfTbZ8p", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_xtbL3_JhQnAYS_6AQGDiQ" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_BowKpX7oIEvSZAa5G-8Cj", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_AlkJCvRexbLp1t3wre1uD" }, { "gaps": [ "Missing explicit parameter definitions in documentation" ], "pages": [], "sourceId": "sds_jRl0O0t2JNWjX4MjQ_kC5", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_0KHmU6zKJBn3JfGQhhbYP" }, { "gaps": [ "Missing parameter details and response schema" ], "pages": [], "sourceId": "sds_UpX4G0QiFQ_cIhdwzu8pk", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_eR8hqN-7MniZX5AeOeQLh" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_wvqPOTBJ3ELhy96dsub_l", "authority": "supplemental", "conflicts": [ "/summary", "/description" ], "revisionId": "sdrn_f7m9IOfd1EwYpLs8JZOMM" } ], "x-zeroclick-services": [ "realtime-news-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-news-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-news-data/topic-news-by-section": { "get": { "summary": "Topic News By Section", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "required": [ "title", "link" ], "properties": { "link": { "type": "string", "description": "Canonical URL of the article." }, "title": { "type": "string", "description": "Headline of the news article." }, "authors": { "type": "array", "items": { "type": "string", "description": "A single author name." }, "nullable": true, "description": "Author names credited on the article." }, "snippet": { "type": "string", "nullable": true, "description": "Short excerpt of the article body." }, "photo_url": { "type": "string", "nullable": true, "description": "URL of the article's lead image." }, "source_url": { "type": "string", "nullable": true, "description": "Homepage URL of the source publisher." }, "source_name": { "type": "string", "nullable": true, "description": "Publisher name of the source." }, "thumbnail_url": { "type": "string", "nullable": true, "description": "URL of the article's thumbnail image." }, "related_topics": { "type": "array", "items": { "type": "object", "required": [ "topic_id", "topic_name" ], "properties": { "topic_id": { "type": "string", "description": "Google News topic ID." }, "topic_name": { "type": "string", "description": "Topic display name." } } }, "nullable": true, "description": "Related Google News topics surfaced for the article." }, "source_logo_url": { "type": "string", "nullable": true, "description": "URL of the source publisher's logo." }, "source_favicon_url": { "type": "string", "nullable": true, "description": "URL of the source publisher's favicon." }, "source_publication_id": { "type": "string", "nullable": true, "description": "Google News publication ID of the source." }, "published_datetime_utc": { "type": "string", "nullable": true, "description": "ISO 8601 UTC datetime of original publication." } } }, "description": "News article results for the requested topic section." }, "status": { "type": "string", "description": "The status of the response" }, "request_id": { "type": "string", "description": "A unique identifier for the request" } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "topic", "schema": { "enum": [ "WORLD", "NATIONAL", "BUSINESS", "TECHNOLOGY", "ENTERTAINMENT", "SPORTS", "SCIENCE", "HEALTH" ], "type": "string", "example": "WORLD" }, "example": "WORLD", "required": true, "description": "Topic or publication for which to get news headlines. \n In addition, topic / publication IDs are also accepted and can be taken from a News topic URL as it appears after the topics/ or publications/ path part (e.g. Football Topic - /topics/CAAqJQgKIh9DQkFTRVFvSUwyMHZNREoyZURRU0JXVnVMVWRDS0FBUAE)." }, { "in": "query", "name": "section", "schema": { "type": "string" } }, { "in": "query", "name": "limit", "schema": { "type": "integer", "default": 500, "maximum": 500, "minimum": 1 }, "description": "Maximum number of news articles to return." }, { "in": "query", "name": "country", "schema": { "type": "string", "default": "us" }, "description": "Country code. See all available country codes." }, { "in": "query", "name": "language", "schema": { "type": "string", "default": "en" }, "description": "The language to use for the results, specified as a 2-letter language code - see ISO 639-1 alpha-2." } ], "description": "Get news article in a specific section of a topic (World, Sports, Technology, etc) or publication (CNN, BBC, etc).", "operationId": "realtime_news_data__get__topic_news_by_section", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_1_LX_FbWCA7U09K5zzV8z", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_1Y4Iq_rRp239QLf6anxmA" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_AtF5v_vXxTbq1wWfTbZ8p", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_xtbL3_JhQnAYS_6AQGDiQ" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_BowKpX7oIEvSZAa5G-8Cj", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_AlkJCvRexbLp1t3wre1uD" }, { "gaps": [ "Missing explicit parameter definitions in documentation" ], "pages": [], "sourceId": "sds_jRl0O0t2JNWjX4MjQ_kC5", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/section/required", "/description", "/operationId" ], "revisionId": "sdrn_0KHmU6zKJBn3JfGQhhbYP" }, { "gaps": [ "Missing parameter details and response schema" ], "pages": [], "sourceId": "sds_UpX4G0QiFQ_cIhdwzu8pk", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/section/required", "/description", "/operationId" ], "revisionId": "sdrn_eR8hqN-7MniZX5AeOeQLh" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_wvqPOTBJ3ELhy96dsub_l", "authority": "supplemental", "conflicts": [ "/summary", "/description" ], "revisionId": "sdrn_f7m9IOfd1EwYpLs8JZOMM" } ], "x-zeroclick-services": [ "realtime-news-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-news-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ] }, "security": [ { "planAccess": [] } ] } }, "/real-time-news-search/search": { "get": { "summary": "Search", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "request_id", "parameters", "data" ], "properties": { "data": { "type": "object", "required": [ "news" ], "properties": { "news": { "type": "array", "items": { "type": "object", "required": [ "title", "link", "position" ], "properties": { "link": { "type": "string", "description": "Canonical URL of the article." }, "title": { "type": "string", "description": "Headline of the news article." }, "snippet": { "type": "string", "nullable": true, "description": "Short excerpt of the article body." }, "position": { "type": "integer", "description": "Position of the result within the news list (1-based)." }, "source_url": { "type": "string", "nullable": true, "description": "Homepage URL of the source publisher." }, "source_name": { "type": "string", "nullable": true, "description": "Publisher name of the source." }, "thumbnail_url": { "type": "string", "nullable": true, "description": "Base64 data URL of the article's lead image, when available." }, "published_date": { "type": "string", "nullable": true, "description": "Localized relative publication date as displayed by Google News." }, "source_favicon_url": { "type": "string", "nullable": true, "description": "Base64 data URL of the source publisher's favicon." }, "published_datetime_utc": { "type": "string", "nullable": true, "description": "ISO 8601 UTC datetime of original publication." } } }, "description": "Main news results for the query." }, "top_stories": { "type": "array", "items": { "type": "object", "required": [ "position", "title", "link" ], "properties": { "link": { "type": "string", "description": "Canonical URL of the article." }, "title": { "type": "string", "description": "Headline of the news article." }, "position": { "type": "integer", "description": "Position of the story within the top stories cluster (1-based)." }, "source_url": { "type": "string", "nullable": true, "description": "Homepage URL of the source publisher." }, "source_name": { "type": "string", "nullable": true, "description": "Publisher name of the source." }, "thumbnail_url": { "type": "string", "nullable": true, "description": "Base64 data URL of the article's lead image, when available." }, "published_date": { "type": "string", "nullable": true, "description": "Localized relative publication date as displayed by Google News." }, "source_favicon_url": { "type": "string", "nullable": true, "description": "Base64 data URL of the source publisher's favicon." }, "published_datetime_utc": { "type": "string", "nullable": true, "description": "ISO 8601 UTC datetime of original publication." } } }, "nullable": true, "description": "Top stories cluster for the query, when available." } } }, "status": { "type": "string", "description": "The status of the API response." }, "parameters": { "type": "object", "properties": { "page": { "type": "integer", "description": "Page number for pagination as received." }, "safe": { "type": "string", "description": "Safe search setting as received. Values: off, active." }, "query": { "type": "string", "description": "The news search query as received." }, "country": { "type": "string", "description": "ISO 3166-1 alpha-2 country code used for the search." }, "date_to": { "type": "string", "nullable": true, "description": "End date of the custom date range filter (MM/DD/YYYY), when provided." }, "sort_by": { "type": "string", "description": "Sort order as received. Values: relevance, date." }, "language": { "type": "string", "description": "ISO 639-1 language code used for the search." }, "date_from": { "type": "string", "nullable": true, "description": "Start date of the custom date range filter (MM/DD/YYYY), when provided." }, "time_period": { "type": "string", "description": "Time window filter as received. Values: any, last_hour, last_day, last_week, last_month, last_year." } }, "description": "The parameters the API received and used for this request, echoed back." }, "request_id": { "type": "string", "description": "A unique ID to trace the API request." } } } } }, "description": "Successful response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "query", "schema": { "type": "string" }, "example": "artificial intelligence", "required": true, "description": "The news search query.\n\n**Examples:**\n\n`climate change`\n\n`artificial intelligence startups`\n\n`bitcoin price 2026`" }, { "in": "query", "name": "page", "schema": { "type": "integer", "default": 1, "minimum": 1 }, "description": "Page number for pagination. Each page returns up to 10 news results.\n\n**Allowed values:** `1` and above." }, { "in": "query", "name": "country", "schema": { "type": "string", "default": "us" }, "description": "Country code of the country to return news results for. See https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2 for supported values.\n\n**Default:** `us`" }, { "in": "query", "name": "language", "schema": { "type": "string", "default": "en" }, "description": "The language of the results, specified as a 2-letter language code - see ISO 639-1.\n\n**Default:** `en`" }, { "in": "query", "name": "time_period", "schema": { "enum": [ "any", "last_hour", "last_day", "last_week", "last_month", "last_year" ], "type": "string", "default": "any" }, "description": "Filter results to a specific time period. Cannot be used together with `date_from`/`date_to`.\n\n**Allowed values:** `any`, `last_hour`, `last_day`, `last_week`, `last_month`, `last_year`\n\n**Default:** `any`" }, { "in": "query", "name": "date_from", "schema": { "type": "string" }, "description": "Start date for a custom date range filter, in `MM/DD/YYYY` format. Must be provided together with `date_to`. Cannot be used together with `time_period` (other than `any`).\n\n**Example:** `01/01/2026`" }, { "in": "query", "name": "date_to", "schema": { "type": "string" }, "description": "End date for a custom date range filter, in `MM/DD/YYYY` format. Must be provided together with `date_from`.\n\n**Example:** `04/10/2026`" }, { "in": "query", "name": "sort_by", "schema": { "enum": [ "relevance", "date" ], "type": "string", "default": "relevance" }, "description": "Sort order for the results.\n\n**Allowed values:** `relevance`, `date`\n\n**Default:** `relevance`" }, { "in": "query", "name": "safe", "schema": { "enum": [ "off", "active" ], "type": "string", "default": "off" }, "description": "Safe search setting to filter explicit content.\n\n**Allowed values:** `off`, `active`\n\n**Default:** `off`" } ], "description": "Search Google News for any query and get real-time news results. Returns a top stories cluster (when available for the query), main news results with article metadata, source info, thumbnails, and published dates (both localized relative text and ISO 8601 UTC). Supports pagination, filtering by time period or custom date range, country, language, sort order, and safe search.", "operationId": "realtime_news_search__Search", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing full parameter list and response schema." ], "pages": [ 1 ], "sourceId": "sds__1fiQu9RHG0jaOVImz_2s", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/q", "/description", "/operationId" ], "revisionId": "sdrn_fMzoiFNl9X0S__Sj10MeV" }, { "gaps": [ "Missing explicit parameter definitions for query, language, location, and pagination in the provided documentation." ], "pages": [], "sourceId": "sds_-LRkHZTW3kkFz3P0VCP9x", "authority": "supplemental", "conflicts": [ "/summary", "/description", "/operationId" ], "revisionId": "sdrn_IFNtzsGFVdRfOmGNpEt-c" }, { "gaps": [ "Missing response schema." ], "pages": [], "sourceId": "sds_G0U8VUwSzsI5a3e1H5DC1", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/q", "/description", "/operationId" ], "revisionId": "sdrn_YNvYe3cGaeWzpXoXqMHAs" }, { "gaps": [ "Missing full parameter list and response schema" ], "pages": [ 1 ], "sourceId": "sds_MAxJPNBPJFwSKQLj1M1dr", "authority": "supplemental", "conflicts": [ "/summary", "/description", "/operationId" ], "revisionId": "sdrn_QFW9HQumx231aOJCusPx0" }, { "gaps": [ "Missing explicit parameter definitions for query, language, location, and pagination in the provided documentation." ], "pages": [], "sourceId": "sds_vdxxiVsx4OKV5vH7hrhwb", "authority": "supplemental", "conflicts": [ "/summary", "/description", "/operationId" ], "revisionId": "sdrn_46RDkwnCaOF5IxAFfXTW0" }, { "gaps": [ "Missing response schema" ], "pages": [ 1 ], "sourceId": "sds_wvqPOTBJ3ELhy96dsub_l", "authority": "supplemental", "conflicts": [ "/summary", "/parameters/query/q", "/description", "/operationId" ], "revisionId": "sdrn_f7m9IOfd1EwYpLs8JZOMM" } ], "x-zeroclick-services": [ "real-time-news-search" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "real-time-news-search", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "real-time-news-search", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-product-search/deals-v2": { "get": { "summary": "Deals (New Layout / US)", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "products": { "type": "array", "items": { "type": "object", "properties": { "offer": { "type": "object", "properties": { "price": { "type": "string", "description": "The price of the product in the offer" }, "on_sale": { "type": "boolean", "description": "Indicates whether the offer is on sale" }, "offer_id": { "type": "string", "description": "Unique identifier for the offer" }, "shipping": { "type": "string", "description": "The shipping cost for the offer" }, "store_name": { "type": "string", "description": "The name of the store offering the product" }, "percent_off": { "type": "string", "description": "The percentage discount for the offer" }, "store_rating": { "type": "string", "description": "The rating of the store offering the product" }, "store_favicon": { "type": "string", "description": "The favicon URL for the store" }, "original_price": { "type": "string", "description": "The original price of the product before any discounts" }, "store_review_count": { "type": "integer", "description": "The number of reviews for the store" } } }, "product_id": { "type": "string", "description": "The unique identifier of the product" }, "product_title": { "type": "string", "description": "The title of the product" }, "product_rating": { "type": "number", "description": "The average rating of the product" }, "product_page_url": { "type": "string", "description": "URL for the product page" }, "product_num_offers": { "type": "string", "description": "The number of offers available for the product" }, "product_description": { "type": "string", "description": "A detailed description of the product" }, "product_num_reviews": { "type": "integer", "description": "The total number of reviews for the product" }, "typical_price_range": { "type": "array", "items": { "type": "string" }, "description": "The typical price range for the product" } } } }, "sponsored_products": { "type": "array", "items": { "type": "object" }, "description": "Array of sponsored product results displayed alongside the deals listings. Empty when no sponsored placements were returned." } } }, "status": { "type": "string", "description": "The status of the response" }, "request_id": { "type": "string", "description": "A unique identifier for the request" } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "q", "schema": { "type": "string" }, "example": "Laptop", "required": true, "description": "Search query / keyword" }, { "in": "query", "name": "country", "schema": { "type": "string", "default": "us" }, "description": "Country code of the region/country to return offers for. Allowed values: See https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2." }, { "in": "query", "name": "language", "schema": { "type": "string", "default": "en" }, "description": "The language of the results. Allowed values: See https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes." }, { "in": "query", "name": "page", "schema": { "type": "integer", "default": 1, "maximum": 100, "minimum": 1 }, "description": "Results page to return (each page contains up to 100 product results)." }, { "in": "query", "name": "limit", "schema": { "type": "integer", "default": 10, "maximum": 100, "minimum": 1 }, "description": "Maximum number of products to return." }, { "in": "query", "name": "sort_by", "schema": { "enum": [ "BEST_MATCH", "TOP_RATED", "LOWEST_PRICE", "HIGHEST_PRICE" ], "type": "string", "default": "BEST_MATCH" }, "description": "Sort product offers by best match, top rated, lowest or highest price." }, { "in": "query", "name": "min_price", "schema": { "type": "number" }, "description": "Only return product offers with price greater than a certain value" }, { "in": "query", "name": "max_price", "schema": { "type": "number" }, "description": "Only return product offers with price lower than a certain value" }, { "in": "query", "name": "product_condition", "schema": { "enum": [ "ANY", "NEW", "USED", "REFURBISHED" ], "type": "string", "default": "ANY" }, "description": "Only return products with a specific condition." }, { "in": "query", "name": "stores", "schema": { "type": "string" }, "description": "Only return product offers from specific stores. Accepts a single or a comma delimited list of store names (e.g. best buy,walmart,amazon)." }, { "in": "query", "name": "free_returns", "schema": { "type": "boolean", "default": false }, "description": "Only return product offers that offer free returns." }, { "in": "query", "name": "free_shipping", "schema": { "type": "boolean", "default": false }, "description": "Only return product offers that offer free shipping/delivery." }, { "in": "query", "name": "on_sale", "schema": { "type": "boolean", "default": false }, "description": "Only return product offers that are currently on sale." }, { "in": "query", "name": "shoprs", "schema": { "type": "string" }, "description": "The parameter controls filtering, along with the q parameter. \n It should be used in combination with the updated q parameter, which now contains the name of the filter applied next to your original query. \n You can get the shoprs filter value from the response of this endpoint, under the filters response field. \n In addition, it can be obtained directly from Google Shopping and used with the endpoint." }, { "in": "query", "name": "return_filters", "schema": { "type": "boolean" }, "description": "Whether to return filters / refinements from Google Shopping (left refinement filters panel on desktop)." } ], "description": "Search for product deals on Google Shopping with pagination/scrolling support.", "operationId": "realtime_product_search__get__deals_v2", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_1_LX_FbWCA7U09K5zzV8z", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_1Y4Iq_rRp239QLf6anxmA" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_AtF5v_vXxTbq1wWfTbZ8p", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_xtbL3_JhQnAYS_6AQGDiQ" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_BowKpX7oIEvSZAa5G-8Cj", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_AlkJCvRexbLp1t3wre1uD" }, { "gaps": [], "pages": [], "sourceId": "sds_jRl0O0t2JNWjX4MjQ_kC5", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_0KHmU6zKJBn3JfGQhhbYP" }, { "gaps": [ "Missing response schema" ], "pages": [], "sourceId": "sds_UpX4G0QiFQ_cIhdwzu8pk", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_eR8hqN-7MniZX5AeOeQLh" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_wvqPOTBJ3ELhy96dsub_l", "authority": "supplemental", "conflicts": [ "/summary", "/description" ], "revisionId": "sdrn_f7m9IOfd1EwYpLs8JZOMM" } ], "x-zeroclick-services": [ "realtime-product-search" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-product-search", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-product-search", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-product-search/product-details": { "get": { "summary": "Product Details", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "offer": { "type": "object", "properties": { "tax": { "type": "string", "description": "The tax amount or details applicable to the product." }, "price": { "type": "string", "description": "The current selling price of the product." }, "on_sale": { "type": "boolean", "description": "Indicates whether the product is on sale." }, "offer_id": { "type": "string", "description": "A unique identifier for the offer." }, "shipping": { "type": "string", "description": "The shipping cost or details for the product." }, "store_name": { "type": "string", "description": "The name of the store offering the product." }, "store_favicon": { "type": "string", "description": "The URL of the store's favicon." }, "offer_page_url": { "type": "string", "description": "The URL of the offer page." }, "original_price": { "type": "string", "description": "The original price before any discount." }, "product_condition": { "type": "string", "description": "The condition of the product (e.g., new, used)." }, "top_quality_store": { "type": "boolean", "description": "Indicates if the store is rated as a top-quality seller." } } }, "product_id": { "type": "string", "description": "A unique identifier for the product." }, "product_title": { "type": "string", "description": "The title of the product." }, "product_rating": { "type": "number", "description": "The average rating of the product." }, "product_page_url": { "type": "string", "description": "The URL of the product's main page." }, "product_num_offers": { "type": "string", "description": "The number of offers available for the product." }, "product_description": { "type": "string", "description": "A brief description of the product." }, "product_num_reviews": { "type": "integer", "description": "The total number of reviews for the product." }, "typical_price_range": { "type": "array", "items": { "type": "string" }, "description": "The usual price range of the product." }, "product_specs_page_url": { "type": "string", "description": "The URL to view the product specifications." }, "product_offers_page_url": { "type": "string", "description": "The URL to view different offers for the product." }, "product_reviews_page_url": { "type": "string", "description": "The URL to view customer reviews of the product." } } }, "status": { "type": "string", "description": "The status of the response, indicating success or failure." }, "request_id": { "type": "string", "description": "A unique identifier for the request." } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "product_id", "schema": { "type": "string" }, "example": "3264458344382933005", "required": true, "description": "Product id of the product for which to get full details." }, { "in": "query", "name": "country", "schema": { "type": "string", "default": "us" }, "description": "Country code of the region/country to return offers for. Allowed values: See https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2." }, { "in": "query", "name": "language", "schema": { "type": "string", "default": "en" }, "description": "The language of the results. Allowed values: See https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes." } ], "description": "Get the details of a specific product by product id. Returns the full product details in addition to reviews sample, photos, product specs and more information.", "operationId": "realtime_product_search__get__product_details", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_1_LX_FbWCA7U09K5zzV8z", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_1Y4Iq_rRp239QLf6anxmA" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_AtF5v_vXxTbq1wWfTbZ8p", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_xtbL3_JhQnAYS_6AQGDiQ" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_BowKpX7oIEvSZAa5G-8Cj", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_AlkJCvRexbLp1t3wre1uD" }, { "gaps": [ "Missing explicit parameter definitions in documentation" ], "pages": [], "sourceId": "sds_jRl0O0t2JNWjX4MjQ_kC5", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_0KHmU6zKJBn3JfGQhhbYP" }, { "gaps": [ "Missing parameter details and response schema" ], "pages": [], "sourceId": "sds_UpX4G0QiFQ_cIhdwzu8pk", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_eR8hqN-7MniZX5AeOeQLh" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_wvqPOTBJ3ELhy96dsub_l", "authority": "supplemental", "conflicts": [ "/description" ], "revisionId": "sdrn_f7m9IOfd1EwYpLs8JZOMM" } ], "x-zeroclick-services": [ "realtime-product-search" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-product-search", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-product-search", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-product-search/product-details-v2": { "get": { "summary": "Product Details (New Layout / US)", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "offer": { "type": "object", "properties": { "price": { "type": "string", "description": "The current price of the product in the offer." }, "on_sale": { "type": "boolean", "description": "Indicates if the product is currently on sale." }, "offer_id": { "type": "string", "description": "The unique identifier for the offer." }, "shipping": { "type": "string", "description": "The shipping details of the offer." }, "store_name": { "type": "string", "description": "The name of the store offering the product." }, "offer_badge": { "type": "string", "description": "A label for promotional offers." }, "offer_title": { "type": "string", "description": "The title of the offer." }, "percent_off": { "type": "string", "description": "The percentage discount applied." }, "store_rating": { "type": "string", "description": "The rating of the store." }, "store_favicon": { "type": "string", "description": "The favicon URL of the store." }, "offer_page_url": { "type": "string", "description": "The URL of the offer page." }, "original_price": { "type": "string", "description": "The original price before any discounts." }, "payment_methods": { "type": "string", "description": "The available payment methods for the offer." }, "product_condition": { "type": "string", "description": "The condition of the product (e.g., new, used)." }, "store_review_count": { "type": "integer", "description": "The number of reviews for the store." }, "store_reviews_page_url": { "type": "string", "description": "The URL of the store's reviews page." }, "coupon_discount_percent": { "type": "string", "description": "The discount percentage applied via coupon." } } }, "product_id": { "type": "string", "description": "The unique identifier for the product." }, "product_title": { "type": "string", "description": "The title of the product." }, "product_rating": { "type": "number", "description": "The average rating of the product." }, "product_page_url": { "type": "string", "description": "The URL of the product page." }, "product_num_offers": { "type": "integer", "description": "The total number of available offers for the product." }, "product_description": { "type": "string", "description": "A brief description of the product." }, "product_num_reviews": { "type": "integer", "description": "The total number of reviews for the product." }, "typical_price_range": { "type": "array", "items": { "type": "string" }, "description": "The typical price range for the product." } } }, "status": { "type": "string", "description": "The status of the response, indicating success or failure." }, "request_id": { "type": "string", "description": "A unique identifier for the request." } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "product_id", "schema": { "type": "string" }, "example": "catalogid:15554707778408471208,gpcid:6219277726645206819,headlineOfferDocid:8835386203856143595,rds:PC_15478400683365031707|PROD_PC_15478400683365031707,imageDocid:10653897321817113741,mid:576462815432560445,pvt:hg,pvf:", "required": true, "description": "Product id of the product for which to get full details." }, { "in": "query", "name": "country", "schema": { "type": "string", "default": "us" }, "description": "Country code of the region/country to return offers for. Allowed values: See https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2." }, { "in": "query", "name": "language", "schema": { "type": "string", "default": "en" }, "description": "The language of the results. Allowed values: See https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes." } ], "description": "Get the details of a specific product by product id. Returns the full product details in addition to reviews sample, photos, product specs and more information.", "operationId": "realtime_product_search__get__product_details_v2", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_1_LX_FbWCA7U09K5zzV8z", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_1Y4Iq_rRp239QLf6anxmA" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_AtF5v_vXxTbq1wWfTbZ8p", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_xtbL3_JhQnAYS_6AQGDiQ" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_BowKpX7oIEvSZAa5G-8Cj", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_AlkJCvRexbLp1t3wre1uD" }, { "gaps": [ "Missing explicit parameter definitions in documentation" ], "pages": [], "sourceId": "sds_jRl0O0t2JNWjX4MjQ_kC5", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_0KHmU6zKJBn3JfGQhhbYP" }, { "gaps": [ "Missing parameter details and response schema" ], "pages": [], "sourceId": "sds_UpX4G0QiFQ_cIhdwzu8pk", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_eR8hqN-7MniZX5AeOeQLh" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_wvqPOTBJ3ELhy96dsub_l", "authority": "supplemental", "conflicts": [ "/summary", "/description" ], "revisionId": "sdrn_f7m9IOfd1EwYpLs8JZOMM" } ], "x-zeroclick-services": [ "realtime-product-search" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-product-search", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-product-search", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-product-search/product-offers": { "get": { "summary": "Product Offers", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "offers": { "type": "array", "items": { "type": "object", "properties": { "tax": { "type": "string", "description": "The tax amount or details applicable to the product." }, "price": { "type": "string", "description": "The current selling price of the product." }, "on_sale": { "type": "boolean", "description": "Indicates whether the product is on sale." }, "offer_id": { "type": "string", "description": "A unique identifier for the offer." }, "shipping": { "type": "string", "description": "The shipping cost or details for the product." }, "store_name": { "type": "string", "description": "The name of the store offering the product." }, "store_favicon": { "type": "string", "description": "The URL of the store's favicon." }, "offer_page_url": { "type": "string", "description": "The URL of the offer page." }, "original_price": { "type": "string", "description": "The original price before any discount." }, "product_condition": { "type": "string", "description": "The condition of the product (e.g., new, used)." }, "top_quality_store": { "type": "boolean", "description": "Indicates if the store is rated as a top-quality seller." } } } }, "product_rating": { "type": "number", "description": "The average rating of the product." }, "product_num_reviews": { "type": "integer", "description": "The total number of reviews for the product." } } }, "status": { "type": "string", "description": "The status of the response, indicating success or failure." }, "request_id": { "type": "string", "description": "A unique identifier for the request." } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "product_id", "schema": { "type": "string" }, "example": "3264458344382933005", "required": true, "description": "Product id of the product for which to fetch offers." }, { "in": "query", "name": "page", "schema": { "type": "integer", "default": 1 }, "description": "The page to return. Each page contains offers from 5 different stores." }, { "in": "query", "name": "country", "schema": { "type": "string", "default": "us" }, "description": "Country code of the region/country to return offers for. Allowed values: See https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2." }, { "in": "query", "name": "language", "schema": { "type": "string", "default": "en" }, "description": "The language of the results. Allowed values: See https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes." } ], "description": "Get all offers available for a product. Each page of offers contains offers from 10 sellers, since some stores sell the same item more than once (e.g. Amazon, Ebay, etc), it's possible that more than 10 offers will be returned.", "operationId": "realtime_product_search__get__product_offers", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_1_LX_FbWCA7U09K5zzV8z", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_1Y4Iq_rRp239QLf6anxmA" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_AtF5v_vXxTbq1wWfTbZ8p", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_xtbL3_JhQnAYS_6AQGDiQ" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_BowKpX7oIEvSZAa5G-8Cj", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_AlkJCvRexbLp1t3wre1uD" }, { "gaps": [ "Missing explicit parameter definitions in documentation" ], "pages": [], "sourceId": "sds_jRl0O0t2JNWjX4MjQ_kC5", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_0KHmU6zKJBn3JfGQhhbYP" }, { "gaps": [ "Missing parameter details and response schema" ], "pages": [], "sourceId": "sds_UpX4G0QiFQ_cIhdwzu8pk", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_eR8hqN-7MniZX5AeOeQLh" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_wvqPOTBJ3ELhy96dsub_l", "authority": "supplemental", "conflicts": [ "/description" ], "revisionId": "sdrn_f7m9IOfd1EwYpLs8JZOMM" } ], "x-zeroclick-services": [ "realtime-product-search" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-product-search", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-product-search", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-product-search/product-offers-v2": { "get": { "summary": "Product Offers (New Layout / US)", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "product_rating": { "type": "number", "description": "The average rating of the product." }, "product_num_reviews": { "type": "integer", "description": "The total number of reviews for the product." } } }, "status": { "type": "string", "description": "The status of the response, indicating success or failure." }, "request_id": { "type": "string", "description": "A unique identifier for the request." } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "product_id", "schema": { "type": "string" }, "example": "catalogid:15554707778408471208,gpcid:6219277726645206819,headlineOfferDocid:8835386203856143595,rds:PC_15478400683365031707|PROD_PC_15478400683365031707,imageDocid:10653897321817113741,mid:576462815432560445,pvt:hg,pvf:", "required": true, "description": "Product id of the product for which to fetch offers." }, { "in": "query", "name": "page", "schema": { "type": "integer", "default": 1 }, "description": "The page to return. Each page contains offers from 5 different stores." }, { "in": "query", "name": "country", "schema": { "type": "string", "default": "us" }, "description": "Country code of the region/country to return offers for. Allowed values: See https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2." }, { "in": "query", "name": "language", "schema": { "type": "string", "default": "en" }, "description": "The language of the results. Allowed values: See https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes." } ], "description": "Get all offers available for a product. \n Each page of offers contains offers from 10 sellers, however, since some stores sell the same item more than once (e.g. Amazon, eBay, etc), it's possible that more than 10 offers will be returned.", "operationId": "realtime_product_search__get__product_offers_v2", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_1_LX_FbWCA7U09K5zzV8z", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_1Y4Iq_rRp239QLf6anxmA" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_AtF5v_vXxTbq1wWfTbZ8p", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_xtbL3_JhQnAYS_6AQGDiQ" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_BowKpX7oIEvSZAa5G-8Cj", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_AlkJCvRexbLp1t3wre1uD" }, { "gaps": [ "Missing explicit parameter definitions in documentation" ], "pages": [], "sourceId": "sds_jRl0O0t2JNWjX4MjQ_kC5", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_0KHmU6zKJBn3JfGQhhbYP" }, { "gaps": [ "Missing parameter details and response schema" ], "pages": [], "sourceId": "sds_UpX4G0QiFQ_cIhdwzu8pk", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_eR8hqN-7MniZX5AeOeQLh" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_wvqPOTBJ3ELhy96dsub_l", "authority": "supplemental", "conflicts": [ "/summary", "/description" ], "revisionId": "sdrn_f7m9IOfd1EwYpLs8JZOMM" } ], "x-zeroclick-services": [ "realtime-product-search" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-product-search", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-product-search", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-product-search/product-reviews": { "get": { "summary": "Product Reviews", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "cursor": { "type": "string", "description": "A pagination cursor for fetching additional reviews." }, "product_rating": { "type": "number", "description": "The average rating of the product." }, "reviews_per_rating": { "type": "object", "properties": { "1": { "type": "integer", "description": "The number of one-star reviews." }, "2": { "type": "integer", "description": "The number of two-star reviews." }, "3": { "type": "integer", "description": "The number of three-star reviews." }, "4": { "type": "integer", "description": "The number of four-star reviews." }, "5": { "type": "integer", "description": "The number of five-star reviews." } } }, "product_num_reviews": { "type": "integer", "description": "The total number of reviews for the product." } } }, "status": { "type": "string", "description": "The status of the response, indicating success or failure." }, "request_id": { "type": "string", "description": "A unique identifier for the request." } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "product_id", "schema": { "type": "string" }, "example": "3264458344382933005", "required": true, "description": "Product id of the product for which to fetch reviews." }, { "in": "query", "name": "limit", "schema": { "type": "integer", "default": 10, "maximum": 100, "minimum": 1 }, "description": "Maximum number of product reviews to return." }, { "in": "query", "name": "cursor", "schema": { "type": "string" }, "description": "A cursor to get the next set of results, it can be used for for paging purposes. Note: the cursor value for the next set of results is returned by this endpoint under data.cursor." }, { "in": "query", "name": "sort_by", "schema": { "enum": [ "MOST_RELEVANT", "MOST_RECENT" ], "type": "string", "default": "MOST_RELEVANT" }, "description": "Return reviews in a specific sort order." }, { "in": "query", "name": "rating", "schema": { "type": "string", "default": 0 }, "description": "Only return reviews with user rating greater than the specified value. Allowed values: 1-5." }, { "in": "query", "name": "country", "schema": { "type": "string", "default": "us" }, "description": "Country code of the region/country to return offers for. Allowed values: See https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2." }, { "in": "query", "name": "language", "schema": { "type": "string", "default": "en" }, "description": "The language of the results. Allowed values: See https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes." } ], "description": "Get all product reviews. Pagination/scrolling is supported using the *cursor* and *limit* parameters.", "operationId": "realtime_product_search__get__product_reviews", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_1_LX_FbWCA7U09K5zzV8z", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_1Y4Iq_rRp239QLf6anxmA" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_AtF5v_vXxTbq1wWfTbZ8p", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_xtbL3_JhQnAYS_6AQGDiQ" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_BowKpX7oIEvSZAa5G-8Cj", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_AlkJCvRexbLp1t3wre1uD" }, { "gaps": [ "Missing explicit parameter definitions in documentation" ], "pages": [], "sourceId": "sds_jRl0O0t2JNWjX4MjQ_kC5", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_0KHmU6zKJBn3JfGQhhbYP" }, { "gaps": [ "Missing parameter details and response schema" ], "pages": [], "sourceId": "sds_UpX4G0QiFQ_cIhdwzu8pk", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_eR8hqN-7MniZX5AeOeQLh" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_wvqPOTBJ3ELhy96dsub_l", "authority": "supplemental", "conflicts": [ "/description" ], "revisionId": "sdrn_f7m9IOfd1EwYpLs8JZOMM" } ], "x-zeroclick-services": [ "realtime-product-search" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-product-search", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-product-search", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-product-search/product-reviews-v2": { "get": { "summary": "Product Reviews (New Layout / US)", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "cursor": { "type": "string", "description": "A pagination cursor for retrieving more reviews" }, "product_rating": { "type": "number", "description": "The average rating of the product" }, "reviews_per_rating": { "type": "object", "properties": { "1": { "type": "integer", "description": "The number of 1-star reviews" }, "2": { "type": "integer", "description": "The number of 2-star reviews" }, "3": { "type": "integer", "description": "The number of 3-star reviews" }, "4": { "type": "integer", "description": "The number of 4-star reviews" }, "5": { "type": "integer", "description": "The number of 5-star reviews" } } }, "product_num_reviews": { "type": "integer", "description": "The total number of reviews for the product" } } }, "status": { "type": "string", "description": "The status of the response" }, "request_id": { "type": "string", "description": "A unique identifier for the request" } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "product_id", "schema": { "type": "string" }, "example": "catalogid:15554707778408471208,gpcid:6219277726645206819,headlineOfferDocid:8835386203856143595,rds:PC_15478400683365031707|PROD_PC_15478400683365031707,imageDocid:10653897321817113741,mid:576462815432560445,pvt:hg,pvf:", "required": true, "description": "Product id of the product for which to fetch reviews." }, { "in": "query", "name": "limit", "schema": { "type": "integer", "default": 10, "maximum": 100, "minimum": 1 }, "description": "Maximum number of product reviews to return." }, { "in": "query", "name": "cursor", "schema": { "type": "string" }, "description": "A cursor to get the next set of results, it can be used for for paging purposes. \n **Note:** the cursor value for the next set of results is returned by this endpoint under data.cursor." }, { "in": "query", "name": "sort_by", "schema": { "enum": [ "MOST_RELEVANT", "MOST_RECENT" ], "type": "string", "default": "MOST_RELEVANT" }, "description": "Return reviews in a specific sort order." }, { "in": "query", "name": "rating", "schema": { "type": "string", "default": 0 }, "description": "Only return reviews with user rating greater than the specified value. Allowed values: 1-5." }, { "in": "query", "name": "country", "schema": { "type": "string", "default": "us" }, "description": "Country code of the region/country to return offers for. Allowed values: See https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2." }, { "in": "query", "name": "language", "schema": { "type": "string", "default": "en" }, "description": "The language of the results. Allowed values: See https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes." } ], "description": "Get all product reviews with pagination/scrolling support. \n\n This endpoint provides the data and functionality available on the new Google Shopping layout / UI. \n \n At that moment, the new Google Shopping layout is available on the following countries: \n `ai, gb, in, aw, ar, at, au, br, bm, io, be, ky, ca, cl, co, cc, cx, dk, cz, fk, fi, pf, fr, tf, de, gf, gp, hk, hm, hu, gr, id, in, il, it, ie, jp, kr, my, yt, mx, mq, ms, nc, nl, no, nf, ph, nz, ro, pt, re, ru, pl, sa, pm, sg, sk, za, se, tw, gs, tk, th, ch, tc, ua, es, ae, vg, tr, us, gb, vn, wf` \n \n For other countries, use the \"Product Reviews\" endpoint under \"Google Shopping V1\" instead. \n We are monitoring this change and will add support for other countries as they are rolled out to Google Shopping.", "operationId": "realtime_product_search__get__product_reviews_v2", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_1_LX_FbWCA7U09K5zzV8z", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_1Y4Iq_rRp239QLf6anxmA" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_AtF5v_vXxTbq1wWfTbZ8p", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_xtbL3_JhQnAYS_6AQGDiQ" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_BowKpX7oIEvSZAa5G-8Cj", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_AlkJCvRexbLp1t3wre1uD" }, { "gaps": [ "Missing explicit parameter definitions in documentation" ], "pages": [], "sourceId": "sds_jRl0O0t2JNWjX4MjQ_kC5", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_0KHmU6zKJBn3JfGQhhbYP" }, { "gaps": [ "Missing parameter details and response schema" ], "pages": [], "sourceId": "sds_UpX4G0QiFQ_cIhdwzu8pk", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_eR8hqN-7MniZX5AeOeQLh" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_wvqPOTBJ3ELhy96dsub_l", "authority": "supplemental", "conflicts": [ "/summary", "/description" ], "revisionId": "sdrn_f7m9IOfd1EwYpLs8JZOMM" } ], "x-zeroclick-services": [ "realtime-product-search" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-product-search", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-product-search", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-product-search/search": { "get": { "summary": "Search", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "filters": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the filter." }, "multivalue": { "type": "boolean", "description": "Indicates whether multiple values can be selected for the filter." } } } }, "products": { "type": "array", "items": { "type": "object", "properties": { "product_id": { "type": "string", "description": "A unique identifier for the product." }, "product_title": { "type": "string", "description": "The title of the product." }, "product_rating": { "type": "number", "description": "The average rating of the product." }, "product_page_url": { "type": "string", "description": "The URL of the product's main page." }, "product_num_offers": { "type": "string", "description": "The number of offers available for the product." }, "product_description": { "type": "string", "description": "A brief description of the product." }, "product_num_reviews": { "type": "integer", "description": "The total number of reviews for the product." }, "typical_price_range": { "type": "array", "items": { "type": "string" }, "description": "The usual price range of the product." }, "product_specs_page_url": { "type": "string", "description": "The URL to view the product specifications." }, "product_offers_page_url": { "type": "string", "description": "The URL to view different offers for the product." }, "product_reviews_page_url": { "type": "string", "description": "The URL to view customer reviews of the product." } } } } } }, "status": { "type": "string", "description": "The status of the response, typically indicating success or failure." }, "request_id": { "type": "string", "description": "A unique identifier for the request." } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "q", "schema": { "type": "string" }, "example": "Nike shoes", "required": true, "description": "Search query / keyword" }, { "in": "query", "name": "country", "schema": { "type": "string", "default": "us" }, "description": "Country code of the region/country to return offers for. Allowed values: See https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2." }, { "in": "query", "name": "language", "schema": { "type": "string", "default": "en" }, "description": "The language of the results. Allowed values: See https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes." }, { "in": "query", "name": "page", "schema": { "type": "integer", "default": 1, "maximum": 100, "minimum": 1 }, "description": "Results page to return (each page contains up to 100 product results)." }, { "in": "query", "name": "limit", "schema": { "type": "integer", "default": 10, "maximum": 100, "minimum": 1 }, "description": "Maximum number of products to return." }, { "in": "query", "name": "sort_by", "schema": { "enum": [ "BEST_MATCH", "TOP_RATED", "LOWEST_PRICE", "HIGHEST_PRICE" ], "type": "string", "default": "BEST_MATCH" }, "description": "Sort product offers by best match, top rated, lowest or highest price." }, { "in": "query", "name": "min_price", "schema": { "type": "number" }, "description": "Only return product offers with price greater than a certain value" }, { "in": "query", "name": "max_price", "schema": { "type": "number" }, "description": "Only return product offers with price lower than a certain value" }, { "in": "query", "name": "product_condition", "schema": { "enum": [ "ANY", "NEW", "USED", "REFURBISHED" ], "type": "string", "default": "ANY" }, "description": "Only return products with a specific condition." }, { "in": "query", "name": "free_returns", "schema": { "type": "boolean", "default": false }, "description": "Only return product offers that offer free returns." }, { "in": "query", "name": "free_shipping", "schema": { "type": "boolean", "default": false }, "description": "Only return product offers that offer free shipping/delivery." }, { "in": "query", "name": "max_shipping_days", "schema": { "type": "number" }, "description": "Only return product offers that offer shipping/delivery of up to specific number of days (i.e. shipping speed)." }, { "in": "query", "name": "on_sale", "schema": { "type": "boolean", "default": false }, "description": "Only return product offers that are currently on sale." }, { "in": "query", "name": "store_id", "schema": { "type": "string" }, "description": "Only return product offers from specific stores. \n Store IDs can be obtained from the Google Shopping URL after using the Seller filter by taking the part after the merchagg: variable within the tbs parameter. \n When filtering for a certain Seller / Store on Google Shopping, a URL similar to the following is shown on the address bar: \n https://www.google.com/search?gl=us&tbm=shop&q=shoes&tbs=mr:1,merchagg:m100456214|m114373355, in that case, the Store IDs are m100456214 and m114373355 - to filter for these stores set store_id=m100456214,m114373355." }, { "in": "query", "name": "min_rating", "schema": { "enum": [ "ANY", "1", "2", "3", "4" ], "type": "string", "default": "ANY" }, "description": "Return products with rating greater than the specified value." }, { "in": "query", "name": "filters", "schema": { "type": "string" }, "description": "A list of filters (e.g. Size, Color, Price, etc) supported by Google Shopping for a specific query and result set. The filter values should be taken from the Search response filters array (separated by comma when multiple values are specified). \n In case a refinement filter is defined as multivalue (i.e. multivalue: true), multiple values from within the specific filter can be specified in the filters list (e.g. Seller), otherwise, only a single value can be specified for the filter (e.g. Price). " }, { "in": "query", "name": "return_filters", "schema": { "type": "boolean" }, "description": "Whether to return filters / refinements from Google Shopping (left refinement filters panel on desktop)." } ], "description": "Search for products on Google Shopping V1. Pagination/scrolling is supported using the page and limit parameters.", "operationId": "realtime_product_search__get__search", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing parameter details for filters, location, and pagination" ], "pages": [ 1 ], "sourceId": "sds__1fiQu9RHG0jaOVImz_2s", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/q/description", "/description", "/operationId" ], "revisionId": "sdrn_fMzoiFNl9X0S__Sj10MeV" }, { "gaps": [ "Missing parameter definitions", "Missing response schema" ], "pages": [], "sourceId": "sds_0prF_Y5BkmqQXtEQyheXN", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_Z5rvTt1qYfVU6DSLLxPnI" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds_5fumgq7Dew7p7p505C6Vj", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_UDnMGDO2AU7l2pD7FR4rR" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_D1eKbJ9D0SJoHD3LLOLYI", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_WiAI6D9DA33xLudF2TJIh" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_FK2maa1cDe4qcElj5U3zU", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_gZ-rMsS0AnYbgxe2iW2Nm" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds_MAxJPNBPJFwSKQLj1M1dr", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_QFW9HQumx231aOJCusPx0" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_soxpzUWt2CLoTKLGBZfNb", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_3H-1br_3SJ3ASZfGOL5Yr" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_vdxxiVsx4OKV5vH7hrhwb", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_46RDkwnCaOF5IxAFfXTW0" } ], "x-zeroclick-services": [ "realtime-product-search" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-product-search", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-product-search", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-product-search/search-light-v2": { "get": { "summary": "Search Light (New Layout / US)", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "filters": { "type": "array", "items": { "type": "object", "properties": { "title": { "type": "string", "description": "The title of the filter." }, "values": { "type": "array", "items": { "type": "object", "properties": { "q": { "type": "string", "description": "The query parameter value for the filter." }, "title": { "type": "string", "description": "The display name of the filter value." }, "shoprs": { "type": "string", "description": "A reference ID for shopping results." } } } }, "multivalue": { "type": "boolean", "description": "Indicates if multiple values can be selected for the filter." } } } } } }, "status": { "type": "string", "description": "The status of the response, indicating success or failure." }, "request_id": { "type": "string", "description": "A unique identifier for the request." } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "q", "schema": { "type": "string" }, "example": "Nike shoes", "required": true, "description": "Search query / keyword" }, { "in": "query", "name": "country", "schema": { "type": "string", "default": "us" }, "description": "Country code of the region/country to return offers for. Allowed values: See https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2." }, { "in": "query", "name": "language", "schema": { "type": "string", "default": "en" }, "description": "The language of the results. Allowed values: See https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes." }, { "in": "query", "name": "page", "schema": { "type": "integer", "default": 1, "maximum": 100, "minimum": 1 }, "description": "Results page to return (each page contains up to 100 product results)." }, { "in": "query", "name": "limit", "schema": { "type": "integer", "default": 10, "maximum": 100, "minimum": 1 }, "description": "Maximum number of products to return." }, { "in": "query", "name": "sort_by", "schema": { "enum": [ "BEST_MATCH", "TOP_RATED", "LOWEST_PRICE", "HIGHEST_PRICE" ], "type": "string", "default": "BEST_MATCH" }, "description": "Sort product offers by best match, top rated, lowest or highest price." }, { "in": "query", "name": "min_price", "schema": { "type": "number" }, "description": "Only return product offers with price greater than a certain value" }, { "in": "query", "name": "max_price", "schema": { "type": "number" }, "description": "Only return product offers with price lower than a certain value" }, { "in": "query", "name": "product_condition", "schema": { "enum": [ "ANY", "NEW", "USED", "REFURBISHED" ], "type": "string", "default": "ANY" }, "description": "Only return products with a specific condition." }, { "in": "query", "name": "stores", "schema": { "type": "string" }, "description": "Only return product offers from specific stores. Accepts a single or a comma delimited list of store names (e.g. best buy,walmart,amazon)." }, { "in": "query", "name": "free_returns", "schema": { "type": "boolean", "default": false }, "description": "Only return product offers that offer free returns." }, { "in": "query", "name": "free_shipping", "schema": { "type": "boolean", "default": false }, "description": "Only return product offers that offer free shipping/delivery." }, { "in": "query", "name": "on_sale", "schema": { "type": "boolean", "default": false }, "description": "Only return product offers that are currently on sale." }, { "in": "query", "name": "shoprs", "schema": { "type": "string" }, "description": "The parameter controls filtering, along with the q parameter. \n It should be used in combination with the updated q parameter, which now contains the name of the filter applied next to your original query. \n You can get the shoprs filter value from the response of this endpoint, under the filters response field. \n In addition, it can be obtained directly from Google Shopping and used with the endpoint." }, { "in": "query", "name": "return_filters", "schema": { "type": "boolean" }, "description": "Whether to return filters / refinements from Google Shopping (left refinement filters panel on desktop)." } ], "description": "Super fast product search endpoint providing product listings, sponsored products, and search filters / refinements from Google Shopping. To search and get the full product details, please refer to the \"Search (Full)\" endpoint.", "operationId": "realtime_product_search__get__search_light_v2", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing parameter definitions", "Missing response schema" ], "pages": [], "sourceId": "sds_0prF_Y5BkmqQXtEQyheXN", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_Z5rvTt1qYfVU6DSLLxPnI" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds_5fumgq7Dew7p7p505C6Vj", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_UDnMGDO2AU7l2pD7FR4rR" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_D1eKbJ9D0SJoHD3LLOLYI", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_WiAI6D9DA33xLudF2TJIh" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_FK2maa1cDe4qcElj5U3zU", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_gZ-rMsS0AnYbgxe2iW2Nm" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds_MAxJPNBPJFwSKQLj1M1dr", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_QFW9HQumx231aOJCusPx0" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_soxpzUWt2CLoTKLGBZfNb", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_3H-1br_3SJ3ASZfGOL5Yr" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_vdxxiVsx4OKV5vH7hrhwb", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_46RDkwnCaOF5IxAFfXTW0" } ], "x-zeroclick-services": [ "realtime-product-search" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-product-search", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-product-search", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-product-search/search-v2": { "get": { "summary": "Search (Full) (New Layout / US)", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "filters": { "type": "array", "items": { "type": "object", "properties": { "title": { "type": "string", "description": "The title of the filter." }, "values": { "type": "array", "items": { "type": "object", "properties": { "q": { "type": "string", "description": "The query parameter value for the filter." }, "title": { "type": "string", "description": "The display name of the filter value." }, "shoprs": { "type": "string", "description": "A reference ID for shopping results." } } } }, "multivalue": { "type": "boolean", "description": "Indicates if multiple values can be selected for the filter." } } } } } }, "status": { "type": "string", "description": "The status of the response, indicating success or failure." }, "request_id": { "type": "string", "description": "A unique identifier for the request." } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "q", "schema": { "type": "string" }, "example": "Nike shoes", "required": true, "description": "Search query / keyword" }, { "in": "query", "name": "country", "schema": { "type": "string", "default": "us" }, "description": "Country code of the region/country to return offers for. Allowed values: See https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2." }, { "in": "query", "name": "language", "schema": { "type": "string", "default": "en" }, "description": "The language of the results. Allowed values: See https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes." }, { "in": "query", "name": "page", "schema": { "type": "integer", "default": 1, "maximum": 100, "minimum": 1 }, "description": "Results page to return (each page contains up to 100 product results)." }, { "in": "query", "name": "limit", "schema": { "type": "integer", "default": 10, "maximum": 100, "minimum": 1 }, "description": "Maximum number of products to return." }, { "in": "query", "name": "sort_by", "schema": { "enum": [ "BEST_MATCH", "TOP_RATED", "LOWEST_PRICE", "HIGHEST_PRICE" ], "type": "string", "default": "BEST_MATCH" }, "description": "Sort product offers by best match, top rated, lowest or highest price." }, { "in": "query", "name": "min_price", "schema": { "type": "number" }, "description": "Only return product offers with price greater than a certain value" }, { "in": "query", "name": "max_price", "schema": { "type": "number" }, "description": "Only return product offers with price lower than a certain value" }, { "in": "query", "name": "product_condition", "schema": { "enum": [ "ANY", "NEW", "USED", "REFURBISHED" ], "type": "string", "default": "ANY" }, "description": "Only return products with a specific condition." }, { "in": "query", "name": "stores", "schema": { "type": "string" }, "description": "Only return product offers from specific stores. Accepts a single or a comma delimited list of store names (e.g. best buy,walmart,amazon)." }, { "in": "query", "name": "free_returns", "schema": { "type": "boolean", "default": false }, "description": "Only return product offers that offer free returns." }, { "in": "query", "name": "free_shipping", "schema": { "type": "boolean", "default": false }, "description": "Only return product offers that offer free shipping/delivery." }, { "in": "query", "name": "on_sale", "schema": { "type": "boolean", "default": false }, "description": "Only return product offers that are currently on sale." }, { "in": "query", "name": "shoprs", "schema": { "type": "string" }, "description": "The parameter controls filtering, along with the q parameter. \n It should be used in combination with the updated q parameter, which now contains the name of the filter applied next to your original query. \n You can get the shoprs filter value from the response of this endpoint, under the filters response field. \n In addition, it can be obtained directly from Google Shopping and used with the endpoint." }, { "in": "query", "name": "return_filters", "schema": { "type": "boolean" }, "description": "Whether to return filters / refinements from Google Shopping (left refinement filters panel on desktop)." } ], "description": "Search and get product listings (including full product details), sponsored products, and search filters / refinements from Google Shopping.", "operationId": "realtime_product_search__get__search_v2", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing parameter definitions", "Missing response schema" ], "pages": [], "sourceId": "sds_0prF_Y5BkmqQXtEQyheXN", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_Z5rvTt1qYfVU6DSLLxPnI" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds_5fumgq7Dew7p7p505C6Vj", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_UDnMGDO2AU7l2pD7FR4rR" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_D1eKbJ9D0SJoHD3LLOLYI", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_WiAI6D9DA33xLudF2TJIh" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_FK2maa1cDe4qcElj5U3zU", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_gZ-rMsS0AnYbgxe2iW2Nm" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds_MAxJPNBPJFwSKQLj1M1dr", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_QFW9HQumx231aOJCusPx0" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_soxpzUWt2CLoTKLGBZfNb", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_3H-1br_3SJ3ASZfGOL5Yr" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_vdxxiVsx4OKV5vH7hrhwb", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_46RDkwnCaOF5IxAFfXTW0" } ], "x-zeroclick-services": [ "realtime-product-search" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-product-search", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-product-search", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-product-search/store-reviews": { "get": { "summary": "Store Reviews", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "cursor": { "type": "string", "description": "A pagination cursor for fetching additional reviews." }, "store_rating": { "type": "number", "description": "The average rating of the store." }, "store_num_reviews": { "type": "integer", "description": "The total number of reviews for the store." } } }, "status": { "type": "string", "description": "The status of the response, indicating success or failure." }, "request_id": { "type": "string", "description": "A unique identifier for the request." } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "store_domain", "schema": { "type": "string" }, "example": "amazon.com", "required": true, "description": "The domain of the (TLD) of the store for which to get reviews (e.g. amazon.com)." }, { "in": "query", "name": "limit", "schema": { "type": "integer", "default": 10, "maximum": 100, "minimum": 1 }, "description": "Maximum number of store reviews to return." }, { "in": "query", "name": "cursor", "schema": { "type": "string" }, "description": "A cursor to get the next set of results, for for paging purposes. **Note:** the cursor value for the next set of results is returned by this endpoint under data.cursor." }, { "in": "query", "name": "rating", "schema": { "type": "string" }, "description": "Only return reviews with specific rating. Default: ALL Allowed values: ALL, FIVE_STARS, FOUR_STARS, THREE_STARS, TWO_STARS, ONE_STAR" }, { "in": "query", "name": "sort_by", "schema": { "enum": [ "MOST_HELPFUL", "MOST_RECENT" ], "type": "string", "default": "MOST_HELPFUL" }, "description": "Return store reviews in a specific sort order." }, { "in": "query", "name": "time_frame", "schema": { "enum": [ "ALL", "ONE_YEAR", "TWO_YEARS", "SIX_MONTHS", "THREE_MONTHS" ], "type": "string", "default": "ALL" }, "description": "Only return reviews posted in a specific time range." }, { "in": "query", "name": "country", "schema": { "type": "string", "default": "us" }, "description": "Country code of the region/country. Allowed values: See https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2." }, { "in": "query", "name": "language", "schema": { "type": "string", "default": "en" }, "description": "The language of the results. Allowed values: See https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes." } ], "description": "Get all store / merchant reviews with pagination/scrolling support using the cursor and limit parameters.", "operationId": "realtime_product_search__get__store_reviews", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing parameter definitions", "Missing response schema" ], "pages": [], "sourceId": "sds_0prF_Y5BkmqQXtEQyheXN", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_Z5rvTt1qYfVU6DSLLxPnI" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds_5fumgq7Dew7p7p505C6Vj", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_UDnMGDO2AU7l2pD7FR4rR" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_D1eKbJ9D0SJoHD3LLOLYI", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_WiAI6D9DA33xLudF2TJIh" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_FK2maa1cDe4qcElj5U3zU", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_gZ-rMsS0AnYbgxe2iW2Nm" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds_MAxJPNBPJFwSKQLj1M1dr", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_QFW9HQumx231aOJCusPx0" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_soxpzUWt2CLoTKLGBZfNb", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_3H-1br_3SJ3ASZfGOL5Yr" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_vdxxiVsx4OKV5vH7hrhwb", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_46RDkwnCaOF5IxAFfXTW0" } ], "x-zeroclick-services": [ "realtime-product-search" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-product-search", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-product-search", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-product-search/v2/deals": { "get": { "summary": "Deals", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "filters": { "type": "array", "items": { "type": "object", "properties": { "title": { "type": "string", "description": "The title of the filter." }, "values": { "type": "array", "items": { "type": "object", "properties": { "q": { "type": "string", "description": "The query parameter value for the filter." }, "title": { "type": "string", "description": "The display name of the filter value." }, "shoprs": { "type": "string", "description": "A reference ID for shopping results." } } } }, "multivalue": { "type": "boolean", "description": "Indicates if multiple values can be selected for the filter." } } } } } }, "status": { "type": "string", "description": "The status of the response" }, "request_id": { "type": "string", "description": "A unique identifier for the request" } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "q", "schema": { "type": "string" }, "example": "Laptop", "required": true, "description": "Search query / keyword" }, { "in": "query", "name": "country", "schema": { "type": "string", "default": "us" }, "description": "Country code of the region/country to return offers for. Allowed values: See https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2." }, { "in": "query", "name": "language", "schema": { "type": "string", "default": "en" }, "description": "The language of the results. Allowed values: See https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes." }, { "in": "query", "name": "page", "schema": { "type": "integer", "default": 1, "maximum": 100, "minimum": 1 }, "description": "Results page to return (each page contains up to 40 product results)." }, { "in": "query", "name": "limit", "schema": { "type": "integer", "default": 40, "maximum": 120, "minimum": 1 }, "description": "Maximum number of products to return." }, { "in": "query", "name": "sort_by", "schema": { "enum": [ "BEST_MATCH", "TOP_RATED", "LOWEST_PRICE", "HIGHEST_PRICE" ], "type": "string", "default": "BEST_MATCH" }, "description": "Sort product offers by best match, top rated, lowest or highest price." }, { "in": "query", "name": "min_price", "schema": { "type": "number" }, "description": "Only return product offers with price greater than a certain value" }, { "in": "query", "name": "max_price", "schema": { "type": "number" }, "description": "Only return product offers with price lower than a certain value" }, { "in": "query", "name": "product_condition", "schema": { "enum": [ "ANY", "NEW", "USED", "REFURBISHED" ], "type": "string", "default": "ANY" }, "description": "Only return products with a specific condition." }, { "in": "query", "name": "stores", "schema": { "type": "string" }, "description": "Only return product offers from specific stores. Accepts a single or a comma delimited list of store names (e.g. best buy,walmart,amazon)." }, { "in": "query", "name": "free_returns", "schema": { "type": "boolean", "default": false }, "description": "Only return product offers that offer free returns." }, { "in": "query", "name": "free_shipping", "schema": { "type": "boolean", "default": false }, "description": "Only return product offers that offer free shipping/delivery." }, { "in": "query", "name": "on_sale", "schema": { "type": "boolean", "default": false }, "description": "Only return product offers that are currently on sale." }, { "in": "query", "name": "shoprs", "schema": { "type": "string" }, "description": "The parameter controls filtering, along with the q parameter. \n It should be used in combination with the updated q parameter, which now contains the name of the filter applied next to your original query. \n You can get the shoprs filter value from the response of this endpoint, under the filters response field. \n In addition, it can be obtained directly from Google Shopping and used with the endpoint." }, { "in": "query", "name": "return_filters", "schema": { "type": "boolean" }, "description": "Whether to return filters / refinements from Google Shopping (left refinement filters panel on desktop)." } ], "description": "Search for product deals on Google Shopping with pagination/scrolling support.", "operationId": "realtime_product_search_v2__get__deals", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing parameter definitions", "Missing response schema" ], "pages": [], "sourceId": "sds_0prF_Y5BkmqQXtEQyheXN", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_Z5rvTt1qYfVU6DSLLxPnI" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds_5fumgq7Dew7p7p505C6Vj", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_UDnMGDO2AU7l2pD7FR4rR" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_D1eKbJ9D0SJoHD3LLOLYI", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_WiAI6D9DA33xLudF2TJIh" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_FK2maa1cDe4qcElj5U3zU", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_gZ-rMsS0AnYbgxe2iW2Nm" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds_MAxJPNBPJFwSKQLj1M1dr", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_QFW9HQumx231aOJCusPx0" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_soxpzUWt2CLoTKLGBZfNb", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_3H-1br_3SJ3ASZfGOL5Yr" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_vdxxiVsx4OKV5vH7hrhwb", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_46RDkwnCaOF5IxAFfXTW0" } ], "x-zeroclick-services": [ "realtime-product-search" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-product-search", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-product-search", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-product-search/v2/product-details": { "get": { "summary": "Product Details", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "offer": { "type": "object", "properties": { "price": { "type": "string", "description": "The current price of the product in the offer." }, "on_sale": { "type": "boolean", "description": "Indicates if the product is currently on sale." }, "offer_id": { "type": "string", "description": "The unique identifier for the offer." }, "shipping": { "type": "string", "description": "The shipping details of the offer." }, "store_name": { "type": "string", "description": "The name of the store offering the product." }, "offer_badge": { "type": "string", "description": "A label for promotional offers." }, "offer_title": { "type": "string", "description": "The title of the offer." }, "percent_off": { "type": "string", "description": "The percentage discount applied." }, "store_rating": { "type": "string", "description": "The rating of the store." }, "store_favicon": { "type": "string", "description": "The favicon URL of the store." }, "offer_page_url": { "type": "string", "description": "The URL of the offer page." }, "original_price": { "type": "string", "description": "The original price before any discounts." }, "payment_methods": { "type": "string", "description": "The available payment methods for the offer." }, "product_condition": { "type": "string", "description": "The condition of the product (e.g., new, used)." }, "store_review_count": { "type": "integer", "description": "The number of reviews for the store." }, "store_reviews_page_url": { "type": "string", "description": "The URL of the store's reviews page." }, "coupon_discount_percent": { "type": "string", "description": "The discount percentage applied via coupon." } } }, "videos": { "type": "array", "items": { "type": "object", "properties": { "title": { "type": "string", "nullable": true, "description": "The video title." }, "views": { "type": "integer", "nullable": true, "description": "The number of views the video has." }, "source": { "type": "string", "nullable": true, "description": "The platform hosting the video (e.g. YouTube)." }, "channel": { "type": "string", "nullable": true, "description": "The channel or publisher that posted the video." }, "duration": { "type": "string", "nullable": true, "description": "The video duration, formatted as M:SS." }, "video_id": { "type": "string", "nullable": true, "description": "The video identifier (e.g. the YouTube video id)." }, "video_url": { "type": "string", "nullable": true, "description": "The URL of the video." }, "favicon_url": { "type": "string", "nullable": true, "description": "The favicon URL of the video source." }, "thumbnail_url": { "type": "string", "nullable": true, "description": "The URL of the video thumbnail." } } }, "description": "Related videos for the product, such as reviews and unboxings." }, "product_id": { "type": "string", "description": "The unique identifier for the product." }, "top_insights": { "type": "array", "items": { "type": "object", "properties": { "topic": { "type": "string", "nullable": true, "description": "The insight topic (e.g. Comfort, Sizing, Value)." }, "topic_id": { "type": "string", "nullable": true, "description": "The identifier of the topic." }, "highlights": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "string", "nullable": true, "description": "The date of the highlight." }, "text": { "type": "string", "nullable": true, "description": "The highlight text." }, "author": { "type": "string", "nullable": true, "description": "The author of the highlight." }, "deep_link": { "type": "string", "nullable": true, "description": "A deep link to the specific review or section." }, "source_url": { "type": "string", "nullable": true, "description": "The URL of the source." }, "source_name": { "type": "string", "nullable": true, "description": "The name of the source the highlight came from." }, "thumbnail_url": { "type": "string", "nullable": true, "description": "The thumbnail image URL associated with the highlight." }, "timestamp_label": { "type": "string", "nullable": true, "description": "A human-readable recency label for the highlight." } } }, "description": "Individual review highlights supporting the topic." } } }, "description": "Aggregated review insights grouped by topic, summarizing what customers say about the product." }, "product_title": { "type": "string", "description": "The title of the product." }, "product_rating": { "type": "number", "description": "The average rating of the product." }, "product_page_url": { "type": "string", "description": "The URL of the product page." }, "product_num_offers": { "type": "integer", "description": "The total number of available offers for the product." }, "product_description": { "type": "string", "description": "A brief description of the product." }, "product_num_reviews": { "type": "integer", "description": "The total number of reviews for the product." }, "typical_price_range": { "type": "array", "items": { "type": "string" }, "description": "The typical price range for the product." }, "discussions_and_forums": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string", "nullable": true, "description": "The URL of the discussion thread." }, "date": { "type": "string", "nullable": true, "description": "The date of the discussion." }, "title": { "type": "string", "nullable": true, "description": "The title of the discussion thread." }, "site_url": { "type": "string", "nullable": true, "description": "The URL of the site hosting the discussion." }, "snippets": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string", "nullable": true, "description": "The URL associated with the snippet." }, "text": { "type": "string", "nullable": true, "description": "The snippet text." } } }, "description": "Excerpts from the discussion thread." }, "subforum": { "type": "string", "nullable": true, "description": "The subforum or section the thread belongs to." }, "site_name": { "type": "string", "nullable": true, "description": "The name of the site hosting the discussion." }, "favicon_url": { "type": "string", "nullable": true, "description": "The favicon URL of the site." }, "subforum_url": { "type": "string", "nullable": true, "description": "The URL of the subforum." } } }, "description": "Relevant discussions and forum threads about the product." } } }, "status": { "type": "string", "description": "The status of the response, indicating success or failure." }, "request_id": { "type": "string", "description": "A unique identifier for the request." } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "product_id", "schema": { "type": "string" }, "example": "catalogid:2941335935823932668,productid:,gpcid:6219277726645206819,headlineOfferDocid:6922745083394626272,rds:PC_6219277726645206819|PROD_PC_6219277726645206819,imageDocid:11700829382450873418,mid:576462815432560445,pvt:a,pvf:", "required": true, "description": "Product id of the product for which to get full details." }, { "in": "query", "name": "country", "schema": { "type": "string", "default": "us" }, "description": "Country code of the region/country for the call.. Allowed values: See https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2." }, { "in": "query", "name": "language", "schema": { "type": "string", "default": "en" }, "description": "The language of the results. Allowed values: See https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes." } ], "description": "Get the details of a specific product by product id. Returns the full product details in addition to reviews sample, photos, product specs and more information.", "operationId": "realtime_product_search_v2__get__product_details", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing parameter definitions", "Missing response schema" ], "pages": [], "sourceId": "sds_0prF_Y5BkmqQXtEQyheXN", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_Z5rvTt1qYfVU6DSLLxPnI" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds_5fumgq7Dew7p7p505C6Vj", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_UDnMGDO2AU7l2pD7FR4rR" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_D1eKbJ9D0SJoHD3LLOLYI", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_WiAI6D9DA33xLudF2TJIh" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_FK2maa1cDe4qcElj5U3zU", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_gZ-rMsS0AnYbgxe2iW2Nm" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds_MAxJPNBPJFwSKQLj1M1dr", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_QFW9HQumx231aOJCusPx0" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_soxpzUWt2CLoTKLGBZfNb", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_3H-1br_3SJ3ASZfGOL5Yr" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_vdxxiVsx4OKV5vH7hrhwb", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_46RDkwnCaOF5IxAFfXTW0" } ], "x-zeroclick-services": [ "realtime-product-search" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-product-search", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-product-search", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-product-search/v2/product-offers": { "get": { "summary": "Product Offers", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "videos": { "type": "array", "items": { "type": "object", "properties": { "title": { "type": "string", "nullable": true, "description": "The video title." }, "views": { "type": "integer", "nullable": true, "description": "The number of views the video has." }, "source": { "type": "string", "nullable": true, "description": "The platform hosting the video (e.g. YouTube)." }, "channel": { "type": "string", "nullable": true, "description": "The channel or publisher that posted the video." }, "duration": { "type": "string", "nullable": true, "description": "The video duration, formatted as M:SS." }, "video_id": { "type": "string", "nullable": true, "description": "The video identifier (e.g. the YouTube video id)." }, "video_url": { "type": "string", "nullable": true, "description": "The URL of the video." }, "favicon_url": { "type": "string", "nullable": true, "description": "The favicon URL of the video source." }, "thumbnail_url": { "type": "string", "nullable": true, "description": "The URL of the video thumbnail." } } }, "description": "Related videos for the product, such as reviews and unboxings." }, "top_insights": { "type": "array", "items": { "type": "object", "properties": { "topic": { "type": "string", "nullable": true, "description": "The insight topic (e.g. Comfort, Sizing, Value)." }, "topic_id": { "type": "string", "nullable": true, "description": "The identifier of the topic." }, "highlights": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "string", "nullable": true, "description": "The date of the highlight." }, "text": { "type": "string", "nullable": true, "description": "The highlight text." }, "author": { "type": "string", "nullable": true, "description": "The author of the highlight." }, "deep_link": { "type": "string", "nullable": true, "description": "A deep link to the specific review or section." }, "source_url": { "type": "string", "nullable": true, "description": "The URL of the source." }, "source_name": { "type": "string", "nullable": true, "description": "The name of the source the highlight came from." }, "thumbnail_url": { "type": "string", "nullable": true, "description": "The thumbnail image URL associated with the highlight." }, "timestamp_label": { "type": "string", "nullable": true, "description": "A human-readable recency label for the highlight." } } }, "description": "Individual review highlights supporting the topic." } } }, "description": "Aggregated review insights grouped by topic, summarizing what customers say about the product." }, "product_rating": { "type": "number", "description": "The average rating of the product." }, "product_num_reviews": { "type": "integer", "description": "The total number of reviews for the product." }, "discussions_and_forums": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string", "nullable": true, "description": "The URL of the discussion thread." }, "date": { "type": "string", "nullable": true, "description": "The date of the discussion." }, "title": { "type": "string", "nullable": true, "description": "The title of the discussion thread." }, "site_url": { "type": "string", "nullable": true, "description": "The URL of the site hosting the discussion." }, "snippets": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string", "nullable": true, "description": "The URL associated with the snippet." }, "text": { "type": "string", "nullable": true, "description": "The snippet text." } } }, "description": "Excerpts from the discussion thread." }, "subforum": { "type": "string", "nullable": true, "description": "The subforum or section the thread belongs to." }, "site_name": { "type": "string", "nullable": true, "description": "The name of the site hosting the discussion." }, "favicon_url": { "type": "string", "nullable": true, "description": "The favicon URL of the site." }, "subforum_url": { "type": "string", "nullable": true, "description": "The URL of the subforum." } } }, "description": "Relevant discussions and forum threads about the product." } } }, "status": { "type": "string", "description": "The status of the response, indicating success or failure." }, "request_id": { "type": "string", "description": "A unique identifier for the request." } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "product_id", "schema": { "type": "string" }, "example": "catalogid:2941335935823932668,productid:,gpcid:6219277726645206819,headlineOfferDocid:6922745083394626272,rds:PC_6219277726645206819|PROD_PC_6219277726645206819,imageDocid:11700829382450873418,mid:576462815432560445,pvt:a,pvf:", "required": true, "description": "Product id of the product for which to fetch offers." }, { "in": "query", "name": "page", "schema": { "type": "integer", "default": 1 }, "description": "The page to return. Each page contains offers from 10 different stores (potentially resulting in more than 10 offers)." }, { "in": "query", "name": "country", "schema": { "type": "string", "default": "us" }, "description": "Country code of the region/country to return offers for. Allowed values: See https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2." }, { "in": "query", "name": "language", "schema": { "type": "string", "default": "en" }, "description": "The language of the results. Allowed values: See https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes." } ], "description": "Get all offers available for a product. \n Each page of offers contains offers from 10 sellers, however, since some stores sell the same item more than once (e.g. Amazon, eBay, etc), it's possible that more than 10 offers will be returned.", "operationId": "realtime_product_search_v2__get__product_offers", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing parameter definitions", "Missing response schema" ], "pages": [], "sourceId": "sds_0prF_Y5BkmqQXtEQyheXN", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_Z5rvTt1qYfVU6DSLLxPnI" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds_5fumgq7Dew7p7p505C6Vj", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_UDnMGDO2AU7l2pD7FR4rR" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_D1eKbJ9D0SJoHD3LLOLYI", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_WiAI6D9DA33xLudF2TJIh" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_FK2maa1cDe4qcElj5U3zU", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_gZ-rMsS0AnYbgxe2iW2Nm" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds_MAxJPNBPJFwSKQLj1M1dr", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_QFW9HQumx231aOJCusPx0" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_soxpzUWt2CLoTKLGBZfNb", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_3H-1br_3SJ3ASZfGOL5Yr" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_vdxxiVsx4OKV5vH7hrhwb", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_46RDkwnCaOF5IxAFfXTW0" } ], "x-zeroclick-services": [ "realtime-product-search" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-product-search", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-product-search", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-product-search/v2/product-price-history-v2": { "get": { "summary": "Product Price History", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "offers": { "type": "array", "items": { "type": "object", "properties": { "price": { "type": "string", "nullable": true, "description": "The current price for this offer." }, "on_sale": { "type": "boolean", "nullable": true, "description": "Indicates whether the offer is currently on sale." }, "returns": { "type": "string", "nullable": true, "description": "The returns policy of the offer." }, "offer_id": { "type": "string", "nullable": true, "description": "The unique identifier for the offer." }, "shipping": { "type": "string", "nullable": true, "description": "The shipping details of the offer." }, "store_name": { "type": "string", "nullable": true, "description": "The name of the store/seller for this offer." }, "merchant_id": { "type": "string", "nullable": true, "description": "The identifier of the merchant." }, "offer_title": { "type": "string", "nullable": true, "description": "The title of the offer." }, "store_rating": { "type": "string", "nullable": true, "description": "The rating of the store." }, "price_history": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "string", "description": "The date of the recorded price." }, "price": { "type": "string", "description": "The recorded price on that date." } } }, "description": "The dated price points for this offer (can be empty when no history is available)." }, "store_favicon": { "type": "string", "nullable": true, "description": "The favicon URL of the store." }, "offer_page_url": { "type": "string", "nullable": true, "description": "The URL of the offer page." }, "original_price": { "type": "string", "nullable": true, "description": "The original price before any discount." }, "payment_methods": { "type": "string", "nullable": true, "description": "The available payment methods for the offer." }, "product_condition": { "type": "string", "nullable": true, "description": "The condition of the product (e.g. NEW)." }, "store_review_count": { "type": "integer", "nullable": true, "description": "The number of reviews for the store." }, "store_reviews_page_url": { "type": "string", "nullable": true, "description": "The URL of the store's reviews page." } } }, "description": "The offers for the current page, each enriched with its dated price history. Use the page parameter to page through offers." }, "product_id": { "type": "string", "description": "The unique identifier of the product. The response also carries the full Product Details payload (product_title, product_photos, product_rating, top_insights, videos, discussions_and_forums, etc.); see the Product Details endpoint for the complete product schema." }, "product_title": { "type": "string", "description": "The title of the product." }, "product_rating": { "type": "number", "description": "The average rating of the product." }, "product_num_offers": { "type": "integer", "description": "The total number of available offers for the product." } } }, "status": { "type": "string", "description": "The status of the API response." }, "request_id": { "type": "string", "description": "A unique identifier for this request." } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "product_id", "schema": { "type": "string" }, "example": "catalogid:2941335935823932668,productid:,gpcid:6219277726645206819,headlineOfferDocid:6922745083394626272,rds:PC_6219277726645206819|PROD_PC_6219277726645206819,imageDocid:11700829382450873418,mid:576462815432560445,pvt:a,pvf:", "required": true, "description": "Product id of the product for which to get price history." }, { "in": "query", "name": "page", "schema": { "type": "integer", "default": 1 }, "description": "The page of offers to return price history for. Page 1 returns the top offers; each subsequent page pages through the remaining stores/offers." }, { "in": "query", "name": "country", "schema": { "type": "string", "default": "us" }, "description": "Country code of the region/country for the call. Allowed values: See https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2" }, { "in": "query", "name": "language", "schema": { "type": "string", "default": "en" }, "description": "The language of the results. Allowed values: See https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes." } ], "description": "Get a product's full details along with the price history of each offer/store selling it. The response mirrors the Product Details endpoint, with every entry in the `offers` array additionally enriched with its dated `price_history`. Use the `page` parameter to page through the offers (page 1 returns the top offers, subsequent pages return additional stores/offers).", "operationId": "realtime_product_search_v2__get__product_price_history_v2", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing parameter definitions", "Missing response schema" ], "pages": [], "sourceId": "sds_0prF_Y5BkmqQXtEQyheXN", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_Z5rvTt1qYfVU6DSLLxPnI" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds_5fumgq7Dew7p7p505C6Vj", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_UDnMGDO2AU7l2pD7FR4rR" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_D1eKbJ9D0SJoHD3LLOLYI", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_WiAI6D9DA33xLudF2TJIh" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_FK2maa1cDe4qcElj5U3zU", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_gZ-rMsS0AnYbgxe2iW2Nm" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds_MAxJPNBPJFwSKQLj1M1dr", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_QFW9HQumx231aOJCusPx0" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_soxpzUWt2CLoTKLGBZfNb", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_3H-1br_3SJ3ASZfGOL5Yr" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_vdxxiVsx4OKV5vH7hrhwb", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_46RDkwnCaOF5IxAFfXTW0" } ], "x-zeroclick-services": [ "realtime-product-search" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-product-search", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-product-search", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-product-search/v2/product-reviews": { "get": { "summary": "Product Reviews", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "cursor": { "type": "string", "description": "A pagination cursor for retrieving more reviews" }, "product_rating": { "type": "number", "description": "The average rating of the product" }, "reviews_per_rating": { "type": "object", "properties": { "1": { "type": "integer", "description": "The number of 1-star reviews" }, "2": { "type": "integer", "description": "The number of 2-star reviews" }, "3": { "type": "integer", "description": "The number of 3-star reviews" }, "4": { "type": "integer", "description": "The number of 4-star reviews" }, "5": { "type": "integer", "description": "The number of 5-star reviews" } } }, "product_num_reviews": { "type": "integer", "description": "The total number of reviews for the product" } } }, "status": { "type": "string", "description": "The status of the response" }, "request_id": { "type": "string", "description": "A unique identifier for the request" } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "product_id", "schema": { "type": "string" }, "example": "catalogid:8425421641323327810,gpcid:1261873578657646759,headlineOfferDocid:6367138647863486978,rds:PC_1261873578657646759|PROD_PC_1261873578657646759,imageDocid:17958223083723421156,mid:576462516936404275,pvt:hg,pvf:", "required": true, "description": "Product id of the product for which to fetch reviews." }, { "in": "query", "name": "limit", "schema": { "type": "integer", "default": 10, "maximum": 100, "minimum": 1 }, "description": "Maximum number of product reviews to return." }, { "in": "query", "name": "cursor", "schema": { "type": "string" }, "description": "A cursor to get the next set of results, it can be used for for paging purposes. \n **Note:** the cursor value for the next set of results is returned by this endpoint under data.cursor." }, { "in": "query", "name": "sort_by", "schema": { "enum": [ "MOST_RELEVANT", "MOST_RECENT" ], "type": "string", "default": "MOST_RELEVANT" }, "description": "Return reviews in a specific sort order." }, { "in": "query", "name": "rating", "schema": { "type": "string", "default": 0 }, "description": "Only return reviews with user rating greater than the specified value. Allowed values: 1-5." }, { "in": "query", "name": "country", "schema": { "type": "string", "default": "us" }, "description": "Country code of the region/country. Allowed values: See https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2." }, { "in": "query", "name": "language", "schema": { "type": "string", "default": "en" }, "description": "The language of the results. Allowed values: See https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes." } ], "description": "Get all product reviews with pagination/scrolling support. \n\n This endpoint provides the data and functionality available on the new Google Shopping layout / UI. \n \n At that moment, the new Google Shopping layout is available on the following countries: \n `ai, gb, in, aw, ar, at, au, br, bm, io, be, ky, ca, cl, co, cc, cx, dk, cz, fk, fi, pf, fr, tf, de, gf, gp, hk, hm, hu, gr, id, in, il, it, ie, jp, kr, my, yt, mx, mq, ms, nc, nl, no, nf, ph, nz, ro, pt, re, ru, pl, sa, pm, sg, sk, za, se, tw, gs, tk, th, ch, tc, ua, es, ae, vg, tr, us, gb, vn, wf` \n \n For other countries, use the \"Product Reviews\" endpoint under \"Google Shopping V1\" instead. \n We are monitoring this change and will add support for other countries as they are rolled out to Google Shopping.", "operationId": "realtime_product_search_v2__get__product_reviews", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing parameter definitions", "Missing response schema" ], "pages": [], "sourceId": "sds_0prF_Y5BkmqQXtEQyheXN", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_Z5rvTt1qYfVU6DSLLxPnI" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds_5fumgq7Dew7p7p505C6Vj", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_UDnMGDO2AU7l2pD7FR4rR" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_D1eKbJ9D0SJoHD3LLOLYI", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_WiAI6D9DA33xLudF2TJIh" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_FK2maa1cDe4qcElj5U3zU", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_gZ-rMsS0AnYbgxe2iW2Nm" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds_MAxJPNBPJFwSKQLj1M1dr", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_QFW9HQumx231aOJCusPx0" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_soxpzUWt2CLoTKLGBZfNb", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_3H-1br_3SJ3ASZfGOL5Yr" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_vdxxiVsx4OKV5vH7hrhwb", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_46RDkwnCaOF5IxAFfXTW0" } ], "x-zeroclick-services": [ "realtime-product-search" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-product-search", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-product-search", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-product-search/v2/search": { "get": { "summary": "Product Search", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "filters": { "type": "array", "items": { "type": "object", "properties": { "title": { "type": "string", "description": "The title of the filter." }, "values": { "type": "array", "items": { "type": "object", "properties": { "q": { "type": "string", "description": "The query parameter value for the filter." }, "title": { "type": "string", "description": "The display name of the filter value." }, "shoprs": { "type": "string", "description": "A reference ID for shopping results." } } } }, "multivalue": { "type": "boolean", "description": "Indicates if multiple values can be selected for the filter." } } } } } }, "status": { "type": "string", "description": "The status of the response, indicating success or failure." }, "request_id": { "type": "string", "description": "A unique identifier for the request." } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "q", "schema": { "type": "string" }, "example": "Nike shoes", "required": true, "description": "Search query / keyword" }, { "in": "query", "name": "country", "schema": { "type": "string", "default": "us" }, "description": "Country code of the region/country to return offers for. Allowed values: See https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2." }, { "in": "query", "name": "language", "schema": { "type": "string", "default": "en" }, "description": "The language of the results. Allowed values: See https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes." }, { "in": "query", "name": "page", "schema": { "type": "integer", "default": 1, "maximum": 100, "minimum": 1 }, "description": "Results page to return (each page contains up to 40 product results)." }, { "in": "query", "name": "limit", "schema": { "type": "integer", "default": 40, "maximum": 120, "minimum": 1 }, "description": "Maximum number of products to return." }, { "in": "query", "name": "sort_by", "schema": { "enum": [ "BEST_MATCH", "TOP_RATED", "LOWEST_PRICE", "HIGHEST_PRICE" ], "type": "string", "default": "BEST_MATCH" }, "description": "Sort product offers by best match, top rated, lowest or highest price." }, { "in": "query", "name": "min_price", "schema": { "type": "number" }, "description": "Only return product offers with price greater than a certain value" }, { "in": "query", "name": "max_price", "schema": { "type": "number" }, "description": "Only return product offers with price lower than a certain value" }, { "in": "query", "name": "product_condition", "schema": { "enum": [ "ANY", "NEW", "USED", "REFURBISHED" ], "type": "string", "default": "ANY" }, "description": "Only return products with a specific condition." }, { "in": "query", "name": "stores", "schema": { "type": "string" }, "description": "Only return product offers from specific stores. Accepts a single or a comma delimited list of store names (e.g. best buy,walmart,amazon)." }, { "in": "query", "name": "free_returns", "schema": { "type": "boolean", "default": false }, "description": "Only return product offers that offer free returns." }, { "in": "query", "name": "free_shipping", "schema": { "type": "boolean", "default": false }, "description": "Only return product offers that offer free shipping/delivery." }, { "in": "query", "name": "on_sale", "schema": { "type": "boolean", "default": false }, "description": "Only return product offers that are currently on sale." }, { "in": "query", "name": "shoprs", "schema": { "type": "string" }, "description": "The parameter controls filtering, along with the q parameter. \n It should be used in combination with the updated q parameter, which now contains the name of the filter applied next to your original query. \n You can get the shoprs filter value from the response of this endpoint, under the filters response field. \n In addition, it can be obtained directly from Google Shopping and used with the endpoint." }, { "in": "query", "name": "return_filters", "schema": { "type": "boolean" }, "description": "Whether to return filters / refinements from Google Shopping (left refinement filters panel on desktop)." } ], "description": "Search and get product listings (including full product details), sponsored products, and search filters / refinements from Google Shopping.", "operationId": "realtime_product_search_v2__get__search", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing parameter definitions", "Missing response schema" ], "pages": [], "sourceId": "sds_0prF_Y5BkmqQXtEQyheXN", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_Z5rvTt1qYfVU6DSLLxPnI" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds_5fumgq7Dew7p7p505C6Vj", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_UDnMGDO2AU7l2pD7FR4rR" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_D1eKbJ9D0SJoHD3LLOLYI", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_WiAI6D9DA33xLudF2TJIh" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_FK2maa1cDe4qcElj5U3zU", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_gZ-rMsS0AnYbgxe2iW2Nm" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds_MAxJPNBPJFwSKQLj1M1dr", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_QFW9HQumx231aOJCusPx0" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_soxpzUWt2CLoTKLGBZfNb", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_3H-1br_3SJ3ASZfGOL5Yr" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_vdxxiVsx4OKV5vH7hrhwb", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_46RDkwnCaOF5IxAFfXTW0" } ], "x-zeroclick-services": [ "realtime-product-search" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-product-search", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-product-search", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-product-search/v2/store-reviews": { "get": { "summary": "Store Reviews", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "cursor": { "type": "string", "description": "A pagination cursor for fetching additional reviews." }, "store_rating": { "type": "number", "description": "The average rating of the store." }, "store_num_reviews": { "type": "integer", "description": "The total number of reviews for the store." } } }, "status": { "type": "string", "description": "The status of the response, indicating success or failure." }, "request_id": { "type": "string", "description": "A unique identifier for the request." } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "store_domain", "schema": { "type": "string" }, "example": "amazon.com", "required": true, "description": "The domain of the (TLD) of the store for which to get reviews (e.g. amazon.com)." }, { "in": "query", "name": "limit", "schema": { "type": "integer", "default": 10, "maximum": 100, "minimum": 1 }, "description": "Maximum number of store reviews to return." }, { "in": "query", "name": "cursor", "schema": { "type": "string" }, "description": "A cursor to get the next set of results, for for paging purposes. **Note:** the cursor value for the next set of results is returned by this endpoint under data.cursor." }, { "in": "query", "name": "rating", "schema": { "type": "string" }, "description": "Only return reviews with specific rating. Default: ALL Allowed values: ALL, FIVE_STARS, FOUR_STARS, THREE_STARS, TWO_STARS, ONE_STAR" }, { "in": "query", "name": "sort_by", "schema": { "enum": [ "MOST_HELPFUL", "MOST_RECENT" ], "type": "string", "default": "MOST_HELPFUL" }, "description": "Return store reviews in a specific sort order." }, { "in": "query", "name": "time_frame", "schema": { "enum": [ "ALL", "ONE_YEAR", "TWO_YEARS", "SIX_MONTHS", "THREE_MONTHS" ], "type": "string", "default": "ALL" }, "description": "Only return reviews posted in a specific time range." }, { "in": "query", "name": "country", "schema": { "type": "string", "default": "us" }, "description": "Country code of the region/country. Allowed values: See https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2." }, { "in": "query", "name": "language", "schema": { "type": "string", "default": "en" }, "description": "The language of the results. Allowed values: See https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes." } ], "description": "Get all store / merchant reviews with pagination/scrolling support using the cursor and limit parameters.", "operationId": "realtime_product_search_v2__get__store_reviews", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing parameter definitions", "Missing response schema" ], "pages": [], "sourceId": "sds_0prF_Y5BkmqQXtEQyheXN", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_Z5rvTt1qYfVU6DSLLxPnI" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds_5fumgq7Dew7p7p505C6Vj", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_UDnMGDO2AU7l2pD7FR4rR" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_D1eKbJ9D0SJoHD3LLOLYI", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_WiAI6D9DA33xLudF2TJIh" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_FK2maa1cDe4qcElj5U3zU", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_gZ-rMsS0AnYbgxe2iW2Nm" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds_MAxJPNBPJFwSKQLj1M1dr", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_QFW9HQumx231aOJCusPx0" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_soxpzUWt2CLoTKLGBZfNb", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_3H-1br_3SJ3ASZfGOL5Yr" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_vdxxiVsx4OKV5vH7hrhwb", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_46RDkwnCaOF5IxAFfXTW0" } ], "x-zeroclick-services": [ "realtime-product-search" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-product-search", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-product-search", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/real-time-redfin-data/market-trends": { "get": { "summary": "Market Trends", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "demand": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "time_series": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "string" }, "value": { "type": "string" }, "yoy_change": { "type": "string" } } } }, "current_value": { "type": "string" } } }, "description": "Demand time series metrics (Sale-to-List Price, Homes Sold Above List Price)" }, "region": { "type": "object", "properties": { "url": { "type": "string" }, "name": { "type": "string" }, "region_id": { "type": "string" }, "region_type": { "type": "integer" }, "country_code": { "type": "string" } } }, "snapshot": { "type": "object", "properties": { "avgNumOffers": { "type": "string" }, "numHomesSold": { "type": "string" }, "yoySalePrice": { "type": "string" }, "avgDownPayment": { "type": "string" }, "yoySalePerSqft": { "type": "string" }, "avgDaysOnMarket": { "type": "string" }, "medianListPrice": { "type": "string" }, "medianSalePrice": { "type": "string" }, "numHomesOnMarket": { "type": "string" }, "medianListPerSqFt": { "type": "string" }, "medianSalePerList": { "type": "string" }, "medianSalePerSqFt": { "type": "string" } }, "description": "Latest market snapshot (formatted display values)" }, "region_url": { "type": "string" }, "home_prices": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "time_series": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "string" }, "value": { "type": "string" }, "yoy_change": { "type": "string" } } } }, "current_value": { "type": "string" } } }, "description": "Home prices time series metrics (Median Sale Price, # of Homes Sold, Median Days on Market)" }, "region_name": { "type": "string" } } }, "status": { "type": "string" }, "parameters": { "type": "object" }, "request_id": { "type": "string" } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "location", "schema": { "type": "string" }, "example": "90210", "required": true, "description": "The location to fetch market trends for. Accepts a 5-digit US zip code, a Canadian postal-code area, or a full Redfin region URL (e.g., `https://www.redfin.com/city/30749/NY/New-York` or `https://www.redfin.com/zipcode/90210`)." }, { "in": "query", "name": "country_code", "schema": { "enum": [ "US", "CA" ], "type": "string", "default": "US" }, "description": "Country code to scope the lookup. Use `US` for redfin.com or `CA` for redfin.ca." } ], "description": "Get Redfin housing market trends for a region. Returns the latest snapshot (median list price, median sale price, sale-to-list ratio, average days on market, year-over-year sale price change, inventory) plus full home price and demand time series (median sale price, # of homes sold, median days on market, sale-to-list price, homes sold above list price).", "operationId": "realtime_redfin_data__get__market_trends", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing response schema" ], "pages": [ 1 ], "sourceId": "sds_wvqPOTBJ3ELhy96dsub_l", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_f7m9IOfd1EwYpLs8JZOMM" } ], "x-zeroclick-services": [ "real-time-redfin-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "real-time-redfin-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "real-time-redfin-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/real-time-redfin-data/property-details": { "get": { "summary": "Property Details", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "apn": { "type": "string", "description": "Assessor Parcel Number" }, "url": { "type": "string", "description": "Redfin URL path for the listing" }, "beds": { "type": "number" }, "city": { "type": "string" }, "fips": { "type": "string", "description": "FIPS county code" }, "sqft": { "type": "number" }, "baths": { "type": "number" }, "price": { "type": "number" }, "state": { "type": "string" }, "is_hot": { "type": "boolean" }, "photos": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string" }, "caption": { "type": "string" } } }, "description": "First 30 photos for the listing" }, "status": { "type": "string", "description": "Display listing status" }, "schools": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "level": { "type": "string" }, "grades": { "type": "string" }, "rating": { "type": "number" }, "distance_miles": { "type": "number" } } }, "description": "Schools serving the property (if available)" }, "hoa_dues": { "type": "number" }, "latitude": { "type": "number" }, "mls_name": { "type": "string" }, "zip_code": { "type": "string" }, "is_redfin": { "type": "boolean", "description": "Whether the listing is a Redfin listing" }, "list_date": { "type": "string", "description": "ISO 8601 listing date" }, "longitude": { "type": "number" }, "sold_date": { "type": "string", "description": "ISO 8601 sold date (last sale on record)" }, "full_baths": { "type": "number" }, "half_baths": { "type": "number" }, "listing_id": { "type": "string" }, "mls_number": { "type": "string" }, "sold_price": { "type": "number" }, "year_built": { "type": "number" }, "open_houses": { "type": "array", "items": { "type": "object", "properties": { "end": { "type": "string" }, "start": { "type": "string" }, "is_virtual": { "type": "boolean" } } } }, "photo_count": { "type": "integer" }, "property_id": { "type": "string" }, "tax_history": { "type": "array", "items": { "type": "object", "properties": { "year": { "type": "integer" }, "taxes": { "type": "number" }, "assessed_value": { "type": "number" } } } }, "unit_number": { "type": "string" }, "country_code": { "type": "string" }, "last_updated": { "type": "string", "description": "ISO 8601 last update timestamp" }, "sale_history": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "string" }, "price": { "type": "number" } } } }, "hoa_frequency": { "type": "string" }, "listing_agent": { "type": "object", "properties": { "name": { "type": "string" }, "is_redfin": { "type": "boolean" } } }, "lot_size_sqft": { "type": "number" }, "price_history": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "string" }, "event": { "type": "string" }, "price": { "type": "number" }, "source": { "type": "string" } } }, "description": "Full price history timeline (Listed, Price Changed, Sold, Pending, etc.)" }, "property_type": { "type": "string", "description": "Redfin property type code" }, "amenity_groups": { "type": "array", "items": { "type": "object", "properties": { "title": { "type": "string" }, "groups": { "type": "array", "items": { "type": "object", "properties": { "title": { "type": "string" }, "entries": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "values": { "type": "array", "items": { "type": "string" } } } } } } } } } }, "description": "Grouped property amenities (Parking, Interior, Exterior, Financial, Location, Public facts, etc.)" }, "days_on_market": { "type": "number" }, "listing_broker": { "type": "object", "properties": { "name": { "type": "string" } } }, "price_per_sqft": { "type": "number" }, "static_map_url": { "type": "string", "description": "Google static map URL for the listing" }, "street_address": { "type": "string" }, "redfin_estimate": { "type": "number", "description": "Redfin AVM (Automated Valuation Model) estimate" }, "co_listing_agent": { "type": "object", "nullable": true }, "property_subtype": { "type": "string" }, "co_listing_broker": { "type": "object", "nullable": true }, "primary_photo_url": { "type": "string" }, "photos_url_pattern": { "type": "string" }, "public_description": { "type": "string", "description": "Public marketing description / remarks" }, "redfin_estimate_low": { "type": "number" }, "redfin_estimate_high": { "type": "number" }, "redfin_estimate_time_series": { "type": "array", "items": { "type": "number" }, "description": "Trailing AVM time series (most recent 60 datapoints)" } } }, "status": { "type": "string" }, "parameters": { "type": "object", "properties": { "url": { "type": "string" }, "property_id": { "type": "string" }, "country_code": { "type": "string" } } }, "request_id": { "type": "string" } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "property_id", "schema": { "type": "string" }, "example": "6834288", "required": true, "description": "Redfin internal property ID. You can find property IDs in the `property_id` field of the `/search` response or in any Redfin URL (e.g., `https://www.redfin.com/CA/Beverly-Hills/.../home/6824074`).\nOne of `property_id` or `url` is required." }, { "in": "query", "name": "url", "schema": { "type": "string" }, "description": "Full Redfin listing URL.\nExample: `https://www.redfin.com/CA/Beverly-Hills/1185-Angelo-Dr-90210/home/6824074`\nOne of `property_id` or `url` is required." }, { "in": "query", "name": "country_code", "schema": { "enum": [ "US", "CA" ], "type": "string", "default": "US" }, "description": "Country code to scope the lookup. Use `US` for redfin.com or `CA` for redfin.ca." } ], "description": "Get the full details of a specific Redfin property by `property_id` or Redfin listing URL. Returns a consolidated payload with address, price, beds/baths, square footage, MLS info, listing agent and broker, public description, amenity groups, photos, price history, tax history, schools, open houses, Redfin Estimate (AVM), and AVM time series.", "operationId": "realtime_redfin_data__get__property_details", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing full parameter list and response schema." ], "pages": [ 1 ], "sourceId": "sds__1fiQu9RHG0jaOVImz_2s", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_fMzoiFNl9X0S__Sj10MeV" }, { "gaps": [ "Missing response schema." ], "pages": [], "sourceId": "sds_G0U8VUwSzsI5a3e1H5DC1", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_YNvYe3cGaeWzpXoXqMHAs" }, { "gaps": [ "Missing full parameter list and response schema" ], "pages": [ 1 ], "sourceId": "sds_MAxJPNBPJFwSKQLj1M1dr", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_QFW9HQumx231aOJCusPx0" }, { "gaps": [ "Missing response schema" ], "pages": [ 1 ], "sourceId": "sds_wvqPOTBJ3ELhy96dsub_l", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_f7m9IOfd1EwYpLs8JZOMM" } ], "x-zeroclick-services": [ "real-time-redfin-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "real-time-redfin-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "real-time-redfin-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/real-time-redfin-data/search": { "get": { "summary": "Search", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "region": { "type": "object", "properties": { "name": { "type": "string", "description": "Region display name" }, "region_id": { "type": "string", "description": "Redfin internal region ID" }, "region_type": { "type": "integer", "description": "Redfin region type code (1=neighborhood, 2=zip code, 4=county, 5=zip code, 6=city, 7=state)" }, "country_code": { "type": "string", "description": "Country code (US or CA)" } }, "description": "The resolved Redfin region for the location query" }, "results": { "type": "array", "items": { "type": "object", "properties": { "beds": { "type": "number" }, "city": { "type": "string" }, "sqft": { "type": "number" }, "baths": { "type": "number" }, "price": { "type": "number", "description": "Listing price (for sale, sold, or rent)" }, "state": { "type": "string" }, "is_hot": { "type": "boolean", "description": "Whether the listing is flagged as a Redfin Hot Home" }, "latitude": { "type": "number" }, "zip_code": { "type": "string" }, "key_facts": { "type": "array", "items": { "type": "string" } }, "longitude": { "type": "number" }, "sold_date": { "type": "string", "description": "ISO 8601 sold date (last sale on record)" }, "time_zone": { "type": "string" }, "full_baths": { "type": "number" }, "listing_id": { "type": "string", "description": "Redfin internal listing ID" }, "mls_number": { "type": "string", "description": "MLS number for the listing" }, "mls_status": { "type": "string", "description": "MLS status string as shown on Redfin" }, "year_built": { "type": "number" }, "has_3d_tour": { "type": "boolean" }, "hoa_monthly": { "type": "number", "description": "Monthly HOA dues, if applicable" }, "listing_url": { "type": "string", "description": "Full Redfin listing URL" }, "photo_count": { "type": "integer" }, "property_id": { "type": "string", "description": "Redfin internal property ID (use with /property-details)" }, "unit_number": { "type": "string", "description": "Unit number (apartments, condos)" }, "country_code": { "type": "string" }, "listing_tags": { "type": "array", "items": { "type": "string" }, "description": "Marketing tags extracted from the listing" }, "neighborhood": { "type": "string", "description": "Neighborhood / sublocation" }, "lot_size_sqft": { "type": "number" }, "property_type": { "type": "string", "description": "Property type" }, "search_status": { "type": "string", "description": "Normalized listing status" }, "days_on_market": { "type": "number" }, "has_video_tour": { "type": "boolean" }, "open_house_end": { "type": "string", "description": "ISO 8601 open house end time" }, "price_per_sqft": { "type": "number" }, "street_address": { "type": "string", "description": "Street address" }, "listing_remarks": { "type": "string", "description": "Listing marketing remarks / public description" }, "has_virtual_tour": { "type": "boolean" }, "listing_agent_id": { "type": "string" }, "open_house_start": { "type": "string", "description": "ISO 8601 open house start time" }, "time_on_redfin_ms": { "type": "number", "description": "Total time on Redfin in milliseconds" }, "listing_agent_name": { "type": "string" }, "is_new_construction": { "type": "boolean" }, "listing_broker_name": { "type": "string" }, "listing_broker_is_redfin": { "type": "boolean" } } }, "description": "Array of property listings" }, "has_more": { "type": "boolean", "description": "Whether more pages are available" }, "median_beds": { "type": "number", "description": "Median number of bedrooms" }, "median_sqft": { "type": "number", "description": "Median interior square footage" }, "current_page": { "type": "integer", "description": "The current page number" }, "median_baths": { "type": "number", "description": "Median number of bathrooms" }, "median_price": { "type": "number", "description": "Median listing price across the current result set" }, "results_count": { "type": "integer", "description": "Number of results in the current page" }, "median_days_on_market": { "type": "number", "description": "Median days on market" }, "median_price_per_sqft": { "type": "number", "description": "Median price per square foot" } } }, "status": { "type": "string", "description": "The status of the API response" }, "parameters": { "type": "object", "description": "The request parameters echoed back as the server received them" }, "request_id": { "type": "string", "description": "A unique identifier for the API request" } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "location", "schema": { "type": "string" }, "example": "90210", "required": true, "description": "The location to search. Accepts a 5-digit US zip code (e.g., `90210`), a Canadian postal-code area, or a full Redfin region URL (e.g., `https://www.redfin.com/city/30749/NY/New-York` or `https://www.redfin.com/zipcode/90210`)." }, { "in": "query", "name": "status", "schema": { "enum": [ "for_sale", "sold", "for_rent", "coming_soon" ], "type": "string", "default": "for_sale" }, "description": "Listing status to filter by.\nAllowed values: `for_sale`, `sold`, `for_rent`, `coming_soon`." }, { "in": "query", "name": "property_types", "schema": { "type": "string" }, "description": "Comma-separated list of property types to filter by.\nAllowed values: `HOUSE`, `CONDO`, `TOWNHOUSE`, `MULTI_FAMILY`, `LAND`, `OTHER`, `MANUFACTURED`, `CO_OP`." }, { "in": "query", "name": "sort", "schema": { "enum": [ "redfin_recommended", "newest", "oldest", "price_low_high", "price_high_low", "beds", "baths", "sqft", "lot_size" ], "type": "string", "default": "redfin_recommended" }, "description": "Sort order for the results." }, { "in": "query", "name": "page", "schema": { "type": "integer", "default": 1 }, "description": "Page number for pagination.\nAllowed values: `1` to `100`." }, { "in": "query", "name": "num_homes", "schema": { "type": "integer", "default": 40 }, "description": "Number of homes to return per page.\nAllowed values: `1` to `350`." }, { "in": "query", "name": "country_code", "schema": { "enum": [ "US", "CA" ], "type": "string", "default": "US" }, "description": "Country code to scope the search. Use `US` for redfin.com or `CA` for redfin.ca." }, { "in": "query", "name": "min_price", "schema": { "type": "number" }, "description": "Minimum listing price filter." }, { "in": "query", "name": "max_price", "schema": { "type": "number" }, "description": "Maximum listing price filter." }, { "in": "query", "name": "min_beds", "schema": { "type": "integer" }, "description": "Minimum number of bedrooms." }, { "in": "query", "name": "max_beds", "schema": { "type": "integer" }, "description": "Maximum number of bedrooms." }, { "in": "query", "name": "min_baths", "schema": { "type": "number" }, "description": "Minimum number of bathrooms (supports half-baths, e.g., `2.5`)." }, { "in": "query", "name": "min_sqft", "schema": { "type": "integer" }, "description": "Minimum interior square footage." }, { "in": "query", "name": "max_sqft", "schema": { "type": "integer" }, "description": "Maximum interior square footage." }, { "in": "query", "name": "min_lot_size", "schema": { "type": "integer" }, "description": "Minimum lot size in square feet." }, { "in": "query", "name": "max_lot_size", "schema": { "type": "integer" }, "description": "Maximum lot size in square feet." }, { "in": "query", "name": "min_year_built", "schema": { "type": "integer" }, "description": "Minimum year built." }, { "in": "query", "name": "max_year_built", "schema": { "type": "integer" }, "description": "Maximum year built." }, { "in": "query", "name": "max_hoa", "schema": { "type": "number" }, "description": "Maximum monthly HOA dues." }, { "in": "query", "name": "has_pool", "schema": { "type": "boolean" }, "description": "Only return properties with a pool." }, { "in": "query", "name": "has_garage", "schema": { "type": "boolean" }, "description": "Only return properties with a garage." }, { "in": "query", "name": "is_waterfront", "schema": { "type": "boolean" }, "description": "Only return waterfront properties." }, { "in": "query", "name": "time_on_market_days", "schema": { "type": "integer" }, "description": "Only return properties on the market within the last N days." }, { "in": "query", "name": "sold_within_days", "schema": { "type": "integer" }, "description": "For `status=sold` searches, only return properties sold within the last N days.\nAllowed values: `1` to `1095` (3 years)." } ], "description": "Search Redfin property listings by location (5-digit US zip code, Canadian postal-code area, or a Redfin URL). Supports filters for listing status, property type, price, beds, baths, square footage, lot size, year built, HOA, pool/garage/waterfront, time on market, and sorting. Returns paginated property results with full details.", "operationId": "realtime_redfin_data__get__search", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing response schema" ], "pages": [ 1 ], "sourceId": "sds_wvqPOTBJ3ELhy96dsub_l", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/q", "/description", "/operationId" ], "revisionId": "sdrn_f7m9IOfd1EwYpLs8JZOMM" } ], "x-zeroclick-services": [ "real-time-redfin-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "real-time-redfin-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "real-time-redfin-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/real-time-redfin-data/search-coordinates": { "get": { "summary": "Search by Coordinates", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "description": "Same shape as /search response (results_count, current_page, has_more, medians, bounding_box, results[])" }, "status": { "type": "string" }, "parameters": { "type": "object" }, "request_id": { "type": "string" } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "ne_lat", "schema": { "type": "number" }, "example": "37.79", "required": true, "description": "Latitude of the Northeast corner of the bounding box.\nAllowed values: `-90` to `90`." }, { "in": "query", "name": "ne_lng", "schema": { "type": "number" }, "example": "-122.40", "required": true, "description": "Longitude of the Northeast corner of the bounding box.\nAllowed values: `-180` to `180`." }, { "in": "query", "name": "sw_lat", "schema": { "type": "number" }, "example": "37.77", "required": true, "description": "Latitude of the Southwest corner of the bounding box.\nAllowed values: `-90` to `90`. Must be less than `ne_lat`." }, { "in": "query", "name": "sw_lng", "schema": { "type": "number" }, "example": "-122.43", "required": true, "description": "Longitude of the Southwest corner of the bounding box.\nAllowed values: `-180` to `180`. Must be less than `ne_lng`." }, { "in": "query", "name": "status", "schema": { "enum": [ "for_sale", "sold", "for_rent", "coming_soon" ], "type": "string", "default": "for_sale" }, "description": "Listing status to filter by.\nAllowed values: `for_sale`, `sold`, `for_rent`, `coming_soon`." }, { "in": "query", "name": "property_types", "schema": { "type": "string" }, "description": "Comma-separated list of property types to filter by.\nAllowed values: `HOUSE`, `CONDO`, `TOWNHOUSE`, `MULTI_FAMILY`, `LAND`, `OTHER`, `MANUFACTURED`, `CO_OP`." }, { "in": "query", "name": "sort", "schema": { "enum": [ "redfin_recommended", "newest", "oldest", "price_low_high", "price_high_low", "beds", "baths", "sqft", "lot_size" ], "type": "string", "default": "redfin_recommended" }, "description": "Sort order for the results." }, { "in": "query", "name": "page", "schema": { "type": "integer", "default": 1 }, "description": "Page number for pagination. Allowed values: `1` to `100`." }, { "in": "query", "name": "num_homes", "schema": { "type": "integer", "default": 40 }, "description": "Number of homes to return per page. Allowed values: `1` to `350`." }, { "in": "query", "name": "country_code", "schema": { "enum": [ "US", "CA" ], "type": "string", "default": "US" }, "description": "Country code to scope the search. Use `US` for redfin.com or `CA` for redfin.ca." }, { "in": "query", "name": "min_price", "schema": { "type": "number" }, "description": "Minimum listing price filter." }, { "in": "query", "name": "max_price", "schema": { "type": "number" }, "description": "Maximum listing price filter." }, { "in": "query", "name": "min_beds", "schema": { "type": "integer" }, "description": "Minimum number of bedrooms." }, { "in": "query", "name": "max_beds", "schema": { "type": "integer" }, "description": "Maximum number of bedrooms." }, { "in": "query", "name": "min_baths", "schema": { "type": "number" }, "description": "Minimum number of bathrooms." }, { "in": "query", "name": "min_sqft", "schema": { "type": "integer" }, "description": "Minimum interior square footage." }, { "in": "query", "name": "max_sqft", "schema": { "type": "integer" }, "description": "Maximum interior square footage." }, { "in": "query", "name": "min_lot_size", "schema": { "type": "integer" }, "description": "Minimum lot size in square feet." }, { "in": "query", "name": "max_lot_size", "schema": { "type": "integer" }, "description": "Maximum lot size in square feet." }, { "in": "query", "name": "min_year_built", "schema": { "type": "integer" }, "description": "Minimum year built." }, { "in": "query", "name": "max_year_built", "schema": { "type": "integer" }, "description": "Maximum year built." }, { "in": "query", "name": "max_hoa", "schema": { "type": "number" }, "description": "Maximum monthly HOA dues." }, { "in": "query", "name": "has_pool", "schema": { "type": "boolean" }, "description": "Only return properties with a pool." }, { "in": "query", "name": "has_garage", "schema": { "type": "boolean" }, "description": "Only return properties with a garage." }, { "in": "query", "name": "is_waterfront", "schema": { "type": "boolean" }, "description": "Only return waterfront properties." }, { "in": "query", "name": "time_on_market_days", "schema": { "type": "integer" }, "description": "Only return properties on the market within the last N days." }, { "in": "query", "name": "sold_within_days", "schema": { "type": "integer" }, "description": "For `status=sold` searches, only return properties sold within the last N days." } ], "description": "Search Redfin property listings within a geographic bounding box defined by Northeast (NE) and Southwest (SW) latitude/longitude corners. Useful for map-based searches, polygon-around-radius queries, and custom region definitions. Supports the same filters and sorting as /search.", "operationId": "realtime_redfin_data__get__search_coordinates", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing response schema" ], "pages": [ 1 ], "sourceId": "sds_wvqPOTBJ3ELhy96dsub_l", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/lat", "/parameters/query/lng", "/description", "/operationId" ], "revisionId": "sdrn_f7m9IOfd1EwYpLs8JZOMM" } ], "x-zeroclick-services": [ "real-time-redfin-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "real-time-redfin-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "real-time-redfin-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/real-time-redfin-data/search-polygon": { "get": { "summary": "Search by Polygon", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "description": "Same shape as /search response (results_count, current_page, has_more, medians, results[])" }, "status": { "type": "string" }, "parameters": { "type": "object" }, "request_id": { "type": "string" } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "polygon", "schema": { "type": "string" }, "example": "-118.45 34.10,-118.40 34.10,-118.40 34.05,-118.45 34.05", "required": true, "description": "The polygon to search within, specified as a comma-separated list of `longitude latitude` pairs (at least 3 pairs required).\nFormat: `lng1 lat1,lng2 lat2,lng3 lat3,...`. The polygon will be closed automatically if not already closed." }, { "in": "query", "name": "status", "schema": { "enum": [ "for_sale", "sold", "for_rent", "coming_soon" ], "type": "string", "default": "for_sale" }, "description": "Listing status to filter by." }, { "in": "query", "name": "property_types", "schema": { "type": "string" }, "description": "Comma-separated list of property types to filter by.\nAllowed values: `HOUSE`, `CONDO`, `TOWNHOUSE`, `MULTI_FAMILY`, `LAND`, `OTHER`, `MANUFACTURED`, `CO_OP`." }, { "in": "query", "name": "sort", "schema": { "enum": [ "redfin_recommended", "newest", "oldest", "price_low_high", "price_high_low", "beds", "baths", "sqft", "lot_size" ], "type": "string", "default": "redfin_recommended" }, "description": "Sort order for the results." }, { "in": "query", "name": "page", "schema": { "type": "integer", "default": 1 }, "description": "Page number for pagination." }, { "in": "query", "name": "num_homes", "schema": { "type": "integer", "default": 40 }, "description": "Number of homes to return per page. Allowed values: `1` to `350`." }, { "in": "query", "name": "country_code", "schema": { "enum": [ "US", "CA" ], "type": "string", "default": "US" }, "description": "Country code to scope the search." }, { "in": "query", "name": "min_price", "schema": { "type": "number" }, "description": "Minimum listing price filter." }, { "in": "query", "name": "max_price", "schema": { "type": "number" }, "description": "Maximum listing price filter." }, { "in": "query", "name": "min_beds", "schema": { "type": "integer" }, "description": "Minimum number of bedrooms." }, { "in": "query", "name": "max_beds", "schema": { "type": "integer" }, "description": "Maximum number of bedrooms." }, { "in": "query", "name": "min_baths", "schema": { "type": "number" }, "description": "Minimum number of bathrooms." }, { "in": "query", "name": "min_sqft", "schema": { "type": "integer" }, "description": "Minimum interior square footage." }, { "in": "query", "name": "max_sqft", "schema": { "type": "integer" }, "description": "Maximum interior square footage." }, { "in": "query", "name": "min_lot_size", "schema": { "type": "integer" }, "description": "Minimum lot size in square feet." }, { "in": "query", "name": "max_lot_size", "schema": { "type": "integer" }, "description": "Maximum lot size in square feet." }, { "in": "query", "name": "min_year_built", "schema": { "type": "integer" }, "description": "Minimum year built." }, { "in": "query", "name": "max_year_built", "schema": { "type": "integer" }, "description": "Maximum year built." }, { "in": "query", "name": "max_hoa", "schema": { "type": "number" }, "description": "Maximum monthly HOA dues." }, { "in": "query", "name": "has_pool", "schema": { "type": "boolean" }, "description": "Only return properties with a pool." }, { "in": "query", "name": "has_garage", "schema": { "type": "boolean" }, "description": "Only return properties with a garage." }, { "in": "query", "name": "is_waterfront", "schema": { "type": "boolean" }, "description": "Only return waterfront properties." }, { "in": "query", "name": "time_on_market_days", "schema": { "type": "integer" }, "description": "Only return properties on the market within the last N days." }, { "in": "query", "name": "sold_within_days", "schema": { "type": "integer" }, "description": "For `status=sold` searches, only return properties sold within the last N days." } ], "description": "Search Redfin property listings within a custom polygon area. Accepts a polygon as a string of longitude/latitude pairs. Useful for searching irregular regions, drawing a custom shape on a map, or matching the exact shape of a school district, neighborhood, or service area. Supports the same filters and sorting as /search.", "operationId": "realtime_redfin_data__get__search_polygon", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing response schema" ], "pages": [ 1 ], "sourceId": "sds_wvqPOTBJ3ELhy96dsub_l", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_f7m9IOfd1EwYpLs8JZOMM" } ], "x-zeroclick-services": [ "real-time-redfin-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "real-time-redfin-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "real-time-redfin-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-shorts-search/search": { "get": { "summary": "Search Shorts", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the video result" }, "rank": { "type": "integer", "description": "Overall rank of the video in search results" }, "title": { "type": "string", "description": "The title of the video" }, "source": { "type": "string", "description": "The source platform of the video" }, "position": { "type": "integer", "description": "Position of the video in the result list" }, "image_url": { "type": "string", "description": "URL of the thumbnail image for the video" }, "video_url": { "type": "string", "description": "URL where the video can be viewed" }, "aspect_ratio": { "type": "number", "description": "Aspect ratio of the video" }, "channel_name": { "type": "string", "description": "The name of the channel that published the video" } } } }, "status": { "type": "string", "description": "The status of the API response" }, "parameters": { "type": "object", "properties": { "page": { "type": "string", "description": "The page number or token used for pagination" }, "query": { "type": "string", "description": "The search query string used in the request" } } }, "request_id": { "type": "string", "description": "A unique identifier for the API request" } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "query", "schema": { "type": "string" }, "example": "funny cat", "required": true, "description": "Search query / keyword." }, { "in": "query", "name": "page", "schema": { "type": "number", "default": 1 }, "description": "Results page to return (pagination / scrolling)" }, { "in": "query", "name": "time", "schema": { "enum": [ "any", "day", "week", "month", "year" ], "type": "string", "default": "any" }, "description": "Find shorts posted in a specific relative time range." }, { "in": "query", "name": "posted_date_from", "schema": { "type": "string" }, "description": "Find shorts posted after a specific date (e.g. 1/19/2025)." }, { "in": "query", "name": "posted_date_to", "schema": { "type": "string" }, "description": "Find shorts posted before a specific date (e.g. 3/19/2025)." }, { "in": "query", "name": "high_quality", "schema": { "type": "boolean" }, "description": "Return only shorts of high quality." }, { "in": "query", "name": "closed_captioned", "schema": { "type": "boolean" }, "description": "Return only shorts with closed captions." } ], "description": "Get real-time short video search results from across the web with pagination and filtering support.", "operationId": "realtime_shorts_search__get__search", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing parameter definitions", "Missing response schema" ], "pages": [], "sourceId": "sds_0prF_Y5BkmqQXtEQyheXN", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_Z5rvTt1qYfVU6DSLLxPnI" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds_5fumgq7Dew7p7p505C6Vj", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_UDnMGDO2AU7l2pD7FR4rR" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_D1eKbJ9D0SJoHD3LLOLYI", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_WiAI6D9DA33xLudF2TJIh" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_FK2maa1cDe4qcElj5U3zU", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_gZ-rMsS0AnYbgxe2iW2Nm" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds_MAxJPNBPJFwSKQLj1M1dr", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_QFW9HQumx231aOJCusPx0" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_soxpzUWt2CLoTKLGBZfNb", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_3H-1br_3SJ3ASZfGOL5Yr" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_vdxxiVsx4OKV5vH7hrhwb", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_46RDkwnCaOF5IxAFfXTW0" } ], "x-zeroclick-services": [ "realtime-shorts-search" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-shorts-search", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-shorts-search", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/real-time-video-search/search": { "get": { "summary": "Search", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "videos": { "type": "array", "items": { "type": "object", "properties": { "link": { "type": "string" }, "title": { "type": "string" }, "source": { "type": "string" }, "duration": { "type": "string" }, "position": { "type": "integer" }, "source_url": { "type": "string" }, "thumbnail_url": { "type": "string" }, "published_date": { "type": "string" }, "duration_seconds": { "type": "integer" }, "source_favicon_url": { "type": "string" }, "published_datetime_utc": { "type": "string" } } } }, "related_searches": { "type": "array", "items": { "type": "string" } } } }, "status": { "type": "string" }, "parameters": { "type": "object", "properties": { "page": { "type": "integer" }, "safe": { "type": "string" }, "query": { "type": "string" }, "country": { "type": "string" }, "date_to": {}, "sort_by": { "type": "string" }, "duration": { "type": "string" }, "language": { "type": "string" }, "date_from": {}, "time_period": { "type": "string" } } }, "request_id": { "type": "string" } } } } }, "description": "Successful response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "query", "schema": { "type": "string" }, "example": "ai demo", "required": true, "description": "The video search query.\n\n**Examples:**\n\n`how to invest`\n\n`product demo software`\n\n`lebron james highlights`" }, { "in": "query", "name": "page", "schema": { "type": "integer", "default": 1, "minimum": 1 }, "description": "Page number for pagination. Each page returns up to 10 video results.\n\n**Allowed values:** `1` and above." }, { "in": "query", "name": "country", "schema": { "type": "string", "default": "us" }, "description": "Country code of the country to return video results for. See https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2 for supported values.\n\n**Default:** `us`" }, { "in": "query", "name": "language", "schema": { "type": "string", "default": "en" }, "description": "The language of the results, specified as a 2-letter language code - see ISO 639-1.\n\n**Default:** `en`" }, { "in": "query", "name": "time_period", "schema": { "enum": [ "any", "last_hour", "last_day", "last_week", "last_month", "last_year" ], "type": "string", "default": "any" }, "description": "Filter results to a specific time period. Cannot be used together with `date_from`/`date_to`.\n\n**Allowed values:** `any`, `last_hour`, `last_day`, `last_week`, `last_month`, `last_year`\n\n**Default:** `any`" }, { "in": "query", "name": "date_from", "schema": { "type": "string" }, "description": "Start date for a custom date range filter, in `MM/DD/YYYY` format. Must be provided together with `date_to`. Cannot be used together with `time_period` (other than `any`).\n\n**Example:** `01/01/2026`" }, { "in": "query", "name": "date_to", "schema": { "type": "string" }, "description": "End date for a custom date range filter, in `MM/DD/YYYY` format. Must be provided together with `date_from`.\n\n**Example:** `04/29/2026`" }, { "in": "query", "name": "sort_by", "schema": { "enum": [ "relevance", "date" ], "type": "string", "default": "relevance" }, "description": "Sort order for the results.\n\n**Allowed values:** `relevance`, `date`\n\n**Default:** `relevance`" }, { "in": "query", "name": "duration", "schema": { "enum": [ "any", "short", "medium", "long" ], "type": "string", "default": "any" }, "description": "Filter results by video duration.\n\n**Allowed values:** `any`, `short` (under 4 minutes), `medium` (4 to 20 minutes), `long` (over 20 minutes)\n\n**Default:** `any`" }, { "in": "query", "name": "safe", "schema": { "enum": [ "off", "active" ], "type": "string", "default": "off" }, "description": "Safe search setting to filter explicit content.\n\n**Allowed values:** `off`, `active`\n\n**Default:** `off`" } ], "description": "Search Google Videos for any query and get real-time video results. Returns video results with title, link, source info, thumbnail URL, duration (both human-readable string and seconds), and published dates (both localized relative text and ISO 8601 UTC), plus a list of related searches when available for the query. Supports pagination, filtering by time period or custom date range, video duration, country, language, sort order, and safe search.", "operationId": "realtime_video_search__Search", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing full parameter list and response schema." ], "pages": [ 1 ], "sourceId": "sds__1fiQu9RHG0jaOVImz_2s", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/q", "/description", "/operationId" ], "revisionId": "sdrn_fMzoiFNl9X0S__Sj10MeV" }, { "gaps": [ "Missing response schema." ], "pages": [], "sourceId": "sds_G0U8VUwSzsI5a3e1H5DC1", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/q", "/description", "/operationId" ], "revisionId": "sdrn_YNvYe3cGaeWzpXoXqMHAs" }, { "gaps": [ "Missing full parameter list and response schema" ], "pages": [ 1 ], "sourceId": "sds_MAxJPNBPJFwSKQLj1M1dr", "authority": "supplemental", "conflicts": [ "/summary", "/description", "/operationId" ], "revisionId": "sdrn_QFW9HQumx231aOJCusPx0" }, { "gaps": [ "Missing response schema" ], "pages": [ 1 ], "sourceId": "sds_wvqPOTBJ3ELhy96dsub_l", "authority": "supplemental", "conflicts": [ "/summary", "/parameters/query/q", "/description", "/operationId" ], "revisionId": "sdrn_f7m9IOfd1EwYpLs8JZOMM" } ], "x-zeroclick-services": [ "real-time-video-search" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "real-time-video-search", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "real-time-video-search", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/real-time-walmart-data/product-details": { "get": { "summary": "Product Details", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "upc": { "type": "string", "description": "The UPC code associated with the product." }, "url": { "type": "string", "description": "The product page URL." }, "type": { "type": "string", "description": "The product type/category name." }, "brand": { "type": "string", "description": "The product brand name." }, "image": { "type": "string", "description": "The main image URL for the product." }, "model": { "type": "string", "description": "The model name or number of the product." }, "price": { "type": "integer", "description": "The current selling price of the product." }, "title": { "type": "string", "description": "The product title." }, "images": { "type": "array", "items": { "type": "string" }, "description": "A list of additional image URLs for the product." }, "rating": { "type": "number", "description": "The average product rating." }, "seller": { "type": "string", "description": "The seller name for the product." }, "currency": { "type": "string", "description": "The currency code for the displayed prices." }, "location": { "type": "object", "nullable": true, "properties": { "city": { "type": "string", "nullable": true, "description": "City associated with the location. null on walmart.ca when store_id is set." }, "state": { "type": "string", "nullable": true, "description": "State or province code. null on walmart.ca when store_id is set." }, "store_id": { "type": "string", "description": "Walmart store ID the prices were rendered for." }, "postal_code": { "type": "string", "nullable": true, "description": "Postal / ZIP code associated with the location. null on walmart.ca when store_id is set (Walmart does not return the selected store's address; use store_id)." } }, "description": "The store location Walmart resolved this response for. Use it to verify which store the prices belong to. With no store_id, walmart.ca defaults to Mississauga Supercenter (store 1061) and walmart.com to a store near the request's exit location." }, "preorder": { "type": "boolean", "description": "Whether the product is available for pre-order." }, "variants": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The variant dimension name (e.g., Color, Size)." }, "values": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The variant value name." }, "selected": { "type": "boolean", "description": "Whether this variant value is currently selected." }, "available": { "type": "boolean", "description": "Whether this variant value is available." }, "product_id": { "type": "string", "description": "The product ID for this specific variant selection." }, "swatch_url": { "type": "string", "description": "A URL to the color swatch image when available." } } }, "description": "The list of possible values for this variant dimension." } } }, "description": "A list of variant dimensions and their possible values." }, "condition": { "type": "string", "description": "The condition of the product (e.g., new, used)." }, "max_price": { "type": "string", "description": "The maximum price when a price range applies, otherwise null." }, "min_price": { "type": "string", "description": "The minimum price when a price range applies, otherwise null." }, "seller_id": { "type": "string", "description": "The identifier of the seller." }, "thumbnail": { "type": "string", "description": "A thumbnail image URL for the product." }, "categories": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string", "description": "The category URL." }, "name": { "type": "string", "description": "The category name." } } }, "description": "The category breadcrumb list for the product." }, "list_price": { "type": "integer", "description": "The original or list price of the product." }, "product_id": { "type": "string", "description": "The product identifier from the source." }, "us_item_id": { "type": "string", "description": "The US item identifier for the product." }, "return_free": { "type": "boolean", "description": "Whether returns are free for this product." }, "seller_type": { "type": "string", "description": "The seller type classification." }, "wfs_enabled": { "type": "boolean", "description": "Whether Walmart Fulfillment Services (WFS) is enabled for the item." }, "availability": { "type": "string", "description": "The availability status text for the product." }, "out_of_stock": { "type": "boolean", "description": "Whether the product is currently out of stock." }, "review_count": { "type": "integer", "description": "The number of reviews for the product." }, "warranty_url": { "type": "string", "description": "A URL to warranty information when available." }, "price_display": { "type": "string", "description": "A formatted string representation of the price." }, "primary_offer": { "type": "object", "properties": { "offer_id": { "type": "string", "description": "The identifier for the primary offer." }, "min_price": { "type": "string", "description": "The minimum offer price when applicable, otherwise null." }, "offer_type": { "type": "string", "description": "The type of offer (e.g., online, marketplace)." }, "offer_price": { "type": "integer", "description": "The price of the primary offer." } } }, "snap_eligible": { "type": "boolean", "description": "Whether the product is eligible for SNAP benefits." }, "warranty_text": { "type": "string", "description": "The warranty text when available, otherwise null." }, "savings_amount": { "type": "integer", "description": "The amount saved compared to list price." }, "specifications": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The specification name." }, "value": { "type": "string", "description": "The specification value." } } }, "description": "A list of product specification name/value pairs." }, "currency_symbol": { "type": "string", "description": "The currency symbol used for display." }, "fulfillment_type": { "type": "string", "description": "The fulfillment method used to deliver the product." }, "long_description": { "type": "string", "description": "A longer full description of the product." }, "rating_breakdown": { "type": "object", "properties": { "one": { "type": "integer", "description": "The count of 1-star ratings." }, "two": { "type": "integer", "description": "The count of 2-star ratings." }, "five": { "type": "integer", "description": "The count of 5-star ratings." }, "four": { "type": "integer", "description": "The count of 4-star ratings." }, "three": { "type": "integer", "description": "The count of 3-star ratings." } } }, "return_returnable": { "type": "boolean", "description": "Whether the product is eligible for returns." }, "short_description": { "type": "string", "description": "A short marketing description of the product." }, "product_highlights": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The highlight name." }, "value": { "type": "string", "description": "The highlight value." } } }, "description": "A list of product highlight name/value pairs." }, "return_window_days": { "type": "integer", "description": "The number of days in the return window." }, "price_per_unit_type": { "type": "string", "description": "The per-unit price type when available, otherwise null." }, "top_negative_review": { "type": "object", "properties": { "id": { "type": "string", "description": "The identifier of the top negative review." }, "body": { "type": "string", "description": "The text content of the top negative review." }, "date": { "type": "string", "description": "The date the top negative review was posted." }, "title": { "type": "string", "description": "The title of the top negative review." }, "author": { "type": "string", "description": "The author name of the top negative review." }, "rating": { "type": "integer", "description": "The rating given in the top negative review." }, "negative_feedback": { "type": "integer", "description": "The count of negative feedback votes for the review." }, "positive_feedback": { "type": "integer", "description": "The count of positive feedback votes for the review." } } }, "top_positive_review": { "type": "object", "properties": { "id": { "type": "string", "description": "The identifier of the top positive review." }, "body": { "type": "string", "description": "The text content of the top positive review." }, "date": { "type": "string", "description": "The date the top positive review was posted." }, "title": { "type": "string", "description": "The title of the top positive review." }, "author": { "type": "string", "description": "The author name of the top positive review." }, "rating": { "type": "integer", "description": "The rating given in the top positive review." }, "negative_feedback": { "type": "integer", "description": "The count of negative feedback votes for the review." }, "positive_feedback": { "type": "integer", "description": "The count of positive feedback votes for the review." } } }, "price_per_unit_amount": { "type": "string", "description": "The per-unit price amount when available, otherwise null." }, "recommended_percentage": { "type": "integer", "description": "The percentage of reviewers who recommend the product." } } }, "status": { "type": "string", "description": "The status of the API response." }, "parameters": { "type": "object", "properties": { "domain": { "type": "string", "description": "The store or domain used as the data source." }, "store_id": { "type": "string", "nullable": true, "description": "The store ID requested, if any." }, "product_id": { "type": "string", "description": "The product identifier requested from the source." } } }, "request_id": { "type": "string", "description": "A unique identifier for this request." } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "product_id", "schema": { "type": "string" }, "example": "609040889", "required": true, "description": "Walmart product ID. For domain 'us' this can be the numeric us_item_id (e.g. '609040889') or the alphanumeric product_id (e.g. '4SZSM8SXAAJT'). For domain 'ca' use the `us_item_id` value returned by search (e.g. '875806'); the numeric `product_id` (e.g. '875805') is Walmart's internal ID and is not addressable on walmart.ca, so it returns 404." }, { "in": "query", "name": "domain", "schema": { "enum": [ "us", "ca" ], "type": "string", "default": "us" }, "description": "Walmart domain. 'us' for walmart.com, 'ca' for walmart.ca. Default is 'us'." }, { "in": "query", "name": "store_id", "schema": { "type": "string" }, "example": "3148", "description": "Walmart store ID to get store-specific price and availability. Supported for domain 'ca': the product page is rendered for that walmart.ca store (e.g. '3148' for Lévis, QC) and the response `location` object confirms the store applied. Without it walmart.ca defaults to Mississauga Supercenter (store 1061). Not applied for domain 'us'." } ], "description": "Get comprehensive product details including title, price, description, specifications, variants, reviews summary, and more.", "operationId": "realtime_walmart_data__get__product_details", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing full parameter list and response schema." ], "pages": [ 1 ], "sourceId": "sds__1fiQu9RHG0jaOVImz_2s", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_fMzoiFNl9X0S__Sj10MeV" }, { "gaps": [ "Missing response schema." ], "pages": [], "sourceId": "sds_G0U8VUwSzsI5a3e1H5DC1", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_YNvYe3cGaeWzpXoXqMHAs" }, { "gaps": [ "Missing full parameter list and response schema" ], "pages": [ 1 ], "sourceId": "sds_MAxJPNBPJFwSKQLj1M1dr", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_QFW9HQumx231aOJCusPx0" }, { "gaps": [ "Missing response schema details." ], "pages": [ 1 ], "sourceId": "sds_t1I2lol_F5DgGpe13n3Xt", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_OBuPoRSMenxSJ1CM3zwbN" }, { "gaps": [ "Missing response schema" ], "pages": [ 1 ], "sourceId": "sds_wvqPOTBJ3ELhy96dsub_l", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_f7m9IOfd1EwYpLs8JZOMM" } ], "x-zeroclick-services": [ "real-time-walmart-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "real-time-walmart-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "real-time-walmart-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/real-time-walmart-data/product-offers": { "get": { "summary": "Product Offers", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "title": { "type": "string", "description": "The product title." }, "offers": { "type": "array", "items": { "type": "object", "properties": { "price": { "type": "integer", "description": "The offer price amount." }, "currency": { "type": "string", "description": "The currency code for the offer price." }, "in_stock": { "type": "boolean", "description": "Whether the offer is currently in stock." }, "offer_id": { "type": "string", "description": "The identifier of the offer." }, "position": { "type": "integer", "description": "The position of the offer in the returned list." }, "condition": { "type": "string", "description": "The condition of the item being sold in this offer." }, "seller_id": { "type": "string", "description": "The identifier of the seller for this offer." }, "offer_type": { "type": "string", "description": "The type of offer (e.g., marketplace, online)." }, "seller_name": { "type": "string", "description": "The seller name for this offer." }, "seller_type": { "type": "string", "description": "The seller type classification." }, "wfs_enabled": { "type": "boolean", "description": "Whether Walmart Fulfillment Services (WFS) is enabled for this offer." }, "delivery_date": { "type": "string", "description": "The estimated delivery date when available, otherwise null." }, "free_shipping": { "type": "boolean", "description": "Whether the offer includes free shipping." }, "price_display": { "type": "string", "description": "A formatted string representation of the offer price." }, "return_policy": { "type": "object", "properties": { "text": { "type": "string", "description": "A human-readable summary of the return policy." }, "returnable": { "type": "boolean", "description": "Whether the item is eligible for returns." }, "free_returns": { "type": "boolean", "description": "Whether returns are free for this offer." }, "return_window_days": { "type": "integer", "description": "The number of days in the return window." } } }, "shipping_price": { "type": "string", "description": "The shipping price when available, otherwise null." }, "storefront_url": { "type": "string", "description": "The seller storefront URL." }, "currency_symbol": { "type": "string", "description": "The currency symbol used for display." }, "pickup_available": { "type": "boolean", "description": "Whether pickup is available for this offer." }, "catalog_seller_id": { "type": "integer", "description": "The numeric catalog seller identifier when provided." }, "availability_status": { "type": "string", "description": "A textual availability status for the offer." }, "seller_display_name": { "type": "string", "description": "The display name shown to users for the seller." } } }, "description": "A list of seller offers for the product." }, "location": { "type": "object", "nullable": true, "properties": { "city": { "type": "string", "nullable": true, "description": "City associated with the location. null on walmart.ca when store_id is set." }, "state": { "type": "string", "nullable": true, "description": "State or province code. null on walmart.ca when store_id is set." }, "store_id": { "type": "string", "description": "Walmart store ID the prices were rendered for." }, "postal_code": { "type": "string", "nullable": true, "description": "Postal / ZIP code associated with the location. null on walmart.ca when store_id is set (Walmart does not return the selected store's address; use store_id)." } }, "description": "The store location Walmart resolved this response for. Use it to verify which store the prices belong to. With no store_id, walmart.ca defaults to Mississauga Supercenter (store 1061) and walmart.com to a store near the request's exit location." }, "product_id": { "type": "string", "description": "The product identifier from the source." }, "us_item_id": { "type": "string", "description": "The US item identifier for the product." }, "product_url": { "type": "string", "description": "The product page URL." }, "total_offers": { "type": "integer", "description": "The total number of offers available for this product." }, "additional_offers_available": { "type": "string", "description": "Indicates if additional offers exist beyond those returned, otherwise null." } } }, "status": { "type": "string", "description": "The status of the API response." }, "parameters": { "type": "object", "properties": { "domain": { "type": "string", "description": "The store or domain used as the data source." }, "store_id": { "type": "string", "nullable": true, "description": "The store ID requested, if any." }, "product_id": { "type": "string", "description": "The product identifier requested from the source." } } }, "request_id": { "type": "string", "description": "A unique identifier for this request." } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "product_id", "schema": { "type": "string" }, "example": "609040889", "required": true, "description": "Walmart product ID. For domain 'us' this can be the numeric us_item_id (e.g. '609040889') or the alphanumeric product_id (e.g. '4SZSM8SXAAJT'). For domain 'ca' use the `us_item_id` value returned by search (e.g. '875806'), not the numeric internal `product_id`." }, { "in": "query", "name": "domain", "schema": { "enum": [ "us", "ca" ], "type": "string", "default": "us" }, "description": "Walmart domain. 'us' for walmart.com, 'ca' for walmart.ca. Default is 'us'." }, { "in": "query", "name": "store_id", "schema": { "type": "string" }, "example": "3148", "description": "Walmart store ID to get store-specific offers and prices. Supported for domain 'ca': the product page is rendered for that walmart.ca store (e.g. '3148' for Lévis, QC) and the response `location` object confirms the store applied. Without it walmart.ca defaults to Mississauga Supercenter (store 1061). Not applied for domain 'us'." } ], "description": "Get all available seller offers for a specific Walmart product, including prices, seller info, shipping, and return policies.", "operationId": "realtime_walmart_data__get__product_offers", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_5-N-bD-w4FEvDbPufA7rY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_JMX_MdcNKNvBSfEXsR78v" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_D1eKbJ9D0SJoHD3LLOLYI", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_WiAI6D9DA33xLudF2TJIh" } ], "x-zeroclick-services": [ "real-time-walmart-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "real-time-walmart-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "real-time-walmart-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/real-time-walmart-data/product-reviews": { "get": { "summary": "Product Reviews", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "page": { "type": "integer", "description": "The current page number of results." }, "rating": { "type": "number", "description": "The average product rating." }, "product": { "type": "object", "properties": { "url": { "type": "string", "description": "The product page URL." }, "name": { "type": "string", "description": "The product name." }, "categories": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string", "description": "The category URL." }, "name": { "type": "string", "description": "The category name." } } }, "description": "The category breadcrumb list for the product." } } }, "reviews": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The identifier of the review." }, "body": { "type": "string", "description": "The text content of the review." }, "date": { "type": "string", "description": "The date the review was posted." }, "media": { "type": "array", "items": { "type": "object" }, "description": "A list of media items associated with the review." }, "title": { "type": "string", "description": "The title of the review." }, "author": { "type": "string", "description": "The author name shown for the review." }, "badges": { "type": "array", "items": { "type": "string" }, "description": "A list of badge labels applied to the review." }, "rating": { "type": "integer", "description": "The star rating given in the review." }, "source": { "type": "object", "properties": { "author_id": { "type": "string", "description": "The author identifier from the source metadata when provided." }, "author_name": { "type": "string", "description": "The author name from the source metadata when provided." }, "external_source": { "type": "string", "description": "The external source name when applicable." }, "verified_purchase": { "type": "boolean", "description": "Whether the review is marked as a verified purchase." }, "is_external_source": { "type": "boolean", "description": "Whether the review originates from an external source." } } }, "position": { "type": "integer", "description": "The position of the review in the returned list." }, "top_reviewer": { "type": "boolean", "description": "Whether the author is marked as a top reviewer." }, "negative_feedback": { "type": "integer", "description": "The count of negative feedback votes for the review." }, "positive_feedback": { "type": "integer", "description": "The count of positive feedback votes for the review." } } }, "description": "A paginated list of individual product reviews." }, "per_page": { "type": "integer", "description": "The number of reviews returned per page." }, "total_pages": { "type": "integer", "description": "The total number of pages available." }, "review_count": { "type": "integer", "description": "The total number of reviews for the product." }, "ratings_count": { "type": "integer", "description": "The total number of ratings for the product." }, "rating_breakdown": { "type": "object", "properties": { "one": { "type": "integer", "description": "The count of 1-star ratings." }, "two": { "type": "integer", "description": "The count of 2-star ratings." }, "five": { "type": "integer", "description": "The count of 5-star ratings." }, "four": { "type": "integer", "description": "The count of 4-star ratings." }, "three": { "type": "integer", "description": "The count of 3-star ratings." } } }, "top_negative_review": { "type": "object", "properties": { "id": { "type": "string", "description": "The identifier of the top negative review." }, "body": { "type": "string", "description": "The text content of the top negative review." }, "date": { "type": "string", "description": "The date the top negative review was posted." }, "title": { "type": "string", "description": "The title of the top negative review." }, "author": { "type": "string", "description": "The author name of the top negative review." }, "rating": { "type": "integer", "description": "The rating given in the top negative review." }, "negative_feedback": { "type": "integer", "description": "The count of negative feedback votes for the review." }, "positive_feedback": { "type": "integer", "description": "The count of positive feedback votes for the review." } } }, "top_positive_review": { "type": "object", "properties": { "id": { "type": "string", "description": "The identifier of the top positive review." }, "body": { "type": "string", "description": "The text content of the top positive review." }, "date": { "type": "string", "description": "The date the top positive review was posted." }, "title": { "type": "string", "description": "The title of the top positive review." }, "author": { "type": "string", "description": "The author name of the top positive review." }, "rating": { "type": "integer", "description": "The rating given in the top positive review." }, "negative_feedback": { "type": "integer", "description": "The count of negative feedback votes for the review." }, "positive_feedback": { "type": "integer", "description": "The count of positive feedback votes for the review." } } }, "recommended_percentage": { "type": "integer", "description": "The percentage of reviewers who recommend the product." } } }, "status": { "type": "string", "description": "The status of the API response." }, "parameters": { "type": "object", "properties": { "page": { "type": "integer", "description": "The page number of reviews to return." }, "sort": { "type": "string", "description": "The sorting method used for returned reviews." }, "limit": { "type": "integer", "description": "The maximum number of reviews to return per page." }, "domain": { "type": "string", "description": "The store or domain used as the data source." }, "product_id": { "type": "string", "description": "The product identifier to fetch reviews for." } } }, "request_id": { "type": "string", "description": "A unique identifier for this request." } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "product_id", "schema": { "type": "string" }, "example": "609040889", "required": true, "description": "Walmart product ID. For domain 'us' this can be the numeric us_item_id (e.g. '609040889') or the alphanumeric product_id (e.g. '4SZSM8SXAAJT'); alphanumeric IDs are automatically resolved to numeric IDs. For domain 'ca' use the `us_item_id` value returned by search (e.g. '875806'); the numeric internal `product_id` returns reviews without product details." }, { "in": "query", "name": "page", "schema": { "type": "number", "default": 1, "maximum": 100, "minimum": 1 }, "description": "Page number for pagination. Default is 1." }, { "in": "query", "name": "domain", "schema": { "enum": [ "us", "ca" ], "type": "string", "default": "us" }, "description": "Walmart domain. 'us' for walmart.com, 'ca' for walmart.ca. Default is 'us'." }, { "in": "query", "name": "rating", "schema": { "type": "number", "default": 5, "maximum": 5, "minimum": 1 }, "description": "Filter reviews by star rating (1-5). Only returns reviews with the specified rating." }, { "in": "query", "name": "limit", "schema": { "type": "number", "default": 10, "maximum": 50, "minimum": 1 }, "description": "Number of reviews to return per page (1-50). Default is 10." }, { "in": "query", "name": "sort", "schema": { "enum": [ "relevancy", "recent", "rating_high_low", "rating_low_high" ], "type": "string", "default": "relevancy" }, "description": "Sort order for reviews. Default is 'relevancy'." } ], "description": "Get customer reviews for a Walmart product with pagination, sorting, and rating filter options. Includes review text, ratings, author info, and review statistics.", "operationId": "realtime_walmart_data__get__product_reviews", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_5-N-bD-w4FEvDbPufA7rY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_JMX_MdcNKNvBSfEXsR78v" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_D1eKbJ9D0SJoHD3LLOLYI", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_WiAI6D9DA33xLudF2TJIh" } ], "x-zeroclick-services": [ "real-time-walmart-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "real-time-walmart-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "real-time-walmart-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/real-time-walmart-data/products-by-category": { "get": { "summary": "Products By Category", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "location": { "type": "object", "nullable": true, "properties": { "city": { "type": "string", "nullable": true, "description": "City associated with the location. null on walmart.ca when store_id is set." }, "state": { "type": "string", "nullable": true, "description": "State or province code. null on walmart.ca when store_id is set." }, "store_id": { "type": "string", "description": "Walmart store ID the prices were rendered for." }, "postal_code": { "type": "string", "nullable": true, "description": "Postal / ZIP code associated with the location. null on walmart.ca when store_id is set (Walmart does not return the selected store's address; use store_id)." } }, "description": "The store location Walmart resolved this response for. Use it to verify which store the prices belong to. With no store_id, walmart.ca defaults to Mississauga Supercenter (store 1061) and walmart.com to a store near the request's exit location." }, "products": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string", "description": "The product page URL." }, "brand": { "type": "string", "description": "The product brand when available, otherwise null." }, "image": { "type": "string", "description": "The main image URL for the product." }, "price": { "type": "number", "description": "The current selling price of the product." }, "title": { "type": "string", "description": "The product title." }, "pickup": { "type": "boolean", "description": "Whether pickup is available for the product." }, "rating": { "type": "number", "description": "The average product rating." }, "seller": { "type": "string", "description": "The seller name for the product." }, "currency": { "type": "string", "description": "The currency code for the displayed prices." }, "position": { "type": "integer", "description": "The position of the product in the returned list." }, "preorder": { "type": "boolean", "description": "Whether the product is available for pre-order." }, "shipping": { "type": "boolean", "description": "Whether shipping is available for the product." }, "max_price": { "type": "string", "description": "The maximum price when a price range applies, otherwise null." }, "min_price": { "type": "string", "description": "The minimum price when a price range applies, otherwise null." }, "seller_id": { "type": "string", "description": "The identifier of the seller." }, "sponsored": { "type": "boolean", "description": "Whether the product listing is sponsored." }, "thumbnail": { "type": "string", "description": "A thumbnail image URL for the product." }, "list_price": { "type": "number", "description": "The original or list price of the product." }, "product_id": { "type": "string", "description": "The product identifier from the source." }, "us_item_id": { "type": "string", "description": "The US item identifier for the product." }, "badge_flags": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "The badge flag key." }, "text": { "type": "string", "description": "The display text for the badge flag." } } }, "description": "A list of badge flags applied to the product." }, "best_seller": { "type": "boolean", "description": "Whether the product is marked as a best seller." }, "description": { "type": "string", "description": "A product description when available, otherwise null." }, "availability": { "type": "string", "description": "The availability status text for the product." }, "out_of_stock": { "type": "boolean", "description": "Whether the product is currently out of stock." }, "review_count": { "type": "integer", "description": "The number of reviews for the product." }, "free_shipping": { "type": "boolean", "description": "Whether free shipping is available." }, "price_display": { "type": "string", "description": "A formatted string representation of the price." }, "primary_offer": { "type": "object", "properties": { "offer_id": { "type": "string", "description": "The identifier for the primary offer." }, "min_price": { "type": "string", "description": "The minimum price for the offer when applicable, otherwise null." }, "offer_price": { "type": "number", "description": "The price of the primary offer." } } }, "shipping_days": { "type": "string", "description": "The estimated shipping time in days when available, otherwise null." }, "savings_amount": { "type": "number", "description": "The amount saved compared to list price when available." }, "currency_symbol": { "type": "string", "description": "The currency symbol used for display." }, "two_day_shipping": { "type": "boolean", "description": "Whether two-day shipping is available." }, "delivery_from_store": { "type": "boolean", "description": "Whether delivery from a local store is available." }, "price_per_unit_type": { "type": "string", "description": "The per-unit price type (e.g., oz, lb) when available, otherwise null." }, "price_per_unit_amount": { "type": "string", "description": "The per-unit price amount when available, otherwise null." }, "multiple_options_available": { "type": "boolean", "description": "Whether multiple variants/options are available for the product." }, "free_shipping_with_walmart_plus": { "type": "boolean", "description": "Whether free shipping is available with Walmart+." } } }, "description": "The list of product results for the current page." }, "total_pages": { "type": "integer", "description": "The total number of pages available for the current category." }, "total_results": { "type": "string", "description": "The total number of matching results when available, otherwise null." } } }, "status": { "type": "string", "description": "The status of the API response." }, "parameters": { "type": "object", "properties": { "page": { "type": "integer", "description": "The page number of results to return." }, "domain": { "type": "string", "description": "The store or domain used as the data source for results." }, "sort_by": { "type": "string", "description": "The sorting method used for the product results." }, "category_id": { "type": "string", "description": "The category identifier used to retrieve products." } } }, "request_id": { "type": "string", "description": "A unique identifier for this request." } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "category_id", "schema": { "type": "string" }, "example": "3944", "required": true, "description": "Walmart category ID. E.g. '3944' for Electronics, '976759' for Cell Phones. Found in product details category URLs or Walmart's site navigation." }, { "in": "query", "name": "page", "schema": { "type": "number", "default": 1, "minimum": 1 }, "description": "Page number for pagination. Default is 1." }, { "in": "query", "name": "sort_by", "schema": { "enum": [ "best_match", "price_low", "price_high", "best_seller", "top_rated" ], "type": "string", "default": "best_match" }, "description": "Sort results by the given criteria. Accepts aliases: price_low, price_high, best_seller, top_rated. Default is best_match." }, { "in": "query", "name": "max_price", "schema": { "type": "number" }, "description": "Maximum price filter. Must be higher than min_price if both are specified." }, { "in": "query", "name": "min_price", "schema": { "type": "number" }, "description": "Minimum price filter. Must be lower than max_price if both are specified." }, { "in": "query", "name": "store_id", "schema": { "type": "string" }, "example": "3148", "description": "Walmart store ID to get store-specific prices and availability. Supported for domain 'ca': results are rendered for that walmart.ca store (e.g. '3148' for Lévis, QC) and the response `location` object confirms the store applied. Without it walmart.ca defaults to Mississauga Supercenter (store 1061). For domain 'us' this parameter is currently not applied." }, { "in": "query", "name": "facet", "schema": { "type": "string" }, "description": "Facet filter string for refining results (e.g. by brand, category)." }, { "in": "query", "name": "domain", "schema": { "enum": [ "us", "ca" ], "type": "string", "default": "us" }, "description": "Walmart domain. 'us' for walmart.com, 'ca' for walmart.ca. Default is 'us'." }, { "in": "query", "name": "state", "schema": { "type": "string" }, "description": "US state code (e.g. 'CA', 'NY') to localize results." }, { "in": "query", "name": "zip", "schema": { "type": "string" }, "description": "ZIP/postal code to localize results." } ], "description": "Get products from a specific Walmart category with pagination, sorting, and filtering options.", "operationId": "realtime_walmart_data__get__products_by_category", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_5-N-bD-w4FEvDbPufA7rY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_JMX_MdcNKNvBSfEXsR78v" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_D1eKbJ9D0SJoHD3LLOLYI", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_WiAI6D9DA33xLudF2TJIh" } ], "x-zeroclick-services": [ "real-time-walmart-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "real-time-walmart-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "real-time-walmart-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/real-time-walmart-data/search": { "get": { "summary": "Product Search", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "location": { "type": "object", "nullable": true, "properties": { "city": { "type": "string", "nullable": true, "description": "City associated with the location. null on walmart.ca when store_id is set." }, "state": { "type": "string", "nullable": true, "description": "State or province code. null on walmart.ca when store_id is set." }, "store_id": { "type": "string", "description": "Walmart store ID the prices were rendered for." }, "postal_code": { "type": "string", "nullable": true, "description": "Postal / ZIP code associated with the location. null on walmart.ca when store_id is set (Walmart does not return the selected store's address; use store_id)." } }, "description": "The store location Walmart resolved this response for. Use it to verify which store the prices belong to. With no store_id, walmart.ca defaults to Mississauga Supercenter (store 1061) and walmart.com to a store near the request's exit location." }, "products": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string", "description": "The product page URL." }, "brand": { "type": "string", "description": "The product brand when available, otherwise null." }, "image": { "type": "string", "description": "The main image URL for the product." }, "price": { "type": "number", "description": "The current selling price of the product." }, "title": { "type": "string", "description": "The product title." }, "pickup": { "type": "boolean", "description": "Whether pickup is available for the product." }, "rating": { "type": "number", "description": "The average product rating." }, "seller": { "type": "string", "description": "The seller name for the product." }, "currency": { "type": "string", "description": "The currency code for the displayed prices." }, "position": { "type": "integer", "description": "The position of the product in the returned list." }, "preorder": { "type": "boolean", "description": "Whether the product is available for pre-order." }, "shipping": { "type": "boolean", "description": "Whether shipping is available for the product." }, "max_price": { "type": "string", "description": "The maximum price when a price range applies, otherwise null." }, "min_price": { "type": "string", "description": "The minimum price when a price range applies, otherwise null." }, "seller_id": { "type": "string", "description": "The identifier of the seller." }, "sponsored": { "type": "boolean", "description": "Whether the product listing is sponsored." }, "thumbnail": { "type": "string", "description": "A thumbnail image URL for the product." }, "list_price": { "type": "integer", "description": "The original or list price of the product." }, "product_id": { "type": "string", "description": "The product identifier from the source." }, "us_item_id": { "type": "string", "description": "The US item identifier for the product." }, "badge_flags": { "type": "array", "items": { "type": "string" }, "description": "A list of badge flags applied to the product." }, "best_seller": { "type": "boolean", "description": "Whether the product is marked as a best seller." }, "description": { "type": "string", "description": "A short description of the product." }, "availability": { "type": "string", "description": "The availability status text for the product." }, "out_of_stock": { "type": "boolean", "description": "Whether the product is currently out of stock." }, "review_count": { "type": "integer", "description": "The number of reviews for the product." }, "free_shipping": { "type": "boolean", "description": "Whether free shipping is available." }, "price_display": { "type": "string", "description": "A formatted string representation of the price." }, "primary_offer": { "type": "object", "properties": { "offer_id": { "type": "string", "description": "The identifier for the primary offer." }, "min_price": { "type": "string", "description": "The minimum price for the offer when applicable, otherwise null." }, "offer_price": { "type": "number", "description": "The price of the primary offer." } } }, "shipping_days": { "type": "string", "description": "The estimated shipping time in days when available, otherwise null." }, "savings_amount": { "type": "integer", "description": "The amount saved compared to list price." }, "currency_symbol": { "type": "string", "description": "The currency symbol used for display." }, "two_day_shipping": { "type": "boolean", "description": "Whether two-day shipping is available." }, "delivery_from_store": { "type": "boolean", "description": "Whether delivery from a local store is available." }, "price_per_unit_type": { "type": "string", "description": "The per-unit price type (e.g., oz, lb) when available, otherwise null." }, "price_per_unit_amount": { "type": "string", "description": "The per-unit price amount when available, otherwise null." }, "multiple_options_available": { "type": "boolean", "description": "Whether multiple variants/options are available for the product." }, "free_shipping_with_walmart_plus": { "type": "boolean", "description": "Whether free shipping is available with Walmart+." } } }, "description": "The list of product results for the current page." }, "total_pages": { "type": "integer", "description": "The total number of pages available for the current query." }, "total_results": { "type": "string", "description": "The total number of matching results when available, otherwise null." } } }, "status": { "type": "string", "description": "The status of the API response." }, "parameters": { "type": "object", "properties": { "page": { "type": "integer", "description": "The page number of results to return." }, "query": { "type": "string", "description": "The search query used to retrieve products." }, "domain": { "type": "string", "description": "The store or domain used as the data source for results." }, "sort_by": { "type": "string", "description": "The sorting method used for the product results." } } }, "request_id": { "type": "string", "description": "A unique identifier for this request." } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "query", "schema": { "type": "string" }, "example": "laptop", "required": true, "description": "Search query string. E.g. 'laptop', 'iphone 15', 'nike shoes'" }, { "in": "query", "name": "page", "schema": { "type": "number", "default": 1, "minimum": 1 }, "description": "Page number for pagination. Default is 1." }, { "in": "query", "name": "sort_by", "schema": { "enum": [ "best_match", "price_low", "price_high", "best_seller", "top_rated" ], "type": "string", "default": "best_match" }, "description": "Sort results by the given criteria. Accepts aliases: price_low, price_high, best_seller, top_rated. Default is best_match." }, { "in": "query", "name": "min_price", "schema": { "type": "number" }, "description": "Minimum price filter. Must be lower than max_price if both are specified." }, { "in": "query", "name": "max_price", "schema": { "type": "number" }, "description": "Maximum price filter. Must be higher than min_price if both are specified." }, { "in": "query", "name": "store_id", "schema": { "type": "string" }, "example": "3148", "description": "Walmart store ID to get store-specific prices and availability. Supported for domain 'ca': results are rendered for that walmart.ca store (e.g. '3148' for Lévis, QC) and the response `location` object confirms the store applied. Without it walmart.ca defaults to Mississauga Supercenter (store 1061). For domain 'us' this parameter is currently not applied to search results." }, { "in": "query", "name": "facet", "schema": { "type": "string" }, "description": "Facet filter string for refining results (e.g. by brand, category). Obtained from a previous search response's facet data." }, { "in": "query", "name": "domain", "schema": { "enum": [ "us", "ca" ], "type": "string", "default": "us" }, "description": "Walmart domain to search. 'us' for walmart.com, 'ca' for walmart.ca. Default is 'us'." }, { "in": "query", "name": "state", "schema": { "type": "string" }, "description": "US state code (e.g. 'CA', 'NY') to localize search results such as availability and shipping options." } ], "description": "Search for products on Walmart with pagination support and multiple filters and options such as sort by, price range, location, and more.", "operationId": "realtime_walmart_data__get__search", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_5-N-bD-w4FEvDbPufA7rY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_JMX_MdcNKNvBSfEXsR78v" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_D1eKbJ9D0SJoHD3LLOLYI", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_WiAI6D9DA33xLudF2TJIh" } ], "x-zeroclick-services": [ "real-time-walmart-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "real-time-walmart-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "real-time-walmart-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/real-time-wayfair-data/product-details": { "get": { "summary": "Product Details", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "request_id", "parameters", "data" ], "properties": { "data": { "type": "object", "required": [ "sku", "piid", "name", "brand", "manufacturer", "url", "description", "features", "images", "pricing", "rating", "review_count", "in_stock", "stock_message", "options", "variants", "specifications", "dimensions", "overall_dimensions", "part_number", "highlights", "whats_included", "shipping", "return_policy", "open_box", "breadcrumbs", "reviews" ], "properties": { "sku": { "type": "string", "description": "Wayfair product SKU." }, "url": { "type": "string", "description": "Canonical URL of the product on Wayfair." }, "name": { "type": "string", "description": "Product name, brand included, as in the product page title without the store suffix." }, "piid": { "type": "string", "nullable": true, "description": "Option id(s) of the option this response describes, comma-separated when the product has several option categories. Pass it back as the 'piid' parameter. Null for a product without options." }, "brand": { "type": "string", "nullable": true, "description": "Brand / manufacturer name." }, "images": { "type": "array", "items": { "type": "string", "description": "A product image URL." }, "description": "Full-size URLs of every image in the product gallery, for the selected option." }, "rating": { "type": "number", "nullable": true, "description": "Average customer rating (0-5)." }, "options": { "type": "array", "items": { "type": "object", "required": [ "category_id", "category", "selected_option_id", "options" ], "properties": { "options": { "type": "array", "items": { "type": "object", "required": [ "option_id", "name", "swatch_image", "image", "in_stock", "is_selected", "sku", "url" ], "properties": { "sku": { "type": "string", "description": "SKU of the product this option belongs to." }, "url": { "type": "string", "nullable": true, "description": "Product page URL of this option." }, "name": { "type": "string", "description": "Option name." }, "image": { "type": "string", "nullable": true, "description": "Main image URL of this option." }, "in_stock": { "type": "boolean", "nullable": true, "description": "Whether this option is in stock." }, "option_id": { "type": "string", "nullable": true, "description": "Option ID (piid). Pass it as the 'piid' parameter to get this option's pricing, images and details. Null when the option is a separate product (use its sku instead)." }, "is_selected": { "type": "boolean", "description": "Whether this is the option the response describes." }, "swatch_image": { "type": "string", "nullable": true, "description": "Swatch image URL." } }, "description": "An option." }, "description": "The options in this category." }, "category": { "type": "string", "description": "Option category name." }, "category_id": { "type": "string", "description": "Wayfair option category ID. A negative ID marks a category whose options are separate Wayfair products (for example other colours sold under their own SKU)." }, "selected_option_id": { "type": "string", "nullable": true, "description": "option_id of the option selected in this response. Null for a category of separate products." } }, "description": "An option category." }, "description": "Option categories of the product (Color, Size, and so on), each with every option Wayfair offers in it. Empty for a product without options." }, "pricing": { "type": "object", "nullable": true, "required": [ "current_price", "original_price", "discount_amount", "discount_percentage", "currency" ], "properties": { "currency": { "type": "string", "description": "ISO 4217 currency code." }, "current_price": { "type": "number", "description": "Current price." }, "original_price": { "type": "number", "nullable": true, "description": "Original (struck-through) price, when on sale." }, "discount_amount": { "type": "number", "nullable": true, "description": "Discount amount in the listing currency, when on sale." }, "discount_percentage": { "type": "number", "nullable": true, "description": "Discount as a percentage, when on sale." } }, "description": "Pricing of the selected option." }, "reviews": { "type": "array", "items": { "type": "object", "required": [ "review_id", "body", "date", "rating" ], "properties": { "body": { "type": "string", "description": "Review body text." }, "date": { "type": "string", "nullable": true, "description": "Review date (MM/DD/YYYY)." }, "rating": { "type": "integer", "nullable": true, "description": "Reviewer's rating (1-5)." }, "review_id": { "type": "string", "description": "Wayfair review ID." } }, "description": "A review." }, "description": "Sample of reviews displayed on the product page." }, "features": { "type": "array", "items": { "type": "string", "description": "A feature bullet." }, "description": "Feature bullets shown on the product page, for the selected option." }, "in_stock": { "type": "boolean", "nullable": true, "description": "Whether the selected option is in stock." }, "open_box": { "type": "object", "nullable": true, "required": [ "message", "price" ], "properties": { "price": { "type": "number", "nullable": true, "description": "Open box price." }, "message": { "type": "string", "nullable": true, "description": "Open box message." } }, "description": "Open box offer, when available." }, "shipping": { "type": "object", "nullable": true, "required": [ "delivery_estimate", "delivery_date_min", "delivery_date_max", "delivery_method", "delivery_badge" ], "properties": { "delivery_badge": { "type": "string", "nullable": true, "description": "Delivery badge as displayed." }, "delivery_method": { "type": "string", "nullable": true, "description": "Delivery method." }, "delivery_date_max": { "type": "string", "nullable": true, "description": "Latest delivery date (ISO 8601)." }, "delivery_date_min": { "type": "string", "nullable": true, "description": "Earliest delivery date (ISO 8601)." }, "delivery_estimate": { "type": "string", "nullable": true, "description": "Delivery estimate as displayed." } }, "description": "Delivery information for the selected option." }, "variants": { "type": "array", "items": { "type": "object", "required": [ "name", "display_id" ], "properties": { "name": { "type": "string", "description": "Option name." }, "display_id": { "type": "integer", "description": "Option ID (piid)." } }, "description": "An option." }, "deprecated": true, "description": "Deprecated: option names and IDs in the earlier format. Use options." }, "dimensions": { "type": "array", "items": { "type": "object", "required": [ "key", "value" ], "properties": { "key": { "type": "string", "description": "Dimension name." }, "value": { "type": "string", "nullable": true, "description": "Dimension value as displayed." } }, "description": "A dimension." }, "description": "Product dimensions as displayed on the product page." }, "highlights": { "type": "array", "items": { "type": "object", "required": [ "label", "value" ], "properties": { "label": { "type": "string", "description": "Highlight label." }, "value": { "type": "string", "nullable": true, "description": "Highlight value." } }, "description": "A highlight." }, "description": "Product highlights shown near the top of the page." }, "breadcrumbs": { "type": "array", "items": { "type": "string", "description": "A category name." }, "description": "Category breadcrumbs of the product." }, "description": { "type": "string", "nullable": true, "description": "Product description shown under \"About This Product\", for the selected option. Null when the product page has none." }, "part_number": { "type": "string", "nullable": true, "description": "Manufacturer part number of the selected option, when the manufacturer lists one." }, "manufacturer": { "type": "object", "nullable": true, "required": [ "id", "name", "url" ], "properties": { "id": { "type": "string", "nullable": true, "description": "Wayfair manufacturer ID, usable as manufacturer_id on the Search endpoint." }, "url": { "type": "string", "nullable": true, "description": "Brand page URL on Wayfair." }, "name": { "type": "string", "description": "Brand / manufacturer name." } }, "description": "Brand / manufacturer details." }, "review_count": { "type": "integer", "nullable": true, "description": "Total number of customer reviews." }, "return_policy": { "type": "object", "nullable": true, "required": [ "days_to_return" ], "properties": { "days_to_return": { "type": "integer", "description": "Number of days to return the product." } }, "description": "Return policy." }, "stock_message": { "type": "string", "nullable": true, "description": "Stock message shown on the product page." }, "specifications": { "type": "array", "items": { "type": "object", "required": [ "section", "items" ], "properties": { "items": { "type": "array", "items": { "type": "object", "required": [ "name", "value" ], "properties": { "name": { "type": "string", "description": "Specification name." }, "value": { "type": "string", "nullable": true, "description": "Specification value, with units as displayed." } }, "description": "A specification." }, "description": "Specifications in this section." }, "section": { "type": "string", "description": "Section name. Values: Dimensions, Details, Certifications, Assembly, Warranty." } }, "description": "A specifications section." }, "description": "The full specifications table of the product page, by section, for the selected option. Values carry their units as displayed." }, "whats_included": { "type": "array", "items": { "type": "string", "description": "An included item." }, "description": "Items listed as included in the box." }, "overall_dimensions": { "type": "object", "nullable": true, "required": [ "height", "width", "depth", "length", "diameter", "unit", "weight", "weight_unit" ], "properties": { "unit": { "type": "string", "nullable": true, "description": "Unit of the dimensions. Values: in, ft, cm, mm, m." }, "depth": { "type": "number", "nullable": true, "description": "Depth." }, "width": { "type": "number", "nullable": true, "description": "Width." }, "height": { "type": "number", "nullable": true, "description": "Height." }, "length": { "type": "number", "nullable": true, "description": "Length (rugs and similar)." }, "weight": { "type": "number", "nullable": true, "description": "Product weight." }, "diameter": { "type": "number", "nullable": true, "description": "Diameter (round products)." }, "weight_unit": { "type": "string", "nullable": true, "description": "Unit of the weight. Values: lb, kg, g, oz." } }, "description": "Overall dimensions and weight as numbers, parsed from the \"Overall Dimensions\" and \"Overall Product Weight\" values. Null when the product lists neither." } }, "description": "Product details." }, "status": { "type": "string", "description": "The status of the API response." }, "parameters": { "type": "object", "properties": { "sku": { "type": "string", "description": "The Wayfair product SKU as received." }, "piid": { "type": "string", "description": "The option id(s) as received, when given." }, "domain": { "type": "string", "description": "Wayfair domain as received." } }, "description": "The parameters the API received and used for this request, echoed back." }, "request_id": { "type": "string", "description": "A unique ID to trace the API request." } } } } }, "description": "Successful response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "sku", "schema": { "type": "string" }, "example": "MBYC1330", "required": true, "description": "The Wayfair product SKU. You can find SKUs in the product URL or from the Search endpoint results.\n\n**Examples:**\n`MBYC1330`\n`W110469263`" }, { "in": "query", "name": "piid", "schema": { "type": "string" }, "description": "Option id(s) (piid) to select a specific option of the product, for example a color or a size: the same piid Wayfair puts in its product URLs (`...-w100446152.html?piid=951771611`). Pricing, images, description, stock and delivery then describe that option. For a product with several option categories pass one id per category, comma-separated (`124921195,132911014`). The ids are listed in `data.options`. When omitted, Wayfair's default option is returned." }, { "in": "query", "name": "domain", "schema": { "type": "string", "default": "com" }, "description": "Wayfair domain/country.\n\n**Default:** `com`\n\n**Allowed values:** `com, ca, co.uk, ie`\n\n`de` is no longer supported: Wayfair has closed wayfair.de." } ], "description": "Get full product details by Wayfair SKU: name, brand, pricing, every product image, description and feature bullets, the full specifications table, dimensions, stock, delivery, reviews sample, and all product options (Color, Size, and so on) with their option ids and swatches. Pass an option id as piid to get that option's pricing, images and details.", "operationId": "realtime_wayfair_data__Product_Details", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_5-N-bD-w4FEvDbPufA7rY", "authority": "supplemental", "conflicts": [ "/summary", "/description", "/operationId" ], "revisionId": "sdrn_JMX_MdcNKNvBSfEXsR78v" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_D1eKbJ9D0SJoHD3LLOLYI", "authority": "supplemental", "conflicts": [ "/summary", "/description", "/operationId" ], "revisionId": "sdrn_WiAI6D9DA33xLudF2TJIh" } ], "x-zeroclick-services": [ "real-time-wayfair-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "real-time-wayfair-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "real-time-wayfair-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/real-time-wayfair-data/product-reviews": { "get": { "summary": "Product Reviews", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "request_id", "parameters", "data" ], "properties": { "data": { "type": "object", "required": [ "sku", "reviews" ], "properties": { "sku": { "type": "string", "description": "Wayfair product SKU." }, "aspects": { "type": "array", "items": { "type": "object", "required": [ "name", "sentiment" ], "properties": { "name": { "type": "string", "description": "Aspect label (e.g. Functionality, Durability, Ease of use)." }, "count": { "type": "integer", "nullable": true, "description": "Number of reviews mentioning this aspect." }, "sentiment": { "type": "string", "description": "Sentiment classification for the aspect. Values: POSITIVE, NEUTRAL, NEGATIVE, MIXED." } } }, "nullable": true, "description": "Aspect sentiment breakdown derived from the reviews." }, "reviews": { "type": "array", "items": { "type": "object", "required": [ "review_id", "rating" ], "properties": { "body": { "type": "string", "nullable": true, "description": "Review body text." }, "date": { "type": "string", "nullable": true, "description": "Review date (MM/DD/YYYY)." }, "badge": { "type": "string", "nullable": true, "description": "Wayfair badge displayed on the review (e.g. Verified Buyer)." }, "locale": { "type": "string", "nullable": true, "description": "Locale of the review." }, "rating": { "type": "integer", "description": "Reviewer's rating (1-5)." }, "review_id": { "type": "integer", "description": "Wayfair review ID." }, "is_verified": { "type": "boolean", "nullable": true, "description": "Whether the review is from a verified buyer." }, "reviewer_name": { "type": "string", "nullable": true, "description": "Reviewer's display name." }, "reviewer_location": { "type": "string", "nullable": true, "description": "Reviewer's location." } } }, "description": "Reviews on this page." }, "sort_by": { "type": "string", "nullable": true, "description": "Echo of the sort order used." }, "ai_summary": { "type": "string", "nullable": true, "description": "AI-generated summary of the reviews." }, "end_cursor": { "type": "string", "nullable": true, "description": "Cursor representing the position at the end of this page (opaque)." }, "total_reviews": { "type": "integer", "nullable": true, "description": "Total number of reviews available for the product." }, "reviews_returned": { "type": "integer", "nullable": true, "description": "Number of reviews returned in this page." } } }, "status": { "type": "string", "description": "The status of the API response." }, "parameters": { "type": "object", "properties": { "sku": { "type": "string", "description": "The Wayfair product SKU as received." }, "page": { "type": "integer", "description": "Page number for pagination as received." }, "domain": { "type": "string", "description": "Wayfair domain country code as received." }, "sort_by": { "type": "string", "description": "Sort order as received. Values: relevance, helpful, date_ascending, date_descending, rating_ascending, rating_descending." } }, "description": "The parameters the API received and used for this request, echoed back." }, "request_id": { "type": "string", "description": "A unique ID to trace the API request." } } } } }, "description": "Successful response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "sku", "schema": { "type": "string" }, "example": "MBYC1062", "required": true, "description": "The Wayfair product SKU.\n\n**Examples:**\n`MBYC1062`\n`W110469263`" }, { "in": "query", "name": "page", "schema": { "type": "integer", "default": 1 }, "description": "Page number for pagination.\n\n**Allowed values:** `1` and above." }, { "in": "query", "name": "sort_by", "schema": { "enum": [ "relevance", "helpful", "date_ascending", "date_descending", "rating_ascending", "rating_descending" ], "type": "string", "default": "relevance" }, "description": "Sort order for reviews." }, { "in": "query", "name": "star", "schema": { "enum": [ "1", "2", "3", "4", "5" ], "type": "string" }, "description": "Filter reviews by star rating.\n\n**Allowed values:** `1`, `2`, `3`, `4`, `5`" }, { "in": "query", "name": "domain", "schema": { "type": "string", "default": "com" }, "description": "Wayfair domain/country.\n\n**Default:** `com`\n\n**Allowed values:** `com, ca, co.uk, ie`\n\n`de` is no longer supported: Wayfair has closed wayfair.de." } ], "description": "Get paginated product reviews by Wayfair SKU. Returns 10 reviews per page with cursor-based pagination, AI-generated review summary, and aspect sentiments.", "operationId": "realtime_wayfair_data__Product_Reviews", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_5-N-bD-w4FEvDbPufA7rY", "authority": "supplemental", "conflicts": [ "/summary", "/description", "/operationId" ], "revisionId": "sdrn_JMX_MdcNKNvBSfEXsR78v" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_D1eKbJ9D0SJoHD3LLOLYI", "authority": "supplemental", "conflicts": [ "/summary", "/description", "/operationId" ], "revisionId": "sdrn_WiAI6D9DA33xLudF2TJIh" } ], "x-zeroclick-services": [ "real-time-wayfair-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "real-time-wayfair-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "real-time-wayfair-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/real-time-wayfair-data/search": { "get": { "summary": "Search", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "request_id", "parameters", "data" ], "properties": { "data": { "type": "object", "required": [ "products" ], "properties": { "keyword": { "type": "string", "nullable": true, "description": "Echo of the search keyword." }, "products": { "type": "array", "items": { "type": "object", "required": [ "sku", "name", "url" ], "properties": { "sku": { "type": "string", "description": "Wayfair product SKU." }, "url": { "type": "string", "description": "Canonical URL of the product on Wayfair." }, "flag": { "type": "string", "nullable": true, "description": "Special flag set on the product (e.g. sale, new)." }, "name": { "type": "string", "description": "Product name." }, "brand": { "type": "string", "nullable": true, "description": "Brand / manufacturer name." }, "rating": { "type": "number", "nullable": true, "description": "Average customer rating (0-5)." }, "pricing": { "type": "object", "nullable": true, "required": [ "current_price", "currency" ], "properties": { "currency": { "type": "string", "description": "ISO 4217 currency code." }, "current_price": { "type": "number", "description": "Current sale price." }, "original_price": { "type": "number", "nullable": true, "description": "Original (pre-discount) price, when on sale." }, "discount_amount": { "type": "number", "nullable": true, "description": "Discount amount in the listing currency, when on sale." }, "discount_percentage": { "type": "number", "nullable": true, "description": "Discount as a percentage, when on sale." } }, "description": "Current pricing for the product." }, "in_stock": { "type": "boolean", "nullable": true, "description": "Whether the product is currently in stock." }, "image_url": { "type": "string", "nullable": true, "description": "URL of the product's primary image." }, "promo_text": { "type": "string", "nullable": true, "description": "Promotional label displayed on the product card." }, "review_count": { "type": "integer", "nullable": true, "description": "Total number of customer reviews." }, "free_shipping": { "type": "boolean", "nullable": true, "description": "Whether the product ships free." }, "shipping_text": { "type": "string", "nullable": true, "description": "Free-form shipping label as displayed on Wayfair." }, "option_summary": { "type": "string", "nullable": true, "description": "Short summary of the variant option type (e.g. Fabric)." }, "delivery_estimate": { "type": "string", "nullable": true, "description": "Estimated delivery date label." }, "color_option_count": { "type": "integer", "nullable": true, "description": "Number of color variants available." } } }, "description": "Wayfair products matching the search." }, "total_pages": { "type": "integer", "nullable": true, "description": "Total number of pages available for this search." }, "current_page": { "type": "integer", "nullable": true, "description": "Current page number returned." }, "sort_options": { "type": "array", "items": { "type": "object", "required": [ "value", "name" ], "properties": { "name": { "type": "string", "description": "Display name of the sort option." }, "value": { "type": "integer", "description": "Wayfair internal sort option value." } } }, "nullable": true, "description": "Available sort options for this search, as Wayfair reports them." }, "total_results": { "type": "integer", "nullable": true, "description": "Approximate total number of products matching the search." }, "items_per_page": { "type": "integer", "nullable": true, "description": "Number of products returned per page." } } }, "status": { "type": "string", "description": "The status of the API response." }, "parameters": { "type": "object", "properties": { "page": { "type": "integer", "description": "Page number for pagination as received." }, "query": { "type": "string", "nullable": true, "description": "The search query as received." }, "sort_by": { "type": "string", "description": "Sort order as received. Values: recommended, customer_rating, price_low_to_high, price_high_to_low." }, "items_per_page": { "type": "integer", "description": "Number of products requested per page. Values: 24, 48, 96." } }, "description": "The parameters the API received and used for this request, echoed back." }, "request_id": { "type": "string", "description": "A unique ID to trace the API request." } } } } }, "description": "Successful response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "query", "schema": { "type": "string" }, "example": "sofa", "required": true, "description": "Search query (keyword search). Either `query` or `manufacturer_id` is required.\n\n**Examples:**\n`sofa`\n`standing desk`\n`outdoor patio furniture`" }, { "in": "query", "name": "manufacturer_id", "schema": { "type": "string" }, "description": "Wayfair manufacturer/brand ID for browsing all products by a specific brand. Either `query` or `manufacturer_id` is required.\n\nYou can find manufacturer IDs in the product URLs on Wayfair (e.g., wayfair.com/brand/bnd/ninja-b**21377**.html)." }, { "in": "query", "name": "page", "schema": { "type": "integer", "default": 1 }, "description": "Page number for pagination.\n\n**Allowed values:** `1` and above." }, { "in": "query", "name": "items_per_page", "schema": { "enum": [ "24", "48", "96" ], "type": "string", "default": "48" }, "description": "Number of products to return per page.\n\n**Allowed values:** `24`, `48`, `96`" }, { "in": "query", "name": "sort_by", "schema": { "enum": [ "recommended", "customer_rating", "price_low_to_high", "price_high_to_low" ], "type": "string", "default": "recommended" }, "description": "Sort order for the results." }, { "in": "query", "name": "category_id", "schema": { "type": "string" }, "description": "Wayfair category ID to filter results within a specific category. Used with `manufacturer_id` to browse brand products in a category." }, { "in": "query", "name": "min_price", "schema": { "type": "number" }, "description": "Only return products with a price greater than or equal to this value (in USD)." }, { "in": "query", "name": "max_price", "schema": { "type": "number" }, "description": "Only return products with a price less than or equal to this value (in USD)." }, { "in": "query", "name": "color", "schema": { "type": "string" }, "description": "Filter products by color.\n\n**Examples:** `Black`, `White`, `Blue`, `Gray`, `Brown`, `Red`, `Green`, `Beige`, `Gold`, `Silver`, `Multi Colored`" }, { "in": "query", "name": "in_stock", "schema": { "type": "boolean", "default": false }, "description": "Only return products that are currently in stock." }, { "in": "query", "name": "domain", "schema": { "type": "string", "default": "com" }, "description": "Wayfair domain/country for the search.\n\n**Default:** `com`\n\n**Allowed values:** `com, ca, co.uk, ie`\n\n`de` is no longer supported: Wayfair has closed wayfair.de." } ], "description": "Search for Wayfair products by keyword or browse by brand/manufacturer. Supports pagination, sorting, and filters.", "operationId": "realtime_wayfair_data__Search", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_5-N-bD-w4FEvDbPufA7rY", "authority": "supplemental", "conflicts": [ "/summary", "/description", "/operationId" ], "revisionId": "sdrn_JMX_MdcNKNvBSfEXsR78v" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_D1eKbJ9D0SJoHD3LLOLYI", "authority": "supplemental", "conflicts": [ "/summary", "/description", "/operationId" ], "revisionId": "sdrn_WiAI6D9DA33xLudF2TJIh" } ], "x-zeroclick-services": [ "real-time-wayfair-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "real-time-wayfair-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "real-time-wayfair-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-web-search/ai-mode": { "get": { "summary": "AI Mode", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "request_id", "parameters", "data" ], "properties": { "data": { "type": "object", "required": [ "reply_parts", "reference_links" ], "properties": { "reply_parts": { "type": "array", "items": { "type": "object", "required": [ "type" ], "properties": { "list": { "type": "array", "items": { "type": "object", "properties": { "text": { "type": "string", "description": "Item body text." }, "title": { "type": "string", "nullable": true, "description": "Bold label preceding the item text, when present." } } }, "nullable": true, "description": "Items of a list fragment." }, "text": { "type": "string", "nullable": true, "description": "Text content of paragraph/heading fragments." }, "type": { "type": "string", "description": "Fragment kind. Values: paragraph, heading, list, images." }, "images": { "type": "array", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "description": "Image URL." }, "label": { "type": "string", "nullable": true, "description": "Image alt text / caption." }, "width": { "type": "integer", "nullable": true, "description": "Image width in pixels." }, "height": { "type": "integer", "nullable": true, "description": "Image height in pixels." } } }, "nullable": true, "description": "Images carried by an images fragment." }, "ordered": { "type": "boolean", "nullable": true, "description": "Whether a list fragment is ordered (numbered)." } } }, "description": "Sequenced fragments composing the AI Mode reply (paragraphs, headings, lists, images)." }, "session_token": { "type": "string", "nullable": true, "description": "Token to pass back as session_token on a follow-up request to continue this conversation. Null when the upstream did not surface one." }, "reference_links": { "type": "array", "items": { "type": "object", "required": [ "title", "link" ], "properties": { "date": { "type": "string", "nullable": true, "description": "Publication date of the cited page, when present." }, "link": { "type": "string", "description": "URL of the cited page." }, "title": { "type": "string", "description": "Title of the cited page." }, "source": { "type": "string", "nullable": true, "description": "Publisher / source label." }, "favicon": { "type": "string", "nullable": true, "description": "Favicon URL of the cited page." }, "snippet": { "type": "string", "nullable": true, "description": "Short excerpt of the cited page." } } }, "description": "Citation links referenced by the AI Mode reply." } } }, "status": { "type": "string", "description": "The status of the API response." }, "parameters": { "type": "object", "properties": { "gl": { "type": "string", "description": "ISO 3166-1 alpha-2 country code used for the search." }, "hl": { "type": "string", "description": "ISO 639 language code used for the search." }, "tbs": { "type": "string", "nullable": true, "description": "Advanced Google search parameter (tbs) as received (only when explicitly passed)." }, "uule": { "type": "string", "nullable": true, "description": "Google uule location string as received (only when explicitly passed)." }, "prompt": { "type": "string", "description": "The AI Mode prompt as received." }, "location": { "type": "string", "nullable": true, "description": "Search origin location as received (only when explicitly passed)." }, "session_token": { "type": "string", "nullable": true, "description": "Session token as received (only when explicitly passed to continue a conversation)." } }, "description": "The parameters the API received and used for this request, echoed back." }, "request_id": { "type": "string", "description": "A unique ID to trace the API request." } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "prompt", "schema": { "type": "string", "example": "How to make a pizza step by step?", "description": "AI Mode prompt." }, "example": "How to make a pizza step by step?", "required": true }, { "in": "query", "name": "session_token", "schema": { "type": "string", "description": "Specify a session token from previous AI Mode response to continue the chat from the same point (preserving history in context for continuous conversation)." } }, { "in": "query", "name": "location", "schema": { "type": "string" }, "description": "Where the AI Mode search originates from, for location-dependent prompts such as local businesses, weather or events. Recommended to specify at city level to simulate a real user's search (e.g. London, England, United Kingdom). See https://openwebninja.s3.us-east-1.amazonaws.com/locations.json for the list of supported locations. Cannot be combined with uule." }, { "in": "query", "name": "uule", "schema": { "type": "string" }, "description": "Google's own encoded location string (e.g. w+CAIQICIgU2VhdHRsZSxXYXNoaW5ndG9uLFVuaXRlZCBTdGF0ZXM=), passed to Google as is. Use it instead of location when you already generate uule values. Cannot be combined with location." }, { "in": "query", "name": "gl", "schema": { "type": "string", "default": "us", "description": "The country / region for which to make the query. 2-letter country code, see ISO 3166-1 alpha-2." } }, { "in": "query", "name": "hl", "schema": { "type": "string", "default": "en", "description": "The language to use for the search (Google's hl parameter). 2-letter country code, see ISO 639-1 alpha-2." } }, { "in": "query", "name": "attachments", "schema": { "type": "string" }, "description": "Optional JSON array of document URLs (PDF) to attach to the prompt, passed as a string, e.g. [\"https://example.com/file.pdf\"]. Up to 5 files, 10 MB each. Images are not supported. Attaching one or more documents is charged a flat 1 extra request credit. For multiple or long URLs use the POST method (no URL length limit)." } ], "description": "Send a prompt/query and get structured results and reference links from Google's AI Mode.", "operationId": "realtime_web_search__ai_mode", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing parameter definitions", "Missing response schema" ], "pages": [], "sourceId": "sds_0prF_Y5BkmqQXtEQyheXN", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_Z5rvTt1qYfVU6DSLLxPnI" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds_5fumgq7Dew7p7p505C6Vj", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_UDnMGDO2AU7l2pD7FR4rR" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_D1eKbJ9D0SJoHD3LLOLYI", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_WiAI6D9DA33xLudF2TJIh" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_FK2maa1cDe4qcElj5U3zU", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_gZ-rMsS0AnYbgxe2iW2Nm" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds_MAxJPNBPJFwSKQLj1M1dr", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_QFW9HQumx231aOJCusPx0" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_soxpzUWt2CLoTKLGBZfNb", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_3H-1br_3SJ3ASZfGOL5Yr" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_vdxxiVsx4OKV5vH7hrhwb", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_46RDkwnCaOF5IxAFfXTW0" } ], "x-zeroclick-services": [ "realtime-web-search" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-web-search", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-web-search", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] }, "post": { "summary": "AI Mode (POST)", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "request_id", "parameters", "data" ], "properties": { "data": { "type": "object", "required": [ "reply_parts", "reference_links" ], "properties": { "reply_parts": { "type": "array", "items": { "type": "object", "required": [ "type" ], "properties": { "list": { "type": "array", "items": { "type": "object", "properties": { "text": { "type": "string", "description": "Item body text." }, "title": { "type": "string", "nullable": true, "description": "Bold label preceding the item text, when present." } } }, "nullable": true, "description": "Items of a list fragment." }, "text": { "type": "string", "nullable": true, "description": "Text content of paragraph/heading fragments." }, "type": { "type": "string", "description": "Fragment kind. Values: paragraph, heading, list, images." }, "images": { "type": "array", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "description": "Image URL." }, "label": { "type": "string", "nullable": true, "description": "Image alt text / caption." }, "width": { "type": "integer", "nullable": true, "description": "Image width in pixels." }, "height": { "type": "integer", "nullable": true, "description": "Image height in pixels." } } }, "nullable": true, "description": "Images carried by an images fragment." }, "ordered": { "type": "boolean", "nullable": true, "description": "Whether a list fragment is ordered (numbered)." } } }, "description": "Sequenced fragments composing the AI Mode reply (paragraphs, headings, lists, images)." }, "session_token": { "type": "string", "nullable": true, "description": "Token to pass back as session_token on a follow-up request to continue this conversation. Null when the upstream did not surface one." }, "reference_links": { "type": "array", "items": { "type": "object", "required": [ "title", "link" ], "properties": { "date": { "type": "string", "nullable": true, "description": "Publication date of the cited page, when present." }, "link": { "type": "string", "description": "URL of the cited page." }, "title": { "type": "string", "description": "Title of the cited page." }, "source": { "type": "string", "nullable": true, "description": "Publisher / source label." }, "favicon": { "type": "string", "nullable": true, "description": "Favicon URL of the cited page." }, "snippet": { "type": "string", "nullable": true, "description": "Short excerpt of the cited page." } } }, "description": "Citation links referenced by the AI Mode reply." } } }, "status": { "type": "string", "description": "The status of the API response." }, "parameters": { "type": "object", "properties": { "gl": { "type": "string", "description": "ISO 3166-1 alpha-2 country code used for the search." }, "hl": { "type": "string", "description": "ISO 639 language code used for the search." }, "tbs": { "type": "string", "nullable": true, "description": "Advanced Google search parameter (tbs) as received (only when explicitly passed)." }, "uule": { "type": "string", "nullable": true, "description": "Google uule location string as received (only when explicitly passed)." }, "prompt": { "type": "string", "description": "The AI Mode prompt as received." }, "location": { "type": "string", "nullable": true, "description": "Search origin location as received (only when explicitly passed)." }, "session_token": { "type": "string", "nullable": true, "description": "Session token as received (only when explicitly passed to continue a conversation)." } }, "description": "The parameters the API received and used for this request, echoed back." }, "request_id": { "type": "string", "description": "A unique ID to trace the API request." } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "description": "Send a prompt/query and get structured results and reference links from Google's AI Mode. POST variant of the AI Mode endpoint - accepts the same parameters in a JSON request body, with no URL length limit (recommended for long prompts).", "operationId": "realtime_web_search__ai_mode_post", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "prompt" ], "properties": { "gl": { "type": "string", "default": "us", "example": "us", "description": "The country / region for which to make the query. 2-letter country code, see ISO 3166-1 alpha-2." }, "hl": { "type": "string", "default": "en", "example": "en", "description": "The language to use for the search (Google's hl parameter). 2-letter country code, see ISO 639-1 alpha-2." }, "tbs": { "type": "string", "nullable": true, "description": "This parameter defines advanced search parameters that aren't available using regular query parameters (to be searched)." }, "uule": { "type": "string", "nullable": true, "description": "Google's own encoded location string (e.g. w+CAIQICIgU2VhdHRsZSxXYXNoaW5ndG9uLFVuaXRlZCBTdGF0ZXM=), passed to Google as is. Use it instead of location when you already generate uule values. Cannot be combined with location." }, "query": { "type": "string", "description": "The search query." }, "prompt": { "type": "string", "example": "How to make a pizza step by step?", "description": "AI Mode prompt." }, "location": { "type": "string", "nullable": true, "description": "Where the AI Mode search originates from, for location-dependent prompts such as local businesses, weather or events. Recommended to specify at city level to simulate a real user's search (e.g. London, England, United Kingdom). See https://openwebninja.s3.us-east-1.amazonaws.com/locations.json for the list of supported locations. Cannot be combined with uule." }, "attachments": { "type": "array", "items": { "type": "string" }, "example": [ "https://pdfobject.com/pdf/sample.pdf" ], "nullable": true, "description": "Optional list of document URLs (PDF) to attach to the prompt, as plain URL strings. Up to 5 files, 10 MB each. Images are not supported. Attaching one or more documents is charged a flat 1 extra request credit." }, "session_token": { "type": "string", "nullable": true, "description": "Specify a session token from previous AI Mode response to continue the chat from the same point (preserving history in context for continuous conversation)." } } }, "example": { "gl": "us", "hl": "en", "tbs": null, "uule": null, "prompt": "Summarize the attached document and give its title.", "location": null, "attachments": [ "https://pdfobject.com/pdf/sample.pdf" ], "session_token": null } } }, "required": true }, "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing detailed request/response schema definitions in documentation." ], "pages": [ 1 ], "sourceId": "sds__1fiQu9RHG0jaOVImz_2s", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/required" ], "revisionId": "sdrn_fMzoiFNl9X0S__Sj10MeV" }, { "gaps": [ "Missing request body schema and parameters" ], "pages": [], "sourceId": "sds_-esx5FCC4ULWvRHgqpp1v", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_jYKdoWAEl7S8gKTR2MMVP" }, { "gaps": [ "Missing request body schema and parameters" ], "pages": [ 1 ], "sourceId": "sds_-LRkHZTW3kkFz3P0VCP9x", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_IFNtzsGFVdRfOmGNpEt-c" }, { "gaps": [ "Missing explicit request body schema details in documentation" ], "pages": [], "sourceId": "sds_1_LX_FbWCA7U09K5zzV8z", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/required" ], "revisionId": "sdrn_1Y4Iq_rRp239QLf6anxmA" }, { "gaps": [ "Missing request body schema", "Missing parameters" ], "pages": [], "sourceId": "sds_2mkzMPjBdeReAr1HmDREz", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_c-7MmamthDbtIrwRq96jn" }, { "gaps": [ "Missing explicit schema details in documentation; inferred from standard API patterns." ], "pages": [], "sourceId": "sds_5-N-bD-w4FEvDbPufA7rY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/required" ], "revisionId": "sdrn_JMX_MdcNKNvBSfEXsR78v" }, { "gaps": [ "Missing request body schema", "Missing parameter definitions" ], "pages": [ 1 ], "sourceId": "sds_5fumgq7Dew7p7p505C6Vj", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_UDnMGDO2AU7l2pD7FR4rR" }, { "gaps": [ "Missing request body schema", "Missing parameters" ], "pages": [], "sourceId": "sds_955t3d9uA70qPIwKC9kkP", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_fAv2s8zxL0Eg2O0xmQwzI" }, { "gaps": [ "Missing explicit request body schema details in documentation", "Missing authentication scheme details" ], "pages": [], "sourceId": "sds_AF8bRESy69frdnjtCAF2z", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/required" ], "revisionId": "sdrn_nUAt1Ad8MTY5qaVlNUqO9" }, { "gaps": [ "Missing request body schema", "Missing parameter definitions" ], "pages": [ 1 ], "sourceId": "sds_AtF5v_vXxTbq1wWfTbZ8p", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_xtbL3_JhQnAYS_6AQGDiQ" }, { "gaps": [ "Missing explicit request body schema details in documentation", "Missing response schema details" ], "pages": [], "sourceId": "sds_bygUmn2K86zcEr8uYnytH", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/required" ], "revisionId": "sdrn_lRwIurwEjFC6EgANnKCbC" }, { "gaps": [ "Missing detailed request/response schema definitions in documentation." ], "pages": [], "sourceId": "sds_D1eKbJ9D0SJoHD3LLOLYI", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/required" ], "revisionId": "sdrn_WiAI6D9DA33xLudF2TJIh" }, { "gaps": [ "Missing explicit request body schema details in documentation", "Missing response schema details" ], "pages": [], "sourceId": "sds_FK2maa1cDe4qcElj5U3zU", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/required" ], "revisionId": "sdrn_gZ-rMsS0AnYbgxe2iW2Nm" }, { "gaps": [ "Missing explicit request body schema details in documentation" ], "pages": [], "sourceId": "sds_fZv-ITvZDV87-KqyW2hgn", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/required" ], "revisionId": "sdrn_aohUeFTorAhUkoXJ0nrWa" }, { "gaps": [ "Missing detailed request/response schema properties beyond query" ], "pages": [ 1 ], "sourceId": "sds_jRl0O0t2JNWjX4MjQ_kC5", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/required" ], "revisionId": "sdrn_0KHmU6zKJBn3JfGQhhbYP" }, { "gaps": [ "Missing explicit request body schema details in documentation", "Missing response schema details" ], "pages": [], "sourceId": "sds_kNNDQzbHD8UafUY8VU2At", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/required" ], "revisionId": "sdrn_CFRFpZthk-T-EyPrsqzIj" }, { "gaps": [ "Missing request body schema", "Missing parameters" ], "pages": [ 1 ], "sourceId": "sds_MagzpRZ5Tm9d-vEaBKRmn", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_pej_Kh1VLu4d3ByQ4BdIs" }, { "gaps": [ "Missing request body schema and parameters" ], "pages": [], "sourceId": "sds_MAxJPNBPJFwSKQLj1M1dr", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_QFW9HQumx231aOJCusPx0" }, { "gaps": [ "Missing request body schema", "Missing parameters" ], "pages": [], "sourceId": "sds_MeUfdaSf30qGBbwR2_Van", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_DgUH3wi-28BNw0nONekhu" }, { "gaps": [ "Missing request body schema", "Missing parameter definitions" ], "pages": [ 1 ], "sourceId": "sds_MV8gWtP36-RZn0HelHkbq", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_zsd2yxhBG769IpVFIUWRc" }, { "gaps": [ "Missing explicit request body schema details in documentation" ], "pages": [], "sourceId": "sds_oztKPm-kDl07iy0vwLc60", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/required" ], "revisionId": "sdrn_VLRawu6tyKfr0AhBGOcro" }, { "gaps": [ "Missing detailed parameter definitions and response schema." ], "pages": [], "sourceId": "sds_pt9NurvrIG0m5qHbodTXY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/required" ], "revisionId": "sdrn_B6aXroJb6q7sAixORNC4V" }, { "gaps": [ "Missing requestBody schema", "Missing parameters" ], "pages": [ 1 ], "sourceId": "sds_QdbGBVHpS4DPABRrX92IS", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_mU_O3DmPCywqfjxJZfC0a" }, { "gaps": [ "Missing explicit parameter definitions in documentation" ], "pages": [], "sourceId": "sds_ROjpin-1soeCivIbZLub5", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/required" ], "revisionId": "sdrn_WrJX2U_i26_CRY3Hi0cz4" }, { "gaps": [ "Missing request body schema, parameters, and authentication details." ], "pages": [ 1 ], "sourceId": "sds_sfehAR974K7XnlJ2wifV_", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description" ], "revisionId": "sdrn_XNjJhPs6At3Kc74UpKt27" }, { "gaps": [ "Missing request body schema", "Missing parameter definitions" ], "pages": [ 1 ], "sourceId": "sds_soxpzUWt2CLoTKLGBZfNb", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_3H-1br_3SJ3ASZfGOL5Yr" }, { "gaps": [ "Missing explicit request body schema details in documentation" ], "pages": [], "sourceId": "sds_SWPCFBdhQTXC3OrJ98RML", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/required" ], "revisionId": "sdrn_bk6BUY0JsF4ImDRAT3nR8" }, { "gaps": [ "Missing request body schema and parameters" ], "pages": [ 1 ], "sourceId": "sds_UpX4G0QiFQ_cIhdwzu8pk", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_eR8hqN-7MniZX5AeOeQLh" }, { "gaps": [ "Missing explicit request body schema details in documentation", "Missing response schema details" ], "pages": [], "sourceId": "sds_uqg4RBYIA1YERc8Rjc_2c", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/required" ], "revisionId": "sdrn_cPgV56wkqJydCcYz3mJU2" }, { "gaps": [ "Missing detailed request/response schema definitions in documentation." ], "pages": [], "sourceId": "sds_vaNNaw5q29aKLh-qRSfR0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/required" ], "revisionId": "sdrn_SrJ_OL_N_pZ70W8niC6g0" }, { "gaps": [ "Missing request body schema", "Missing parameter definitions" ], "pages": [ 1 ], "sourceId": "sds_wvqPOTBJ3ELhy96dsub_l", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_f7m9IOfd1EwYpLs8JZOMM" }, { "gaps": [ "Missing detailed request/response schema properties beyond query" ], "pages": [ 1 ], "sourceId": "sds_y_pAgcC-xJrVMI2TjrXI0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/required" ], "revisionId": "sdrn_58jSAkKvEcC3bWRtd9F4t" }, { "gaps": [ "Missing explicit request body schema details in documentation" ], "pages": [], "sourceId": "sds_YxKB40zPRwtilOdTUDmjR", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/required" ], "revisionId": "sdrn_4Vk_45589KUwJSyCPBwKV" }, { "gaps": [ "Missing explicit request body schema details in documentation page." ], "pages": [], "sourceId": "sds_ZS-xdAQ0s8auc1LcI7Ooo", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/required" ], "revisionId": "sdrn_7knEBvR-UUuEvVL1C_QLq" } ], "x-zeroclick-services": [ "realtime-web-search" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-web-search", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-web-search", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-web-search/people-also-ask": { "get": { "summary": "People Also Ask", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "request_id", "parameters", "data" ], "properties": { "data": { "type": "object", "required": [ "people_also_ask" ], "properties": { "people_also_ask": { "type": "array", "items": { "type": "object", "required": [ "question" ], "properties": { "answer": { "type": "string", "nullable": true, "description": "Plain-text answer extracted for the question. Only present when fetch_answers=true and Google returned an answer body; null when no answer could be extracted." }, "source": { "type": "object", "nullable": true, "properties": { "url": { "type": "string", "description": "URL of the source page." }, "title": { "type": "string", "nullable": true, "description": "Title of the source page, when available." }, "domain": { "type": "string", "nullable": true, "description": "Domain of the source page." } }, "description": "Source page for the answer. Only present when fetch_answers=true and a source link was found." }, "question": { "type": "string", "description": "The question text Google shows in the People Also Ask block." } } }, "description": "People Also Ask questions surfaced for the query (empty array when none)." } } }, "status": { "type": "string", "description": "The status of the API response." }, "parameters": { "type": "object", "properties": { "q": { "type": "string", "description": "The search query as received." }, "gl": { "type": "string", "description": "ISO 3166-1 alpha-2 country code used for the search." }, "hl": { "type": "string", "description": "ISO 639 language code used for the search." }, "location": { "type": "string", "nullable": true, "description": "Search origin location as received (only when explicitly passed)." }, "fetch_answers": { "type": "boolean", "description": "Whether answers + sources were requested for this call." } }, "description": "The parameters the API received and used for this request, echoed back." }, "request_id": { "type": "string", "description": "A unique ID to trace the API request." } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "q", "schema": { "type": "string", "example": "apple inc", "description": "Search query for which to fetch the People Also Ask block." }, "example": "apple inc", "required": true }, { "in": "query", "name": "gl", "schema": { "type": "string", "default": "us", "description": "The country / region for which to make the query. 2-letter country code, see ISO 3166-1 alpha-2." } }, { "in": "query", "name": "hl", "schema": { "type": "string", "default": "en", "description": "The language to use for the search (Google's hl parameter). 2-letter language code, see ISO 639-1 alpha-2." } }, { "in": "query", "name": "location", "schema": { "type": "string", "description": "Where the search originates from. Recommended to specify at city level to simulate a real user's search (e.g. London, England, United Kingdom)." } }, { "in": "query", "name": "fetch_answers", "schema": { "enum": [ "true", "false", "0", "1" ], "type": "string", "default": "true", "description": "Whether to fetch the answer body and source for each question (true by default). \n\n When true or 1, each item includes `answer` and `source` (and the call consumes 3 credits when at least one question is found). When false or 0, items contain only `question` and the call consumes 2 credits." } } ], "description": "Get the People Also Ask block for a Google search query, optionally with the answer body and source link for each question. \n\n Each call consumes 2 request credits, or 3 credits when `fetch_answers=true` AND the query returns at least one question.", "operationId": "realtime_web_search__people_also_ask", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing parameter definitions", "Missing response schema" ], "pages": [], "sourceId": "sds_0prF_Y5BkmqQXtEQyheXN", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_Z5rvTt1qYfVU6DSLLxPnI" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds_5fumgq7Dew7p7p505C6Vj", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_UDnMGDO2AU7l2pD7FR4rR" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_D1eKbJ9D0SJoHD3LLOLYI", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_WiAI6D9DA33xLudF2TJIh" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_FK2maa1cDe4qcElj5U3zU", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_gZ-rMsS0AnYbgxe2iW2Nm" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds_MAxJPNBPJFwSKQLj1M1dr", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_QFW9HQumx231aOJCusPx0" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_soxpzUWt2CLoTKLGBZfNb", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_3H-1br_3SJ3ASZfGOL5Yr" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_vdxxiVsx4OKV5vH7hrhwb", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_46RDkwnCaOF5IxAFfXTW0" } ], "x-zeroclick-services": [ "realtime-web-search" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-web-search", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-web-search", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-web-search/search": { "get": { "summary": "Search", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "request_id", "parameters", "data" ], "properties": { "data": { "type": "object", "required": [ "organic_results", "has_ai_overviews" ], "properties": { "ai_overviews": { "type": "object", "nullable": true, "properties": { "text_parts": { "type": "array", "items": { "type": "object", "required": [ "type" ], "properties": { "list": { "type": "array", "items": { "type": "object", "properties": { "text": { "type": "string", "description": "Item body text." }, "title": { "type": "string", "nullable": true, "description": "Bold label preceding the item text, when present." } } }, "nullable": true, "description": "Items of a list fragment." }, "text": { "type": "string", "nullable": true, "description": "Text content of paragraph/heading fragments." }, "type": { "type": "string", "description": "Fragment kind. Values: paragraph, heading, list." }, "ordered": { "type": "boolean", "nullable": true, "description": "Whether a list fragment is ordered (numbered)." } } }, "description": "Sequenced fragments composing the AI Overview body (paragraphs, headings, lists, images)." }, "reference_links": { "type": "array", "items": { "type": "object", "required": [ "title", "link" ], "properties": { "date": { "type": "string", "nullable": true, "description": "Publication date of the cited page, when present." }, "link": { "type": "string", "description": "URL of the cited page." }, "title": { "type": "string", "description": "Title of the cited page." }, "source": { "type": "string", "nullable": true, "description": "Publisher / source label." }, "snippet": { "type": "string", "nullable": true, "description": "Short excerpt of the cited page." } } }, "description": "Citation links referenced by the AI Overview." } }, "description": "Google's AI Overview block (only present when fetch_ai_overviews=true and AI Overviews are available)." }, "organic_results": { "type": "array", "items": { "type": "object", "required": [ "title", "url", "position", "rank" ], "properties": { "url": { "type": "string", "description": "Canonical URL of the result." }, "date": { "type": "string", "nullable": true, "description": "Date associated with the result, when Google surfaces one." }, "rank": { "type": "integer", "description": "Absolute rank across all pages returned (1-based)." }, "title": { "type": "string", "description": "Title of the search result." }, "domain": { "type": "string", "nullable": true, "description": "Domain extracted from the result URL." }, "source": { "type": "string", "nullable": true, "description": "Source / publisher label Google shows next to the result." }, "snippet": { "type": "string", "nullable": true, "description": "Short text snippet shown by Google under the result." }, "position": { "type": "integer", "description": "Position of the result within the page (1-based)." }, "top_answer": { "type": "string", "nullable": true, "description": "Highlighted top answer when the result is a Q&A page." }, "rich_snippet": { "type": "object", "nullable": true, "properties": { "price": { "type": "string", "nullable": true, "description": "Displayed price of the item, including the currency symbol as shown by Google." }, "rating": { "type": "number", "nullable": true, "description": "Average customer rating of the item." }, "reviews": { "type": "string", "nullable": true, "description": "Number of customer reviews as displayed by Google, which may be abbreviated (for example 1.2k)." }, "delivery": { "type": "string", "nullable": true, "description": "Delivery or shipping information as displayed by Google." }, "rating_max": { "type": "integer", "nullable": true, "description": "Highest value on the rating scale. Returned only when Google exposes the scale." }, "availability": { "type": "string", "nullable": true, "description": "Stock status of the item as displayed by Google." } }, "description": "Rich result data Google displays for product and listing results. Present only when the result carries such data, and each field appears only when Google displays it." }, "answers_count": { "type": "string", "nullable": true, "description": "Count of answers shown for Q&A-style results (e.g. Reddit, Quora)." }, "displayed_link": { "type": "string", "nullable": true, "description": "Breadcrumb-style URL Google displays under the title." } } }, "description": "Organic web search results." }, "has_ai_overviews": { "type": "boolean", "description": "Whether AI Overviews are present in the response. Only true when fetch_ai_overviews=true and AI Overviews are available." }, "total_organic_results": { "type": "integer", "nullable": true, "description": "Approximate total number of organic results Google reports for the query." } } }, "status": { "type": "string", "description": "The status of the API response." }, "parameters": { "type": "object", "properties": { "q": { "type": "string", "description": "The search query as received." }, "gl": { "type": "string", "description": "ISO 3166-1 alpha-2 country code used for the search." }, "hl": { "type": "string", "description": "ISO 639 language code used for the search." }, "lr": { "type": "string", "nullable": true, "description": "Language restriction filter as received (only when explicitly passed)." }, "nhr": { "type": "string", "description": "People-also-ask filter as received. Values: 0 (include), 1 (exclude)." }, "num": { "type": "integer", "description": "Maximum number of organic results requested." }, "tbs": { "type": "string", "nullable": true, "description": "Advanced Google search parameter (tbs) as received (only when explicitly passed)." }, "nfpr": { "type": "string", "description": "Auto-corrected query filter as received. Values: 0 (include), 1 (exclude)." }, "uule": { "type": "string", "nullable": true, "description": "Google uule location string as received (only when explicitly passed)." }, "start": { "type": "integer", "description": "Pagination offset as received (number of results skipped)." }, "device": { "type": "string", "description": "Device simulated for the search as received. Values: desktop (default), mobile, tablet." }, "location": { "type": "string", "nullable": true, "description": "Search origin location as received (only when explicitly passed)." }, "deduplicate": { "type": "boolean", "description": "Whether deduplication by URL was requested." }, "fetch_ai_overviews": { "type": "boolean", "description": "Whether AI Overviews fetching was requested for this call." }, "return_organic_result_video_thumbnail": { "type": "boolean", "description": "Whether base64 video thumbnails were requested for organic video results." } }, "description": "The parameters the API received and used for this request, echoed back." }, "request_id": { "type": "string", "description": "A unique ID to trace the API request." } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "q", "schema": { "type": "string", "example": "how to build a website", "description": "Search query. \n Supports all Google Advanced Search operators (site:, inurl:, intitle:, etc)." }, "example": "how to build a website", "required": true, "description": "Search query" }, { "in": "query", "name": "fetch_ai_overviews", "schema": { "type": "boolean", "description": "Whether to return AI Overviews if available (false by default). \n In case true or 1, AI Overviews will be pulled as well and in case available, the request will consume two request credits from the quota." } }, { "in": "query", "name": "num", "schema": { "type": "integer", "default": 10, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return. Please note that a request credit will be consumed from the quota for each results page (10 results)." } }, { "in": "query", "name": "start", "schema": { "type": "integer", "default": 0, "description": "Number of results to skip (for pagination)." } }, { "in": "query", "name": "gl", "schema": { "type": "string", "default": "us", "description": "The country / region for which to make the query. Allowed values: 2-letter country code, see ISO 3166-1 alpha-2." } }, { "in": "query", "name": "hl", "schema": { "type": "string", "default": "en", "description": "The language to use for the search (Google's hl parameter). Allowed values: 2-letter country code, see ISO 639-1 alpha-2." } }, { "in": "query", "name": "tbs", "schema": { "type": "string", "description": "This parameter defines advanced search parameters that aren't available using regular query parameters (to be searched)." } }, { "in": "query", "name": "location", "schema": { "type": "string", "description": "Where you want the search to originate from. \n It is recommended to specify location at the city level in order to simulate a real user’s search (e.g. London, England, United Kingdom)." } }, { "in": "query", "name": "uule", "schema": { "type": "string" }, "description": "Google's own encoded location string (e.g. w+CAIQICIgU2VhdHRsZSxXYXNoaW5ndG9uLFVuaXRlZCBTdGF0ZXM=), passed to Google as is. Use it instead of location when you already generate uule values. Cannot be combined with location." }, { "in": "query", "name": "device", "schema": { "enum": [ "desktop", "mobile", "tablet" ], "type": "string", "default": "desktop" }, "description": "The device to simulate for the search. Mobile and tablet return Google's mobile SERP layout, whose rankings and features can differ from desktop. Allowed values: desktop (default), mobile, tablet." }, { "in": "query", "name": "nfpr", "schema": { "type": "string", "description": "Exclude results of auto-corrected query when the original query is misspelled with nfpr=1 and include them with nfpr=0 (default)." } }, { "in": "query", "name": "lr", "schema": { "type": "string", "description": "Only return search results in a specific language. \n It uses lang_{two-letter language code} to specify languages and | as a delimiter (e.g. lang_fr|lang_de will only search French and German pages)." } }, { "in": "query", "name": "return_organic_result_video_thumbnail", "schema": { "type": "boolean", "description": "Whether to return the base64 encoded image source for organic video results (false by default). \n In case true or 1, an additional video_thumbnail field will be returned for organic video results containing the base64 encoded image." } }, { "in": "query", "name": "extra_speed", "schema": { "type": "boolean", "description": "Speed up the endpoint by up to 4x of the original speed on a best effort basis (false by default). \n Please note that each call with extra_speed=true will consume 2 requests from the quota . Experimental feature." } } ], "description": "Get real-time organic search results from across the web, AI Overviews, total count, and more. \n Support the Google Search parameters (gl, hl, tbs, etc) and city level geo targeting. \n Supports all Google Advanced Search operators such (e.g. inurl:, site:, intitle:, etc).", "operationId": "realtime_web_search__search", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing parameter details for filters, location, and pagination" ], "pages": [ 1 ], "sourceId": "sds__1fiQu9RHG0jaOVImz_2s", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_fMzoiFNl9X0S__Sj10MeV" }, { "gaps": [ "Missing parameter definitions", "Missing response schema" ], "pages": [], "sourceId": "sds_0prF_Y5BkmqQXtEQyheXN", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_Z5rvTt1qYfVU6DSLLxPnI" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds_5fumgq7Dew7p7p505C6Vj", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_UDnMGDO2AU7l2pD7FR4rR" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_D1eKbJ9D0SJoHD3LLOLYI", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_WiAI6D9DA33xLudF2TJIh" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_FK2maa1cDe4qcElj5U3zU", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_gZ-rMsS0AnYbgxe2iW2Nm" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds_MAxJPNBPJFwSKQLj1M1dr", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_QFW9HQumx231aOJCusPx0" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_soxpzUWt2CLoTKLGBZfNb", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_3H-1br_3SJ3ASZfGOL5Yr" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_vdxxiVsx4OKV5vH7hrhwb", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_46RDkwnCaOF5IxAFfXTW0" } ], "x-zeroclick-services": [ "realtime-web-search" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-web-search", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-web-search", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-web-search/search-full": { "get": { "summary": "Search Full", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "request_id", "parameters", "data" ], "properties": { "data": { "type": "object", "required": [ "organic_results", "has_ai_overviews" ], "properties": { "ads": { "type": "array", "items": { "type": "object" }, "nullable": true, "description": "Sponsored / ad results, when Google surfaces them for this query." }, "places": { "type": "array", "items": { "type": "object" }, "nullable": true, "description": "Local pack / places results, when Google surfaces them for this query." }, "answer_box": { "type": "object", "nullable": true, "properties": { "type": { "type": "string", "description": "Answer box variant. Examples: instant_answer, calculator, definition." }, "answer": { "type": "string", "nullable": true, "description": "Plain-text answer Google displays." } }, "description": "Google answer box (instant answer / calculator / definition), when Google surfaces one." }, "top_stories": { "type": "array", "items": { "type": "object" }, "nullable": true, "description": "Top Stories results, when Google surfaces them for this query." }, "ai_overviews": { "type": "object", "nullable": true, "properties": { "text_parts": { "type": "array", "items": { "type": "object", "required": [ "type" ], "properties": { "list": { "type": "array", "items": { "type": "object", "properties": { "text": { "type": "string", "description": "Item body text." }, "title": { "type": "string", "nullable": true, "description": "Bold label preceding the item text, when present." } } }, "nullable": true, "description": "Items of a list fragment." }, "text": { "type": "string", "nullable": true, "description": "Text content of paragraph/heading fragments." }, "type": { "type": "string", "description": "Fragment kind. Values: paragraph, heading, list." }, "ordered": { "type": "boolean", "nullable": true, "description": "Whether a list fragment is ordered." } } }, "description": "Sequenced fragments composing the AI Overview body (paragraphs, headings, lists, images)." }, "reference_links": { "type": "array", "items": { "type": "object", "required": [ "title", "link" ], "properties": { "date": { "type": "string", "nullable": true, "description": "Publication date of the cited page." }, "link": { "type": "string", "description": "URL of the cited page." }, "title": { "type": "string", "description": "Title of the cited page." }, "source": { "type": "string", "nullable": true, "description": "Publisher / source label." }, "snippet": { "type": "string", "nullable": true, "description": "Short excerpt of the cited page." } } }, "description": "Citation links referenced by the AI Overview." } }, "description": "Google's AI Overview block (only present when fetch_ai_overviews=true and AI Overviews are available)." }, "inline_videos": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string", "description": "Video URL." }, "title": { "type": "string", "description": "Video title with source label." }, "domain": { "type": "string", "nullable": true, "description": "Video host domain." }, "duration": { "type": "string", "nullable": true, "description": "Duration label (e.g. '4:14')." }, "position": { "type": "integer", "description": "Position within the inline videos block." } } }, "nullable": true, "description": "Inline video results." }, "knowledge_graph": { "type": "object", "nullable": true, "properties": { "type": { "type": "string", "nullable": true, "description": "Entity type label (e.g. 'Theoretical physicist')." }, "kgmid": { "type": "string", "nullable": true, "description": "Google Knowledge Graph machine ID." }, "title": { "type": "string", "nullable": true, "description": "Entity title." }, "attributes": { "type": "object", "nullable": true, "description": "Free-form key/value attributes Google surfaces for the entity (e.g. born, died, spouse).", "additionalProperties": { "type": "string" } }, "description": { "type": "string", "nullable": true, "description": "Short description of the entity." } }, "description": "Knowledge Graph entity panel, when Google returns one for this query." }, "organic_results": { "type": "array", "items": { "type": "object", "required": [ "title", "url", "position", "rank" ], "properties": { "url": { "type": "string", "description": "Canonical URL of the result." }, "date": { "type": "string", "nullable": true, "description": "Date associated with the result, when Google surfaces one." }, "rank": { "type": "integer", "description": "Absolute rank across all pages returned (1-based)." }, "title": { "type": "string", "description": "Title of the search result." }, "domain": { "type": "string", "nullable": true, "description": "Domain extracted from the result URL." }, "source": { "type": "string", "nullable": true, "description": "Source / publisher label shown by Google." }, "snippet": { "type": "string", "nullable": true, "description": "Short text snippet shown by Google under the result." }, "position": { "type": "integer", "description": "Position of the result within the page (1-based)." }, "rich_snippet": { "type": "object", "nullable": true, "properties": { "price": { "type": "string", "nullable": true, "description": "Displayed price of the item, including the currency symbol as shown by Google." }, "rating": { "type": "number", "nullable": true, "description": "Average customer rating of the item." }, "reviews": { "type": "string", "nullable": true, "description": "Number of customer reviews as displayed by Google, which may be abbreviated (for example 1.2k)." }, "delivery": { "type": "string", "nullable": true, "description": "Delivery or shipping information as displayed by Google." }, "rating_max": { "type": "integer", "nullable": true, "description": "Highest value on the rating scale. Returned only when Google exposes the scale." }, "availability": { "type": "string", "nullable": true, "description": "Stock status of the item as displayed by Google." } }, "description": "Rich result data Google displays for product and listing results. Present only when the result carries such data, and each field appears only when Google displays it." }, "displayed_link": { "type": "string", "nullable": true, "description": "Breadcrumb-style URL Google displays under the title." }, "video_thumbnail": { "type": "string", "nullable": true, "description": "Base64-encoded thumbnail for organic video results (only when return_organic_result_video_thumbnail=true)." }, "snippet_highlighted_words": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "Substrings Google highlights inside the snippet." } } }, "description": "Organic web search results." }, "has_ai_overviews": { "type": "boolean", "description": "Whether AI Overviews are present in the response. Only true when fetch_ai_overviews=true and AI Overviews are available." }, "related_searches": { "type": "array", "items": { "type": "object", "properties": { "link": { "type": "string", "nullable": true, "description": "Google search URL for the related query." }, "query": { "type": "string", "description": "Related query text." } } }, "nullable": true, "description": "Related search suggestions surfaced by Google." }, "shopping_results": { "type": "array", "items": { "type": "object" }, "nullable": true, "description": "Shopping results, when Google surfaces them for this query." }, "total_organic_results": { "type": "integer", "nullable": true, "description": "Approximate total number of organic results Google reports for the query." }, "discussions_and_forums": { "type": "array", "items": { "type": "object" }, "nullable": true, "description": "Discussions & forums results, when Google surfaces them for this query." } } }, "status": { "type": "string", "description": "The status of the API response." }, "parameters": { "type": "object", "properties": { "q": { "type": "string", "description": "The search query as received." }, "gl": { "type": "string", "description": "ISO 3166-1 alpha-2 country code used for the search." }, "hl": { "type": "string", "description": "ISO 639 language code used for the search." }, "lr": { "type": "string", "nullable": true, "description": "Language restriction filter as received (only when explicitly passed)." }, "nhr": { "type": "string", "description": "People-also-ask filter as received. Values: 0, 1." }, "num": { "type": "integer", "description": "Maximum number of organic results requested." }, "tbs": { "type": "string", "nullable": true, "description": "Advanced Google search parameter (tbs) as received (only when explicitly passed)." }, "nfpr": { "type": "string", "description": "Auto-corrected query filter as received. Values: 0, 1." }, "uule": { "type": "string", "nullable": true, "description": "Google uule location string as received (only when explicitly passed)." }, "start": { "type": "integer", "description": "Pagination offset as received." }, "device": { "type": "string", "description": "Device simulated for the search as received. Values: desktop (default), mobile, tablet." }, "location": { "type": "string", "nullable": true, "description": "Search origin location as received (only when explicitly passed)." }, "deduplicate": { "type": "boolean", "description": "Whether deduplication by URL was requested." }, "fetch_ai_overviews": { "type": "boolean", "description": "Whether AI Overviews fetching was requested for this call." }, "return_organic_result_video_thumbnail": { "type": "boolean", "description": "Whether base64 video thumbnails were requested for organic video results." } }, "description": "The parameters the API received and used for this request, echoed back." }, "request_id": { "type": "string", "description": "A unique ID to trace the API request." } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "q", "schema": { "type": "string", "example": "albert einstein" }, "example": "albert einstein", "required": true, "description": "Search query. Supports all Google Advanced Search operators (site:, inurl:, intitle:, etc)." }, { "in": "query", "name": "gl", "schema": { "type": "string", "default": "us" }, "description": "The country / region for which to make the query. 2-letter country code, see ISO 3166-1 alpha-2." }, { "in": "query", "name": "hl", "schema": { "type": "string", "default": "en" }, "description": "The language to use for the search (Google's hl parameter). 2-letter language code, see ISO 639-1 alpha-2." }, { "in": "query", "name": "tbs", "schema": { "type": "string" }, "description": "Advanced Google search parameters that aren't available using regular query parameters (e.g. qdr:d for the last day, qdr:w for the last week)." }, { "in": "query", "name": "location", "schema": { "type": "string" }, "description": "Where the search originates from. Recommended to specify at city level to simulate a real user's search (e.g. London, England, United Kingdom). See https://openwebninja.s3.us-east-1.amazonaws.com/locations.json for the list of supported locations." }, { "in": "query", "name": "uule", "schema": { "type": "string" }, "description": "Google's own encoded location string (e.g. w+CAIQICIgU2VhdHRsZSxXYXNoaW5ndG9uLFVuaXRlZCBTdGF0ZXM=), passed to Google as is. Use it instead of location when you already generate uule values. Cannot be combined with location." }, { "in": "query", "name": "device", "schema": { "enum": [ "desktop", "mobile", "tablet" ], "type": "string", "default": "desktop" }, "description": "The device to simulate for the search. Mobile and tablet return Google's mobile SERP layout, whose rankings and features can differ from desktop. Allowed values: desktop (default), mobile, tablet." }, { "in": "query", "name": "lr", "schema": { "type": "string" }, "description": "Restrict search results to a specific language. Uses lang_{two-letter language code} with | as delimiter (e.g. lang_fr|lang_de searches French and German pages only)." }, { "in": "query", "name": "nfpr", "schema": { "enum": [ "0", "1" ], "type": "string", "default": "0" }, "description": "Exclude results of the auto-corrected query when the original query is misspelled with nfpr=1, and include them with nfpr=0 (default)." }, { "in": "query", "name": "nhr", "schema": { "enum": [ "0", "1" ], "type": "string", "default": "0" }, "description": "Exclude 'People also ask' style related questions from the results with nhr=1. Include them with nhr=0 (default)." }, { "in": "query", "name": "num", "schema": { "type": "integer", "default": 10, "maximum": 10, "minimum": 1 }, "description": "Maximum number of organic results to return per request (1-10)." }, { "in": "query", "name": "start", "schema": { "type": "integer", "default": 0 }, "description": "Number of results to skip for pagination (default 0)." }, { "in": "query", "name": "fetch_ai_overviews", "schema": { "type": "boolean", "default": false }, "description": "Whether to return AI Overviews when available (false by default). When true or 1, if AI Overviews are available, each request consumes two request credits instead of one." }, { "in": "query", "name": "return_organic_result_video_thumbnail", "schema": { "type": "boolean", "default": false }, "description": "Whether to return a base64-encoded video_thumbnail field for organic video results (false by default)." } ], "description": "Get real-time full-depth web search results via the heavy serp path, including organic results, ads, AI overviews, knowledge graph, places, top stories, inline videos, answer box, and discussions. Supports Google Search parameters (gl, hl, tbs, etc.) and city-level geo targeting. Note: Each request to this endpoint consumes 2 request credits.", "operationId": "realtime_web_search__search_full", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing parameter definitions", "Missing response schema" ], "pages": [], "sourceId": "sds_0prF_Y5BkmqQXtEQyheXN", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_Z5rvTt1qYfVU6DSLLxPnI" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds_5fumgq7Dew7p7p505C6Vj", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_UDnMGDO2AU7l2pD7FR4rR" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_D1eKbJ9D0SJoHD3LLOLYI", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_WiAI6D9DA33xLudF2TJIh" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_FK2maa1cDe4qcElj5U3zU", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_gZ-rMsS0AnYbgxe2iW2Nm" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds_MAxJPNBPJFwSKQLj1M1dr", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_QFW9HQumx231aOJCusPx0" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_soxpzUWt2CLoTKLGBZfNb", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_3H-1br_3SJ3ASZfGOL5Yr" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_vdxxiVsx4OKV5vH7hrhwb", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_46RDkwnCaOF5IxAFfXTW0" } ], "x-zeroclick-services": [ "realtime-web-search" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-web-search", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-web-search", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-web-search/search-light": { "get": { "summary": "Light Search", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "request_id", "data" ], "properties": { "data": { "type": "array", "items": { "type": "object", "required": [ "title", "url", "position" ], "properties": { "url": { "type": "string", "description": "Canonical URL of the result." }, "title": { "type": "string", "description": "Title of the search result." }, "domain": { "type": "string", "nullable": true, "description": "Domain extracted from the result URL." }, "snippet": { "type": "string", "nullable": true, "description": "Short text snippet shown by Google under the result." }, "position": { "type": "integer", "description": "Position of the result in the list (1-based)." } } }, "description": "Organic web search results for the query." }, "status": { "type": "string", "description": "The status of the API response." }, "request_id": { "type": "string", "description": "A unique ID to trace the API request." } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "q", "schema": { "type": "string", "example": "how to build a website", "description": "Search query. \n Supports all Google Advanced Search operators (site:, inurl:, intitle:, etc)." }, "example": "how to build a website", "required": true }, { "in": "query", "name": "limit", "schema": { "type": "string", "default": 10, "maximum": 300, "minimum": 1, "description": "Maximum number of results to return." } } ], "description": "Lightning fast endpoint for getting organic search results from across the web in real-time.\n Supports all Google Advanced Search operators such (e.g. inurl:, site:, intitle:, etc).", "operationId": "realtime_web_search__search_light", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing parameter definitions", "Missing response schema" ], "pages": [], "sourceId": "sds_0prF_Y5BkmqQXtEQyheXN", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_Z5rvTt1qYfVU6DSLLxPnI" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds_5fumgq7Dew7p7p505C6Vj", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_UDnMGDO2AU7l2pD7FR4rR" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_D1eKbJ9D0SJoHD3LLOLYI", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_WiAI6D9DA33xLudF2TJIh" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_FK2maa1cDe4qcElj5U3zU", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_gZ-rMsS0AnYbgxe2iW2Nm" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds_MAxJPNBPJFwSKQLj1M1dr", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_QFW9HQumx231aOJCusPx0" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_soxpzUWt2CLoTKLGBZfNb", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_3H-1br_3SJ3ASZfGOL5Yr" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_vdxxiVsx4OKV5vH7hrhwb", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_46RDkwnCaOF5IxAFfXTW0" } ], "x-zeroclick-services": [ "realtime-web-search" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-web-search", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-web-search", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] }, "post": { "summary": "Light Search (Bulk)", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "request_id", "data" ], "properties": { "data": { "type": "array", "items": { "type": "object", "required": [ "query", "results" ], "properties": { "query": { "type": "string", "description": "The query that produced this result set." }, "results": { "type": "array", "items": { "type": "object", "required": [ "title", "url", "position" ], "properties": { "url": { "type": "string", "description": "Canonical URL of the result." }, "title": { "type": "string", "description": "Title of the search result." }, "domain": { "type": "string", "nullable": true, "description": "Domain extracted from the result URL." }, "snippet": { "type": "string", "nullable": true, "description": "Short text snippet shown by Google under the result." }, "position": { "type": "integer", "description": "Position of the result in the list (1-based)." } } }, "description": "Organic web search results for this query." } } }, "description": "One entry per submitted query, in the order they were processed." }, "status": { "type": "string", "description": "The status of the API response." }, "request_id": { "type": "string", "description": "A unique ID to trace the API request." } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "description": "Perform real-time web searches for up to 100 queries in a single request (each query is counted/charged as a request credit).", "operationId": "realtime_web_search__post__search_light", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "queries" ], "properties": { "gl": { "type": "string", "default": "us", "example": "us", "description": "Geo/region code (lowercased)." }, "hl": { "type": "string", "default": "en", "example": "en", "description": "Language code (lowercased)." }, "limit": { "type": "integer", "default": 10, "example": 10, "maximum": 300, "minimum": 1, "description": "Number of results to return (1–300; capped at 300)." }, "query": { "type": "string", "description": "The search query." }, "queries": { "oneOf": [ { "type": "array", "items": { "type": "string", "maxLength": 5000 }, "example": [ "chatgpt", "build a website" ], "maxItems": 100 } ], "description": "Query or list of queries to search (max 100 items; each trimmed; each ≤ 5000 chars; duplicates removed server-side)." } } }, "example": { "gl": "us", "hl": "en", "limit": 10, "queries": [ "chatgpt", "build a website" ] } } }, "required": true }, "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing detailed request/response schema definitions in documentation." ], "pages": [ 1 ], "sourceId": "sds__1fiQu9RHG0jaOVImz_2s", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/required" ], "revisionId": "sdrn_fMzoiFNl9X0S__Sj10MeV" }, { "gaps": [ "Missing request body schema and parameters" ], "pages": [], "sourceId": "sds_-esx5FCC4ULWvRHgqpp1v", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_jYKdoWAEl7S8gKTR2MMVP" }, { "gaps": [ "Missing request body schema and parameters" ], "pages": [ 1 ], "sourceId": "sds_-LRkHZTW3kkFz3P0VCP9x", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_IFNtzsGFVdRfOmGNpEt-c" }, { "gaps": [ "Missing explicit request body schema details in documentation" ], "pages": [], "sourceId": "sds_1_LX_FbWCA7U09K5zzV8z", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/required" ], "revisionId": "sdrn_1Y4Iq_rRp239QLf6anxmA" }, { "gaps": [ "Missing request body schema", "Missing parameters" ], "pages": [], "sourceId": "sds_2mkzMPjBdeReAr1HmDREz", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_c-7MmamthDbtIrwRq96jn" }, { "gaps": [ "Missing explicit schema details in documentation; inferred from standard API patterns." ], "pages": [], "sourceId": "sds_5-N-bD-w4FEvDbPufA7rY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/required" ], "revisionId": "sdrn_JMX_MdcNKNvBSfEXsR78v" }, { "gaps": [ "Missing request body schema", "Missing parameter definitions" ], "pages": [ 1 ], "sourceId": "sds_5fumgq7Dew7p7p505C6Vj", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_UDnMGDO2AU7l2pD7FR4rR" }, { "gaps": [ "Missing request body schema", "Missing parameters" ], "pages": [], "sourceId": "sds_955t3d9uA70qPIwKC9kkP", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_fAv2s8zxL0Eg2O0xmQwzI" }, { "gaps": [ "Missing explicit request body schema details in documentation", "Missing authentication scheme details" ], "pages": [], "sourceId": "sds_AF8bRESy69frdnjtCAF2z", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/required" ], "revisionId": "sdrn_nUAt1Ad8MTY5qaVlNUqO9" }, { "gaps": [ "Missing request body schema", "Missing parameter definitions" ], "pages": [ 1 ], "sourceId": "sds_AtF5v_vXxTbq1wWfTbZ8p", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_xtbL3_JhQnAYS_6AQGDiQ" }, { "gaps": [ "Missing explicit request body schema details in documentation", "Missing response schema details" ], "pages": [], "sourceId": "sds_bygUmn2K86zcEr8uYnytH", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/required" ], "revisionId": "sdrn_lRwIurwEjFC6EgANnKCbC" }, { "gaps": [ "Missing detailed request/response schema definitions in documentation." ], "pages": [], "sourceId": "sds_D1eKbJ9D0SJoHD3LLOLYI", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/required" ], "revisionId": "sdrn_WiAI6D9DA33xLudF2TJIh" }, { "gaps": [ "Missing explicit request body schema details in documentation", "Missing response schema details" ], "pages": [], "sourceId": "sds_FK2maa1cDe4qcElj5U3zU", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/required" ], "revisionId": "sdrn_gZ-rMsS0AnYbgxe2iW2Nm" }, { "gaps": [ "Missing explicit request body schema details in documentation" ], "pages": [], "sourceId": "sds_fZv-ITvZDV87-KqyW2hgn", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/required" ], "revisionId": "sdrn_aohUeFTorAhUkoXJ0nrWa" }, { "gaps": [ "Missing detailed request/response schema properties beyond query" ], "pages": [ 1 ], "sourceId": "sds_jRl0O0t2JNWjX4MjQ_kC5", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/required" ], "revisionId": "sdrn_0KHmU6zKJBn3JfGQhhbYP" }, { "gaps": [ "Missing explicit request body schema details in documentation", "Missing response schema details" ], "pages": [], "sourceId": "sds_kNNDQzbHD8UafUY8VU2At", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/required" ], "revisionId": "sdrn_CFRFpZthk-T-EyPrsqzIj" }, { "gaps": [ "Missing request body schema", "Missing parameters" ], "pages": [ 1 ], "sourceId": "sds_MagzpRZ5Tm9d-vEaBKRmn", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_pej_Kh1VLu4d3ByQ4BdIs" }, { "gaps": [ "Missing request body schema and parameters" ], "pages": [], "sourceId": "sds_MAxJPNBPJFwSKQLj1M1dr", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_QFW9HQumx231aOJCusPx0" }, { "gaps": [ "Missing request body schema", "Missing parameters" ], "pages": [], "sourceId": "sds_MeUfdaSf30qGBbwR2_Van", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_DgUH3wi-28BNw0nONekhu" }, { "gaps": [ "Missing request body schema", "Missing parameter definitions" ], "pages": [ 1 ], "sourceId": "sds_MV8gWtP36-RZn0HelHkbq", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_zsd2yxhBG769IpVFIUWRc" }, { "gaps": [ "Missing explicit request body schema details in documentation" ], "pages": [], "sourceId": "sds_oztKPm-kDl07iy0vwLc60", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/required" ], "revisionId": "sdrn_VLRawu6tyKfr0AhBGOcro" }, { "gaps": [ "Missing detailed parameter definitions and response schema." ], "pages": [], "sourceId": "sds_pt9NurvrIG0m5qHbodTXY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/required" ], "revisionId": "sdrn_B6aXroJb6q7sAixORNC4V" }, { "gaps": [ "Missing requestBody schema", "Missing parameters" ], "pages": [ 1 ], "sourceId": "sds_QdbGBVHpS4DPABRrX92IS", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_mU_O3DmPCywqfjxJZfC0a" }, { "gaps": [ "Missing explicit parameter definitions in documentation" ], "pages": [], "sourceId": "sds_ROjpin-1soeCivIbZLub5", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/required" ], "revisionId": "sdrn_WrJX2U_i26_CRY3Hi0cz4" }, { "gaps": [ "Missing request body schema, parameters, and authentication details." ], "pages": [ 1 ], "sourceId": "sds_sfehAR974K7XnlJ2wifV_", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description" ], "revisionId": "sdrn_XNjJhPs6At3Kc74UpKt27" }, { "gaps": [ "Missing request body schema", "Missing parameter definitions" ], "pages": [ 1 ], "sourceId": "sds_soxpzUWt2CLoTKLGBZfNb", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_3H-1br_3SJ3ASZfGOL5Yr" }, { "gaps": [ "Missing explicit request body schema details in documentation" ], "pages": [], "sourceId": "sds_SWPCFBdhQTXC3OrJ98RML", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/required" ], "revisionId": "sdrn_bk6BUY0JsF4ImDRAT3nR8" }, { "gaps": [ "Missing request body schema and parameters" ], "pages": [ 1 ], "sourceId": "sds_UpX4G0QiFQ_cIhdwzu8pk", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_eR8hqN-7MniZX5AeOeQLh" }, { "gaps": [ "Missing explicit request body schema details in documentation", "Missing response schema details" ], "pages": [], "sourceId": "sds_uqg4RBYIA1YERc8Rjc_2c", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/required" ], "revisionId": "sdrn_cPgV56wkqJydCcYz3mJU2" }, { "gaps": [ "Missing detailed request/response schema definitions in documentation." ], "pages": [], "sourceId": "sds_vaNNaw5q29aKLh-qRSfR0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/required" ], "revisionId": "sdrn_SrJ_OL_N_pZ70W8niC6g0" }, { "gaps": [ "Missing request body schema", "Missing parameter definitions" ], "pages": [ 1 ], "sourceId": "sds_wvqPOTBJ3ELhy96dsub_l", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_f7m9IOfd1EwYpLs8JZOMM" }, { "gaps": [ "Missing detailed request/response schema properties beyond query" ], "pages": [ 1 ], "sourceId": "sds_y_pAgcC-xJrVMI2TjrXI0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/required" ], "revisionId": "sdrn_58jSAkKvEcC3bWRtd9F4t" }, { "gaps": [ "Missing explicit request body schema details in documentation" ], "pages": [], "sourceId": "sds_YxKB40zPRwtilOdTUDmjR", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/required" ], "revisionId": "sdrn_4Vk_45589KUwJSyCPBwKV" }, { "gaps": [ "Missing explicit request body schema details in documentation page." ], "pages": [], "sourceId": "sds_ZS-xdAQ0s8auc1LcI7Ooo", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/required" ], "revisionId": "sdrn_7knEBvR-UUuEvVL1C_QLq" } ], "x-zeroclick-services": [ "realtime-web-search" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-web-search", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-web-search", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-web-search/v2/ai-mode": { "post": { "summary": "AI Mode", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "request_id", "parameters", "data" ], "properties": { "data": { "type": "object", "required": [ "reply_parts", "reference_links" ], "properties": { "reply_parts": { "type": "array", "items": { "type": "object", "required": [ "type" ], "properties": { "list": { "type": "array", "items": { "type": "object", "properties": { "text": { "type": "string", "description": "Item body text." }, "title": { "type": "string", "nullable": true, "description": "Bold label preceding the item text, when present." } } }, "nullable": true, "description": "Items of a list fragment." }, "text": { "type": "string", "nullable": true, "description": "Text content of paragraph/heading fragments." }, "type": { "type": "string", "description": "Fragment kind. Values: paragraph, heading, list, images." }, "images": { "type": "array", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "description": "Image URL." }, "label": { "type": "string", "nullable": true, "description": "Image alt text / caption." }, "width": { "type": "integer", "nullable": true, "description": "Image width in pixels." }, "height": { "type": "integer", "nullable": true, "description": "Image height in pixels." } } }, "nullable": true, "description": "Images carried by an images fragment." }, "ordered": { "type": "boolean", "nullable": true, "description": "Whether a list fragment is ordered (numbered)." } } }, "description": "Sequenced fragments composing the AI Mode reply (paragraphs, headings, lists, images)." }, "session_token": { "type": "string", "nullable": true, "description": "Token to pass back as session_token on a follow-up request to continue this conversation. Null when the upstream did not surface one." }, "reference_links": { "type": "array", "items": { "type": "object", "required": [ "title", "link" ], "properties": { "date": { "type": "string", "nullable": true, "description": "Publication date of the cited page, when present." }, "link": { "type": "string", "description": "URL of the cited page." }, "title": { "type": "string", "description": "Title of the cited page." }, "source": { "type": "string", "nullable": true, "description": "Publisher / source label." }, "favicon": { "type": "string", "nullable": true, "description": "Favicon URL of the cited page." }, "snippet": { "type": "string", "nullable": true, "description": "Short excerpt of the cited page." } } }, "description": "Citation links referenced by the AI Mode reply." } } }, "status": { "type": "string", "description": "The status of the API response." }, "parameters": { "type": "object", "properties": { "gl": { "type": "string", "description": "ISO 3166-1 alpha-2 country code used for the search." }, "hl": { "type": "string", "description": "ISO 639 language code used for the search." }, "tbs": { "type": "string", "nullable": true, "description": "Advanced Google search parameter (tbs) as received (only when explicitly passed)." }, "uule": { "type": "string", "nullable": true, "description": "Google uule location string as received (only when explicitly passed)." }, "prompt": { "type": "string", "description": "The AI Mode prompt as received." }, "location": { "type": "string", "nullable": true, "description": "Search origin location as received (only when explicitly passed)." }, "session_token": { "type": "string", "nullable": true, "description": "Session token as received (only when explicitly passed to continue a conversation)." } }, "description": "The parameters the API received and used for this request, echoed back." }, "request_id": { "type": "string", "description": "A unique ID to trace the API request." } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "description": "Send a prompt/query and get structured results and reference links from Google's AI Mode. POST variant of the AI Mode endpoint - accepts the same parameters in a JSON request body, with no URL length limit (recommended for long prompts). Each request consumes 2 request credits.", "operationId": "realtime_web_search_v2__ai_mode", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "prompt" ], "properties": { "gl": { "type": "string", "default": "us", "example": "us", "description": "The country / region for which to make the query. 2-letter country code, see ISO 3166-1 alpha-2." }, "hl": { "type": "string", "default": "en", "example": "en", "description": "The language to use for the search (Google's hl parameter). 2-letter country code, see ISO 639-1 alpha-2." }, "tbs": { "type": "string", "nullable": true, "description": "This parameter defines advanced search parameters that aren't available using regular query parameters (to be searched)." }, "uule": { "type": "string", "nullable": true, "description": "Google's own encoded location string (e.g. w+CAIQICIgU2VhdHRsZSxXYXNoaW5ndG9uLFVuaXRlZCBTdGF0ZXM=), passed to Google as is. Use it instead of location when you already generate uule values. Cannot be combined with location." }, "query": { "type": "string", "description": "The search query." }, "prompt": { "type": "string", "example": "How to make a pizza step by step?", "description": "AI Mode prompt." }, "location": { "type": "string", "nullable": true, "description": "Where the AI Mode search originates from, for location-dependent prompts such as local businesses, weather or events. Recommended to specify at city level to simulate a real user's search (e.g. London, England, United Kingdom). See https://openwebninja.s3.us-east-1.amazonaws.com/locations.json for the list of supported locations. Cannot be combined with uule." }, "attachments": { "type": "array", "items": { "type": "string" }, "example": [ "https://pdfobject.com/pdf/sample.pdf" ], "nullable": true, "description": "Optional list of document URLs (PDF) to attach to the prompt, as plain URL strings. Up to 5 files, 10 MB each. Images are not supported. Attaching one or more documents is charged a flat 1 extra request credit." }, "session_token": { "type": "string", "nullable": true, "description": "Specify a session token from previous AI Mode response to continue the chat from the same point (preserving history in context for continuous conversation)." } } }, "example": { "gl": "us", "hl": "en", "tbs": null, "uule": null, "prompt": "Summarize the attached document and give its title.", "location": null, "attachments": [ "https://pdfobject.com/pdf/sample.pdf" ], "session_token": null } } }, "required": true }, "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing detailed request/response schema definitions in documentation." ], "pages": [ 1 ], "sourceId": "sds__1fiQu9RHG0jaOVImz_2s", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/required" ], "revisionId": "sdrn_fMzoiFNl9X0S__Sj10MeV" }, { "gaps": [ "Missing request body schema and parameters" ], "pages": [], "sourceId": "sds_-esx5FCC4ULWvRHgqpp1v", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_jYKdoWAEl7S8gKTR2MMVP" }, { "gaps": [ "Missing request body schema and parameters" ], "pages": [ 1 ], "sourceId": "sds_-LRkHZTW3kkFz3P0VCP9x", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_IFNtzsGFVdRfOmGNpEt-c" }, { "gaps": [ "Missing explicit request body schema details in documentation" ], "pages": [], "sourceId": "sds_1_LX_FbWCA7U09K5zzV8z", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/required" ], "revisionId": "sdrn_1Y4Iq_rRp239QLf6anxmA" }, { "gaps": [ "Missing request body schema", "Missing parameters" ], "pages": [], "sourceId": "sds_2mkzMPjBdeReAr1HmDREz", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_c-7MmamthDbtIrwRq96jn" }, { "gaps": [ "Missing explicit schema details in documentation; inferred from standard API patterns." ], "pages": [], "sourceId": "sds_5-N-bD-w4FEvDbPufA7rY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/required" ], "revisionId": "sdrn_JMX_MdcNKNvBSfEXsR78v" }, { "gaps": [ "Missing request body schema", "Missing parameter definitions" ], "pages": [ 1 ], "sourceId": "sds_5fumgq7Dew7p7p505C6Vj", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_UDnMGDO2AU7l2pD7FR4rR" }, { "gaps": [ "Missing request body schema", "Missing parameters" ], "pages": [], "sourceId": "sds_955t3d9uA70qPIwKC9kkP", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_fAv2s8zxL0Eg2O0xmQwzI" }, { "gaps": [ "Missing explicit request body schema details in documentation", "Missing authentication scheme details" ], "pages": [], "sourceId": "sds_AF8bRESy69frdnjtCAF2z", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/required" ], "revisionId": "sdrn_nUAt1Ad8MTY5qaVlNUqO9" }, { "gaps": [ "Missing request body schema", "Missing parameter definitions" ], "pages": [ 1 ], "sourceId": "sds_AtF5v_vXxTbq1wWfTbZ8p", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_xtbL3_JhQnAYS_6AQGDiQ" }, { "gaps": [ "Missing explicit request body schema details in documentation", "Missing response schema details" ], "pages": [], "sourceId": "sds_bygUmn2K86zcEr8uYnytH", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/required" ], "revisionId": "sdrn_lRwIurwEjFC6EgANnKCbC" }, { "gaps": [ "Missing detailed request/response schema definitions in documentation." ], "pages": [], "sourceId": "sds_D1eKbJ9D0SJoHD3LLOLYI", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/required" ], "revisionId": "sdrn_WiAI6D9DA33xLudF2TJIh" }, { "gaps": [ "Missing explicit request body schema details in documentation", "Missing response schema details" ], "pages": [], "sourceId": "sds_FK2maa1cDe4qcElj5U3zU", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/required" ], "revisionId": "sdrn_gZ-rMsS0AnYbgxe2iW2Nm" }, { "gaps": [ "Missing explicit request body schema details in documentation" ], "pages": [], "sourceId": "sds_fZv-ITvZDV87-KqyW2hgn", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/required" ], "revisionId": "sdrn_aohUeFTorAhUkoXJ0nrWa" }, { "gaps": [ "Missing detailed request/response schema properties beyond query" ], "pages": [ 1 ], "sourceId": "sds_jRl0O0t2JNWjX4MjQ_kC5", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/required" ], "revisionId": "sdrn_0KHmU6zKJBn3JfGQhhbYP" }, { "gaps": [ "Missing explicit request body schema details in documentation", "Missing response schema details" ], "pages": [], "sourceId": "sds_kNNDQzbHD8UafUY8VU2At", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/required" ], "revisionId": "sdrn_CFRFpZthk-T-EyPrsqzIj" }, { "gaps": [ "Missing request body schema", "Missing parameters" ], "pages": [ 1 ], "sourceId": "sds_MagzpRZ5Tm9d-vEaBKRmn", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_pej_Kh1VLu4d3ByQ4BdIs" }, { "gaps": [ "Missing request body schema and parameters" ], "pages": [], "sourceId": "sds_MAxJPNBPJFwSKQLj1M1dr", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_QFW9HQumx231aOJCusPx0" }, { "gaps": [ "Missing request body schema", "Missing parameters" ], "pages": [], "sourceId": "sds_MeUfdaSf30qGBbwR2_Van", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_DgUH3wi-28BNw0nONekhu" }, { "gaps": [ "Missing request body schema", "Missing parameter definitions" ], "pages": [ 1 ], "sourceId": "sds_MV8gWtP36-RZn0HelHkbq", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_zsd2yxhBG769IpVFIUWRc" }, { "gaps": [ "Missing explicit request body schema details in documentation" ], "pages": [], "sourceId": "sds_oztKPm-kDl07iy0vwLc60", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/required" ], "revisionId": "sdrn_VLRawu6tyKfr0AhBGOcro" }, { "gaps": [ "Missing detailed parameter definitions and response schema." ], "pages": [], "sourceId": "sds_pt9NurvrIG0m5qHbodTXY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/required" ], "revisionId": "sdrn_B6aXroJb6q7sAixORNC4V" }, { "gaps": [ "Missing requestBody schema", "Missing parameters" ], "pages": [ 1 ], "sourceId": "sds_QdbGBVHpS4DPABRrX92IS", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_mU_O3DmPCywqfjxJZfC0a" }, { "gaps": [ "Missing explicit parameter definitions in documentation" ], "pages": [], "sourceId": "sds_ROjpin-1soeCivIbZLub5", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/required" ], "revisionId": "sdrn_WrJX2U_i26_CRY3Hi0cz4" }, { "gaps": [ "Missing request body schema, parameters, and authentication details." ], "pages": [ 1 ], "sourceId": "sds_sfehAR974K7XnlJ2wifV_", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description" ], "revisionId": "sdrn_XNjJhPs6At3Kc74UpKt27" }, { "gaps": [ "Missing request body schema", "Missing parameter definitions" ], "pages": [ 1 ], "sourceId": "sds_soxpzUWt2CLoTKLGBZfNb", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_3H-1br_3SJ3ASZfGOL5Yr" }, { "gaps": [ "Missing explicit request body schema details in documentation" ], "pages": [], "sourceId": "sds_SWPCFBdhQTXC3OrJ98RML", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/required" ], "revisionId": "sdrn_bk6BUY0JsF4ImDRAT3nR8" }, { "gaps": [ "Missing request body schema and parameters" ], "pages": [ 1 ], "sourceId": "sds_UpX4G0QiFQ_cIhdwzu8pk", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_eR8hqN-7MniZX5AeOeQLh" }, { "gaps": [ "Missing explicit request body schema details in documentation", "Missing response schema details" ], "pages": [], "sourceId": "sds_uqg4RBYIA1YERc8Rjc_2c", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/required" ], "revisionId": "sdrn_cPgV56wkqJydCcYz3mJU2" }, { "gaps": [ "Missing detailed request/response schema definitions in documentation." ], "pages": [], "sourceId": "sds_vaNNaw5q29aKLh-qRSfR0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/required" ], "revisionId": "sdrn_SrJ_OL_N_pZ70W8niC6g0" }, { "gaps": [ "Missing request body schema", "Missing parameter definitions" ], "pages": [ 1 ], "sourceId": "sds_wvqPOTBJ3ELhy96dsub_l", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_f7m9IOfd1EwYpLs8JZOMM" }, { "gaps": [ "Missing detailed request/response schema properties beyond query" ], "pages": [ 1 ], "sourceId": "sds_y_pAgcC-xJrVMI2TjrXI0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/required" ], "revisionId": "sdrn_58jSAkKvEcC3bWRtd9F4t" }, { "gaps": [ "Missing explicit request body schema details in documentation" ], "pages": [], "sourceId": "sds_YxKB40zPRwtilOdTUDmjR", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/required" ], "revisionId": "sdrn_4Vk_45589KUwJSyCPBwKV" }, { "gaps": [ "Missing explicit request body schema details in documentation page." ], "pages": [], "sourceId": "sds_ZS-xdAQ0s8auc1LcI7Ooo", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/content/application/json/schema/required" ], "revisionId": "sdrn_7knEBvR-UUuEvVL1C_QLq" } ], "x-zeroclick-services": [ "realtime-web-search" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-web-search", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-web-search", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-web-search/v2/people-also-ask": { "get": { "summary": "People Also Ask", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "request_id", "parameters", "data" ], "properties": { "data": { "type": "object", "required": [ "people_also_ask" ], "properties": { "people_also_ask": { "type": "array", "items": { "type": "object", "required": [ "question" ], "properties": { "answer": { "type": "string", "nullable": true, "description": "Plain-text answer extracted for the question. Only present when fetch_answers=true and Google returned an answer body; null when no answer could be extracted." }, "source": { "type": "object", "nullable": true, "properties": { "url": { "type": "string", "description": "URL of the source page." }, "title": { "type": "string", "nullable": true, "description": "Title of the source page, when available." }, "domain": { "type": "string", "nullable": true, "description": "Domain of the source page." } }, "description": "Source page for the answer. Only present when fetch_answers=true and a source link was found." }, "question": { "type": "string", "description": "The question text Google shows in the People Also Ask block." } } }, "description": "People Also Ask questions surfaced for the query (empty array when none)." } } }, "status": { "type": "string", "description": "The status of the API response." }, "parameters": { "type": "object", "properties": { "q": { "type": "string", "description": "The search query as received." }, "gl": { "type": "string", "description": "ISO 3166-1 alpha-2 country code used for the search." }, "hl": { "type": "string", "description": "ISO 639 language code used for the search." }, "location": { "type": "string", "nullable": true, "description": "Search origin location as received (only when explicitly passed)." }, "fetch_answers": { "type": "boolean", "description": "Whether answers + sources were requested for this call." } }, "description": "The parameters the API received and used for this request, echoed back." }, "request_id": { "type": "string", "description": "A unique ID to trace the API request." } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "q", "schema": { "type": "string", "example": "apple inc", "description": "Search query for which to fetch the People Also Ask block." }, "example": "apple inc", "required": true }, { "in": "query", "name": "gl", "schema": { "type": "string", "default": "us", "description": "The country / region for which to make the query. 2-letter country code, see ISO 3166-1 alpha-2." } }, { "in": "query", "name": "hl", "schema": { "type": "string", "default": "en", "description": "The language to use for the search (Google's hl parameter). 2-letter language code, see ISO 639-1 alpha-2." } }, { "in": "query", "name": "location", "schema": { "type": "string", "description": "Where the search originates from. Recommended to specify at city level to simulate a real user's search (e.g. London, England, United Kingdom)." } }, { "in": "query", "name": "lr", "schema": { "type": "string" }, "description": "Restrict search results to a specific language. Uses lang_{two-letter language code} with | as delimiter (e.g. lang_fr|lang_de searches French and German pages only)." }, { "in": "query", "name": "tbs", "schema": { "type": "string" }, "description": "Advanced Google search parameters that aren't available using regular query parameters (e.g. qdr:d for the last day, qdr:w for the last week). \n\n Note that time-filtered result pages often carry no People Also Ask block at all, in which case this endpoint returns an empty list." }, { "in": "query", "name": "nfpr", "schema": { "enum": [ "0", "1" ], "type": "string", "default": "0" }, "description": "Exclude results of the auto-corrected query when the original query is misspelled with nfpr=1, and include them with nfpr=0 (default)." }, { "in": "query", "name": "nhr", "schema": { "enum": [ "0", "1" ], "type": "string", "default": "0" }, "description": "Exclude 'People also ask' style related questions from the results with nhr=1. Include them with nhr=0 (default). \n\n Those questions are exactly what this endpoint returns, so nhr=1 can produce an empty list. Leave it at 0 unless that is what you want." }, { "in": "query", "name": "fetch_answers", "schema": { "enum": [ "true", "false", "0", "1" ], "type": "string", "default": "true", "description": "Whether to fetch the answer body and source for each question (true by default). \n\n When true or 1, each item includes `answer` and `source` (and the call consumes 3 credits when at least one question is found). When false or 0, items contain only `question` and the call consumes 2 credits." } } ], "description": "Get the People Also Ask block for a Google search query, optionally with the answer body and source link for each question. \n\n Each call consumes 2 request credits, or 3 credits when `fetch_answers=true` AND the query returns at least one question.", "operationId": "realtime_web_search_v2__people_also_ask", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing parameter definitions", "Missing response schema" ], "pages": [], "sourceId": "sds_0prF_Y5BkmqQXtEQyheXN", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_Z5rvTt1qYfVU6DSLLxPnI" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds_5fumgq7Dew7p7p505C6Vj", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_UDnMGDO2AU7l2pD7FR4rR" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_D1eKbJ9D0SJoHD3LLOLYI", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_WiAI6D9DA33xLudF2TJIh" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_FK2maa1cDe4qcElj5U3zU", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_gZ-rMsS0AnYbgxe2iW2Nm" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds_MAxJPNBPJFwSKQLj1M1dr", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_QFW9HQumx231aOJCusPx0" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_soxpzUWt2CLoTKLGBZfNb", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_3H-1br_3SJ3ASZfGOL5Yr" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_vdxxiVsx4OKV5vH7hrhwb", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_46RDkwnCaOF5IxAFfXTW0" } ], "x-zeroclick-services": [ "realtime-web-search" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-web-search", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-web-search", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-web-search/v2/search": { "get": { "summary": "Search", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "request_id", "parameters", "data" ], "properties": { "data": { "type": "object", "required": [ "organic_results", "has_ai_overviews" ], "properties": { "ads": { "type": "array", "items": { "type": "object" }, "nullable": true, "description": "Sponsored / ad results, when Google surfaces them for this query." }, "places": { "type": "array", "items": { "type": "object" }, "nullable": true, "description": "Local pack / places results, when Google surfaces them for this query." }, "answer_box": { "type": "object", "nullable": true, "properties": { "type": { "type": "string", "description": "Answer box variant. Examples: instant_answer, calculator, definition." }, "answer": { "type": "string", "nullable": true, "description": "Plain-text answer Google displays." } }, "description": "Google answer box (instant answer / calculator / definition), when Google surfaces one." }, "top_stories": { "type": "array", "items": { "type": "object" }, "nullable": true, "description": "Top Stories results, when Google surfaces them for this query." }, "ai_overviews": { "type": "object", "nullable": true, "properties": { "text_parts": { "type": "array", "items": { "type": "object", "required": [ "type" ], "properties": { "list": { "type": "array", "items": { "type": "object", "properties": { "text": { "type": "string", "description": "Item body text." }, "title": { "type": "string", "nullable": true, "description": "Bold label preceding the item text, when present." } } }, "nullable": true, "description": "Items of a list fragment." }, "text": { "type": "string", "nullable": true, "description": "Text content of paragraph/heading fragments." }, "type": { "type": "string", "description": "Fragment kind. Values: paragraph, heading, list." }, "ordered": { "type": "boolean", "nullable": true, "description": "Whether a list fragment is ordered." } } }, "description": "Sequenced fragments composing the AI Overview body (paragraphs, headings, lists, images)." }, "reference_links": { "type": "array", "items": { "type": "object", "required": [ "title", "link" ], "properties": { "date": { "type": "string", "nullable": true, "description": "Publication date of the cited page." }, "link": { "type": "string", "description": "URL of the cited page." }, "title": { "type": "string", "description": "Title of the cited page." }, "source": { "type": "string", "nullable": true, "description": "Publisher / source label." }, "snippet": { "type": "string", "nullable": true, "description": "Short excerpt of the cited page." } } }, "description": "Citation links referenced by the AI Overview." } }, "description": "Google's AI Overview block (only present when fetch_ai_overviews=true and AI Overviews are available)." }, "inline_videos": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string", "description": "Video URL." }, "title": { "type": "string", "description": "Video title with source label." }, "domain": { "type": "string", "nullable": true, "description": "Video host domain." }, "duration": { "type": "string", "nullable": true, "description": "Duration label (e.g. '4:14')." }, "position": { "type": "integer", "description": "Position within the inline videos block." } } }, "nullable": true, "description": "Inline video results." }, "knowledge_graph": { "type": "object", "nullable": true, "properties": { "type": { "type": "string", "nullable": true, "description": "Entity type label (e.g. 'Theoretical physicist')." }, "kgmid": { "type": "string", "nullable": true, "description": "Google Knowledge Graph machine ID." }, "title": { "type": "string", "nullable": true, "description": "Entity title." }, "attributes": { "type": "object", "nullable": true, "description": "Free-form key/value attributes Google surfaces for the entity (e.g. born, died, spouse).", "additionalProperties": { "type": "string" } }, "description": { "type": "string", "nullable": true, "description": "Short description of the entity." } }, "description": "Knowledge Graph entity panel, when Google returns one for this query." }, "organic_results": { "type": "array", "items": { "type": "object", "required": [ "title", "url", "position", "rank" ], "properties": { "url": { "type": "string", "description": "Canonical URL of the result." }, "date": { "type": "string", "nullable": true, "description": "Date associated with the result, when Google surfaces one." }, "rank": { "type": "integer", "description": "Absolute rank across all pages returned (1-based)." }, "title": { "type": "string", "description": "Title of the search result." }, "domain": { "type": "string", "nullable": true, "description": "Domain extracted from the result URL." }, "source": { "type": "string", "nullable": true, "description": "Source / publisher label shown by Google." }, "snippet": { "type": "string", "nullable": true, "description": "Short text snippet shown by Google under the result." }, "position": { "type": "integer", "description": "Position of the result within the page (1-based)." }, "rich_snippet": { "type": "object", "nullable": true, "properties": { "price": { "type": "string", "nullable": true, "description": "Displayed price of the item, including the currency symbol as shown by Google." }, "rating": { "type": "number", "nullable": true, "description": "Average customer rating of the item." }, "reviews": { "type": "string", "nullable": true, "description": "Number of customer reviews as displayed by Google, which may be abbreviated (for example 1.2k)." }, "delivery": { "type": "string", "nullable": true, "description": "Delivery or shipping information as displayed by Google." }, "rating_max": { "type": "integer", "nullable": true, "description": "Highest value on the rating scale. Returned only when Google exposes the scale." }, "availability": { "type": "string", "nullable": true, "description": "Stock status of the item as displayed by Google." } }, "description": "Rich result data Google displays for product and listing results. Present only when the result carries such data, and each field appears only when Google displays it." }, "displayed_link": { "type": "string", "nullable": true, "description": "Breadcrumb-style URL Google displays under the title." }, "video_thumbnail": { "type": "string", "nullable": true, "description": "Base64-encoded thumbnail for organic video results (only when return_organic_result_video_thumbnail=true)." }, "snippet_highlighted_words": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "Substrings Google highlights inside the snippet." } } }, "description": "Organic web search results." }, "has_ai_overviews": { "type": "boolean", "description": "Whether AI Overviews are present in the response. Only true when fetch_ai_overviews=true and AI Overviews are available." }, "related_searches": { "type": "array", "items": { "type": "object", "properties": { "link": { "type": "string", "nullable": true, "description": "Google search URL for the related query." }, "query": { "type": "string", "description": "Related query text." } } }, "nullable": true, "description": "Related search suggestions surfaced by Google." }, "shopping_results": { "type": "array", "items": { "type": "object" }, "nullable": true, "description": "Shopping results, when Google surfaces them for this query." }, "total_organic_results": { "type": "integer", "nullable": true, "description": "Approximate total number of organic results Google reports for the query." }, "discussions_and_forums": { "type": "array", "items": { "type": "object" }, "nullable": true, "description": "Discussions & forums results, when Google surfaces them for this query." } } }, "status": { "type": "string", "description": "The status of the API response." }, "parameters": { "type": "object", "properties": { "q": { "type": "string", "description": "The search query as received." }, "gl": { "type": "string", "description": "ISO 3166-1 alpha-2 country code used for the search." }, "hl": { "type": "string", "description": "ISO 639 language code used for the search." }, "lr": { "type": "string", "nullable": true, "description": "Language restriction filter as received (only when explicitly passed)." }, "nhr": { "type": "string", "description": "People-also-ask filter as received. Values: 0, 1." }, "num": { "type": "integer", "description": "Maximum number of organic results requested." }, "tbs": { "type": "string", "nullable": true, "description": "Advanced Google search parameter (tbs) as received (only when explicitly passed)." }, "nfpr": { "type": "string", "description": "Auto-corrected query filter as received. Values: 0, 1." }, "uule": { "type": "string", "nullable": true, "description": "Google uule location string as received (only when explicitly passed)." }, "start": { "type": "integer", "description": "Pagination offset as received." }, "device": { "type": "string", "description": "Device simulated for the search as received. Values: desktop (default), mobile, tablet." }, "location": { "type": "string", "nullable": true, "description": "Search origin location as received (only when explicitly passed)." }, "deduplicate": { "type": "boolean", "description": "Whether deduplication by URL was requested." }, "fetch_ai_overviews": { "type": "boolean", "description": "Whether AI Overviews fetching was requested for this call." }, "return_organic_result_video_thumbnail": { "type": "boolean", "description": "Whether base64 video thumbnails were requested for organic video results." } }, "description": "The parameters the API received and used for this request, echoed back." }, "request_id": { "type": "string", "description": "A unique ID to trace the API request." } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "q", "schema": { "type": "string", "example": "albert einstein" }, "example": "albert einstein", "required": true, "description": "Search query. Supports all Google Advanced Search operators (site:, inurl:, intitle:, etc)." }, { "in": "query", "name": "num", "schema": { "type": "integer", "default": 10, "maximum": 10, "minimum": 1 }, "description": "Maximum number of organic results to return per request (1-10)." }, { "in": "query", "name": "start", "schema": { "type": "integer", "default": 0 }, "description": "Number of results to skip for pagination (default 0)." }, { "in": "query", "name": "gl", "schema": { "type": "string", "default": "us" }, "description": "The country / region for which to make the query. 2-letter country code, see ISO 3166-1 alpha-2." }, { "in": "query", "name": "hl", "schema": { "type": "string", "default": "en" }, "description": "The language to use for the search (Google's hl parameter). 2-letter language code, see ISO 639-1 alpha-2." }, { "in": "query", "name": "location", "schema": { "type": "string" }, "description": "Where the search originates from. Recommended to specify at city level to simulate a real user's search (e.g. London, England, United Kingdom). See https://openwebninja.s3.us-east-1.amazonaws.com/locations.json for the list of supported locations." }, { "in": "query", "name": "uule", "schema": { "type": "string" }, "description": "Google's own encoded location string (e.g. w+CAIQICIgU2VhdHRsZSxXYXNoaW5ndG9uLFVuaXRlZCBTdGF0ZXM=), passed to Google as is. Use it instead of location when you already generate uule values. Cannot be combined with location." }, { "in": "query", "name": "device", "schema": { "enum": [ "desktop", "mobile", "tablet" ], "type": "string", "default": "desktop" }, "description": "The device to simulate for the search. Mobile and tablet return Google's mobile SERP layout, whose rankings and features can differ from desktop. Allowed values: desktop (default), mobile, tablet." }, { "in": "query", "name": "lr", "schema": { "type": "string" }, "description": "Restrict search results to a specific language. Uses lang_{two-letter language code} with | as delimiter (e.g. lang_fr|lang_de searches French and German pages only)." }, { "in": "query", "name": "tbs", "schema": { "type": "string" }, "description": "Advanced Google search parameters that aren't available using regular query parameters (e.g. qdr:d for the last day, qdr:w for the last week)." }, { "in": "query", "name": "nfpr", "schema": { "enum": [ "0", "1" ], "type": "string", "default": "0" }, "description": "Exclude results of the auto-corrected query when the original query is misspelled with nfpr=1, and include them with nfpr=0 (default)." }, { "in": "query", "name": "nhr", "schema": { "enum": [ "0", "1" ], "type": "string", "default": "0" }, "description": "Exclude 'People also ask' style related questions from the results with nhr=1. Include them with nhr=0 (default)." }, { "in": "query", "name": "fetch_ai_overviews", "schema": { "type": "boolean", "default": false }, "description": "Whether to return AI Overviews when available (false by default). When true or 1, if AI Overviews are available, each request consumes two request credits instead of one." }, { "in": "query", "name": "return_organic_result_video_thumbnail", "schema": { "type": "boolean", "default": false }, "description": "Whether to return a base64-encoded video_thumbnail field for organic video results (false by default)." } ], "description": "Get real-time full-depth web search results via the heavy serp path, including organic results, ads, AI overviews, knowledge graph, places, top stories, inline videos, answer box, and discussions. Supports Google Search parameters (gl, hl, tbs, etc.) and city-level geo targeting. Note: Each request to this endpoint consumes 2 request credits.", "operationId": "realtime_web_search_v2__search", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing parameter definitions", "Missing response schema" ], "pages": [], "sourceId": "sds_0prF_Y5BkmqQXtEQyheXN", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_Z5rvTt1qYfVU6DSLLxPnI" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds_5fumgq7Dew7p7p505C6Vj", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_UDnMGDO2AU7l2pD7FR4rR" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_D1eKbJ9D0SJoHD3LLOLYI", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_WiAI6D9DA33xLudF2TJIh" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_FK2maa1cDe4qcElj5U3zU", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_gZ-rMsS0AnYbgxe2iW2Nm" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds_MAxJPNBPJFwSKQLj1M1dr", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_QFW9HQumx231aOJCusPx0" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_soxpzUWt2CLoTKLGBZfNb", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_3H-1br_3SJ3ASZfGOL5Yr" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_vdxxiVsx4OKV5vH7hrhwb", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_46RDkwnCaOF5IxAFfXTW0" } ], "x-zeroclick-services": [ "realtime-web-search" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-web-search", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-web-search", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-web-search/v2/search-light": { "get": { "summary": "Search Light", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "request_id", "data" ], "properties": { "data": { "type": "array", "items": { "type": "object", "required": [ "title", "url", "position" ], "properties": { "url": { "type": "string", "description": "Canonical URL of the result." }, "title": { "type": "string", "description": "Title of the search result." }, "domain": { "type": "string", "nullable": true, "description": "Domain extracted from the result URL." }, "snippet": { "type": "string", "nullable": true, "description": "Short text snippet shown by Google under the result." }, "position": { "type": "integer", "description": "Position of the result in the list (1-based)." }, "thumbnail": { "type": "string", "description": "Thumbnail image URL, present only on results Google renders with an image." }, "published_timestamp": { "type": "integer", "description": "Publication date of the result as a Unix timestamp, when Google reports one. Absent for results with no published date." } } }, "description": "Organic web search results for the query." }, "status": { "type": "string", "description": "The status of the API response." }, "request_id": { "type": "string", "description": "A unique ID to trace the API request." } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "q", "schema": { "type": "string", "example": "how to build a website", "description": "Search query. \n Supports all Google Advanced Search operators (site:, inurl:, intitle:, etc)." }, "example": "how to build a website", "required": true }, { "in": "query", "name": "num", "schema": { "type": "integer", "default": 10, "maximum": 300, "minimum": 1, "description": "Maximum number of organic results to return (up to 300). \n This is a result count, not a pagination cursor: a single request returns up to `num` results in one call. \n Google does not hold the full requested depth for every query, so fewer results may come back for narrow queries." } }, { "in": "query", "name": "gl", "schema": { "type": "string", "default": "us", "description": "The country / region for which to make the query. Allowed values: 2-letter country code, see ISO 3166-1 alpha-2." } }, { "in": "query", "name": "hl", "schema": { "type": "string", "default": "en", "description": "The language to use for the search (Google's hl parameter). Allowed values: 2-letter country code, see ISO 639-1 alpha-2." } } ], "description": "Lightning fast endpoint for getting organic web search results in real-time. \n Returns raw organic results only, without AI Overviews, knowledge graph, or a total result count - use the Search endpoint when you need the full SERP. \n Supports all Google Advanced Search operators (site:, inurl:, intitle:, etc). \n Each request consumes 1 request credit.", "operationId": "realtime_web_search_v2__search_light", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing parameter definitions", "Missing response schema" ], "pages": [], "sourceId": "sds_0prF_Y5BkmqQXtEQyheXN", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_Z5rvTt1qYfVU6DSLLxPnI" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds_5fumgq7Dew7p7p505C6Vj", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_UDnMGDO2AU7l2pD7FR4rR" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_D1eKbJ9D0SJoHD3LLOLYI", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_WiAI6D9DA33xLudF2TJIh" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_FK2maa1cDe4qcElj5U3zU", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_gZ-rMsS0AnYbgxe2iW2Nm" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [ 1 ], "sourceId": "sds_MAxJPNBPJFwSKQLj1M1dr", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_QFW9HQumx231aOJCusPx0" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_soxpzUWt2CLoTKLGBZfNb", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_3H-1br_3SJ3ASZfGOL5Yr" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_vdxxiVsx4OKV5vH7hrhwb", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_46RDkwnCaOF5IxAFfXTW0" } ], "x-zeroclick-services": [ "realtime-web-search" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-web-search", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-web-search", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-web-search/v2/search-light-bulk": { "post": { "summary": "Search Light Bulk", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "request_id", "data" ], "properties": { "data": { "type": "array", "items": { "type": "object", "required": [ "query", "results" ], "properties": { "query": { "type": "string", "description": "The query that produced this result set." }, "results": { "type": "array", "items": { "type": "object", "required": [ "title", "url", "position" ], "properties": { "url": { "type": "string", "description": "Canonical URL of the result." }, "title": { "type": "string", "description": "Title of the search result." }, "domain": { "type": "string", "nullable": true, "description": "Domain extracted from the result URL." }, "snippet": { "type": "string", "nullable": true, "description": "Short text snippet shown by Google under the result." }, "position": { "type": "integer", "description": "Position of the result in the list (1-based)." } } }, "description": "Organic web search results for this query." } } }, "description": "One entry per submitted query, in the order they were processed." }, "status": { "type": "string", "description": "The status of the API response." }, "request_id": { "type": "string", "description": "A unique ID to trace the API request." } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "description": "Perform real-time web searches for up to 100 queries in a single request (each query is counted/charged as a request credit).", "operationId": "realtime_web_search_v2__search_light_bulk", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "queries" ], "properties": { "gl": { "type": "string", "default": "us", "example": "us", "description": "Geo/region code (lowercased)." }, "hl": { "type": "string", "default": "en", "example": "en", "description": "Language code (lowercased)." }, "limit": { "type": "integer", "default": 10, "example": 10, "maximum": 300, "minimum": 1, "description": "Number of results to return (1–300; capped at 300)." }, "queries": { "type": "array", "items": { "type": "string" }, "oneOf": [ { "type": "array", "items": { "type": "string", "maxLength": 5000 }, "example": [ "chatgpt", "build a website" ], "maxItems": 100 } ], "description": "Query or list of queries to search (max 100 items; each trimmed; each ≤ 5000 chars; duplicates removed server-side)." } } }, "example": { "gl": "us", "hl": "en", "limit": 10, "queries": [ "chatgpt", "build a website" ] } } }, "required": true }, "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing detailed schema for response body" ], "pages": [ 1 ], "sourceId": "sds__1fiQu9RHG0jaOVImz_2s", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_fMzoiFNl9X0S__Sj10MeV" }, { "gaps": [ "Missing request body schema and parameters" ], "pages": [], "sourceId": "sds_-esx5FCC4ULWvRHgqpp1v", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_jYKdoWAEl7S8gKTR2MMVP" }, { "gaps": [ "Missing request body schema and parameters" ], "pages": [ 1 ], "sourceId": "sds_-LRkHZTW3kkFz3P0VCP9x", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_IFNtzsGFVdRfOmGNpEt-c" }, { "gaps": [ "Missing explicit request body schema details in documentation" ], "pages": [], "sourceId": "sds_1_LX_FbWCA7U09K5zzV8z", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_1Y4Iq_rRp239QLf6anxmA" }, { "gaps": [ "Missing request body schema", "Missing parameters" ], "pages": [], "sourceId": "sds_2mkzMPjBdeReAr1HmDREz", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_c-7MmamthDbtIrwRq96jn" }, { "gaps": [ "Missing explicit schema details in documentation; inferred from standard API patterns." ], "pages": [], "sourceId": "sds_5-N-bD-w4FEvDbPufA7rY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_JMX_MdcNKNvBSfEXsR78v" }, { "gaps": [ "Missing request body schema", "Missing parameter definitions" ], "pages": [ 1 ], "sourceId": "sds_5fumgq7Dew7p7p505C6Vj", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_UDnMGDO2AU7l2pD7FR4rR" }, { "gaps": [ "Missing request body schema", "Missing parameters" ], "pages": [], "sourceId": "sds_955t3d9uA70qPIwKC9kkP", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_fAv2s8zxL0Eg2O0xmQwzI" }, { "gaps": [ "Missing explicit documentation for request body schema and response structure in provided text." ], "pages": [], "sourceId": "sds_AF8bRESy69frdnjtCAF2z", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_nUAt1Ad8MTY5qaVlNUqO9" }, { "gaps": [ "Missing request body schema", "Missing parameter definitions" ], "pages": [ 1 ], "sourceId": "sds_AtF5v_vXxTbq1wWfTbZ8p", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_xtbL3_JhQnAYS_6AQGDiQ" }, { "gaps": [ "Missing detailed schema for response body", "Missing authentication details" ], "pages": [], "sourceId": "sds_bygUmn2K86zcEr8uYnytH", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_lRwIurwEjFC6EgANnKCbC" }, { "gaps": [ "Missing detailed request/response schema definitions in documentation." ], "pages": [], "sourceId": "sds_D1eKbJ9D0SJoHD3LLOLYI", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_WiAI6D9DA33xLudF2TJIh" }, { "gaps": [ "Missing requestBody schema", "Missing parameter definitions" ], "pages": [], "sourceId": "sds_FK2maa1cDe4qcElj5U3zU", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_gZ-rMsS0AnYbgxe2iW2Nm" }, { "gaps": [ "Missing explicit request body schema details in documentation" ], "pages": [], "sourceId": "sds_fZv-ITvZDV87-KqyW2hgn", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_aohUeFTorAhUkoXJ0nrWa" }, { "gaps": [ "Missing detailed request/response schema properties beyond queries" ], "pages": [ 1 ], "sourceId": "sds_jRl0O0t2JNWjX4MjQ_kC5", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_0KHmU6zKJBn3JfGQhhbYP" }, { "gaps": [ "Missing explicit request body schema details in documentation", "Missing response schema details" ], "pages": [], "sourceId": "sds_kNNDQzbHD8UafUY8VU2At", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_CFRFpZthk-T-EyPrsqzIj" }, { "gaps": [ "Missing request body schema", "Missing parameters" ], "pages": [ 1 ], "sourceId": "sds_MagzpRZ5Tm9d-vEaBKRmn", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_pej_Kh1VLu4d3ByQ4BdIs" }, { "gaps": [ "Missing request body schema and parameters" ], "pages": [], "sourceId": "sds_MAxJPNBPJFwSKQLj1M1dr", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_QFW9HQumx231aOJCusPx0" }, { "gaps": [ "Missing request body schema", "Missing parameters" ], "pages": [], "sourceId": "sds_MeUfdaSf30qGBbwR2_Van", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_DgUH3wi-28BNw0nONekhu" }, { "gaps": [ "Missing explicit request body schema details in documentation" ], "pages": [], "sourceId": "sds_oztKPm-kDl07iy0vwLc60", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_VLRawu6tyKfr0AhBGOcro" }, { "gaps": [ "Missing detailed parameter definitions and response schema." ], "pages": [], "sourceId": "sds_pt9NurvrIG0m5qHbodTXY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_B6aXroJb6q7sAixORNC4V" }, { "gaps": [ "Missing requestBody schema", "Missing parameters" ], "pages": [ 1 ], "sourceId": "sds_QdbGBVHpS4DPABRrX92IS", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_mU_O3DmPCywqfjxJZfC0a" }, { "gaps": [ "Missing explicit request body schema details in documentation", "Missing response schema details" ], "pages": [], "sourceId": "sds_qhTee9rhe4IsP9VM8R0Jx", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_n1Qua5iIILpqbVggnqZhR" }, { "gaps": [ "Missing explicit parameter definitions in documentation" ], "pages": [], "sourceId": "sds_ROjpin-1soeCivIbZLub5", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_WrJX2U_i26_CRY3Hi0cz4" }, { "gaps": [ "Missing request body schema, parameters, and authentication details." ], "pages": [ 1 ], "sourceId": "sds_sfehAR974K7XnlJ2wifV_", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description" ], "revisionId": "sdrn_XNjJhPs6At3Kc74UpKt27" }, { "gaps": [ "Missing request body schema", "Missing parameter definitions" ], "pages": [ 1 ], "sourceId": "sds_soxpzUWt2CLoTKLGBZfNb", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_3H-1br_3SJ3ASZfGOL5Yr" }, { "gaps": [ "Missing explicit request body schema details in documentation" ], "pages": [], "sourceId": "sds_SWPCFBdhQTXC3OrJ98RML", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_bk6BUY0JsF4ImDRAT3nR8" }, { "gaps": [ "Missing request body schema and parameters" ], "pages": [ 1 ], "sourceId": "sds_UpX4G0QiFQ_cIhdwzu8pk", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_eR8hqN-7MniZX5AeOeQLh" }, { "gaps": [ "Missing explicit request body schema details in documentation", "Missing response schema details" ], "pages": [], "sourceId": "sds_uqg4RBYIA1YERc8Rjc_2c", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_cPgV56wkqJydCcYz3mJU2" }, { "gaps": [ "Missing detailed request/response schema definitions in documentation." ], "pages": [], "sourceId": "sds_vaNNaw5q29aKLh-qRSfR0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_SrJ_OL_N_pZ70W8niC6g0" }, { "gaps": [ "Missing request body schema", "Missing parameter definitions" ], "pages": [ 1 ], "sourceId": "sds_wvqPOTBJ3ELhy96dsub_l", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_f7m9IOfd1EwYpLs8JZOMM" }, { "gaps": [ "Missing detailed request/response schema properties beyond queries" ], "pages": [ 1 ], "sourceId": "sds_y_pAgcC-xJrVMI2TjrXI0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_58jSAkKvEcC3bWRtd9F4t" }, { "gaps": [ "Missing explicit request body schema details in documentation" ], "pages": [], "sourceId": "sds_YxKB40zPRwtilOdTUDmjR", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_4Vk_45589KUwJSyCPBwKV" }, { "gaps": [ "Missing explicit request body schema details in documentation page." ], "pages": [], "sourceId": "sds_ZS-xdAQ0s8auc1LcI7Ooo", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_7knEBvR-UUuEvVL1C_QLq" } ], "x-zeroclick-services": [ "realtime-web-search" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-web-search", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-web-search", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-zillow-data/agent-properties-for-rent": { "get": { "summary": "Agent Properties (For Rent)", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "listings": { "type": "array", "items": { "type": "object", "properties": { "zpid": { "type": "integer", "description": "Zillow property id." }, "price": { "type": "integer", "nullable": true, "description": "Monthly rent." }, "status": { "type": "string", "nullable": true, "description": "Always null: Zillow no longer exposes it for these listings." }, "address": { "type": "object", "properties": { "city": { "type": "string", "nullable": true }, "line1": { "type": "string", "nullable": true, "description": "Street address." }, "line2": { "type": "string", "nullable": true, "description": "City, state and ZIP code." }, "postalCode": { "type": "string", "nullable": true }, "stateOrProvince": { "type": "string", "nullable": true } } }, "bedrooms": { "type": "number", "nullable": true }, "latitude": { "type": "number", "nullable": true, "description": "Always null: Zillow no longer exposes it for these listings." }, "bathrooms": { "type": "number", "nullable": true }, "home_type": { "type": "string", "nullable": true, "description": "Always null: Zillow no longer exposes it for these listings." }, "longitude": { "type": "number", "nullable": true, "description": "Always null: Zillow no longer exposes it for these listings." }, "openHouses": { "type": "string", "nullable": true, "description": "Always null: Zillow no longer exposes it for these listings." }, "listing_url": { "type": "string", "description": "Zillow property page." }, "hasOpenHouse": { "type": "boolean", "nullable": true, "description": "Always null: Zillow no longer exposes it for these listings." }, "has_vr_model": { "type": "boolean", "nullable": true, "description": "Always null: Zillow no longer exposes it for these listings." }, "brokerage_name": { "type": "string", "nullable": true, "description": "Listing brokerage, when Zillow shows one." }, "price_currency": { "type": "string", "nullable": true, "description": "Always null: Zillow no longer exposes it for these listings." }, "primary_photo_url": { "type": "string", "nullable": true }, "home_marketing_type": { "type": "string", "description": "Always forRent on this endpoint." }, "home_marketing_status": { "type": "string", "nullable": true, "description": "Always null: Zillow no longer exposes it for these listings." } } }, "description": "Rental listings on this page." }, "listing_count": { "type": "integer", "nullable": true, "description": "Always null: Zillow no longer exposes the total number of listings." } } }, "status": { "type": "string" }, "parameters": { "type": "object", "properties": { "page": { "type": "integer" }, "encodedZuid": { "type": "string" }, "include_team": { "type": "boolean" } } }, "request_id": { "type": "string" } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "encodedZuid", "schema": { "type": "string", "example": "X1-ZU12j0quxoelgjt_uwi3", "description": "The agent's unique identifier (obtained from the Agent Search endpoint)." }, "example": "X1-ZU12j0quxoelgjt_uwi3", "required": true }, { "in": "query", "name": "page", "schema": { "type": "number", "default": 1, "minimum": 1, "description": "Page number for paginated results. Each page returns up to 5 listings; a page past the last one returns an empty list." } }, { "in": "query", "name": "include_team", "schema": { "type": "boolean", "default": true, "description": "Accepted for compatibility and has no effect: Zillow returns the same listings its profile page shows." } } ], "description": "Get the rental listings shown on an agent's Zillow profile, 5 per page. Requires the `encodedZuid` identifier from the Agent Search endpoint. Zillow no longer exposes the total number of listings, coordinates, home type, listing status codes, open houses or currency for these listings, so those fields are null.", "operationId": "realtime_zillow_data__get__agent_properties_for_rent", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing parameter descriptions and response schema details." ], "pages": [ 1 ], "sourceId": "sds__1fiQu9RHG0jaOVImz_2s", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/agent_id", "/description", "/operationId" ], "revisionId": "sdrn_fMzoiFNl9X0S__Sj10MeV" }, { "gaps": [ "Missing detailed schema for response body" ], "pages": [ 1 ], "sourceId": "sds_1IfgtOxqP1q4cHvJ7VyPY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/agent_id", "/description", "/operationId" ], "revisionId": "sdrn_mb4oPKVX4C1sgk5EHzdxz" }, { "gaps": [ "Missing response schema details" ], "pages": [ 1 ], "sourceId": "sds_5fumgq7Dew7p7p505C6Vj", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/agent_id", "/description", "/operationId" ], "revisionId": "sdrn_UDnMGDO2AU7l2pD7FR4rR" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_5hlhZJYspBPaHxKN7OhqJ", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_3lrPg3Nc0kbMzAAAdVFHe" }, { "gaps": [ "Missing schema details for response body" ], "pages": [ 1 ], "sourceId": "sds_AtF5v_vXxTbq1wWfTbZ8p", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/agent_id", "/description", "/operationId" ], "revisionId": "sdrn_xtbL3_JhQnAYS_6AQGDiQ" }, { "gaps": [ "Missing schema details for response body" ], "pages": [ 1 ], "sourceId": "sds_FK2maa1cDe4qcElj5U3zU", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/agent_id", "/description", "/operationId" ], "revisionId": "sdrn_gZ-rMsS0AnYbgxe2iW2Nm" }, { "gaps": [ "Missing detailed parameter schema for agent_id and response structure." ], "pages": [ 1 ], "sourceId": "sds_kNNDQzbHD8UafUY8VU2At", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/agent_id", "/description", "/operationId" ], "revisionId": "sdrn_CFRFpZthk-T-EyPrsqzIj" }, { "gaps": [ "Missing detailed schema for response body" ], "pages": [ 1 ], "sourceId": "sds_MeUfdaSf30qGBbwR2_Van", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/agent_id", "/description", "/operationId" ], "revisionId": "sdrn_DgUH3wi-28BNw0nONekhu" }, { "gaps": [ "Missing parameter details and response schema" ], "pages": [], "sourceId": "sds_ROjpin-1soeCivIbZLub5", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/agent_id", "/description", "/operationId" ], "revisionId": "sdrn_WrJX2U_i26_CRY3Hi0cz4" }, { "gaps": [ "Missing explicit parameter definitions in documentation" ], "pages": [], "sourceId": "sds_soxpzUWt2CLoTKLGBZfNb", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/agent_id", "/description", "/operationId" ], "revisionId": "sdrn_3H-1br_3SJ3ASZfGOL5Yr" }, { "gaps": [ "Missing explicit parameter definitions in documentation" ], "pages": [], "sourceId": "sds_uqg4RBYIA1YERc8Rjc_2c", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/agent_id", "/description", "/operationId" ], "revisionId": "sdrn_cPgV56wkqJydCcYz3mJU2" }, { "gaps": [ "Missing parameter details for agent_id", "Missing response schema" ], "pages": [], "sourceId": "sds_y_pAgcC-xJrVMI2TjrXI0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/agent_id", "/description", "/operationId" ], "revisionId": "sdrn_58jSAkKvEcC3bWRtd9F4t" } ], "x-zeroclick-services": [ "realtime-zillow-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-zillow-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-zillow-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-zillow-data/agent-properties-for-sale": { "get": { "summary": "Agent Properties (For Sale)", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "listings": { "type": "array", "items": { "type": "object", "properties": { "zpid": { "type": "integer", "description": "Zillow property id." }, "price": { "type": "integer", "nullable": true, "description": "Asking price." }, "status": { "type": "string", "nullable": true, "description": "Always null: Zillow no longer exposes it for these listings." }, "address": { "type": "object", "properties": { "city": { "type": "string", "nullable": true }, "line1": { "type": "string", "nullable": true, "description": "Street address." }, "line2": { "type": "string", "nullable": true, "description": "City, state and ZIP code." }, "postalCode": { "type": "string", "nullable": true }, "stateOrProvince": { "type": "string", "nullable": true } } }, "bedrooms": { "type": "number", "nullable": true }, "latitude": { "type": "number", "nullable": true, "description": "Always null: Zillow no longer exposes it for these listings." }, "bathrooms": { "type": "number", "nullable": true }, "home_type": { "type": "string", "nullable": true, "description": "Always null: Zillow no longer exposes it for these listings." }, "longitude": { "type": "number", "nullable": true, "description": "Always null: Zillow no longer exposes it for these listings." }, "openHouses": { "type": "string", "nullable": true, "description": "Always null: Zillow no longer exposes it for these listings." }, "listing_url": { "type": "string", "description": "Zillow property page." }, "hasOpenHouse": { "type": "boolean", "nullable": true, "description": "Always null: Zillow no longer exposes it for these listings." }, "has_vr_model": { "type": "boolean", "nullable": true, "description": "Always null: Zillow no longer exposes it for these listings." }, "brokerage_name": { "type": "string", "nullable": true, "description": "Listing brokerage, when Zillow shows one." }, "price_currency": { "type": "string", "nullable": true, "description": "Always null: Zillow no longer exposes it for these listings." }, "primary_photo_url": { "type": "string", "nullable": true }, "home_marketing_type": { "type": "string", "description": "Always forSale on this endpoint." }, "home_marketing_status": { "type": "string", "nullable": true, "description": "Always null: Zillow no longer exposes it for these listings." } } }, "description": "For-sale listings on this page." }, "listing_count": { "type": "integer", "nullable": true, "description": "Always null: Zillow no longer exposes the total number of listings." } } }, "status": { "type": "string" }, "parameters": { "type": "object", "properties": { "page": { "type": "integer" }, "encodedZuid": { "type": "string" }, "include_team": { "type": "boolean" } } }, "request_id": { "type": "string" } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "encodedZuid", "schema": { "type": "string", "example": "X1-ZUxs6j84n4ak95_3mmvm", "description": "The agent's unique identifier (obtained from the Agent Search endpoint)." }, "example": "X1-ZUxs6j84n4ak95_3mmvm", "required": true }, { "in": "query", "name": "page", "schema": { "type": "number", "default": 1, "minimum": 1, "description": "Page number for paginated results. Each page returns up to 5 listings; a page past the last one returns an empty list." } }, { "in": "query", "name": "include_team", "schema": { "type": "boolean", "default": true, "description": "Accepted for compatibility and has no effect: Zillow returns the same listings its profile page shows." } } ], "description": "Get the for-sale listings shown on an agent's Zillow profile, 5 per page. Requires the `encodedZuid` identifier from the Agent Search endpoint. Zillow no longer exposes the total number of listings, coordinates, home type, listing status codes, open houses or currency for these listings, so those fields are null.", "operationId": "realtime_zillow_data__get__agent_properties_for_sale", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing parameter descriptions and response schema details." ], "pages": [ 1 ], "sourceId": "sds__1fiQu9RHG0jaOVImz_2s", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/agent_id", "/description", "/operationId" ], "revisionId": "sdrn_fMzoiFNl9X0S__Sj10MeV" }, { "gaps": [ "Missing detailed schema for response body" ], "pages": [ 1 ], "sourceId": "sds_1IfgtOxqP1q4cHvJ7VyPY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/agent_id", "/description", "/operationId" ], "revisionId": "sdrn_mb4oPKVX4C1sgk5EHzdxz" }, { "gaps": [ "Missing response schema details" ], "pages": [ 1 ], "sourceId": "sds_5fumgq7Dew7p7p505C6Vj", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/agent_id", "/description", "/operationId" ], "revisionId": "sdrn_UDnMGDO2AU7l2pD7FR4rR" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_5hlhZJYspBPaHxKN7OhqJ", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_3lrPg3Nc0kbMzAAAdVFHe" }, { "gaps": [ "Missing schema details for response body" ], "pages": [ 1 ], "sourceId": "sds_AtF5v_vXxTbq1wWfTbZ8p", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/agent_id", "/description", "/operationId" ], "revisionId": "sdrn_xtbL3_JhQnAYS_6AQGDiQ" }, { "gaps": [ "Missing schema details for response body" ], "pages": [ 1 ], "sourceId": "sds_FK2maa1cDe4qcElj5U3zU", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/agent_id", "/description", "/operationId" ], "revisionId": "sdrn_gZ-rMsS0AnYbgxe2iW2Nm" }, { "gaps": [ "Missing detailed parameter schema for agent_id and response structure." ], "pages": [ 1 ], "sourceId": "sds_kNNDQzbHD8UafUY8VU2At", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/agent_id", "/description", "/operationId" ], "revisionId": "sdrn_CFRFpZthk-T-EyPrsqzIj" }, { "gaps": [ "Missing detailed schema for response body" ], "pages": [ 1 ], "sourceId": "sds_MeUfdaSf30qGBbwR2_Van", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/agent_id", "/description", "/operationId" ], "revisionId": "sdrn_DgUH3wi-28BNw0nONekhu" }, { "gaps": [ "Missing parameter details and response schema" ], "pages": [], "sourceId": "sds_ROjpin-1soeCivIbZLub5", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/agent_id", "/description", "/operationId" ], "revisionId": "sdrn_WrJX2U_i26_CRY3Hi0cz4" }, { "gaps": [ "Missing explicit parameter definitions in documentation" ], "pages": [], "sourceId": "sds_soxpzUWt2CLoTKLGBZfNb", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/agent_id", "/description", "/operationId" ], "revisionId": "sdrn_3H-1br_3SJ3ASZfGOL5Yr" }, { "gaps": [ "Missing explicit parameter definitions in documentation" ], "pages": [], "sourceId": "sds_uqg4RBYIA1YERc8Rjc_2c", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/agent_id", "/description", "/operationId" ], "revisionId": "sdrn_cPgV56wkqJydCcYz3mJU2" }, { "gaps": [ "Missing parameter details for agent_id", "Missing response schema" ], "pages": [], "sourceId": "sds_y_pAgcC-xJrVMI2TjrXI0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/agent_id", "/description", "/operationId" ], "revisionId": "sdrn_58jSAkKvEcC3bWRtd9F4t" } ], "x-zeroclick-services": [ "realtime-zillow-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-zillow-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-zillow-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-zillow-data/agent-properties-sold": { "get": { "summary": "Agent Properties (Sold)", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "sold_properties": { "type": "array", "items": { "type": "object", "properties": { "city": { "type": "string", "nullable": true }, "zpid": { "type": "integer", "description": "Zillow property id." }, "price": { "type": "string", "nullable": true, "description": "Sale price as displayed by Zillow." }, "state": { "type": "string", "nullable": true }, "bedrooms": { "type": "number", "nullable": true }, "latitude": { "type": "number", "nullable": true, "description": "Always null: Zillow no longer exposes it for these listings." }, "bathrooms": { "type": "number", "nullable": true }, "image_alt": { "type": "string", "nullable": true, "description": "Always null: Zillow no longer exposes it for these listings." }, "image_url": { "type": "string", "nullable": true }, "longitude": { "type": "number", "nullable": true, "description": "Always null: Zillow no longer exposes it for these listings." }, "sold_date": { "type": "string", "nullable": true, "description": "Sale date, M/D/YYYY." }, "represented": { "type": "string", "nullable": true, "description": "Side the agent represented: Buyer or Seller." }, "street_address": { "type": "string", "nullable": true }, "livingAreaValue": { "type": "number", "nullable": true }, "representedList": { "type": "array", "items": { "type": "string" } }, "home_details_url": { "type": "string", "description": "Zillow property page." }, "medium_image_url": { "type": "string", "nullable": true, "description": "Always null: Zillow no longer exposes it for these listings." }, "city_state_zipcode": { "type": "string", "nullable": true }, "livingAreaUnitsShort": { "type": "string", "nullable": true } } }, "description": "Sold properties on this page." }, "total_sold_properties": { "type": "integer", "nullable": true, "description": "Always null: Zillow no longer exposes the total number of sales." } } }, "status": { "type": "string" }, "parameters": { "type": "object", "properties": { "page": { "type": "integer" }, "encodedZuid": { "type": "string" } } }, "request_id": { "type": "string" } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "encodedZuid", "schema": { "type": "string", "example": "X1-ZUxs6j84n4ak95_3mmvm", "description": "The agent's unique identifier (obtained from the Agent Search endpoint)." }, "example": "X1-ZUxs6j84n4ak95_3mmvm", "required": true }, { "in": "query", "name": "page", "schema": { "type": "number", "default": 1, "maximum": 20, "minimum": 1, "description": "Page number for paginated results (1-20). Each page returns up to 5 sales; a page past the last one returns an empty list." } } ], "description": "Get the sold properties shown on an agent's Zillow profile, 5 per page. Requires the `encodedZuid` identifier from the Agent Search endpoint. Zillow no longer exposes the total number of sales, coordinates or extra photo sizes for these sales, so those fields are null.", "operationId": "realtime_zillow_data__get__agent_properties_sold", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing parameter descriptions and response schema details." ], "pages": [ 1 ], "sourceId": "sds__1fiQu9RHG0jaOVImz_2s", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/agent_id", "/description", "/operationId" ], "revisionId": "sdrn_fMzoiFNl9X0S__Sj10MeV" }, { "gaps": [ "Missing detailed schema for response body" ], "pages": [ 1 ], "sourceId": "sds_1IfgtOxqP1q4cHvJ7VyPY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/agent_id", "/description", "/operationId" ], "revisionId": "sdrn_mb4oPKVX4C1sgk5EHzdxz" }, { "gaps": [ "Missing response schema details" ], "pages": [ 1 ], "sourceId": "sds_5fumgq7Dew7p7p505C6Vj", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/agent_id", "/description", "/operationId" ], "revisionId": "sdrn_UDnMGDO2AU7l2pD7FR4rR" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_5hlhZJYspBPaHxKN7OhqJ", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_3lrPg3Nc0kbMzAAAdVFHe" }, { "gaps": [ "Missing schema details for response body" ], "pages": [ 1 ], "sourceId": "sds_AtF5v_vXxTbq1wWfTbZ8p", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/agent_id", "/description", "/operationId" ], "revisionId": "sdrn_xtbL3_JhQnAYS_6AQGDiQ" }, { "gaps": [ "Missing schema details for response body" ], "pages": [ 1 ], "sourceId": "sds_FK2maa1cDe4qcElj5U3zU", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/agent_id", "/description", "/operationId" ], "revisionId": "sdrn_gZ-rMsS0AnYbgxe2iW2Nm" }, { "gaps": [ "Missing detailed parameter schema for agent_id and response structure." ], "pages": [ 1 ], "sourceId": "sds_kNNDQzbHD8UafUY8VU2At", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/agent_id", "/description", "/operationId" ], "revisionId": "sdrn_CFRFpZthk-T-EyPrsqzIj" }, { "gaps": [ "Missing detailed schema for response body" ], "pages": [ 1 ], "sourceId": "sds_MeUfdaSf30qGBbwR2_Van", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/agent_id", "/description", "/operationId" ], "revisionId": "sdrn_DgUH3wi-28BNw0nONekhu" }, { "gaps": [ "Missing parameter details and response schema" ], "pages": [], "sourceId": "sds_ROjpin-1soeCivIbZLub5", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/agent_id", "/description", "/operationId" ], "revisionId": "sdrn_WrJX2U_i26_CRY3Hi0cz4" }, { "gaps": [ "Missing explicit parameter definitions in documentation" ], "pages": [], "sourceId": "sds_soxpzUWt2CLoTKLGBZfNb", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/agent_id", "/description", "/operationId" ], "revisionId": "sdrn_3H-1br_3SJ3ASZfGOL5Yr" }, { "gaps": [ "Missing explicit parameter definitions in documentation" ], "pages": [], "sourceId": "sds_uqg4RBYIA1YERc8Rjc_2c", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/agent_id", "/description", "/operationId" ], "revisionId": "sdrn_cPgV56wkqJydCcYz3mJU2" }, { "gaps": [ "Missing parameter details for agent_id", "Missing response schema" ], "pages": [], "sourceId": "sds_y_pAgcC-xJrVMI2TjrXI0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/agent_id", "/description", "/operationId" ], "revisionId": "sdrn_58jSAkKvEcC3bWRtd9F4t" } ], "x-zeroclick-services": [ "realtime-zillow-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-zillow-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-zillow-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-zillow-data/agent-search": { "get": { "summary": "Agent Search", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "agents": { "type": "array", "items": { "type": "object", "properties": { "tags": { "type": "array", "items": { "type": "object" }, "description": "Tags shown on the agent card." }, "imageUrl": { "type": "string", "description": "Agent profile photo URL" }, "cardTitle": { "type": "string", "description": "Agent name" }, "isTopAgent": { "type": "boolean", "description": "Whether the agent is a Zillow top agent" }, "encodedZuid": { "type": "string", "description": "Unique agent identifier — use this with the agent listing endpoints" }, "profileData": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "formattedData": { "type": "string" } } }, "description": "Agent stats (price range, sales count, etc.)" }, "cardActionLink": { "type": "string", "description": "Agent profile URL on Zillow" }, "reviewInformation": { "type": "object", "properties": { "reviewAverage": { "type": "number" }, "reviewAverageText": { "type": "string" }, "reviewCountFormattedText": { "type": "string" } }, "description": "Review ratings" }, "secondaryCardTitle": { "type": "string", "description": "Brokerage or company name" } } }, "description": "Array of agent profile cards" }, "total_agents": { "type": "integer", "description": "Total number of agents matching the search" } } }, "status": { "type": "string" }, "parameters": { "type": "object", "properties": { "name": { "type": "string" }, "page": { "type": "integer" }, "location": { "type": "string" } } }, "request_id": { "type": "string" } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "location", "schema": { "type": "string", "example": "new-york-ny", "description": "Location slug for the agent search (city-state format, e.g. `new-york-ny`, `los-angeles-ca`, `miami-fl`)." }, "example": "new-york-ny", "required": true }, { "in": "query", "name": "name", "schema": { "type": "string", "description": "Filter agents by name." } }, { "in": "query", "name": "page", "schema": { "type": "number", "default": 1, "minimum": 1, "description": "Page number for paginated results. Each page returns up to 15 agents." } } ], "description": "Search for real estate agents by location and optionally by name. Returns agent profiles with review ratings, sales data, brokerage info, and an `encodedZuid` identifier that can be used with the agent listing endpoints.", "operationId": "realtime_zillow_data__get__agent_search", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing parameter descriptions and response schema details." ], "pages": [ 1 ], "sourceId": "sds__1fiQu9RHG0jaOVImz_2s", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/parameters/query/query", "/description", "/operationId" ], "revisionId": "sdrn_fMzoiFNl9X0S__Sj10MeV" }, { "gaps": [ "Missing detailed schema for response body" ], "pages": [ 1 ], "sourceId": "sds_1IfgtOxqP1q4cHvJ7VyPY", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/parameters/query/query", "/description", "/operationId" ], "revisionId": "sdrn_mb4oPKVX4C1sgk5EHzdxz" }, { "gaps": [ "Missing response schema details" ], "pages": [ 1 ], "sourceId": "sds_5fumgq7Dew7p7p505C6Vj", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/parameters/query/query", "/description", "/operationId" ], "revisionId": "sdrn_UDnMGDO2AU7l2pD7FR4rR" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_5hlhZJYspBPaHxKN7OhqJ", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_3lrPg3Nc0kbMzAAAdVFHe" }, { "gaps": [ "Missing schema details for response body" ], "pages": [ 1 ], "sourceId": "sds_AtF5v_vXxTbq1wWfTbZ8p", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/query", "/description", "/operationId" ], "revisionId": "sdrn_xtbL3_JhQnAYS_6AQGDiQ" }, { "gaps": [ "Missing schema details for response body" ], "pages": [ 1 ], "sourceId": "sds_FK2maa1cDe4qcElj5U3zU", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/parameters/query/query", "/description", "/operationId" ], "revisionId": "sdrn_gZ-rMsS0AnYbgxe2iW2Nm" }, { "gaps": [ "Missing detailed parameter schema for query and response structure." ], "pages": [ 1 ], "sourceId": "sds_kNNDQzbHD8UafUY8VU2At", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/parameters/query/query", "/description", "/operationId" ], "revisionId": "sdrn_CFRFpZthk-T-EyPrsqzIj" }, { "gaps": [ "Missing detailed schema for response body" ], "pages": [ 1 ], "sourceId": "sds_MeUfdaSf30qGBbwR2_Van", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/parameters/query/query", "/description", "/operationId" ], "revisionId": "sdrn_DgUH3wi-28BNw0nONekhu" }, { "gaps": [ "Missing parameter details and response schema" ], "pages": [], "sourceId": "sds_ROjpin-1soeCivIbZLub5", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/parameters/query/query", "/description", "/operationId" ], "revisionId": "sdrn_WrJX2U_i26_CRY3Hi0cz4" }, { "gaps": [ "Missing explicit parameter definitions in documentation" ], "pages": [], "sourceId": "sds_soxpzUWt2CLoTKLGBZfNb", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/parameters/query/query", "/description", "/operationId" ], "revisionId": "sdrn_3H-1br_3SJ3ASZfGOL5Yr" }, { "gaps": [ "Missing explicit parameter definitions in documentation" ], "pages": [], "sourceId": "sds_uqg4RBYIA1YERc8Rjc_2c", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/parameters/query/query", "/description", "/operationId" ], "revisionId": "sdrn_cPgV56wkqJydCcYz3mJU2" }, { "gaps": [ "Missing parameter details for query", "Missing response schema" ], "pages": [], "sourceId": "sds_y_pAgcC-xJrVMI2TjrXI0", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/parameters/query/query", "/description", "/operationId" ], "revisionId": "sdrn_58jSAkKvEcC3bWRtd9F4t" } ], "x-zeroclick-services": [ "realtime-zillow-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-zillow-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-zillow-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-zillow-data/property-details": { "get": { "summary": "Property Details", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "city": { "type": "string", "description": "City where property is located" }, "zpid": { "type": "integer", "description": "Zillow Property ID" }, "price": { "type": "integer", "description": "Listing price in cents" }, "state": { "type": "string", "description": "State where property is located" }, "lotSize": { "type": "integer", "description": "Lot size in square feet" }, "zipcode": { "type": "string", "description": "Property zipcode" }, "bedrooms": { "type": "integer", "description": "Number of bedrooms" }, "currency": { "type": "string", "description": "Currency for price values" }, "homeType": { "type": "string", "description": "Type of property" }, "latitude": { "type": "number", "description": "Geographic latitude coordinate" }, "bathrooms": { "type": "integer", "description": "Number of bathrooms" }, "longitude": { "type": "number", "description": "Geographic longitude coordinate" }, "yearBuilt": { "type": "integer", "description": "Year the property was built" }, "zestimate": { "type": "integer", "description": "Zillow's estimated value in cents" }, "homeStatus": { "type": "string", "description": "Current status of the property" }, "livingArea": { "type": "integer", "description": "Square footage of living area" }, "photoCount": { "type": "integer", "description": "Number of photos available" }, "daysOnZillow": { "type": "integer", "description": "Days the listing has been on Zillow" }, "pageViewCount": { "type": "integer", "description": "Number of times listing was viewed" }, "rentZestimate": { "type": "integer", "description": "Zillow's estimated rental value in cents" }, "streetAddress": { "type": "string", "description": "Full street address" }, "listingDataSource": { "type": "string", "description": "Source of the listing data" } } }, "status": { "type": "string", "description": "Status of the API response" }, "parameters": { "type": "object", "properties": { "zpid": { "type": "string", "description": "Zillow Property ID" } } }, "request_id": { "type": "string", "description": "Unique identifier for the API request" } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "zpid", "schema": { "type": "string", "description": "A unique identifier assigned by Zillow to each property. \n It can be extracted from the search endpoints (e.g. /search, /search-coordinates) or from a Zillow property URL. \n The zpid is essential for fetching specific property details." }, "example": "52830624", "required": true }, { "in": "query", "name": "url", "schema": { "type": "string", "description": "The url of the property's Zillow listing page. \n This provides a direct link to view the property details on Zillow's website, usually containing the zpid within the URL structure." } } ], "description": "Get detailed information about a property by Zillow unique property ID (zpid) or a Zillow url of a property. \n This endpoint gives access to many details like square footage, number of bedrooms, bathrooms, and more, ensuring users get comprehensive property insights.", "operationId": "realtime_zillow_data__get__property_details", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing parameter descriptions and response schema details." ], "pages": [ 1 ], "sourceId": "sds__1fiQu9RHG0jaOVImz_2s", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/parameters/query/property_id", "/description", "/operationId" ], "revisionId": "sdrn_fMzoiFNl9X0S__Sj10MeV" }, { "gaps": [ "Missing detailed schema for response body" ], "pages": [ 1 ], "sourceId": "sds_1IfgtOxqP1q4cHvJ7VyPY", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/parameters/query/property_id", "/description", "/operationId" ], "revisionId": "sdrn_mb4oPKVX4C1sgk5EHzdxz" }, { "gaps": [ "Missing response schema details" ], "pages": [ 1 ], "sourceId": "sds_5fumgq7Dew7p7p505C6Vj", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/parameters/query/property_id", "/description", "/operationId" ], "revisionId": "sdrn_UDnMGDO2AU7l2pD7FR4rR" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_5hlhZJYspBPaHxKN7OhqJ", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_3lrPg3Nc0kbMzAAAdVFHe" }, { "gaps": [ "Missing schema details for response body" ], "pages": [ 1 ], "sourceId": "sds_AtF5v_vXxTbq1wWfTbZ8p", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/property_id", "/description", "/operationId" ], "revisionId": "sdrn_xtbL3_JhQnAYS_6AQGDiQ" }, { "gaps": [ "Missing schema details for response body" ], "pages": [ 1 ], "sourceId": "sds_FK2maa1cDe4qcElj5U3zU", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/parameters/query/property_id", "/description", "/operationId" ], "revisionId": "sdrn_gZ-rMsS0AnYbgxe2iW2Nm" }, { "gaps": [ "Missing detailed parameter schema for property_id and response structure." ], "pages": [ 1 ], "sourceId": "sds_kNNDQzbHD8UafUY8VU2At", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/parameters/query/property_id", "/description", "/operationId" ], "revisionId": "sdrn_CFRFpZthk-T-EyPrsqzIj" }, { "gaps": [ "Missing detailed schema for response body" ], "pages": [ 1 ], "sourceId": "sds_MeUfdaSf30qGBbwR2_Van", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/parameters/query/property_id", "/description", "/operationId" ], "revisionId": "sdrn_DgUH3wi-28BNw0nONekhu" }, { "gaps": [ "Missing parameter details and response schema" ], "pages": [], "sourceId": "sds_ROjpin-1soeCivIbZLub5", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/parameters/query/property_id", "/description", "/operationId" ], "revisionId": "sdrn_WrJX2U_i26_CRY3Hi0cz4" }, { "gaps": [ "Missing explicit parameter definitions in documentation" ], "pages": [], "sourceId": "sds_soxpzUWt2CLoTKLGBZfNb", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/parameters/query/property_id", "/description", "/operationId" ], "revisionId": "sdrn_3H-1br_3SJ3ASZfGOL5Yr" }, { "gaps": [ "Missing explicit parameter definitions in documentation" ], "pages": [], "sourceId": "sds_uqg4RBYIA1YERc8Rjc_2c", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/parameters/query/property_id", "/description", "/operationId" ], "revisionId": "sdrn_cPgV56wkqJydCcYz3mJU2" }, { "gaps": [ "Missing parameter details for property_id", "Missing response schema" ], "pages": [], "sourceId": "sds_y_pAgcC-xJrVMI2TjrXI0", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/parameters/query/property_id", "/description", "/operationId" ], "revisionId": "sdrn_58jSAkKvEcC3bWRtd9F4t" } ], "x-zeroclick-services": [ "realtime-zillow-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-zillow-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-zillow-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-zillow-data/property-details-address": { "get": { "summary": "Property by Address", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "city": { "type": "string", "description": "City where the property is located" }, "zpid": { "type": "integer", "description": "Zillow property ID" }, "price": { "type": "integer", "description": "Listing price of the property" }, "state": { "type": "string", "description": "State where the property is located" }, "cityId": { "type": "integer", "description": "Internal ID representing the city" }, "county": { "type": "string", "description": "County where the property is located" }, "hdpUrl": { "type": "string", "description": "URL path to the home details page" }, "country": { "type": "string", "description": "Country where the property is located" }, "zipcode": { "type": "string", "description": "ZIP code of the property" }, "bedrooms": { "type": "integer", "description": "Number of bedrooms in the property" }, "homeType": { "type": "string", "description": "Type of home, e.g., SingleFamily, Condo, etc." }, "bathrooms": { "type": "integer", "description": "Number of bathrooms in the property" }, "yearBuilt": { "type": "integer", "description": "Year the property was built" }, "homeStatus": { "type": "string", "description": "Current listing status of the home" }, "streetAddress": { "type": "string", "description": "Street address of the property" }, "isPremierBuilder": { "type": "boolean", "description": "Indicates if the listing is from a premier builder" }, "isShowcaseListing": { "type": "boolean", "description": "Indicates if the listing is a showcase listing" }, "listingDataSource": { "type": "string", "description": "Source of the listing data" }, "providerListingID": { "type": "string", "description": "Listing ID provided by the data source" }, "abbreviatedAddress": { "type": "string", "description": "Shortened version of the address" }, "isUndisclosedAddress": { "type": "boolean", "description": "Whether the address of the listing is undisclosed" }, "isRentalListingOffMarket": { "type": "boolean", "description": "Indicates if a rental listing is off the market" }, "isCurrentSignedInAgentResponsible": { "type": "boolean", "description": "Whether the current signed-in agent is responsible for the listing" }, "isCurrentSignedInUserVerifiedOwner": { "type": "boolean", "description": "Whether the user is a verified owner of the property" }, "isListingClaimedByCurrentSignedInUser": { "type": "boolean", "description": "Whether the listing is claimed by the current user" } } }, "status": { "type": "string", "description": "The status of the API response" }, "parameters": { "type": "object", "properties": { "address": { "type": "string", "description": "The address used in the request" } } }, "request_id": { "type": "string", "description": "A unique identifier for the API request" } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "address", "schema": { "type": "string", "example": "1161 Natchez Dr College Station Texas 77845", "description": "Physical address of the property." }, "example": "1161 Natchez Dr College Station Texas 77845", "required": true } ], "description": "Get detailed information about a property by address. \n This endpoint gives access to many details like square footage, number of bedrooms, bathrooms, and more, ensuring users get comprehensive property insights.", "operationId": "realtime_zillow_data__get__property_details_address", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing parameter descriptions and response schema details." ], "pages": [ 1 ], "sourceId": "sds__1fiQu9RHG0jaOVImz_2s", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_fMzoiFNl9X0S__Sj10MeV" }, { "gaps": [ "Missing detailed schema for response body" ], "pages": [ 1 ], "sourceId": "sds_1IfgtOxqP1q4cHvJ7VyPY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_mb4oPKVX4C1sgk5EHzdxz" }, { "gaps": [ "Missing response schema details" ], "pages": [ 1 ], "sourceId": "sds_5fumgq7Dew7p7p505C6Vj", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_UDnMGDO2AU7l2pD7FR4rR" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_5hlhZJYspBPaHxKN7OhqJ", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_3lrPg3Nc0kbMzAAAdVFHe" }, { "gaps": [ "Missing schema details for response body" ], "pages": [ 1 ], "sourceId": "sds_AtF5v_vXxTbq1wWfTbZ8p", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_xtbL3_JhQnAYS_6AQGDiQ" }, { "gaps": [ "Missing schema details for response body" ], "pages": [ 1 ], "sourceId": "sds_FK2maa1cDe4qcElj5U3zU", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_gZ-rMsS0AnYbgxe2iW2Nm" }, { "gaps": [ "Missing detailed parameter schema for address and response structure." ], "pages": [ 1 ], "sourceId": "sds_kNNDQzbHD8UafUY8VU2At", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_CFRFpZthk-T-EyPrsqzIj" }, { "gaps": [ "Missing detailed schema for response body" ], "pages": [ 1 ], "sourceId": "sds_MeUfdaSf30qGBbwR2_Van", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_DgUH3wi-28BNw0nONekhu" }, { "gaps": [ "Missing parameter details and response schema" ], "pages": [], "sourceId": "sds_ROjpin-1soeCivIbZLub5", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_WrJX2U_i26_CRY3Hi0cz4" }, { "gaps": [ "Missing explicit parameter definitions in documentation" ], "pages": [], "sourceId": "sds_soxpzUWt2CLoTKLGBZfNb", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_3H-1br_3SJ3ASZfGOL5Yr" }, { "gaps": [ "Missing explicit parameter definitions in documentation" ], "pages": [], "sourceId": "sds_uqg4RBYIA1YERc8Rjc_2c", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_cPgV56wkqJydCcYz3mJU2" }, { "gaps": [ "Missing parameter details for address", "Missing response schema" ], "pages": [], "sourceId": "sds_y_pAgcC-xJrVMI2TjrXI0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_58jSAkKvEcC3bWRtd9F4t" } ], "x-zeroclick-services": [ "realtime-zillow-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-zillow-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-zillow-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-zillow-data/search": { "get": { "summary": "Search", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "required": [ "zpid", "homeStatus", "detailUrl", "address" ], "properties": { "city": { "type": "string", "nullable": true, "description": "City where the property is located." }, "unit": { "type": "string", "nullable": true, "description": "Unit / apartment number, when applicable." }, "zpid": { "type": "string", "description": "Zillow's unique property identifier." }, "price": { "type": "number", "nullable": true, "description": "Listed price of the property in the displayed currency." }, "state": { "type": "string", "nullable": true, "description": "US state code where the property is located." }, "imgSrc": { "type": "string", "nullable": true, "description": "URL of the primary listing photo." }, "address": { "type": "string", "description": "Full street address of the property." }, "country": { "type": "string", "nullable": true, "description": "Country code of the property." }, "zipcode": { "type": "string", "nullable": true, "description": "ZIP / postal code of the property." }, "bedrooms": { "type": "number", "nullable": true, "description": "Number of bedrooms in the property." }, "currency": { "type": "string", "nullable": true, "description": "ISO 4217 currency code of `price`." }, "hasImage": { "type": "boolean", "nullable": true, "description": "Whether the listing has at least one image." }, "homeType": { "type": "string", "nullable": true, "description": "Property type. Values include SINGLE_FAMILY, CONDO, TOWNHOUSE, MULTI_FAMILY, MANUFACTURED, APARTMENT, LOT, OTHER." }, "latitude": { "type": "number", "nullable": true, "description": "Latitude coordinate of the property." }, "bathrooms": { "type": "number", "nullable": true, "description": "Number of bathrooms in the property." }, "detailUrl": { "type": "string", "description": "Canonical Zillow URL of the property detail page." }, "longitude": { "type": "number", "nullable": true, "description": "Longitude coordinate of the property." }, "openHouse": { "type": "string", "nullable": true, "description": "Open-house schedule label, when applicable." }, "zestimate": { "type": "number", "nullable": true, "description": "Zillow's automated valuation (Zestimate) for the property." }, "brokerName": { "type": "string", "nullable": true, "description": "Listing agent / brokerage name." }, "homeStatus": { "type": "string", "description": "Listing status. Values: FOR_SALE, FOR_RENT, SOLD, PENDING, OTHER." }, "isFeatured": { "type": "boolean", "nullable": true, "description": "Whether the listing is featured / promoted." }, "livingArea": { "type": "number", "nullable": true, "description": "Living area in square feet." }, "lotAreaUnit": { "type": "string", "nullable": true, "description": "Unit for `lotAreaValue`. Typical values: acres, sqft." }, "priceChange": { "type": "number", "nullable": true, "description": "Most recent price change amount (negative for reductions)." }, "daysOnZillow": { "type": "integer", "nullable": true, "description": "Number of days the listing has been on Zillow." }, "lotAreaValue": { "type": "number", "nullable": true, "description": "Lot area value in `lotAreaUnit`." }, "timeOnZillow": { "type": "integer", "nullable": true, "description": "Time the listing has been on Zillow, in milliseconds." }, "isZillowOwned": { "type": "boolean", "nullable": true, "description": "Whether the property is owned by Zillow (Zillow Offers)." }, "rentZestimate": { "type": "number", "nullable": true, "description": "Zillow's automated rent valuation for the property." }, "streetAddress": { "type": "string", "nullable": true, "description": "Street address component of the property." }, "listingSubType": { "type": "object", "nullable": true, "properties": { "is_FSBA": { "type": "boolean", "nullable": true, "description": "For Sale By Agent." }, "is_FSBO": { "type": "boolean", "nullable": true, "description": "For Sale By Owner." }, "is_newHome": { "type": "boolean", "nullable": true, "description": "New construction." }, "is_bankOwned": { "type": "boolean", "nullable": true, "description": "Bank-owned (REO) listing." }, "is_openHouse": { "type": "boolean", "nullable": true, "description": "Has an open house scheduled." }, "is_comingSoon": { "type": "boolean", "nullable": true, "description": "Coming soon listing." }, "is_forAuction": { "type": "boolean", "nullable": true, "description": "Auction listing." }, "is_foreclosure": { "type": "boolean", "nullable": true, "description": "Foreclosure listing." } }, "description": "Flags describing sub-types of the listing (FSBA, FSBO, open house, etc.)." }, "priceReduction": { "type": "string", "nullable": true, "description": "Human-readable price reduction summary (amount and date)." }, "datePriceChanged": { "type": "integer", "nullable": true, "description": "Unix timestamp (milliseconds) when the price was last changed." }, "isPremierBuilder": { "type": "boolean", "nullable": true, "description": "Whether the listing belongs to a premier builder." }, "taxAssessedValue": { "type": "number", "nullable": true, "description": "Most recent tax-assessed value of the property." }, "isShowcaseListing": { "type": "boolean", "nullable": true, "description": "Whether the listing is a Zillow Showcase listing." }, "isNonOwnerOccupied": { "type": "boolean", "nullable": true, "description": "Whether the property is non-owner occupied." }, "isPreforeclosureAuction": { "type": "boolean", "nullable": true, "description": "Whether the property is in a pre-foreclosure auction." } }, "description": "Array of listing objects" }, "description": "Array of listing objects matching the search criteria." }, "status": { "type": "string", "description": "Status of the API response" }, "parameters": { "type": "object", "properties": { "page": { "type": "integer", "description": "Current page number in paginated results" }, "sort": { "type": "string", "description": "Sorting method for results" }, "location": { "type": "string", "description": "Location filter for listings" }, "home_status": { "type": "string", "description": "Status filter for home listings" }, "listing_type": { "type": "string", "description": "Type of property listing" } } }, "request_id": { "type": "string", "description": "Unique identifier for the API request" } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "location", "schema": { "type": "string", "example": "Los Angeles, CA", "description": "Location details (county, neighborhood or zip code). " }, "example": "Los Angeles, CA", "required": true }, { "in": "query", "name": "page", "schema": { "type": "number", "default": 1, "maximum": 100, "minimum": 1, "description": "Page to return (each page includes up to 41 results)." } }, { "in": "query", "name": "home_status", "schema": { "enum": [ "FOR_SALE", "FOR_RENT", "RECENTLY_SOLD" ], "type": "string", "default": "FOR_SALE" }, "description": "Filters properties based on their status." }, { "in": "query", "name": "home_type", "schema": { "type": "string", "description": "Filters by comma-separated list of property types (leave empty to include all types):\n\n **Allowed values for** FOR_SALE and RECENTLY_SOLD: \n `HOUSES` \n `TOWNHOMES` \n `MULTI_FAMILY` \n `CONDOS_COOPS` \n `LOTSLAND` \n `APARTMENTS` \n `MANUFACTURED`\n\n **Allowed values for** FOR_RENT: \n `HOUSES` \n `APARTMENTS_CONDOS_COOPS` \n `TOWNHOMES` " } }, { "in": "query", "name": "space_type", "schema": { "type": "string" }, "description": "Find properties with specified space type (works for FOR_RENT home_status type), specified as a comma separated list of the following values: `ENTIRE_PLACE`, `ROOM`." }, { "in": "query", "name": "sort", "schema": { "type": "string", "default": "DEFAULT", "description": "Return the results in a specific sort order. \n\n **Allowed values for** FOR_SALE and RECENTLY_SOLD: \n `DEFAULT` \n `PRICE_HIGH_LOW` \n `PRICE_LOW_HIGH` \n `NEWEST` \n `BEDROOMS` \n `BATHROOMS` \n `SQUARE_FEET` \n `LOT_SIZE` \n \n **Allowed values for** FOR_RENT: \n `DEFAULT` \n `VERIFIED_SOURCE` \n `PRICE_HIGH_LOW` \n `PRICE_LOW_HIGH` \n `NEWEST` \n `BEDROOMS` \n `BATHROOMS` \n `SQUARE_FEET` \n `LOT_SIZE`\n\n **Note:** For other status types `DEFAULT` sort order is the equivalent of Homes for you." } }, { "in": "query", "name": "min_price", "schema": { "type": "number", "description": "Sets the minimum price for properties in the search results." } }, { "in": "query", "name": "max_price", "schema": { "type": "number", "description": "Sets the maximum price for properties in the search results." } }, { "in": "query", "name": "min_monthly_payment", "schema": { "type": "number", "description": "Sets the minimum monthly payment for properties in the search results (only for FOR_SALE). \n Includes estimated principal and interest, mortgage insurance, property taxes, home insurance and HOA fees." } }, { "in": "query", "name": "max_monthly_payment", "schema": { "type": "number", "description": "Sets the maxium monthly payment for properties in the search results (only for FOR_SALE). \n Includes estimated principal and interest, mortgage insurance, property taxes, home insurance and HOA fees." } }, { "in": "query", "name": "min_bedrooms", "schema": { "type": "number", "description": "Filters properties by a minimum number of bedrooms." } }, { "in": "query", "name": "max_bedrooms", "schema": { "type": "number", "description": "Filters properties by a maximum number of bedrooms." } }, { "in": "query", "name": "min_bathrooms", "schema": { "type": "number", "description": "Filters properties by a minimum number of bathrooms." } }, { "in": "query", "name": "max_bathrooms", "schema": { "type": "number", "description": "Filters properties by a maximum number of bathrooms." } }, { "in": "query", "name": "min_sqft", "schema": { "type": "number", "description": "Sets the minimum square footage for properties." } }, { "in": "query", "name": "max_sqft", "schema": { "type": "number", "description": "Sets the maximum square footage for properties." } }, { "in": "query", "name": "min_lot_size", "schema": { "type": "number" }, "description": "Sets the minimum lot size for properties (in square feet)." }, { "in": "query", "name": "max_lot_size", "schema": { "type": "number" }, "description": "Sets the minimum lot size for properties (in square feet)." }, { "in": "query", "name": "listing_type", "schema": { "type": "string", "default": "BY_AGENT" }, "description": "Listing type of the property. (`BY_OWNER_OTHER` is for off market properties)." }, { "in": "query", "name": "for_sale_by_agent", "schema": { "type": "boolean", "default": true, "description": "Filters properties listed by real estate agents." } }, { "in": "query", "name": "for_sale_by_owner", "schema": { "type": "boolean", "default": true, "description": "Filters properties listed by the owner directly. \n\n **Note:** works only for listing_type `BY_OWNER_OTHER`." } }, { "in": "query", "name": "for_sale_is_new_construction", "schema": { "type": "boolean", "default": true, "description": "Filters for new construction properties." } }, { "in": "query", "name": "for_sale_is_foreclosure", "schema": { "type": "boolean", "default": true, "description": "Filters for properties that are foreclosures. \n These properties are currently listed for sale. \n They are owned by a bank or a lender who took ownership through foreclosure proceedings. \n These are also known as bank-owned or real estate owned (REO)." } }, { "in": "query", "name": "for_sale_is_auction", "schema": { "type": "boolean", "default": true, "description": "Filters for properties that are for sale at auction." } }, { "in": "query", "name": "for_sale_is_foreclosed", "schema": { "type": "boolean", "default": false, "description": "Filters for properties which had been foreclosed. \n These properties are owned by a bank or a lender who took ownership through foreclosure proceedings. \n They may soon be listed for sale." } }, { "in": "query", "name": "for_sale_is_preforeclosure", "schema": { "type": "boolean", "default": false, "description": "Filters for properties in pre-market foreclosure status. \n The lender initiated foreclosure proceedings on these properties because the owner(s) were in default on their loan obligations. \n Pre-foreclosures also include properties for which a foreclosure auction is scheduled." } }, { "in": "query", "name": "max_hoa_fee", "schema": { "type": "number", "default": "ANY FEE", "description": "Sets the maximum Homeowners Association (HOA) fee for properties (0 - no hoa fee)." } }, { "in": "query", "name": "includes_homes_no_hoa_data", "schema": { "type": "boolean", "default": true, "description": "Include homes with incomplete HOA data." } } ], "description": "Search for properties by location (county, neighborhood, city, or zip code) with support for the filters and options available on Zillow.com.", "operationId": "realtime_zillow_data__get__search", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing parameter descriptions and response schema details." ], "pages": [ 1 ], "sourceId": "sds__1fiQu9RHG0jaOVImz_2s", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/query", "/description", "/operationId" ], "revisionId": "sdrn_fMzoiFNl9X0S__Sj10MeV" }, { "gaps": [ "Missing detailed schema for response body" ], "pages": [ 1 ], "sourceId": "sds_1IfgtOxqP1q4cHvJ7VyPY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/query", "/description", "/operationId" ], "revisionId": "sdrn_mb4oPKVX4C1sgk5EHzdxz" }, { "gaps": [ "Missing response schema details" ], "pages": [ 1 ], "sourceId": "sds_5fumgq7Dew7p7p505C6Vj", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/query", "/description", "/operationId" ], "revisionId": "sdrn_UDnMGDO2AU7l2pD7FR4rR" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_5hlhZJYspBPaHxKN7OhqJ", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_3lrPg3Nc0kbMzAAAdVFHe" }, { "gaps": [ "Missing schema details for response body" ], "pages": [ 1 ], "sourceId": "sds_AtF5v_vXxTbq1wWfTbZ8p", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/query", "/description", "/operationId" ], "revisionId": "sdrn_xtbL3_JhQnAYS_6AQGDiQ" }, { "gaps": [ "Missing schema details for response body" ], "pages": [ 1 ], "sourceId": "sds_FK2maa1cDe4qcElj5U3zU", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/query", "/description", "/operationId" ], "revisionId": "sdrn_gZ-rMsS0AnYbgxe2iW2Nm" }, { "gaps": [ "Missing detailed parameter schema for query and response structure." ], "pages": [ 1 ], "sourceId": "sds_kNNDQzbHD8UafUY8VU2At", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/query", "/description", "/operationId" ], "revisionId": "sdrn_CFRFpZthk-T-EyPrsqzIj" }, { "gaps": [ "Missing detailed schema for response body" ], "pages": [ 1 ], "sourceId": "sds_MeUfdaSf30qGBbwR2_Van", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/query", "/description", "/operationId" ], "revisionId": "sdrn_DgUH3wi-28BNw0nONekhu" }, { "gaps": [ "Missing parameter details and response schema" ], "pages": [], "sourceId": "sds_ROjpin-1soeCivIbZLub5", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_WrJX2U_i26_CRY3Hi0cz4" }, { "gaps": [ "Missing explicit parameter definitions in documentation" ], "pages": [], "sourceId": "sds_soxpzUWt2CLoTKLGBZfNb", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_3H-1br_3SJ3ASZfGOL5Yr" }, { "gaps": [ "Missing explicit parameter definitions in documentation" ], "pages": [], "sourceId": "sds_uqg4RBYIA1YERc8Rjc_2c", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/query", "/description", "/operationId" ], "revisionId": "sdrn_cPgV56wkqJydCcYz3mJU2" }, { "gaps": [ "Missing parameter details for query", "Missing response schema" ], "pages": [], "sourceId": "sds_y_pAgcC-xJrVMI2TjrXI0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/query", "/description", "/operationId" ], "revisionId": "sdrn_58jSAkKvEcC3bWRtd9F4t" } ], "x-zeroclick-services": [ "realtime-zillow-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-zillow-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-zillow-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-zillow-data/search-coordinates": { "get": { "summary": "Search by Coordinates", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "required": [ "zpid", "homeStatus", "detailUrl", "address" ], "properties": { "city": { "type": "string", "nullable": true, "description": "City where the property is located." }, "unit": { "type": "string", "nullable": true, "description": "Unit / apartment number, when applicable." }, "zpid": { "type": "string", "description": "Zillow's unique property identifier." }, "price": { "type": "number", "nullable": true, "description": "Listed price of the property in the displayed currency." }, "state": { "type": "string", "nullable": true, "description": "US state code where the property is located." }, "imgSrc": { "type": "string", "nullable": true, "description": "URL of the primary listing photo." }, "address": { "type": "string", "description": "Full street address of the property." }, "country": { "type": "string", "nullable": true, "description": "Country code of the property." }, "zipcode": { "type": "string", "nullable": true, "description": "ZIP / postal code of the property." }, "bedrooms": { "type": "number", "nullable": true, "description": "Number of bedrooms in the property." }, "currency": { "type": "string", "nullable": true, "description": "ISO 4217 currency code of `price`." }, "hasImage": { "type": "boolean", "nullable": true, "description": "Whether the listing has at least one image." }, "homeType": { "type": "string", "nullable": true, "description": "Property type. Values include SINGLE_FAMILY, CONDO, TOWNHOUSE, MULTI_FAMILY, MANUFACTURED, APARTMENT, LOT, OTHER." }, "latitude": { "type": "number", "nullable": true, "description": "Latitude coordinate of the property." }, "bathrooms": { "type": "number", "nullable": true, "description": "Number of bathrooms in the property." }, "detailUrl": { "type": "string", "description": "Canonical Zillow URL of the property detail page." }, "longitude": { "type": "number", "nullable": true, "description": "Longitude coordinate of the property." }, "openHouse": { "type": "string", "nullable": true, "description": "Open-house schedule label, when applicable." }, "zestimate": { "type": "number", "nullable": true, "description": "Zillow's automated valuation (Zestimate) for the property." }, "brokerName": { "type": "string", "nullable": true, "description": "Listing agent / brokerage name." }, "homeStatus": { "type": "string", "description": "Listing status. Values: FOR_SALE, FOR_RENT, SOLD, PENDING, OTHER." }, "isFeatured": { "type": "boolean", "nullable": true, "description": "Whether the listing is featured / promoted." }, "livingArea": { "type": "number", "nullable": true, "description": "Living area in square feet." }, "lotAreaUnit": { "type": "string", "nullable": true, "description": "Unit for `lotAreaValue`. Typical values: acres, sqft." }, "priceChange": { "type": "number", "nullable": true, "description": "Most recent price change amount (negative for reductions)." }, "daysOnZillow": { "type": "integer", "nullable": true, "description": "Number of days the listing has been on Zillow." }, "lotAreaValue": { "type": "number", "nullable": true, "description": "Lot area value in `lotAreaUnit`." }, "timeOnZillow": { "type": "integer", "nullable": true, "description": "Time the listing has been on Zillow, in milliseconds." }, "isZillowOwned": { "type": "boolean", "nullable": true, "description": "Whether the property is owned by Zillow (Zillow Offers)." }, "rentZestimate": { "type": "number", "nullable": true, "description": "Zillow's automated rent valuation for the property." }, "streetAddress": { "type": "string", "nullable": true, "description": "Street address component of the property." }, "listingSubType": { "type": "object", "nullable": true, "properties": { "is_FSBA": { "type": "boolean", "nullable": true, "description": "For Sale By Agent." }, "is_FSBO": { "type": "boolean", "nullable": true, "description": "For Sale By Owner." }, "is_newHome": { "type": "boolean", "nullable": true, "description": "New construction." }, "is_bankOwned": { "type": "boolean", "nullable": true, "description": "Bank-owned (REO) listing." }, "is_openHouse": { "type": "boolean", "nullable": true, "description": "Has an open house scheduled." }, "is_comingSoon": { "type": "boolean", "nullable": true, "description": "Coming soon listing." }, "is_forAuction": { "type": "boolean", "nullable": true, "description": "Auction listing." }, "is_foreclosure": { "type": "boolean", "nullable": true, "description": "Foreclosure listing." } }, "description": "Flags describing sub-types of the listing (FSBA, FSBO, open house, etc.)." }, "priceReduction": { "type": "string", "nullable": true, "description": "Human-readable price reduction summary (amount and date)." }, "datePriceChanged": { "type": "integer", "nullable": true, "description": "Unix timestamp (milliseconds) when the price was last changed." }, "isPremierBuilder": { "type": "boolean", "nullable": true, "description": "Whether the listing belongs to a premier builder." }, "taxAssessedValue": { "type": "number", "nullable": true, "description": "Most recent tax-assessed value of the property." }, "isShowcaseListing": { "type": "boolean", "nullable": true, "description": "Whether the listing is a Zillow Showcase listing." }, "isNonOwnerOccupied": { "type": "boolean", "nullable": true, "description": "Whether the property is non-owner occupied." }, "isPreforeclosureAuction": { "type": "boolean", "nullable": true, "description": "Whether the property is in a pre-foreclosure auction." } }, "description": "Array of property listing objects" }, "description": "Array of property listing objects within the requested coordinate radius." }, "status": { "type": "string", "description": "Status of the API response" }, "parameters": { "type": "object", "properties": { "lat": { "type": "number", "description": "Latitude coordinate for location search" }, "long": { "type": "number", "description": "Longitude coordinate for location search" }, "page": { "type": "integer", "description": "Current page number in paginated results" }, "sort": { "type": "string", "description": "Sort order for results" }, "diameter": { "type": "number", "description": "Search radius in miles from coordinates" }, "home_status": { "type": "string", "description": "Status of properties to include" }, "listing_type": { "type": "string", "description": "Type of property listings" } } }, "request_id": { "type": "string", "description": "Unique identifier for the API request" } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "long", "schema": { "type": "number", "example": "-118.504744", "description": "Specifies geographic longitude of the area center point for the property search." }, "example": "-118.504744", "required": true }, { "in": "query", "name": "lat", "schema": { "type": "number", "example": "34.01822", "description": "Specifies geographic latitude of the area center point for the property search." }, "example": "34.01822", "required": true }, { "in": "query", "name": "diameter", "schema": { "type": "number", "default": 1, "maximum": 100, "minimum": 1, "description": "Diameter in miles for the search area around center point defined by long, lat." } }, { "in": "query", "name": "page", "schema": { "type": "number", "default": 1, "maximum": 100, "minimum": 1, "description": "Page to return (each page includes up to 41 results)." } }, { "in": "query", "name": "home_status", "schema": { "enum": [ "FOR_SALE", "FOR_RENT", "RECENTLY_SOLD" ], "type": "string", "default": "FOR_SALE" }, "description": "Filters properties based on their status." }, { "in": "query", "name": "home_type", "schema": { "type": "string", "description": "Filters by comma-separated list of property types (leave empty to include all types):\n\n **Allowed values for** FOR_SALE and RECENTLY_SOLD: \n `HOUSES` \n `TOWNHOMES` \n `MULTI_FAMILY` \n `CONDOS_COOPS` \n `LOTSLAND` \n `APARTMENTS` \n `MANUFACTURED`\n\n **Allowed values for** FOR_RENT: \n `HOUSES` \n `APARTMENTS_CONDOS_COOPS` \n `TOWNHOMES` " } }, { "in": "query", "name": "space_type", "schema": { "type": "string" }, "description": "Find properties with specified space type (works for FOR_RENT home_status type), specified as a comma separated list of the following values: `ENTIRE_PLACE`, `ROOM`." }, { "in": "query", "name": "sort", "schema": { "type": "string", "default": "DEFAULT", "description": "Return the results in a specific sort order. \n\n **Allowed values for** FOR_SALE and RECENTLY_SOLD: \n `DEFAULT` \n `PRICE_HIGH_LOW` \n `PRICE_LOW_HIGH` \n `NEWEST` \n `BEDROOMS` \n `BATHROOMS` \n `SQUARE_FEET` \n `LOT_SIZE` \n \n **Allowed values for** FOR_RENT: \n `DEFAULT` \n `VERIFIED_SOURCE` \n `PRICE_HIGH_LOW` \n `PRICE_LOW_HIGH` \n `NEWEST` \n `BEDROOMS` \n `BATHROOMS` \n `SQUARE_FEET` \n `LOT_SIZE`\n\n **Note:** For other status types `DEFAULT` sort order is the equivalent of Homes for you." } }, { "in": "query", "name": "min_price", "schema": { "type": "number", "description": "Sets the minimum price for properties in the search results." } }, { "in": "query", "name": "max_price", "schema": { "type": "number", "description": "Sets the maximum price for properties in the search results." } }, { "in": "query", "name": "min_monthly_payment", "schema": { "type": "number", "description": "Sets the minimum monthly payment for properties in the search results (only for FOR_SALE). \n Includes estimated principal and interest, mortgage insurance, property taxes, home insurance and HOA fees." } }, { "in": "query", "name": "max_monthly_payment", "schema": { "type": "number", "description": "Sets the maxium monthly payment for properties in the search results (only for FOR_SALE). \n Includes estimated principal and interest, mortgage insurance, property taxes, home insurance and HOA fees." } }, { "in": "query", "name": "min_bedrooms", "schema": { "type": "number", "description": "Filters properties by a minimum number of bedrooms." } }, { "in": "query", "name": "max_bedrooms", "schema": { "type": "number", "description": "Filters properties by a maximum number of bedrooms." } }, { "in": "query", "name": "min_bathrooms", "schema": { "type": "number", "description": "Filters properties by a minimum number of bathrooms." } }, { "in": "query", "name": "max_bathrooms", "schema": { "type": "number", "description": "Filters properties by a maximum number of bathrooms." } }, { "in": "query", "name": "min_sqft", "schema": { "type": "number", "description": "Sets the minimum square footage for properties." } }, { "in": "query", "name": "max_sqft", "schema": { "type": "number", "description": "Sets the maximum square footage for properties." } }, { "in": "query", "name": "min_lot_size", "schema": { "type": "number" }, "description": "Sets the minimum lot size for properties (in square feet)." }, { "in": "query", "name": "max_lot_size", "schema": { "type": "number" }, "description": "Sets the minimum lot size for properties (in square feet)." }, { "in": "query", "name": "listing_type", "schema": { "type": "string", "default": "BY_AGENT" }, "description": "Listing type of the property. (`BY_OWNER_OTHER` is for off market properties)." }, { "in": "query", "name": "for_sale_by_agent", "schema": { "type": "boolean", "default": true, "description": "Filters properties listed by real estate agents." } }, { "in": "query", "name": "for_sale_by_owner", "schema": { "type": "boolean", "default": true, "description": "Filters properties listed by the owner directly. \n\n **Note:** works only for listing_type `BY_OWNER_OTHER`." } }, { "in": "query", "name": "for_sale_is_new_construction", "schema": { "type": "boolean", "default": true, "description": "Filters for new construction properties." } }, { "in": "query", "name": "for_sale_is_foreclosure", "schema": { "type": "boolean", "default": true, "description": "Filters for properties that are foreclosures. \n These properties are currently listed for sale. \n They are owned by a bank or a lender who took ownership through foreclosure proceedings. \n These are also known as bank-owned or real estate owned (REO)." } }, { "in": "query", "name": "for_sale_is_auction", "schema": { "type": "boolean", "default": true, "description": "Filters for properties that are for sale at auction." } }, { "in": "query", "name": "for_sale_is_foreclosed", "schema": { "type": "boolean", "default": false, "description": "Filters for properties which had been foreclosed. \n These properties are owned by a bank or a lender who took ownership through foreclosure proceedings. \n They may soon be listed for sale." } }, { "in": "query", "name": "for_sale_is_preforeclosure", "schema": { "type": "boolean", "default": false, "description": "Filters for properties in pre-market foreclosure status. \n The lender initiated foreclosure proceedings on these properties because the owner(s) were in default on their loan obligations. \n Pre-foreclosures also include properties for which a foreclosure auction is scheduled." } }, { "in": "query", "name": "max_hoa_fee", "schema": { "type": "number", "default": "ANY FEE", "description": "Sets the maximum Homeowners Association (HOA) fee for properties (0 - no hoa fee)." } }, { "in": "query", "name": "includes_homes_no_hoa_data", "schema": { "type": "boolean", "default": true, "description": "Include homes with incomplete HOA data." } } ], "description": "Search for properties in a specific geographic location, by a center latitude, longitude point and a diameter. \n Support all filters and options available on Zillow.com.", "operationId": "realtime_zillow_data__get__search_coordinates", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing parameter descriptions and response schema details." ], "pages": [ 1 ], "sourceId": "sds__1fiQu9RHG0jaOVImz_2s", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/lat/schema/type", "/parameters/query/lng", "/description", "/operationId" ], "revisionId": "sdrn_fMzoiFNl9X0S__Sj10MeV" }, { "gaps": [ "Missing detailed schema for response body" ], "pages": [ 1 ], "sourceId": "sds_1IfgtOxqP1q4cHvJ7VyPY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/lat/schema/type", "/parameters/query/lng", "/description", "/operationId" ], "revisionId": "sdrn_mb4oPKVX4C1sgk5EHzdxz" }, { "gaps": [ "Missing response schema details" ], "pages": [ 1 ], "sourceId": "sds_5fumgq7Dew7p7p505C6Vj", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/lat/schema/type", "/parameters/query/lng", "/description", "/operationId" ], "revisionId": "sdrn_UDnMGDO2AU7l2pD7FR4rR" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_5hlhZJYspBPaHxKN7OhqJ", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_3lrPg3Nc0kbMzAAAdVFHe" }, { "gaps": [ "Missing schema details for response body" ], "pages": [ 1 ], "sourceId": "sds_AtF5v_vXxTbq1wWfTbZ8p", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/lng", "/description", "/operationId" ], "revisionId": "sdrn_xtbL3_JhQnAYS_6AQGDiQ" }, { "gaps": [ "Missing schema details for response body" ], "pages": [ 1 ], "sourceId": "sds_FK2maa1cDe4qcElj5U3zU", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/lng", "/description", "/operationId" ], "revisionId": "sdrn_gZ-rMsS0AnYbgxe2iW2Nm" }, { "gaps": [ "Missing detailed parameter schema for lat/lng and response structure." ], "pages": [ 1 ], "sourceId": "sds_kNNDQzbHD8UafUY8VU2At", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/lat/schema/type", "/parameters/query/lng", "/description", "/operationId" ], "revisionId": "sdrn_CFRFpZthk-T-EyPrsqzIj" }, { "gaps": [ "Missing detailed schema for response body" ], "pages": [ 1 ], "sourceId": "sds_MeUfdaSf30qGBbwR2_Van", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/lng", "/description", "/operationId" ], "revisionId": "sdrn_DgUH3wi-28BNw0nONekhu" }, { "gaps": [ "Missing parameter details and response schema" ], "pages": [], "sourceId": "sds_ROjpin-1soeCivIbZLub5", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/lng", "/description", "/operationId" ], "revisionId": "sdrn_WrJX2U_i26_CRY3Hi0cz4" }, { "gaps": [ "Missing explicit parameter definitions in documentation" ], "pages": [], "sourceId": "sds_soxpzUWt2CLoTKLGBZfNb", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/latitude", "/parameters/query/longitude", "/description", "/operationId" ], "revisionId": "sdrn_3H-1br_3SJ3ASZfGOL5Yr" }, { "gaps": [ "Missing explicit parameter definitions in documentation" ], "pages": [], "sourceId": "sds_uqg4RBYIA1YERc8Rjc_2c", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/lng", "/description", "/operationId" ], "revisionId": "sdrn_cPgV56wkqJydCcYz3mJU2" }, { "gaps": [ "Missing parameter details for lat/lng", "Missing response schema" ], "pages": [], "sourceId": "sds_y_pAgcC-xJrVMI2TjrXI0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/lng", "/description", "/operationId" ], "revisionId": "sdrn_58jSAkKvEcC3bWRtd9F4t" } ], "x-zeroclick-services": [ "realtime-zillow-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-zillow-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-zillow-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-zillow-data/search-polygon": { "get": { "summary": "Search by Polygon", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "required": [ "zpid", "homeStatus", "detailUrl", "address" ], "properties": { "city": { "type": "string", "nullable": true, "description": "City where the property is located." }, "unit": { "type": "string", "nullable": true, "description": "Unit / apartment number, when applicable." }, "zpid": { "type": "string", "description": "Zillow's unique property identifier." }, "price": { "type": "number", "nullable": true, "description": "Listed price of the property in the displayed currency." }, "state": { "type": "string", "nullable": true, "description": "US state code where the property is located." }, "imgSrc": { "type": "string", "nullable": true, "description": "URL of the primary listing photo." }, "address": { "type": "string", "description": "Full street address of the property." }, "country": { "type": "string", "nullable": true, "description": "Country code of the property." }, "zipcode": { "type": "string", "nullable": true, "description": "ZIP / postal code of the property." }, "bedrooms": { "type": "number", "nullable": true, "description": "Number of bedrooms in the property." }, "currency": { "type": "string", "nullable": true, "description": "ISO 4217 currency code of `price`." }, "hasImage": { "type": "boolean", "nullable": true, "description": "Whether the listing has at least one image." }, "homeType": { "type": "string", "nullable": true, "description": "Property type. Values include SINGLE_FAMILY, CONDO, TOWNHOUSE, MULTI_FAMILY, MANUFACTURED, APARTMENT, LOT, OTHER." }, "latitude": { "type": "number", "nullable": true, "description": "Latitude coordinate of the property." }, "bathrooms": { "type": "number", "nullable": true, "description": "Number of bathrooms in the property." }, "detailUrl": { "type": "string", "description": "Canonical Zillow URL of the property detail page." }, "longitude": { "type": "number", "nullable": true, "description": "Longitude coordinate of the property." }, "openHouse": { "type": "string", "nullable": true, "description": "Open-house schedule label, when applicable." }, "zestimate": { "type": "number", "nullable": true, "description": "Zillow's automated valuation (Zestimate) for the property." }, "brokerName": { "type": "string", "nullable": true, "description": "Listing agent / brokerage name." }, "homeStatus": { "type": "string", "description": "Listing status. Values: FOR_SALE, FOR_RENT, SOLD, PENDING, OTHER." }, "isFeatured": { "type": "boolean", "nullable": true, "description": "Whether the listing is featured / promoted." }, "livingArea": { "type": "number", "nullable": true, "description": "Living area in square feet." }, "lotAreaUnit": { "type": "string", "nullable": true, "description": "Unit for `lotAreaValue`. Typical values: acres, sqft." }, "priceChange": { "type": "number", "nullable": true, "description": "Most recent price change amount (negative for reductions)." }, "daysOnZillow": { "type": "integer", "nullable": true, "description": "Number of days the listing has been on Zillow." }, "lotAreaValue": { "type": "number", "nullable": true, "description": "Lot area value in `lotAreaUnit`." }, "timeOnZillow": { "type": "integer", "nullable": true, "description": "Time the listing has been on Zillow, in milliseconds." }, "isZillowOwned": { "type": "boolean", "nullable": true, "description": "Whether the property is owned by Zillow (Zillow Offers)." }, "rentZestimate": { "type": "number", "nullable": true, "description": "Zillow's automated rent valuation for the property." }, "streetAddress": { "type": "string", "nullable": true, "description": "Street address component of the property." }, "listingSubType": { "type": "object", "nullable": true, "properties": { "is_FSBA": { "type": "boolean", "nullable": true, "description": "For Sale By Agent." }, "is_FSBO": { "type": "boolean", "nullable": true, "description": "For Sale By Owner." }, "is_newHome": { "type": "boolean", "nullable": true, "description": "New construction." }, "is_bankOwned": { "type": "boolean", "nullable": true, "description": "Bank-owned (REO) listing." }, "is_openHouse": { "type": "boolean", "nullable": true, "description": "Has an open house scheduled." }, "is_comingSoon": { "type": "boolean", "nullable": true, "description": "Coming soon listing." }, "is_forAuction": { "type": "boolean", "nullable": true, "description": "Auction listing." }, "is_foreclosure": { "type": "boolean", "nullable": true, "description": "Foreclosure listing." } }, "description": "Flags describing sub-types of the listing (FSBA, FSBO, open house, etc.)." }, "priceReduction": { "type": "string", "nullable": true, "description": "Human-readable price reduction summary (amount and date)." }, "datePriceChanged": { "type": "integer", "nullable": true, "description": "Unix timestamp (milliseconds) when the price was last changed." }, "isPremierBuilder": { "type": "boolean", "nullable": true, "description": "Whether the listing belongs to a premier builder." }, "taxAssessedValue": { "type": "number", "nullable": true, "description": "Most recent tax-assessed value of the property." }, "isShowcaseListing": { "type": "boolean", "nullable": true, "description": "Whether the listing is a Zillow Showcase listing." }, "isNonOwnerOccupied": { "type": "boolean", "nullable": true, "description": "Whether the property is non-owner occupied." }, "isPreforeclosureAuction": { "type": "boolean", "nullable": true, "description": "Whether the property is in a pre-foreclosure auction." } }, "description": "Array of property listing objects" }, "description": "Array of property listing objects within the requested polygon." }, "status": { "type": "string", "description": "The status of the API response" }, "parameters": { "type": "object", "properties": { "page": { "type": "integer", "description": "Current page number in paginated results" }, "sort": { "type": "string", "description": "How the results should be sorted" }, "polygon": { "type": "string", "description": "Geographic area defined by polygon coordinates" }, "home_status": { "type": "string", "description": "Status of the properties (for sale, sold, etc)" }, "listing_type": { "type": "string", "description": "Type of property listing" } } }, "request_id": { "type": "string", "description": "Unique identifier for the API request" } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "polygon", "schema": { "type": "string", "example": "-118.50394248962402 34.02926010734425, -118.5084056854248 34.02926010734425, -118.51286888122559 34.028691046671696, -118.51527214050293 34.02570341552858, \n -118.51321220397949 34.02257340341831, -118.51750373840332 34.0215774662657, -118.51681709289551 34.017878168811684, -118.51286888122559 34.016455319170184, \n -118.51080894470215 34.013324966013194, -118.50789070129395 34.010621386310234, -118.50411415100098 34.008629219864694, -118.49982261657715 34.008486920473, \n -118.49570274353027 34.007063913440916, -118.4919261932373 34.00891381793271, -118.48849296569824 34.01119056813859, -118.4860897064209 34.014463289606894, \n -118.48471641540527 34.018020452464164, -118.48042488098145 34.01858958468914, -118.4780216217041 34.0215774662657, -118.47939491271973 34.0249920592766, \n -118.47681999206543 34.02797971546417, -118.47493171691895 34.03125178964367, -118.4721851348877 34.034381481654364, -118.47733497619629 34.035377268536706, \n -118.48231315612793 34.035377268536706, -118.48677635192871 34.035377268536706, -118.49141120910645 34.03495050416125, -118.49604606628418 34.034096968969656, \n -118.49621772766113 34.03054047990366, -118.50033760070801 34.02926010734425, -118.50239753723145 34.032532132148006, -118.50394248962402 34.02926010734425", "description": "Defines a custom geographic search area by specifying a series of longitude and latitude coordinates that form a closed shape (polygon). \n Each coordinate pair is longitude first, then latitude (lng lat), separated by a space. Pairs are separated by commas. The polygon is closed automatically if the last pair does not match the first. \n \n **Format:** lng1 lat1,lng2 lat2,lng3 lat3,... \n This allows users to search for properties within complex, non-standard boundaries." }, "example": "-118.50394248962402 34.02926010734425, -118.5084056854248 34.02926010734425, -118.51286888122559 34.028691046671696, -118.51527214050293 34.02570341552858, \n -118.51321220397949 34.02257340341831, -118.51750373840332 34.0215774662657, -118.51681709289551 34.017878168811684, -118.51286888122559 34.016455319170184, \n -118.51080894470215 34.013324966013194, -118.50789070129395 34.010621386310234, -118.50411415100098 34.008629219864694, -118.49982261657715 34.008486920473, \n -118.49570274353027 34.007063913440916, -118.4919261932373 34.00891381793271, -118.48849296569824 34.01119056813859, -118.4860897064209 34.014463289606894, \n -118.48471641540527 34.018020452464164, -118.48042488098145 34.01858958468914, -118.4780216217041 34.0215774662657, -118.47939491271973 34.0249920592766, \n -118.47681999206543 34.02797971546417, -118.47493171691895 34.03125178964367, -118.4721851348877 34.034381481654364, -118.47733497619629 34.035377268536706, \n -118.48231315612793 34.035377268536706, -118.48677635192871 34.035377268536706, -118.49141120910645 34.03495050416125, -118.49604606628418 34.034096968969656, \n -118.49621772766113 34.03054047990366, -118.50033760070801 34.02926010734425, -118.50239753723145 34.032532132148006, -118.50394248962402 34.02926010734425", "required": true }, { "in": "query", "name": "page", "schema": { "type": "number", "default": 1, "maximum": 100, "minimum": 1, "description": "Page to return (each page includes up to 41 results). " } }, { "in": "query", "name": "home_status", "schema": { "enum": [ "FOR_SALE", "FOR_RENT", "RECENTLY_SOLD" ], "type": "string", "default": "FOR_SALE" }, "description": "Filters properties based on their status." }, { "in": "query", "name": "home_type", "schema": { "type": "string", "description": "Filters by comma-separated list of property types (leave empty to include all types):\n\n **Allowed values for** FOR_SALE and RECENTLY_SOLD: \n `HOUSES` \n `TOWNHOMES` \n `MULTI_FAMILY` \n `CONDOS_COOPS` \n `LOTSLAND` \n `APARTMENTS` \n `MANUFACTURED`\n\n **Allowed values for** FOR_RENT: \n `HOUSES` \n `APARTMENTS_CONDOS_COOPS` \n `TOWNHOMES` " } }, { "in": "query", "name": "space_type", "schema": { "type": "string" }, "description": "Find properties with specified space type (works for FOR_RENT home_status type), specified as a comma separated list of the following values: `ENTIRE_PLACE`, `ROOM`." }, { "in": "query", "name": "sort", "schema": { "type": "string", "default": "DEFAULT", "description": "Return the results in a specific sort order. \n\n **Allowed values for** FOR_SALE and RECENTLY_SOLD: \n `DEFAULT` \n `PRICE_HIGH_LOW` \n `PRICE_LOW_HIGH` \n `NEWEST` \n `BEDROOMS` \n `BATHROOMS` \n `SQUARE_FEET` \n `LOT_SIZE` \n \n **Allowed values for** FOR_RENT: \n `DEFAULT` \n `VERIFIED_SOURCE` \n `PRICE_HIGH_LOW` \n `PRICE_LOW_HIGH` \n `NEWEST` \n `BEDROOMS` \n `BATHROOMS` \n `SQUARE_FEET` \n `LOT_SIZE`\n\n **Note:** For other status types `DEFAULT` sort order is the equivalent of Homes for you." } }, { "in": "query", "name": "min_price", "schema": { "type": "number", "description": "Sets the minimum price for properties in the search results." } }, { "in": "query", "name": "max_price", "schema": { "type": "number", "description": "Sets the maximum price for properties in the search results." } }, { "in": "query", "name": "min_monthly_payment", "schema": { "type": "number", "description": "Sets the minimum monthly payment for properties in the search results (only for FOR_SALE). \n Includes estimated principal and interest, mortgage insurance, property taxes, home insurance and HOA fees." } }, { "in": "query", "name": "max_monthly_payment", "schema": { "type": "number", "description": "Sets the maxium monthly payment for properties in the search results (only for FOR_SALE). \n Includes estimated principal and interest, mortgage insurance, property taxes, home insurance and HOA fees." } }, { "in": "query", "name": "min_bedrooms", "schema": { "type": "number", "description": "Filters properties by a minimum number of bedrooms." } }, { "in": "query", "name": "max_bedrooms", "schema": { "type": "number", "description": "Filters properties by a maximum number of bedrooms." } }, { "in": "query", "name": "min_bathrooms", "schema": { "type": "number", "description": "Filters properties by a minimum number of bathrooms." } }, { "in": "query", "name": "max_bathrooms", "schema": { "type": "number", "description": "Filters properties by a maximum number of bathrooms." } }, { "in": "query", "name": "min_sqft", "schema": { "type": "number", "description": "Sets the minimum square footage for properties." } }, { "in": "query", "name": "max_sqft", "schema": { "type": "number", "description": "Sets the maximum square footage for properties." } }, { "in": "query", "name": "min_lot_size", "schema": { "type": "number" }, "description": "Sets the minimum lot size for properties (in square feet)." }, { "in": "query", "name": "max_lot_size", "schema": { "type": "number" }, "description": "Sets the minimum lot size for properties (in square feet)." }, { "in": "query", "name": "listing_type", "schema": { "type": "string", "default": "BY_AGENT" }, "description": "Listing type of the property. (`BY_OWNER_OTHER` is for off market properties)." }, { "in": "query", "name": "for_sale_by_agent", "schema": { "type": "boolean", "default": true, "description": "Filters properties listed by real estate agents." } }, { "in": "query", "name": "for_sale_by_owner", "schema": { "type": "boolean", "default": true, "description": "Filters properties listed by the owner directly. \n\n **Note:** works only for listing_type `BY_OWNER_OTHER`." } }, { "in": "query", "name": "for_sale_is_new_construction", "schema": { "type": "boolean", "default": true, "description": "Filters for new construction properties." } }, { "in": "query", "name": "for_sale_is_foreclosure", "schema": { "type": "boolean", "default": true, "description": "Filters for properties that are foreclosures. \n These properties are currently listed for sale. \n They are owned by a bank or a lender who took ownership through foreclosure proceedings. \n These are also known as bank-owned or real estate owned (REO)." } }, { "in": "query", "name": "for_sale_is_auction", "schema": { "type": "boolean", "default": true, "description": "Filters for properties that are for sale at auction." } }, { "in": "query", "name": "for_sale_is_foreclosed", "schema": { "type": "boolean", "default": false, "description": "Filters for properties which had been foreclosed. \n These properties are owned by a bank or a lender who took ownership through foreclosure proceedings. \n They may soon be listed for sale." } }, { "in": "query", "name": "for_sale_is_preforeclosure", "schema": { "type": "boolean", "default": false, "description": "Filters for properties in pre-market foreclosure status. \n The lender initiated foreclosure proceedings on these properties because the owner(s) were in default on their loan obligations. \n Pre-foreclosures also include properties for which a foreclosure auction is scheduled." } }, { "in": "query", "name": "max_hoa_fee", "schema": { "type": "number", "default": "ANY FEE", "description": "Sets the maximum Homeowners Association (HOA) fee for properties (0 - no hoa fee)." } }, { "in": "query", "name": "includes_homes_no_hoa_data", "schema": { "type": "boolean", "default": true, "description": "Include homes with incomplete HOA data." } } ], "description": "Search for properties in a specific geographic polygon area. \n Perfect for those who need more control over their search boundaries, this feature enables finding properties in complex or non-standard geographic areas. \n Support all filters and options available on Zillow.com.", "operationId": "realtime_zillow_data__get__search_polygon", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing parameter descriptions and response schema details." ], "pages": [ 1 ], "sourceId": "sds__1fiQu9RHG0jaOVImz_2s", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_fMzoiFNl9X0S__Sj10MeV" }, { "gaps": [ "Missing detailed schema for response body" ], "pages": [ 1 ], "sourceId": "sds_1IfgtOxqP1q4cHvJ7VyPY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_mb4oPKVX4C1sgk5EHzdxz" }, { "gaps": [ "Missing response schema details" ], "pages": [ 1 ], "sourceId": "sds_5fumgq7Dew7p7p505C6Vj", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_UDnMGDO2AU7l2pD7FR4rR" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_5hlhZJYspBPaHxKN7OhqJ", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_3lrPg3Nc0kbMzAAAdVFHe" }, { "gaps": [ "Missing schema details for response body" ], "pages": [ 1 ], "sourceId": "sds_AtF5v_vXxTbq1wWfTbZ8p", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_xtbL3_JhQnAYS_6AQGDiQ" }, { "gaps": [ "Missing schema details for response body" ], "pages": [ 1 ], "sourceId": "sds_FK2maa1cDe4qcElj5U3zU", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_gZ-rMsS0AnYbgxe2iW2Nm" }, { "gaps": [ "Missing detailed parameter schema for polygon and response structure." ], "pages": [ 1 ], "sourceId": "sds_kNNDQzbHD8UafUY8VU2At", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_CFRFpZthk-T-EyPrsqzIj" }, { "gaps": [ "Missing detailed schema for response body" ], "pages": [ 1 ], "sourceId": "sds_MeUfdaSf30qGBbwR2_Van", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_DgUH3wi-28BNw0nONekhu" }, { "gaps": [ "Missing parameter details and response schema" ], "pages": [], "sourceId": "sds_ROjpin-1soeCivIbZLub5", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_WrJX2U_i26_CRY3Hi0cz4" }, { "gaps": [ "Missing explicit parameter definitions in documentation" ], "pages": [], "sourceId": "sds_soxpzUWt2CLoTKLGBZfNb", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_3H-1br_3SJ3ASZfGOL5Yr" }, { "gaps": [ "Missing explicit parameter definitions in documentation" ], "pages": [], "sourceId": "sds_uqg4RBYIA1YERc8Rjc_2c", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_cPgV56wkqJydCcYz3mJU2" }, { "gaps": [ "Missing parameter details for polygon", "Missing response schema" ], "pages": [], "sourceId": "sds_y_pAgcC-xJrVMI2TjrXI0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_58jSAkKvEcC3bWRtd9F4t" } ], "x-zeroclick-services": [ "realtime-zillow-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-zillow-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-zillow-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-zillow-data/zestimate": { "get": { "summary": "Property Zestimate", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "zestimate": { "type": "integer", "description": "Estimated market value of the property" } } }, "status": { "type": "string", "description": "The status of the API response" }, "parameters": { "type": "object", "properties": { "zpid": { "type": "string", "description": "Zillow property ID used in the request" } } }, "request_id": { "type": "string", "description": "A unique identifier for the request" } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "zpid", "schema": { "type": "string", "example": "28253016", "description": "A unique identifier assigned by Zillow to each property. \n It can be extracted from the search endpoints (e.g. /search, /search-coordinates) or from a Zillow property URL. \n The zpid is essential for fetching specific property details." }, "example": "28253016", "required": true }, { "in": "query", "name": "url", "schema": { "type": "string", "description": "The url of the property's Zillow listing page. \n This provides a direct link to view the property details on Zillow's website, usually containing the zpid within the URL structure." } } ], "description": "Get Zestimate value for a property by zpid or url. Zillow's estimated market value, which includes both sale and rental price estimates.", "operationId": "realtime_zillow_data__get__zestimate", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing parameter descriptions and response schema details." ], "pages": [ 1 ], "sourceId": "sds__1fiQu9RHG0jaOVImz_2s", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/property_id", "/description", "/operationId" ], "revisionId": "sdrn_fMzoiFNl9X0S__Sj10MeV" }, { "gaps": [ "Missing detailed schema for response body" ], "pages": [ 1 ], "sourceId": "sds_1IfgtOxqP1q4cHvJ7VyPY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/property_id", "/description", "/operationId" ], "revisionId": "sdrn_mb4oPKVX4C1sgk5EHzdxz" }, { "gaps": [ "Missing response schema details" ], "pages": [ 1 ], "sourceId": "sds_5fumgq7Dew7p7p505C6Vj", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/property_id", "/description", "/operationId" ], "revisionId": "sdrn_UDnMGDO2AU7l2pD7FR4rR" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_5hlhZJYspBPaHxKN7OhqJ", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_3lrPg3Nc0kbMzAAAdVFHe" }, { "gaps": [ "Missing schema details for response body" ], "pages": [ 1 ], "sourceId": "sds_AtF5v_vXxTbq1wWfTbZ8p", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/property_id", "/description", "/operationId" ], "revisionId": "sdrn_xtbL3_JhQnAYS_6AQGDiQ" }, { "gaps": [ "Missing schema details for response body" ], "pages": [ 1 ], "sourceId": "sds_FK2maa1cDe4qcElj5U3zU", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/property_id", "/description", "/operationId" ], "revisionId": "sdrn_gZ-rMsS0AnYbgxe2iW2Nm" }, { "gaps": [ "Missing detailed parameter schema for property_id and response structure." ], "pages": [ 1 ], "sourceId": "sds_kNNDQzbHD8UafUY8VU2At", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/property_id", "/description", "/operationId" ], "revisionId": "sdrn_CFRFpZthk-T-EyPrsqzIj" }, { "gaps": [ "Missing detailed schema for response body" ], "pages": [ 1 ], "sourceId": "sds_MeUfdaSf30qGBbwR2_Van", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/property_id", "/description", "/operationId" ], "revisionId": "sdrn_DgUH3wi-28BNw0nONekhu" }, { "gaps": [ "Missing parameter details and response schema" ], "pages": [], "sourceId": "sds_ROjpin-1soeCivIbZLub5", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/property_id", "/description", "/operationId" ], "revisionId": "sdrn_WrJX2U_i26_CRY3Hi0cz4" }, { "gaps": [ "Missing explicit parameter definitions in documentation" ], "pages": [], "sourceId": "sds_soxpzUWt2CLoTKLGBZfNb", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/property_id", "/description", "/operationId" ], "revisionId": "sdrn_3H-1br_3SJ3ASZfGOL5Yr" }, { "gaps": [ "Missing explicit parameter definitions in documentation" ], "pages": [], "sourceId": "sds_uqg4RBYIA1YERc8Rjc_2c", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/property_id", "/description", "/operationId" ], "revisionId": "sdrn_cPgV56wkqJydCcYz3mJU2" }, { "gaps": [ "Missing parameter details for property_id", "Missing response schema" ], "pages": [], "sourceId": "sds_y_pAgcC-xJrVMI2TjrXI0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/property_id", "/description", "/operationId" ], "revisionId": "sdrn_58jSAkKvEcC3bWRtd9F4t" } ], "x-zeroclick-services": [ "realtime-zillow-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-zillow-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-zillow-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-ziprecruiter-data/estimated-salary": { "get": { "summary": "Estimated Salary", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "request_id", "parameters", "data" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_901e1a996e16938b_ref1" }, "description": "Exactly one salary row, in an array, matching the shape of every other\nendpoint on this API and the house `/estimated-salary` contract." }, "status": { "enum": [ "OK" ], "type": "string", "description": "Always `OK` on a successful request." }, "parameters": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_901e1a996e16938b_ref0" }, "request_id": { "type": "string", "description": "Unique id for this request, useful when contacting support." } } } } }, "description": "One salary row for the requested title and scope." }, "400": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_901e1a996e16938b_ref9" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." }, "404": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_901e1a996e16938b_ref13" }, "429": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_901e1a996e16938b_ref14" }, "500": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_901e1a996e16938b_ref15" }, "503": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_901e1a996e16938b_ref16" } }, "parameters": [ { "in": "query", "name": "job_title", "schema": { "type": "string", "example": "Registered Nurse" }, "example": "Registered Nurse", "required": true, "description": "Job title to price, for example `Registered Nurse`. Matched against ZipRecruiter's own\nsalary pages, so a title it does not publish returns a 404 error." }, { "in": "query", "name": "location", "schema": { "type": "string" }, "required": false, "description": "US state, Canadian province or country, spelled out in full, for example `New York` or\n`Alberta`. Two-letter codes and city names return a 400 error: ZipRecruiter publishes\nfigures at state and national level. Omit for the national figure.\n\n**Default:** nationwide" }, { "in": "query", "name": "country", "schema": { "enum": [ "us", "ca" ], "type": "string", "default": "us" }, "required": false, "description": "Country market the figures belong to. Only `us` and `ca` are served.\n\n**Allowed values:** `us`, `ca`\n\n**Default:** `us`" }, { "in": "query", "name": "fields", "schema": { "type": "string" }, "required": false, "description": "Comma-separated projection over the salary row, for example\n`median_salary,salary_period`. `job_title` and `location` are always included. An\nunknown field name returns a 400 error; use the salary row's own field names." } ], "description": "The pay distribution ZipRecruiter publishes for a job title, nationally or in one US state\nor Canadian province. One upstream page, one row.\n\nThe row carries the house `/estimated-salary` contract keys, plus 18 `ziprecruiter_*`\nextras.\n\n**The median is the real median.** ZipRecruiter's own JSON-LD publishes a field labelled\n`median` that is actually the MEAN: it was byte-identical to the page's average on 16 of 16\npages measured, and on Truck Driver it reads 56,348 against a true median of 49,500, which\nis 13.8% high. Every scraper that reads the easy JSON-LD field ships that mean labelled as\na median. `median_salary` here is parsed out of the page's own data layer and is the real\nmedian; ZipRecruiter's figure is carried alongside as `ziprecruiter_json_ld_median` so the\ndifference is auditable in the response itself.\n\n**Figures are always annual** and `salary_period` is always `YEAR`.\nZipRecruiter leads 6 of 11 titles measured with an hourly figure, but its own structured\ndata is annual (`P1Y`) on 13 of 13 pages, including every hourly-preferring title. Driving\nthe row off the page's preference would make `median_salary` mean something different for\nTruck Driver than for Data Scientist. All four frequencies ride along in\n`ziprecruiter_pay_frequencies`, and the page's own preference is preserved as\n`ziprecruiter_preferred_pay_period`.\n\n**What only this source has:** p25 and p75, an 11-bucket salary histogram giving the real\ndistribution, a 59 to 64 row state and province table, the 10 top-paying cities, 5 related\ntitles with pay deltas, all four pay frequencies on one row, the count of open listings\nbehind the figures, the spread level, ZipRecruiter's own summary prose and its generated\nFAQ.\n\n**Coverage is national and state or province level only.** A city returns a 400 error\nbefore any request is made: ZipRecruiter publishes salary pages at state and national\nlevel. `location_type` and `years_of_experience`, which JSearch offers, return a 400 error\nhere.\n\nA title ZipRecruiter has never published, or a title with no figures for the requested\nstate, returns a 404 error. Coverage is decided per title and state pair:\n`Software-Engineer` has an Ontario page, `Truck-Driver` a national page only.\n\n**Billing:** `Requests` counts 1 per call.", "operationId": "realtime_ziprecruiter_data__Estimated_Salary", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing parameter descriptions and response schema details." ], "pages": [ 1 ], "sourceId": "sds__1fiQu9RHG0jaOVImz_2s", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/parameters/query/location/required", "/description", "/operationId" ], "revisionId": "sdrn_fMzoiFNl9X0S__Sj10MeV" }, { "gaps": [ "Missing detailed schema for response body" ], "pages": [ 1 ], "sourceId": "sds_1IfgtOxqP1q4cHvJ7VyPY", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/parameters/query/location/required", "/description", "/operationId" ], "revisionId": "sdrn_mb4oPKVX4C1sgk5EHzdxz" }, { "gaps": [ "Missing explicit parameter definitions in documentation" ], "pages": [], "sourceId": "sds_2mkzMPjBdeReAr1HmDREz", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_c-7MmamthDbtIrwRq96jn" }, { "gaps": [ "Missing response schema details" ], "pages": [ 1 ], "sourceId": "sds_5fumgq7Dew7p7p505C6Vj", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/parameters/query/location/required", "/description", "/operationId" ], "revisionId": "sdrn_UDnMGDO2AU7l2pD7FR4rR" }, { "gaps": [ "Missing explicit parameter definitions in provided text" ], "pages": [], "sourceId": "sds_5hlhZJYspBPaHxKN7OhqJ", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_3lrPg3Nc0kbMzAAAdVFHe" }, { "gaps": [ "Missing schema details for response body" ], "pages": [ 1 ], "sourceId": "sds_AtF5v_vXxTbq1wWfTbZ8p", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/location/required", "/description", "/operationId" ], "revisionId": "sdrn_xtbL3_JhQnAYS_6AQGDiQ" }, { "gaps": [ "Missing schema details for response body" ], "pages": [ 1 ], "sourceId": "sds_FK2maa1cDe4qcElj5U3zU", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/parameters/query/location/required", "/description", "/operationId" ], "revisionId": "sdrn_gZ-rMsS0AnYbgxe2iW2Nm" }, { "gaps": [ "Missing detailed parameter schema for job_title/location and response structure." ], "pages": [ 1 ], "sourceId": "sds_kNNDQzbHD8UafUY8VU2At", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/parameters/query/location/required", "/description", "/operationId" ], "revisionId": "sdrn_CFRFpZthk-T-EyPrsqzIj" }, { "gaps": [ "Missing detailed schema for response body" ], "pages": [ 1 ], "sourceId": "sds_MeUfdaSf30qGBbwR2_Van", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/parameters/query/location/required", "/description", "/operationId" ], "revisionId": "sdrn_DgUH3wi-28BNw0nONekhu" }, { "gaps": [ "Missing parameter details for location and experience level" ], "pages": [ 1 ], "sourceId": "sds_QN3ukfHdtXTOIp_KXoTb_", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_fqMlN4jSZ8jNeUn6Wv8Vq" }, { "gaps": [ "Missing parameter details and response schema" ], "pages": [], "sourceId": "sds_ROjpin-1soeCivIbZLub5", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/parameters/query/location/required", "/description", "/operationId" ], "revisionId": "sdrn_WrJX2U_i26_CRY3Hi0cz4" }, { "gaps": [ "Missing explicit parameter definitions in documentation" ], "pages": [], "sourceId": "sds_soxpzUWt2CLoTKLGBZfNb", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/location/required", "/description", "/operationId" ], "revisionId": "sdrn_3H-1br_3SJ3ASZfGOL5Yr" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_SWPCFBdhQTXC3OrJ98RML", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_bk6BUY0JsF4ImDRAT3nR8" }, { "gaps": [ "Missing explicit parameter definitions in documentation" ], "pages": [], "sourceId": "sds_uqg4RBYIA1YERc8Rjc_2c", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/parameters/query/location/required", "/description", "/operationId" ], "revisionId": "sdrn_cPgV56wkqJydCcYz3mJU2" }, { "gaps": [ "Missing parameter details", "Missing response schema" ], "pages": [], "sourceId": "sds_y_pAgcC-xJrVMI2TjrXI0", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/parameters/query/location/required", "/description", "/operationId" ], "revisionId": "sdrn_58jSAkKvEcC3bWRtd9F4t" }, { "gaps": [ "Missing parameter definitions", "Missing response schema" ], "pages": [ 1 ], "sourceId": "sds_YxKB40zPRwtilOdTUDmjR", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_4Vk_45589KUwJSyCPBwKV" }, { "gaps": [ "Missing parameter definitions and response schema" ], "pages": [ 1 ], "sourceId": "sds_ZS-xdAQ0s8auc1LcI7Ooo", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_7knEBvR-UUuEvVL1C_QLq" } ], "x-zeroclick-services": [ "realtime-ziprecruiter-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-ziprecruiter-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-ziprecruiter-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-ziprecruiter-data/job-details": { "get": { "summary": "Job Details", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "request_id", "parameters", "data" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_6a426ce028a594c8_ref1" }, "description": "The requested jobs, in the order the ids were supplied. An id that does not\nresolve is omitted from the array." }, "status": { "enum": [ "OK" ], "type": "string" }, "parameters": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_6a426ce028a594c8_ref0" }, "request_id": { "type": "string", "description": "Unique id for this request, useful when contacting support." } } } } }, "description": "The requested jobs, in the order the ids were supplied." }, "400": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_6a426ce028a594c8_ref5" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." }, "404": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_6a426ce028a594c8_ref9" }, "429": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_6a426ce028a594c8_ref10" }, "500": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_6a426ce028a594c8_ref11" }, "503": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_6a426ce028a594c8_ref12" } }, "parameters": [ { "in": "query", "name": "job_id", "schema": { "type": "string", "example": "emlwcmVjcnVpdGVyOjkzNjIxNWNiNTAzZDhiZTI" }, "example": "emlwcmVjcnVpdGVyOjkzNjIxNWNiNTAzZDhiZTI", "required": true, "description": "Comma-separated job ids from a `/search` response, up to 20 per request. The raw\n`job_uid` of a previous response is also accepted." }, { "in": "query", "name": "country", "schema": { "enum": [ "us", "ca" ], "type": "string", "default": "us" }, "required": false, "description": "Country market the posting belongs to. Only `us` and `ca` are served.\n\n**Allowed values:** `us`, `ca`\n\n**Default:** `us`" }, { "in": "query", "name": "fields", "schema": { "type": "string" }, "required": false, "description": "Comma-separated projection over the job object, for example\n`job_title,employer_name,job_apply_link`. `job_id` and `job_title` are always included.\nAn unknown field name returns a 400 error." } ], "description": "Full details for up to 20 ZipRecruiter job postings in one call, fetched concurrently.\n\nThis endpoint always reads the detail surface, so the detail-only fields are filled without\nany flag: `job_description` and `ziprecruiter_description_html` at 100%, `job_highlights`\nat 72%, `job_onet_soc`, `ziprecruiter_job_industry` and `ziprecruiter_valid_through` at 73%\n(ZipRecruiter ships JSON-LD on 73% of detail pages), `employer_website` and the company\nwidget fields at 54%, and `employer_reviews` at 14%.\n\nThree fields belong to the search card and are `null` here:\n`ziprecruiter_short_description`, the card teaser; `ziprecruiter_updated_at`,\nZipRecruiter's listing refresh stamp; and `ziprecruiter_is_new`, a card badge.\n\nAn id this API did not mint, or a posting ZipRecruiter has taken down, is omitted from the\narray while the rest of the batch resolves normally. A request made entirely of ids from\nanother job API returns a 200 with an empty array.\n\n**Billing:** `Requests` counts one per requested id, including ids that turn out to be\nforeign, so the cost of a call is predictable before you make it.", "operationId": "realtime_ziprecruiter_data__Job_Details", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing parameter descriptions and response schema details." ], "pages": [ 1 ], "sourceId": "sds__1fiQu9RHG0jaOVImz_2s", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_fMzoiFNl9X0S__Sj10MeV" }, { "gaps": [ "Missing detailed schema for response body" ], "pages": [ 1 ], "sourceId": "sds_1IfgtOxqP1q4cHvJ7VyPY", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_mb4oPKVX4C1sgk5EHzdxz" }, { "gaps": [ "Missing explicit parameter definitions in documentation" ], "pages": [], "sourceId": "sds_2mkzMPjBdeReAr1HmDREz", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_c-7MmamthDbtIrwRq96jn" }, { "gaps": [ "Missing response schema details" ], "pages": [ 1 ], "sourceId": "sds_5fumgq7Dew7p7p505C6Vj", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_UDnMGDO2AU7l2pD7FR4rR" }, { "gaps": [ "Missing explicit parameter definitions in provided text" ], "pages": [], "sourceId": "sds_5hlhZJYspBPaHxKN7OhqJ", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_3lrPg3Nc0kbMzAAAdVFHe" }, { "gaps": [ "Missing schema details for response body" ], "pages": [ 1 ], "sourceId": "sds_AtF5v_vXxTbq1wWfTbZ8p", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_xtbL3_JhQnAYS_6AQGDiQ" }, { "gaps": [ "Missing schema details for response body" ], "pages": [ 1 ], "sourceId": "sds_FK2maa1cDe4qcElj5U3zU", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_gZ-rMsS0AnYbgxe2iW2Nm" }, { "gaps": [ "Missing detailed parameter schema for job_id and response structure." ], "pages": [ 1 ], "sourceId": "sds_kNNDQzbHD8UafUY8VU2At", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_CFRFpZthk-T-EyPrsqzIj" }, { "gaps": [ "Missing detailed schema for response body" ], "pages": [ 1 ], "sourceId": "sds_MeUfdaSf30qGBbwR2_Van", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_DgUH3wi-28BNw0nONekhu" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_QN3ukfHdtXTOIp_KXoTb_", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_fqMlN4jSZ8jNeUn6Wv8Vq" }, { "gaps": [ "Missing parameter details and response schema" ], "pages": [], "sourceId": "sds_ROjpin-1soeCivIbZLub5", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_WrJX2U_i26_CRY3Hi0cz4" }, { "gaps": [ "Missing explicit parameter definitions in documentation" ], "pages": [], "sourceId": "sds_soxpzUWt2CLoTKLGBZfNb", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_3H-1br_3SJ3ASZfGOL5Yr" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_SWPCFBdhQTXC3OrJ98RML", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_bk6BUY0JsF4ImDRAT3nR8" }, { "gaps": [ "Missing explicit parameter definitions in documentation" ], "pages": [], "sourceId": "sds_uqg4RBYIA1YERc8Rjc_2c", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_cPgV56wkqJydCcYz3mJU2" }, { "gaps": [ "Missing parameter details", "Missing response schema" ], "pages": [], "sourceId": "sds_y_pAgcC-xJrVMI2TjrXI0", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_58jSAkKvEcC3bWRtd9F4t" }, { "gaps": [ "Missing parameter definitions", "Missing response schema" ], "pages": [ 1 ], "sourceId": "sds_YxKB40zPRwtilOdTUDmjR", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_4Vk_45589KUwJSyCPBwKV" }, { "gaps": [ "Missing parameter definitions and response schema" ], "pages": [ 1 ], "sourceId": "sds_ZS-xdAQ0s8auc1LcI7Ooo", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_7knEBvR-UUuEvVL1C_QLq" } ], "x-zeroclick-services": [ "realtime-ziprecruiter-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-ziprecruiter-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-ziprecruiter-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/realtime-ziprecruiter-data/search": { "get": { "summary": "Search Jobs", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "request_id", "parameters", "data" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_24e03882eaa99c44_ref1" }, "description": "Matching jobs, deduplicated, in ZipRecruiter's own relevance order for the\nrequested window." }, "status": { "enum": [ "OK" ], "type": "string" }, "parameters": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_24e03882eaa99c44_ref0" }, "request_id": { "type": "string", "description": "Unique id for this request, useful when contacting support." } } } } }, "description": "Matching jobs." }, "400": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_24e03882eaa99c44_ref5" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." }, "404": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_24e03882eaa99c44_ref9" }, "429": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_24e03882eaa99c44_ref10" }, "500": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_24e03882eaa99c44_ref11" }, "503": { "$ref": "#/components/schemas/sds_L_Fsr74jXxRwFrRFUiukT_24e03882eaa99c44_ref12" } }, "parameters": [ { "in": "query", "name": "query", "schema": { "type": "string", "example": "software engineer" }, "example": "software engineer", "required": true, "description": "Free-text job search query, for example `software engineer` or `registered nurse`.\nExactly one `query` is accepted; a second one returns a 400 error." }, { "in": "query", "name": "location", "schema": { "type": "string" }, "required": false, "description": "Free-text location, for example `New York, NY` or `Toronto, ON`. This is what drives\ngeography on ZipRecruiter. Omit it to search the whole country." }, { "in": "query", "name": "page", "schema": { "type": "integer", "default": 1, "maximum": 50, "minimum": 1 }, "required": false, "description": "1-based page of results to start from. ZipRecruiter returns 20 jobs per page. The real\nceiling is `ceil(total_results / 20)`, and the largest result set observed was 946\njobs.\n\n**Allowed values:** `1-50`\n\n**Default:** `1`" }, { "in": "query", "name": "num_pages", "schema": { "type": "integer", "default": 1, "maximum": 20, "minimum": 1 }, "required": false, "description": "Number of consecutive pages to fetch starting at `page`. Each page is 20 jobs.\nDuplicate listings ZipRecruiter repeats across pages are removed, so a page may yield\nfewer than 20 new jobs.\n\n**Allowed values:** `1-20`\n\n**Default:** `1`" }, { "in": "query", "name": "country", "schema": { "enum": [ "us", "ca" ], "type": "string", "default": "us" }, "required": false, "description": "Country market to search. Only `us` and `ca` are served.\n\n**Allowed values:** `us`, `ca`\n\n**Default:** `us`" }, { "in": "query", "name": "date_posted", "schema": { "enum": [ "all", "today", "3days", "week", "month" ], "type": "string", "default": "all" }, "required": false, "description": "Only return jobs posted within this window. Applied by ZipRecruiter server-side, and\neach window maps exactly onto 1, 3, 7 and 30 days.\n\n**Allowed values:** `all`, `today`, `3days`, `week`, `month`\n\n**Default:** `all`" }, { "in": "query", "name": "employment_types", "schema": { "type": "string" }, "required": false, "description": "Comma-separated employment types to include, for example `FULLTIME,CONTRACTOR`. Values\nare OR-ed: a job matching any of them is returned. Applied by ZipRecruiter.\n\n**Allowed values:** `FULLTIME`, `PARTTIME`, `CONTRACTOR`, `TEMPORARY`,\n`CONTRACT_TO_HIRE`, `AS_NEEDED`, `OTHER`" }, { "in": "query", "name": "experience_level", "schema": { "enum": [ "no_experience", "junior", "mid", "senior" ], "type": "string" }, "required": false, "description": "Only return jobs at this experience level. A single value; a comma-separated list is\nrejected, because ZipRecruiter's behaviour for multiple levels is unverified. Applied\nby ZipRecruiter.\n\n**Allowed values:** `no_experience`, `junior`, `mid`, `senior`" }, { "in": "query", "name": "remote_jobs_only", "schema": { "type": "boolean", "default": false }, "required": false, "description": "Set to `true` to return only remote jobs. Applied by ZipRecruiter server-side, so\nrecall is ZipRecruiter's own remote classification.\n\n**Default:** `false`" }, { "in": "query", "name": "salary_min", "schema": { "type": "integer", "minimum": 0 }, "required": false, "description": "Minimum ANNUAL salary in whole dollars, for example `80000`. When set, ZipRecruiter\nlimits results to jobs that state a salary." }, { "in": "query", "name": "salary_max", "schema": { "type": "integer", "minimum": 0 }, "required": false, "description": "Maximum ANNUAL salary in whole dollars, for example `150000`. Must be greater than or\nequal to `salary_min`." }, { "in": "query", "name": "radius", "schema": { "type": "integer", "minimum": 1 }, "required": false, "description": "Search radius around `location`, in KILOMETRES, converted to the miles ZipRecruiter\nexpects. Any positive integer is accepted. Requires `location`. ZipRecruiter's own\ndefault is 25 miles." }, { "in": "query", "name": "zipapply_only", "schema": { "type": "boolean", "default": false }, "required": false, "description": "Set to `true` to return only jobs that support ZipApply, ZipRecruiter's one-click\napply. Applied by ZipRecruiter.\n\n**Default:** `false`" }, { "in": "query", "name": "company_id", "schema": { "type": "string" }, "required": false, "description": "Return only jobs from one company, identified by the `ziprecruiter_company_id` carried\non a previous `/search` result. Send `location` too: ZipRecruiter applies this filter\nfar more reliably with one. Every card is verified, and an unknown id returns a 404\nerror." }, { "in": "query", "name": "include_details", "schema": { "type": "boolean", "default": false }, "required": false, "description": "Set to `true` to fetch each job's full description and detail-only fields. Costs one\nextra request per job, so it is much slower and is billed accordingly. Caps `num_pages`\nat 5.\n\n**Default:** `false`" }, { "in": "query", "name": "fields", "schema": { "type": "string" }, "required": false, "description": "Comma-separated projection over the job object, for example\n`job_title,employer_name,job_apply_link`. `job_id` and `job_title` are always included.\nAn unknown field name returns a 400 error." } ], "description": "Search ZipRecruiter job postings by keyword, with the filters ZipRecruiter honors\nserver-side: `location` with a kilometre `radius`, `date_posted`, `employment_types`,\n`experience_level`, `salary_min` / `salary_max`, `remote_jobs_only`, `zipapply_only` and\n`company_id`.\n\n**`include_details` defaults to `false`, and this is the single most important thing to\nunderstand about this endpoint.** A ZipRecruiter search card carries a roughly\n200-character teaser and nothing more. `job_description`, `job_highlights`,\n`employer_website`, `employer_reviews`, `job_onet_soc`, `ziprecruiter_description_html`,\n`ziprecruiter_job_industry`, `ziprecruiter_valid_through`, `ziprecruiter_ats_identifier`,\n`ziprecruiter_company_size`, `ziprecruiter_company_hq`, `ziprecruiter_company_industries`,\n`ziprecruiter_key_responsibilities` and `ziprecruiter_employer_faq` are all detail-only and\ncome back `null` on a plain search. Set `include_details=true` to fill them. The teaser is\nalways published separately as `ziprecruiter_short_description`, so a card-only response\nstill carries usable copy.\n\nFilling the details costs one extra upstream request per job, which is why it is opt-in.\nWith `include_details=true`, `num_pages` may be at most 5, which is 100 jobs; a larger\nvalue returns a 400 error.\n\n**Pagination** is 20 jobs per page. The ceiling is `ceil(total_results / 20)`, where\n`total_results` is ZipRecruiter's own count of matches, and the largest result set observed\nwas 946 jobs. Duplicates ZipRecruiter repeats across adjacent pages are removed, so a page\nmay yield fewer than 20 new jobs. The response is a flat array, so a call returning fewer\nthan `num_pages` x 20 jobs is how you know you have reached the end of the result set.\n\n**Scoping to one company** is what `company_id` is for, and the value is the\n`ziprecruiter_company_id` carried on every job. ZipRecruiter fails this filter OPEN in two\nways, both silent: a bad id returns the full unfiltered search, and a valid one\nintermittently drops the filter. Send `location` alongside `company_id`: that is what keeps\nthe drop rare. Measured on one id with five interleaved repeats per arm, the filter held\n5/5 with a location and 1/5 without, and the misses returned 6, 4 and 20 distinct\nemployers. So every returned card is checked against the requested id, a page that fails\nthe check is refetched, and an id that stays unscoped returns a 404 error.\n`total_results` is omitted for a company-scoped search: ZipRecruiter's count there swings\nfrom 1 to 540 across 20 identical calls. Note that roughly a third of postings carry the\nplaceholder id `zr_missing_company_default`, ZipRecruiter's marker for a posting whose\ncompany record is missing; it returns a 404 error here, so pick an id off a job whose\n`employer_name` is the company you want.\n\n**Sorting.** Results come back in ZipRecruiter's own relevance order. `sort_by`, `sort`,\n`order` and a `company` NAME each return a 400 error, because ZipRecruiter accepts and\nthen ignores them.\n\n**Billing:** `Requests` counts one per requested SERP page, plus one per detail page when\n`include_details=true`. Extra pages walked to refill a page after deduplication, and\nretries of a blocked page, are absorbed.", "operationId": "realtime_ziprecruiter_data__Search_Jobs", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing parameter descriptions and response schema details." ], "pages": [ 1 ], "sourceId": "sds__1fiQu9RHG0jaOVImz_2s", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_fMzoiFNl9X0S__Sj10MeV" }, { "gaps": [ "Missing detailed schema for response body" ], "pages": [ 1 ], "sourceId": "sds_1IfgtOxqP1q4cHvJ7VyPY", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_mb4oPKVX4C1sgk5EHzdxz" }, { "gaps": [ "Missing explicit parameter definitions in documentation" ], "pages": [], "sourceId": "sds_2mkzMPjBdeReAr1HmDREz", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_c-7MmamthDbtIrwRq96jn" }, { "gaps": [ "Missing response schema details" ], "pages": [ 1 ], "sourceId": "sds_5fumgq7Dew7p7p505C6Vj", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_UDnMGDO2AU7l2pD7FR4rR" }, { "gaps": [ "Missing explicit parameter definitions in provided text" ], "pages": [], "sourceId": "sds_5hlhZJYspBPaHxKN7OhqJ", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_3lrPg3Nc0kbMzAAAdVFHe" }, { "gaps": [ "Missing schema details for response body" ], "pages": [ 1 ], "sourceId": "sds_AtF5v_vXxTbq1wWfTbZ8p", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_xtbL3_JhQnAYS_6AQGDiQ" }, { "gaps": [ "Missing schema details for response body" ], "pages": [ 1 ], "sourceId": "sds_FK2maa1cDe4qcElj5U3zU", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_gZ-rMsS0AnYbgxe2iW2Nm" }, { "gaps": [ "Missing detailed parameter schema for query and response structure." ], "pages": [ 1 ], "sourceId": "sds_kNNDQzbHD8UafUY8VU2At", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_CFRFpZthk-T-EyPrsqzIj" }, { "gaps": [ "Missing detailed schema for response body" ], "pages": [ 1 ], "sourceId": "sds_MeUfdaSf30qGBbwR2_Van", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_DgUH3wi-28BNw0nONekhu" }, { "gaps": [ "Missing parameter details for location and filters" ], "pages": [ 1 ], "sourceId": "sds_QN3ukfHdtXTOIp_KXoTb_", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_fqMlN4jSZ8jNeUn6Wv8Vq" }, { "gaps": [ "Missing parameter details and response schema" ], "pages": [], "sourceId": "sds_ROjpin-1soeCivIbZLub5", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_WrJX2U_i26_CRY3Hi0cz4" }, { "gaps": [ "Missing explicit parameter definitions in documentation" ], "pages": [], "sourceId": "sds_soxpzUWt2CLoTKLGBZfNb", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_3H-1br_3SJ3ASZfGOL5Yr" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_SWPCFBdhQTXC3OrJ98RML", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_bk6BUY0JsF4ImDRAT3nR8" }, { "gaps": [ "Missing explicit parameter definitions in documentation" ], "pages": [], "sourceId": "sds_uqg4RBYIA1YERc8Rjc_2c", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_cPgV56wkqJydCcYz3mJU2" }, { "gaps": [ "Missing parameter details", "Missing response schema" ], "pages": [], "sourceId": "sds_y_pAgcC-xJrVMI2TjrXI0", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_58jSAkKvEcC3bWRtd9F4t" }, { "gaps": [ "Missing parameter definitions", "Missing response schema" ], "pages": [ 1 ], "sourceId": "sds_YxKB40zPRwtilOdTUDmjR", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_4Vk_45589KUwJSyCPBwKV" }, { "gaps": [ "Missing parameter definitions and response schema" ], "pages": [ 1 ], "sourceId": "sds_ZS-xdAQ0s8auc1LcI7Ooo", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_7knEBvR-UUuEvVL1C_QLq" } ], "x-zeroclick-services": [ "realtime-ziprecruiter-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "realtime-ziprecruiter-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "realtime-ziprecruiter-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/reverse-image-search/reverse-image-search": { "get": { "summary": "Reverse Image Search", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "required": [ "title", "link", "domain", "image", "image_width", "image_height" ], "properties": { "date": { "type": "string", "nullable": true, "description": "Publication date of the source page, when Google surfaces one." }, "link": { "type": "string", "description": "URL of the source web page." }, "logo": { "type": "string", "nullable": true, "description": "Favicon URL of the source domain." }, "image": { "type": "string", "description": "Thumbnail URL of the matched image on the source page." }, "price": { "type": "string", "nullable": true, "description": "Product price extracted from the source page, when the page is an e-commerce listing." }, "title": { "type": "string", "description": "Title of the source web page." }, "domain": { "type": "string", "description": "Domain extracted from the source URL." }, "image_width": { "type": "integer", "description": "Width of the matched image in pixels." }, "availability": { "type": "string", "nullable": true, "description": "Product availability extracted from the source page, when the page is an e-commerce listing." }, "image_height": { "type": "integer", "description": "Height of the matched image in pixels." } } }, "description": "Source web pages referencing the queried image, ordered by relevance." }, "status": { "type": "string", "description": "The status of the request" }, "parameters": { "type": "object", "properties": { "url": { "type": "string", "description": "The URL provided in the request" }, "limit": { "type": "integer", "description": "The maximum number of results to return" }, "safe_search": { "type": "string", "description": "The safe search filter level" } } }, "request_id": { "type": "string", "description": "A unique identifier for the request" } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "url", "schema": { "type": "string" }, "example": "https://i.imgur.com/HBrB8p0.png", "required": true, "description": "Image URL to search" }, { "in": "query", "name": "limit", "schema": { "type": "number", "default": 500, "maximum": 500, "minimum": 1 }, "description": "Maximum number of results to return." }, { "in": "query", "name": "safe_search", "schema": { "enum": [ "off", "blur" ], "type": "string", "default": "blur" }, "description": "How to show explicit / NSFW content in your search results." } ], "description": "Send an image URL and get the top 500 source web pages. Get the top 500 referencing source web pages for an image by image URL.", "operationId": "reverse_image_search__get__reverse_image_search", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing parameter descriptions and response schema details." ], "pages": [ 1 ], "sourceId": "sds__1fiQu9RHG0jaOVImz_2s", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/parameters/query/image_url", "/description", "/operationId" ], "revisionId": "sdrn_fMzoiFNl9X0S__Sj10MeV" }, { "gaps": [ "Missing detailed schema for response body" ], "pages": [ 1 ], "sourceId": "sds_1IfgtOxqP1q4cHvJ7VyPY", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/parameters/query/image_url", "/description", "/operationId" ], "revisionId": "sdrn_mb4oPKVX4C1sgk5EHzdxz" }, { "gaps": [ "Missing explicit parameter definitions in documentation" ], "pages": [], "sourceId": "sds_2mkzMPjBdeReAr1HmDREz", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/image_url", "/description", "/operationId" ], "revisionId": "sdrn_c-7MmamthDbtIrwRq96jn" }, { "gaps": [ "Missing response schema details" ], "pages": [ 1 ], "sourceId": "sds_5fumgq7Dew7p7p505C6Vj", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/parameters/query/image_url", "/description", "/operationId" ], "revisionId": "sdrn_UDnMGDO2AU7l2pD7FR4rR" }, { "gaps": [ "Missing explicit parameter definitions in provided text" ], "pages": [], "sourceId": "sds_5hlhZJYspBPaHxKN7OhqJ", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/image_url", "/description", "/operationId" ], "revisionId": "sdrn_3lrPg3Nc0kbMzAAAdVFHe" }, { "gaps": [ "Missing schema details for response body" ], "pages": [ 1 ], "sourceId": "sds_AtF5v_vXxTbq1wWfTbZ8p", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/image_url", "/description", "/operationId" ], "revisionId": "sdrn_xtbL3_JhQnAYS_6AQGDiQ" }, { "gaps": [ "Missing schema details for response body" ], "pages": [ 1 ], "sourceId": "sds_FK2maa1cDe4qcElj5U3zU", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/parameters/query/image_url", "/description", "/operationId" ], "revisionId": "sdrn_gZ-rMsS0AnYbgxe2iW2Nm" }, { "gaps": [ "Missing detailed parameter schema for image_url and response structure." ], "pages": [ 1 ], "sourceId": "sds_kNNDQzbHD8UafUY8VU2At", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/parameters/query/image_url", "/description", "/operationId" ], "revisionId": "sdrn_CFRFpZthk-T-EyPrsqzIj" }, { "gaps": [ "Missing detailed schema for response body" ], "pages": [ 1 ], "sourceId": "sds_MeUfdaSf30qGBbwR2_Van", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/parameters/query/image_url", "/description", "/operationId" ], "revisionId": "sdrn_DgUH3wi-28BNw0nONekhu" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_QN3ukfHdtXTOIp_KXoTb_", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/image_url", "/description", "/operationId" ], "revisionId": "sdrn_fqMlN4jSZ8jNeUn6Wv8Vq" }, { "gaps": [ "Missing parameter details and response schema" ], "pages": [], "sourceId": "sds_ROjpin-1soeCivIbZLub5", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/parameters/query/image_url", "/description", "/operationId" ], "revisionId": "sdrn_WrJX2U_i26_CRY3Hi0cz4" }, { "gaps": [ "Missing explicit parameter definitions in documentation" ], "pages": [], "sourceId": "sds_soxpzUWt2CLoTKLGBZfNb", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/parameters/query/image_url", "/description", "/operationId" ], "revisionId": "sdrn_3H-1br_3SJ3ASZfGOL5Yr" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_SWPCFBdhQTXC3OrJ98RML", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_bk6BUY0JsF4ImDRAT3nR8" }, { "gaps": [ "Missing explicit parameter definitions in documentation" ], "pages": [], "sourceId": "sds_uqg4RBYIA1YERc8Rjc_2c", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/parameters/query/image_url", "/description", "/operationId" ], "revisionId": "sdrn_cPgV56wkqJydCcYz3mJU2" }, { "gaps": [ "Missing parameter details", "Missing response schema" ], "pages": [], "sourceId": "sds_y_pAgcC-xJrVMI2TjrXI0", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/parameters/query/image_url", "/description", "/operationId" ], "revisionId": "sdrn_58jSAkKvEcC3bWRtd9F4t" }, { "gaps": [ "Missing parameter definitions", "Missing response schema" ], "pages": [ 1 ], "sourceId": "sds_YxKB40zPRwtilOdTUDmjR", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_4Vk_45589KUwJSyCPBwKV" }, { "gaps": [ "Missing parameter definitions and response schema" ], "pages": [ 1 ], "sourceId": "sds_ZS-xdAQ0s8auc1LcI7Ooo", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_7knEBvR-UUuEvVL1C_QLq" } ], "x-zeroclick-services": [ "reverse-image-search" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "reverse-image-search", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "reverse-image-search", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/social-links-search/search-social-links": { "get": { "summary": "Search Social Links", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "github": { "type": "array", "items": { "type": "string" }, "description": "GitHub profile URLs matching the query." }, "tiktok": { "type": "array", "items": { "type": "string" }, "description": "TikTok profile URLs matching the query." }, "twitter": { "type": "array", "items": { "type": "string" }, "description": "Twitter / X profile URLs matching the query." }, "youtube": { "type": "array", "items": { "type": "string" }, "description": "YouTube channel / user URLs matching the query." }, "facebook": { "type": "array", "items": { "type": "string" }, "description": "Facebook profile URLs matching the query." }, "linkedin": { "type": "array", "items": { "type": "string" }, "description": "LinkedIn profile URLs matching the query." }, "snapchat": { "type": "array", "items": { "type": "string" }, "description": "Snapchat profile URLs matching the query." }, "instagram": { "type": "array", "items": { "type": "string" }, "description": "Instagram profile URLs matching the query." }, "pinterest": { "type": "array", "items": { "type": "string" }, "description": "Pinterest profile URLs matching the query." } }, "description": "Discovered social profile URLs grouped by network. Only the networks requested via `social_networks` (and that returned hits) are present." }, "status": { "type": "string", "description": "The status of the response." }, "request_id": { "type": "string", "description": "A unique identifier for the request." } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "query", "schema": { "type": "string" }, "example": "John Smith", "required": true, "description": "Social links search query." }, { "in": "query", "name": "social_networks", "schema": { "type": "string", "default": "facebook,tiktok,instagram,snapchat,twitter,youtube,linkedin,github" }, "description": "Find social links for the specified social networks, specified as a comma delimited list of the following values: facebook, tiktok, instagram, snapchat, twitter, youtube, linkedin, github, pinterest." } ], "description": "Get social profile links by search query or keywords. \n The following social networks are supported: Facebook, TikTok, Instagram, Snapchat, Twitter, Youtube, LinkedIn, GitHub and Pinterest.", "operationId": "social_links_search__get__search_social_links", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing parameter descriptions and response schema details." ], "pages": [ 1 ], "sourceId": "sds__1fiQu9RHG0jaOVImz_2s", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_fMzoiFNl9X0S__Sj10MeV" }, { "gaps": [ "Missing detailed schema for response body" ], "pages": [ 1 ], "sourceId": "sds_1IfgtOxqP1q4cHvJ7VyPY", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_mb4oPKVX4C1sgk5EHzdxz" }, { "gaps": [ "Missing explicit parameter definitions in documentation" ], "pages": [], "sourceId": "sds_2mkzMPjBdeReAr1HmDREz", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_c-7MmamthDbtIrwRq96jn" }, { "gaps": [ "Missing response schema details" ], "pages": [ 1 ], "sourceId": "sds_5fumgq7Dew7p7p505C6Vj", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_UDnMGDO2AU7l2pD7FR4rR" }, { "gaps": [ "Missing explicit parameter definitions in provided text" ], "pages": [], "sourceId": "sds_5hlhZJYspBPaHxKN7OhqJ", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_3lrPg3Nc0kbMzAAAdVFHe" }, { "gaps": [ "Missing schema details for response body" ], "pages": [ 1 ], "sourceId": "sds_AtF5v_vXxTbq1wWfTbZ8p", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_xtbL3_JhQnAYS_6AQGDiQ" }, { "gaps": [ "Missing schema details for response body" ], "pages": [ 1 ], "sourceId": "sds_FK2maa1cDe4qcElj5U3zU", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_gZ-rMsS0AnYbgxe2iW2Nm" }, { "gaps": [ "Missing detailed parameter schema for query and response structure." ], "pages": [ 1 ], "sourceId": "sds_kNNDQzbHD8UafUY8VU2At", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_CFRFpZthk-T-EyPrsqzIj" }, { "gaps": [ "Missing detailed schema for response body" ], "pages": [ 1 ], "sourceId": "sds_MeUfdaSf30qGBbwR2_Van", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_DgUH3wi-28BNw0nONekhu" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_QN3ukfHdtXTOIp_KXoTb_", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_fqMlN4jSZ8jNeUn6Wv8Vq" }, { "gaps": [ "Missing parameter details and response schema" ], "pages": [], "sourceId": "sds_ROjpin-1soeCivIbZLub5", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_WrJX2U_i26_CRY3Hi0cz4" }, { "gaps": [ "Missing explicit parameter definitions in documentation" ], "pages": [], "sourceId": "sds_soxpzUWt2CLoTKLGBZfNb", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_3H-1br_3SJ3ASZfGOL5Yr" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_SWPCFBdhQTXC3OrJ98RML", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_bk6BUY0JsF4ImDRAT3nR8" }, { "gaps": [ "Missing explicit parameter definitions in documentation" ], "pages": [], "sourceId": "sds_uqg4RBYIA1YERc8Rjc_2c", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_cPgV56wkqJydCcYz3mJU2" }, { "gaps": [ "Missing parameter details", "Missing response schema" ], "pages": [], "sourceId": "sds_y_pAgcC-xJrVMI2TjrXI0", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_58jSAkKvEcC3bWRtd9F4t" }, { "gaps": [ "Missing parameter definitions", "Missing response schema" ], "pages": [ 1 ], "sourceId": "sds_YxKB40zPRwtilOdTUDmjR", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_4Vk_45589KUwJSyCPBwKV" }, { "gaps": [ "Missing parameter definitions and response schema" ], "pages": [ 1 ], "sourceId": "sds_ZS-xdAQ0s8auc1LcI7Ooo", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_7knEBvR-UUuEvVL1C_QLq" } ], "x-zeroclick-services": [ "social-links-search" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "social-links-search", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "social-links-search", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/trustpilot-company-and-reviews/category-company-list": { "get": { "summary": "Companies by Category", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "category": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the category" }, "name": { "type": "string", "description": "The name of the category" }, "level": { "type": "string", "description": "The hierarchical level of the category" }, "parent_id": { "type": "string", "description": "The ID of the parent category" }, "company_count": { "type": "integer", "description": "The number of companies in this category" } } }, "total_companies": { "type": "integer", "description": "The total number of companies found" } } }, "status": { "type": "string", "description": "The status of the response" }, "parameters": { "type": "object", "properties": { "page": { "type": "string", "description": "The requested page number" }, "locale": { "type": "string", "description": "The locale of the request" }, "category_id": { "type": "string", "description": "The ID of the category requested" } } }, "request_id": { "type": "string", "description": "A unique identifier for the request" } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "category_id", "schema": { "type": "string" }, "example": "software_company", "required": true, "description": "The type of the company for which to get details." }, { "in": "query", "name": "page", "schema": { "type": "integer", "default": 1 }, "description": "The page to return (each page includes up to 20 results)." }, { "in": "query", "name": "min_rating", "schema": { "enum": [ "any", "3", "4", "4.5" ], "type": "string", "default": "any" }, "description": "Only return companies with at least the specified rating." }, { "in": "query", "name": "verified", "schema": { "type": "boolean", "default": false }, "description": "Only return verified companies / businesses." }, { "in": "query", "name": "claimed", "schema": { "type": "boolean", "default": false }, "description": "Only return claimed companies / businesses." }, { "in": "query", "name": "sort", "schema": { "enum": [ "most_relevant", "reviews_count", "latest_review" ], "type": "string", "default": "most_relevant" }, "description": "How to sort the companies in the results." }, { "in": "query", "name": "country", "schema": { "type": "string", "default": "us" }, "description": "Only return companies / businesses from a specific country, specified as an ISO 639 (alpha-2) country code. Allowed values: For a list of supported region/country codes see https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes (Alpha-2 code)." }, { "in": "query", "name": "city_or_zip_code", "schema": { "type": "string" }, "description": "City or zip code from which to return companies / businesses." }, { "in": "query", "name": "locale", "schema": { "enum": [ "da-DK", "de-AT", "de-CH", "de-DE", "en-AU", "en-CA", "en-GB", "en-IE", "en-NZ", "en-US", "es-ES", "fi-FI", "fr-BE", "nl-BE", "fr-FR", "it-IT", "ja-JP", "nb-NO", "nl-NL", "pl-PL", "pt-BR", "pt-PT", "sv-SE" ], "type": "string", "default": "en-US" }, "description": "Locale code to use. Corresponds to the country selector on the Trustpilot website footer." } ], "description": "Get the full list of companies in a specific company, with extensive filtering capabilities and pagination support. Supports the options / filters available on the best companies in category page (e.g. https://www.trustpilot.com/categories/gaming).", "operationId": "trustpilot_company_and_reviews__get__category_company_list", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing parameter descriptions and response schema details." ], "pages": [ 1 ], "sourceId": "sds__1fiQu9RHG0jaOVImz_2s", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/category", "/description", "/operationId" ], "revisionId": "sdrn_fMzoiFNl9X0S__Sj10MeV" }, { "gaps": [ "Missing detailed schema for response body" ], "pages": [ 1 ], "sourceId": "sds_1IfgtOxqP1q4cHvJ7VyPY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_mb4oPKVX4C1sgk5EHzdxz" }, { "gaps": [ "Missing explicit parameter definitions in documentation" ], "pages": [], "sourceId": "sds_2mkzMPjBdeReAr1HmDREz", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/category_url", "/description", "/operationId" ], "revisionId": "sdrn_c-7MmamthDbtIrwRq96jn" }, { "gaps": [ "Missing response schema details" ], "pages": [ 1 ], "sourceId": "sds_5fumgq7Dew7p7p505C6Vj", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/category", "/description", "/operationId" ], "revisionId": "sdrn_UDnMGDO2AU7l2pD7FR4rR" }, { "gaps": [ "Missing explicit parameter definitions in provided text" ], "pages": [], "sourceId": "sds_5hlhZJYspBPaHxKN7OhqJ", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_3lrPg3Nc0kbMzAAAdVFHe" }, { "gaps": [ "Missing schema details for response body" ], "pages": [ 1 ], "sourceId": "sds_AtF5v_vXxTbq1wWfTbZ8p", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/category", "/description", "/operationId" ], "revisionId": "sdrn_xtbL3_JhQnAYS_6AQGDiQ" }, { "gaps": [ "Missing schema details for response body" ], "pages": [ 1 ], "sourceId": "sds_FK2maa1cDe4qcElj5U3zU", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_gZ-rMsS0AnYbgxe2iW2Nm" }, { "gaps": [ "Missing detailed parameter schema for category and response structure." ], "pages": [ 1 ], "sourceId": "sds_kNNDQzbHD8UafUY8VU2At", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/category", "/description", "/operationId" ], "revisionId": "sdrn_CFRFpZthk-T-EyPrsqzIj" }, { "gaps": [ "Missing detailed schema for response body" ], "pages": [ 1 ], "sourceId": "sds_MeUfdaSf30qGBbwR2_Van", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/category", "/description", "/operationId" ], "revisionId": "sdrn_DgUH3wi-28BNw0nONekhu" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_QN3ukfHdtXTOIp_KXoTb_", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_fqMlN4jSZ8jNeUn6Wv8Vq" }, { "gaps": [ "Missing parameter details and response schema" ], "pages": [], "sourceId": "sds_ROjpin-1soeCivIbZLub5", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/category", "/description", "/operationId" ], "revisionId": "sdrn_WrJX2U_i26_CRY3Hi0cz4" }, { "gaps": [ "Missing explicit parameter definitions in documentation" ], "pages": [], "sourceId": "sds_soxpzUWt2CLoTKLGBZfNb", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/category", "/description", "/operationId" ], "revisionId": "sdrn_3H-1br_3SJ3ASZfGOL5Yr" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_SWPCFBdhQTXC3OrJ98RML", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_bk6BUY0JsF4ImDRAT3nR8" }, { "gaps": [ "Missing explicit parameter definitions in documentation" ], "pages": [], "sourceId": "sds_uqg4RBYIA1YERc8Rjc_2c", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_cPgV56wkqJydCcYz3mJU2" }, { "gaps": [ "Missing parameter details", "Missing response schema" ], "pages": [], "sourceId": "sds_y_pAgcC-xJrVMI2TjrXI0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_58jSAkKvEcC3bWRtd9F4t" }, { "gaps": [ "Missing parameter definitions", "Missing response schema" ], "pages": [ 1 ], "sourceId": "sds_YxKB40zPRwtilOdTUDmjR", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_4Vk_45589KUwJSyCPBwKV" }, { "gaps": [ "Missing parameter definitions and response schema" ], "pages": [ 1 ], "sourceId": "sds_ZS-xdAQ0s8auc1LcI7Ooo", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_7knEBvR-UUuEvVL1C_QLq" } ], "x-zeroclick-services": [ "trustpilot-company-and-reviews" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "trustpilot-company-and-reviews", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "trustpilot-company-and-reviews", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/trustpilot-company-and-reviews/category-details": { "get": { "summary": "Category Details", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "category": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique ID of the category." }, "name": { "type": "string", "description": "The name of the category." }, "level": { "type": "string", "description": "The hierarchical level of the category." }, "parent_id": { "type": "string", "description": "The ID of the parent category." }, "company_count": { "type": "integer", "description": "The number of companies in this category." } } }, "subcategories": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique ID of the subcategory." }, "name": { "type": "string", "description": "The name of the subcategory." }, "level": { "type": "string", "description": "The hierarchical level of the subcategory." }, "parent_id": { "type": "string", "description": "The ID of the parent category." }, "company_count": { "type": "integer", "description": "The number of companies in this subcategory." } } } }, "parent_category": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique ID of the parent category." }, "name": { "type": "string", "description": "The name of the parent category." }, "level": { "type": "string", "description": "The hierarchical level of the parent category." }, "parent_id": { "type": "string", "description": "The ID of the parent's parent category." }, "company_count": { "type": "integer", "description": "The number of companies in the parent category." } } }, "sibling_categories": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique ID of the sibling category." }, "name": { "type": "string", "description": "The name of the sibling category." }, "level": { "type": "string", "description": "The hierarchical level of the sibling category." }, "parent_id": { "type": "string", "description": "The ID of the shared parent category." }, "company_count": { "type": "integer", "description": "The number of companies in the sibling category." } } } } } }, "status": { "type": "string", "description": "The status of the response." }, "parameters": { "type": "object", "properties": { "locale": { "type": "string", "description": "The locale for the response data." }, "category_id": { "type": "string", "description": "The ID of the requested category." } } }, "request_id": { "type": "string", "description": "Unique identifier for the request." } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "category_id", "schema": { "type": "string" }, "example": "internet_software", "required": true, "description": "The ID of the category for which to get full details." }, { "in": "query", "name": "locale", "schema": { "enum": [ "da-DK", "de-AT", "de-CH", "de-DE", "en-AU", "en-CA", "en-GB", "en-IE", "en-NZ", "en-US", "es-ES", "fi-FI", "fr-BE", "nl-BE", "fr-FR", "it-IT", "ja-JP", "nb-NO", "nl-NL", "pl-PL", "pt-BR", "pt-PT", "sv-SE" ], "type": "string", "default": "en-US" }, "description": "Locale code to use. Corresponds to the country selector on the Trustpilot website footer." } ], "description": "Get the full details of a category, including subcategories, parent categories, sibling categories and more information.", "operationId": "trustpilot_company_and_reviews__get__category_details", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing parameter descriptions and response schema details." ], "pages": [ 1 ], "sourceId": "sds__1fiQu9RHG0jaOVImz_2s", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/parameters/query/category", "/description", "/operationId" ], "revisionId": "sdrn_fMzoiFNl9X0S__Sj10MeV" }, { "gaps": [ "Missing detailed schema for response body" ], "pages": [ 1 ], "sourceId": "sds_1IfgtOxqP1q4cHvJ7VyPY", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_mb4oPKVX4C1sgk5EHzdxz" }, { "gaps": [ "Missing explicit parameter definitions in documentation" ], "pages": [], "sourceId": "sds_2mkzMPjBdeReAr1HmDREz", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/category_url", "/description", "/operationId" ], "revisionId": "sdrn_c-7MmamthDbtIrwRq96jn" }, { "gaps": [ "Missing response schema details" ], "pages": [ 1 ], "sourceId": "sds_5fumgq7Dew7p7p505C6Vj", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/parameters/query/category", "/description", "/operationId" ], "revisionId": "sdrn_UDnMGDO2AU7l2pD7FR4rR" }, { "gaps": [ "Missing explicit parameter definitions in provided text" ], "pages": [], "sourceId": "sds_5hlhZJYspBPaHxKN7OhqJ", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_3lrPg3Nc0kbMzAAAdVFHe" }, { "gaps": [ "Missing schema details for response body" ], "pages": [ 1 ], "sourceId": "sds_AtF5v_vXxTbq1wWfTbZ8p", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/category", "/description", "/operationId" ], "revisionId": "sdrn_xtbL3_JhQnAYS_6AQGDiQ" }, { "gaps": [ "Missing schema details for response body" ], "pages": [ 1 ], "sourceId": "sds_FK2maa1cDe4qcElj5U3zU", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_gZ-rMsS0AnYbgxe2iW2Nm" }, { "gaps": [ "Missing detailed parameter schema for category and response structure." ], "pages": [ 1 ], "sourceId": "sds_kNNDQzbHD8UafUY8VU2At", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/parameters/query/category", "/description", "/operationId" ], "revisionId": "sdrn_CFRFpZthk-T-EyPrsqzIj" }, { "gaps": [ "Missing detailed schema for response body" ], "pages": [ 1 ], "sourceId": "sds_MeUfdaSf30qGBbwR2_Van", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/parameters/query/category", "/description", "/operationId" ], "revisionId": "sdrn_DgUH3wi-28BNw0nONekhu" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_QN3ukfHdtXTOIp_KXoTb_", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_fqMlN4jSZ8jNeUn6Wv8Vq" }, { "gaps": [ "Missing parameter details and response schema" ], "pages": [], "sourceId": "sds_ROjpin-1soeCivIbZLub5", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/parameters/query/category", "/description", "/operationId" ], "revisionId": "sdrn_WrJX2U_i26_CRY3Hi0cz4" }, { "gaps": [ "Missing explicit parameter definitions in documentation" ], "pages": [], "sourceId": "sds_soxpzUWt2CLoTKLGBZfNb", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/parameters/query/category", "/description", "/operationId" ], "revisionId": "sdrn_3H-1br_3SJ3ASZfGOL5Yr" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_SWPCFBdhQTXC3OrJ98RML", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_bk6BUY0JsF4ImDRAT3nR8" }, { "gaps": [ "Missing explicit parameter definitions in documentation" ], "pages": [], "sourceId": "sds_uqg4RBYIA1YERc8Rjc_2c", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_cPgV56wkqJydCcYz3mJU2" }, { "gaps": [ "Missing parameter details", "Missing response schema" ], "pages": [], "sourceId": "sds_y_pAgcC-xJrVMI2TjrXI0", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_58jSAkKvEcC3bWRtd9F4t" }, { "gaps": [ "Missing parameter definitions", "Missing response schema" ], "pages": [ 1 ], "sourceId": "sds_YxKB40zPRwtilOdTUDmjR", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_4Vk_45589KUwJSyCPBwKV" }, { "gaps": [ "Missing parameter definitions and response schema" ], "pages": [ 1 ], "sourceId": "sds_ZS-xdAQ0s8auc1LcI7Ooo", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_7knEBvR-UUuEvVL1C_QLq" } ], "x-zeroclick-services": [ "trustpilot-company-and-reviews" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "trustpilot-company-and-reviews", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "trustpilot-company-and-reviews", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/trustpilot-company-and-reviews/category-newest-companies": { "get": { "summary": "Newest Companies in Category", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "category": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier for the category." }, "name": { "type": "string", "description": "The name of the category." }, "level": { "type": "string", "description": "The hierarchical level of the category." }, "parent_id": { "type": "string", "description": "The parent category ID." }, "company_count": { "type": "integer", "description": "The number of companies in this category." } } }, "companies": { "type": "array", "items": { "type": "object" } } } }, "status": { "type": "string", "description": "The status of the response." }, "parameters": { "type": "object", "properties": { "locale": { "type": "string", "description": "The locale of the request." }, "category_id": { "type": "string", "description": "The ID of the category." } } }, "request_id": { "type": "string", "description": "A unique identifier for the request." } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "category_id", "schema": { "type": "string" }, "example": "software_company", "required": true, "description": "The type of the company for which to get details." }, { "in": "query", "name": "locale", "schema": { "enum": [ "da-DK", "de-AT", "de-CH", "de-DE", "en-AU", "en-CA", "en-GB", "en-IE", "en-NZ", "en-US", "es-ES", "fi-FI", "fr-BE", "nl-BE", "fr-FR", "it-IT", "ja-JP", "nb-NO", "nl-NL", "pl-PL", "pt-BR", "pt-PT", "sv-SE" ], "type": "string", "default": "en-US" }, "description": "Locale code to use. Corresponds to the country selector on the Trustpilot website footer." } ], "description": "Get the list of newest companies is a specific category.", "operationId": "trustpilot_company_and_reviews__get__category_newest_companies", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing parameter descriptions and response schema details." ], "pages": [ 1 ], "sourceId": "sds__1fiQu9RHG0jaOVImz_2s", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/parameters/query/category", "/description", "/operationId" ], "revisionId": "sdrn_fMzoiFNl9X0S__Sj10MeV" }, { "gaps": [ "Missing detailed schema for response body" ], "pages": [ 1 ], "sourceId": "sds_1IfgtOxqP1q4cHvJ7VyPY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_mb4oPKVX4C1sgk5EHzdxz" }, { "gaps": [ "Missing explicit parameter definitions in documentation" ], "pages": [], "sourceId": "sds_2mkzMPjBdeReAr1HmDREz", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/category_url", "/description", "/operationId" ], "revisionId": "sdrn_c-7MmamthDbtIrwRq96jn" }, { "gaps": [ "Missing response schema details" ], "pages": [ 1 ], "sourceId": "sds_5fumgq7Dew7p7p505C6Vj", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/category", "/description", "/operationId" ], "revisionId": "sdrn_UDnMGDO2AU7l2pD7FR4rR" }, { "gaps": [ "Missing explicit parameter definitions in provided text" ], "pages": [], "sourceId": "sds_5hlhZJYspBPaHxKN7OhqJ", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_3lrPg3Nc0kbMzAAAdVFHe" }, { "gaps": [ "Missing schema details for response body" ], "pages": [ 1 ], "sourceId": "sds_AtF5v_vXxTbq1wWfTbZ8p", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/category", "/description", "/operationId" ], "revisionId": "sdrn_xtbL3_JhQnAYS_6AQGDiQ" }, { "gaps": [ "Missing schema details for response body" ], "pages": [ 1 ], "sourceId": "sds_FK2maa1cDe4qcElj5U3zU", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_gZ-rMsS0AnYbgxe2iW2Nm" }, { "gaps": [ "Missing detailed parameter schema for category and response structure." ], "pages": [ 1 ], "sourceId": "sds_kNNDQzbHD8UafUY8VU2At", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/parameters/query/category", "/description", "/operationId" ], "revisionId": "sdrn_CFRFpZthk-T-EyPrsqzIj" }, { "gaps": [ "Missing detailed schema for response body" ], "pages": [ 1 ], "sourceId": "sds_MeUfdaSf30qGBbwR2_Van", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/parameters/query/category", "/description", "/operationId" ], "revisionId": "sdrn_DgUH3wi-28BNw0nONekhu" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_QN3ukfHdtXTOIp_KXoTb_", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_fqMlN4jSZ8jNeUn6Wv8Vq" }, { "gaps": [ "Missing parameter details and response schema" ], "pages": [], "sourceId": "sds_ROjpin-1soeCivIbZLub5", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/parameters/query/category", "/description", "/operationId" ], "revisionId": "sdrn_WrJX2U_i26_CRY3Hi0cz4" }, { "gaps": [ "Missing explicit parameter definitions in documentation" ], "pages": [], "sourceId": "sds_soxpzUWt2CLoTKLGBZfNb", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/parameters/query/category", "/description", "/operationId" ], "revisionId": "sdrn_3H-1br_3SJ3ASZfGOL5Yr" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_SWPCFBdhQTXC3OrJ98RML", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_bk6BUY0JsF4ImDRAT3nR8" }, { "gaps": [ "Missing explicit parameter definitions in documentation" ], "pages": [], "sourceId": "sds_uqg4RBYIA1YERc8Rjc_2c", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_cPgV56wkqJydCcYz3mJU2" }, { "gaps": [ "Missing parameter details", "Missing response schema" ], "pages": [], "sourceId": "sds_y_pAgcC-xJrVMI2TjrXI0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_58jSAkKvEcC3bWRtd9F4t" }, { "gaps": [ "Missing parameter definitions", "Missing response schema" ], "pages": [ 1 ], "sourceId": "sds_YxKB40zPRwtilOdTUDmjR", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_4Vk_45589KUwJSyCPBwKV" }, { "gaps": [ "Missing parameter definitions and response schema" ], "pages": [ 1 ], "sourceId": "sds_ZS-xdAQ0s8auc1LcI7Ooo", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_7knEBvR-UUuEvVL1C_QLq" } ], "x-zeroclick-services": [ "trustpilot-company-and-reviews" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "trustpilot-company-and-reviews", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "trustpilot-company-and-reviews", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/trustpilot-company-and-reviews/category-recently-reviewed-companies": { "get": { "summary": "Recently Reviewed Companies in Category", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "category": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique ID of the category." }, "name": { "type": "string", "description": "The name of the category." }, "level": { "type": "string", "description": "The hierarchical level of the category." }, "parent_id": { "type": "string", "description": "The ID of the parent category." }, "company_count": { "type": "integer", "description": "The number of companies in this category." } } }, "companies": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the company." }, "domain": { "type": "string", "description": "The website domain of the company." }, "rating": { "type": "number", "description": "The average rating of the company." }, "company_id": { "type": "string", "description": "The unique ID of the company." }, "trust_score": { "type": "number", "description": "The trust score of the company." }, "review_count": { "type": "integer", "description": "The total number of reviews for the company." } } } } } }, "status": { "type": "string", "description": "The status of the response." }, "parameters": { "type": "object", "properties": { "locale": { "type": "string", "description": "The locale of the request." }, "category_id": { "type": "string", "description": "The ID of the category." } } }, "request_id": { "type": "string", "description": "A unique identifier for the request." } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "category_id", "schema": { "type": "string" }, "example": "software_company", "required": true, "description": "The type of the company for which to get details." }, { "in": "query", "name": "locale", "schema": { "enum": [ "da-DK", "de-AT", "de-CH", "de-DE", "en-AU", "en-CA", "en-GB", "en-IE", "en-NZ", "en-US", "es-ES", "fi-FI", "fr-BE", "nl-BE", "fr-FR", "it-IT", "ja-JP", "nb-NO", "nl-NL", "pl-PL", "pt-BR", "pt-PT", "sv-SE" ], "type": "string", "default": "en-US" }, "description": "Locale code to use. Corresponds to the country selector on the Trustpilot website footer." } ], "description": "Get the list of recently reviewed companies is a specific category.", "operationId": "trustpilot_company_and_reviews__get__category_recently_reviewed_companies", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing parameter descriptions and response schema details." ], "pages": [ 1 ], "sourceId": "sds__1fiQu9RHG0jaOVImz_2s", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/category", "/description", "/operationId" ], "revisionId": "sdrn_fMzoiFNl9X0S__Sj10MeV" }, { "gaps": [ "Missing detailed schema for response body" ], "pages": [ 1 ], "sourceId": "sds_1IfgtOxqP1q4cHvJ7VyPY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_mb4oPKVX4C1sgk5EHzdxz" }, { "gaps": [ "Missing explicit parameter definitions in documentation" ], "pages": [], "sourceId": "sds_2mkzMPjBdeReAr1HmDREz", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/category_url", "/description", "/operationId" ], "revisionId": "sdrn_c-7MmamthDbtIrwRq96jn" }, { "gaps": [ "Missing response schema details" ], "pages": [ 1 ], "sourceId": "sds_5fumgq7Dew7p7p505C6Vj", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/category", "/description", "/operationId" ], "revisionId": "sdrn_UDnMGDO2AU7l2pD7FR4rR" }, { "gaps": [ "Missing explicit parameter definitions in provided text" ], "pages": [], "sourceId": "sds_5hlhZJYspBPaHxKN7OhqJ", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_3lrPg3Nc0kbMzAAAdVFHe" }, { "gaps": [ "Missing schema details for response body" ], "pages": [ 1 ], "sourceId": "sds_AtF5v_vXxTbq1wWfTbZ8p", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/category", "/description", "/operationId" ], "revisionId": "sdrn_xtbL3_JhQnAYS_6AQGDiQ" }, { "gaps": [ "Missing schema details for response body" ], "pages": [ 1 ], "sourceId": "sds_FK2maa1cDe4qcElj5U3zU", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_gZ-rMsS0AnYbgxe2iW2Nm" }, { "gaps": [ "Missing detailed parameter schema for category and response structure." ], "pages": [ 1 ], "sourceId": "sds_kNNDQzbHD8UafUY8VU2At", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/category", "/description", "/operationId" ], "revisionId": "sdrn_CFRFpZthk-T-EyPrsqzIj" }, { "gaps": [ "Missing detailed schema for response body" ], "pages": [ 1 ], "sourceId": "sds_MeUfdaSf30qGBbwR2_Van", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/category", "/description", "/operationId" ], "revisionId": "sdrn_DgUH3wi-28BNw0nONekhu" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_QN3ukfHdtXTOIp_KXoTb_", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_fqMlN4jSZ8jNeUn6Wv8Vq" }, { "gaps": [ "Missing parameter details and response schema" ], "pages": [], "sourceId": "sds_ROjpin-1soeCivIbZLub5", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/category", "/description", "/operationId" ], "revisionId": "sdrn_WrJX2U_i26_CRY3Hi0cz4" }, { "gaps": [ "Missing explicit parameter definitions in documentation" ], "pages": [], "sourceId": "sds_soxpzUWt2CLoTKLGBZfNb", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/category", "/description", "/operationId" ], "revisionId": "sdrn_3H-1br_3SJ3ASZfGOL5Yr" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_SWPCFBdhQTXC3OrJ98RML", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_bk6BUY0JsF4ImDRAT3nR8" }, { "gaps": [ "Missing explicit parameter definitions in documentation" ], "pages": [], "sourceId": "sds_uqg4RBYIA1YERc8Rjc_2c", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_cPgV56wkqJydCcYz3mJU2" }, { "gaps": [ "Missing parameter details", "Missing response schema" ], "pages": [], "sourceId": "sds_y_pAgcC-xJrVMI2TjrXI0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_58jSAkKvEcC3bWRtd9F4t" }, { "gaps": [ "Missing parameter definitions", "Missing response schema" ], "pages": [ 1 ], "sourceId": "sds_YxKB40zPRwtilOdTUDmjR", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_4Vk_45589KUwJSyCPBwKV" }, { "gaps": [ "Missing parameter definitions and response schema" ], "pages": [ 1 ], "sourceId": "sds_ZS-xdAQ0s8auc1LcI7Ooo", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_7knEBvR-UUuEvVL1C_QLq" } ], "x-zeroclick-services": [ "trustpilot-company-and-reviews" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "trustpilot-company-and-reviews", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "trustpilot-company-and-reviews", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/trustpilot-company-and-reviews/category-search": { "get": { "summary": "Category Search", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "A unique identifier for the data item" }, "name": { "type": "string", "description": "The name of the data item" } } } }, "status": { "type": "string", "description": "The status of the request" }, "parameters": { "type": "object", "properties": { "query": { "type": "string", "description": "The search query parameter" }, "locale": { "type": "string", "description": "The locale of the request" } } }, "request_id": { "type": "string", "description": "A unique identifier for the request" } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "query", "schema": { "type": "string" }, "example": "soft", "required": true, "description": "Search query / keyword" }, { "in": "query", "name": "locale", "schema": { "enum": [ "da-DK", "de-AT", "de-CH", "de-DE", "en-AU", "en-CA", "en-GB", "en-IE", "en-NZ", "en-US", "es-ES", "fi-FI", "fr-BE", "nl-BE", "fr-FR", "it-IT", "ja-JP", "nb-NO", "nl-NL", "pl-PL", "pt-BR", "pt-PT", "sv-SE" ], "type": "string", "default": "en-US" }, "description": "Locale code to use. Corresponds to the country selector on the Trustpilot website footer." } ], "description": "Search all Trustpilot categories.", "operationId": "trustpilot_company_and_reviews__get__category_search", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing parameter descriptions and response schema details." ], "pages": [ 1 ], "sourceId": "sds__1fiQu9RHG0jaOVImz_2s", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_fMzoiFNl9X0S__Sj10MeV" }, { "gaps": [ "Missing detailed schema for response body" ], "pages": [ 1 ], "sourceId": "sds_1IfgtOxqP1q4cHvJ7VyPY", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_mb4oPKVX4C1sgk5EHzdxz" }, { "gaps": [ "Missing explicit parameter definitions in documentation" ], "pages": [], "sourceId": "sds_2mkzMPjBdeReAr1HmDREz", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_c-7MmamthDbtIrwRq96jn" }, { "gaps": [ "Missing response schema details" ], "pages": [ 1 ], "sourceId": "sds_5fumgq7Dew7p7p505C6Vj", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_UDnMGDO2AU7l2pD7FR4rR" }, { "gaps": [ "Missing explicit parameter definitions in provided text" ], "pages": [], "sourceId": "sds_5hlhZJYspBPaHxKN7OhqJ", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_3lrPg3Nc0kbMzAAAdVFHe" }, { "gaps": [ "Missing schema details for response body" ], "pages": [ 1 ], "sourceId": "sds_AtF5v_vXxTbq1wWfTbZ8p", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_xtbL3_JhQnAYS_6AQGDiQ" }, { "gaps": [ "Missing schema details for response body" ], "pages": [ 1 ], "sourceId": "sds_FK2maa1cDe4qcElj5U3zU", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_gZ-rMsS0AnYbgxe2iW2Nm" }, { "gaps": [ "Missing detailed parameter schema for query and response structure." ], "pages": [ 1 ], "sourceId": "sds_kNNDQzbHD8UafUY8VU2At", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_CFRFpZthk-T-EyPrsqzIj" }, { "gaps": [ "Missing detailed schema for response body" ], "pages": [ 1 ], "sourceId": "sds_MeUfdaSf30qGBbwR2_Van", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_DgUH3wi-28BNw0nONekhu" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_QN3ukfHdtXTOIp_KXoTb_", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_fqMlN4jSZ8jNeUn6Wv8Vq" }, { "gaps": [ "Missing parameter details and response schema" ], "pages": [], "sourceId": "sds_ROjpin-1soeCivIbZLub5", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_WrJX2U_i26_CRY3Hi0cz4" }, { "gaps": [ "Missing explicit parameter definitions in documentation" ], "pages": [], "sourceId": "sds_soxpzUWt2CLoTKLGBZfNb", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_3H-1br_3SJ3ASZfGOL5Yr" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_SWPCFBdhQTXC3OrJ98RML", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_bk6BUY0JsF4ImDRAT3nR8" }, { "gaps": [ "Missing explicit parameter definitions in documentation" ], "pages": [], "sourceId": "sds_uqg4RBYIA1YERc8Rjc_2c", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_cPgV56wkqJydCcYz3mJU2" }, { "gaps": [ "Missing parameter details", "Missing response schema" ], "pages": [], "sourceId": "sds_y_pAgcC-xJrVMI2TjrXI0", "authority": "supplemental", "conflicts": [ "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_58jSAkKvEcC3bWRtd9F4t" }, { "gaps": [ "Missing parameter definitions", "Missing response schema" ], "pages": [ 1 ], "sourceId": "sds_YxKB40zPRwtilOdTUDmjR", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_4Vk_45589KUwJSyCPBwKV" }, { "gaps": [ "Missing parameter definitions and response schema" ], "pages": [ 1 ], "sourceId": "sds_ZS-xdAQ0s8auc1LcI7Ooo", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_7knEBvR-UUuEvVL1C_QLq" } ], "x-zeroclick-services": [ "trustpilot-company-and-reviews" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "trustpilot-company-and-reviews", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "trustpilot-company-and-reviews", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/trustpilot-company-and-reviews/company-details": { "get": { "summary": "Company Details", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "company": { "type": "object", "properties": { "city": { "type": "string", "description": "The city where the company is located" }, "logo": { "type": "string", "description": "The URL of the company's logo" }, "name": { "type": "string", "description": "The name of the company" }, "email": { "type": "string", "description": "The contact email address of the company" }, "phone": { "type": "string", "description": "The contact phone number of the company" }, "domain": { "type": "string", "description": "The company's website domain" }, "rating": { "type": "number", "description": "The average rating of the company" }, "address": { "type": "string", "description": "The street address of the company" }, "country": { "type": "string", "description": "The country where the company is located" }, "is_paid": { "type": "boolean", "description": "Indicates if the company has a paid plan" }, "website": { "type": "string", "description": "The official website of the company" }, "is_closed": { "type": "boolean", "description": "Indicates if the company is permanently closed" }, "company_id": { "type": "string", "description": "The unique identifier of the company" }, "is_claimed": { "type": "boolean", "description": "Indicates if the company profile is claimed" }, "is_verified": { "type": "boolean", "description": "Indicates if the company is verified" }, "trust_score": { "type": "number", "description": "The trust score of the company" }, "review_count": { "type": "integer", "description": "The total number of reviews for the company" }, "about_company": { "type": "string", "description": "A brief description of the company" }, "is_verified_user": { "type": "boolean", "description": "Indicates if the user verifying the company is verified" }, "average_days_to_reply": { "type": "number", "description": "The average number of days the company takes to reply to reviews" }, "is_asking_for_reviews": { "type": "boolean", "description": "Indicates if the company is actively asking for reviews" }, "is_temporarily_closed": { "type": "boolean", "description": "Indicates if the company is temporarily closed" }, "is_verified_by_google": { "type": "boolean", "description": "Indicates if the company is verified by Google" }, "negative_review_count": { "type": "integer", "description": "The total count of negative reviews" }, "is_verified_payment_method": { "type": "boolean", "description": "Indicates if the company's payment method is verified" }, "negative_review_count_with_reply": { "type": "integer", "description": "The count of negative reviews with company replies" }, "reply_to_negative_review_percent": { "type": "integer", "description": "The percentage of negative reviews that have a reply" } } }, "rating_distribution": { "type": "object", "properties": { "1": { "type": "integer", "description": "Count of 1-star ratings" }, "2": { "type": "integer", "description": "Count of 2-star ratings" }, "3": { "type": "integer", "description": "Count of 3-star ratings" }, "4": { "type": "integer", "description": "Count of 4-star ratings" }, "5": { "type": "integer", "description": "Count of 5-star ratings" } } }, "review_language_distribution": { "type": "object", "properties": { "Deutsch": { "type": "integer", "description": "Count of reviews written in German" }, "English": { "type": "integer", "description": "Count of reviews written in English" }, "español": { "type": "integer", "description": "Count of reviews written in Spanish" }, "français": { "type": "integer", "description": "Count of reviews written in French" } } } } }, "status": { "type": "string", "description": "The status of the API response" }, "parameters": { "type": "object", "properties": { "locale": { "type": "string", "description": "The locale for the request" }, "company_domain": { "type": "string", "description": "The domain of the company requested" } } }, "request_id": { "type": "string", "description": "A unique identifier for the request" } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "company_domain", "schema": { "type": "string" }, "example": "gossby.com", "required": true, "description": "The domain of the company for which to get details." }, { "in": "query", "name": "locale", "schema": { "enum": [ "da-DK", "de-AT", "de-CH", "de-DE", "en-AU", "en-CA", "en-GB", "en-IE", "en-NZ", "en-US", "es-ES", "fi-FI", "fr-BE", "nl-BE", "fr-FR", "it-IT", "ja-JP", "nb-NO", "nl-NL", "pl-PL", "pt-BR", "pt-PT", "sv-SE" ], "type": "string", "default": "en-US" }, "description": "Locale code to use. Corresponds to the country selector on the Trustpilot website footer." } ], "description": "Get the full details of a specific company by company domain.", "operationId": "trustpilot_company_and_reviews__get__company_details", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_0prF_Y5BkmqQXtEQyheXN", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_Z5rvTt1qYfVU6DSLLxPnI" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_1IfgtOxqP1q4cHvJ7VyPY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_mb4oPKVX4C1sgk5EHzdxz" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_2Dc9eyhO3NLPUm0GEbTiV", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_Z1eLurdzog7OgIWS9gcdZ" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_2EOeqrIsWKjYBjoNIGwV0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_ds2DI_Xad11MCFdnoGvH0" }, { "gaps": [ "Missing query parameters for company identification" ], "pages": [ 1 ], "sourceId": "sds_5hlhZJYspBPaHxKN7OhqJ", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_3lrPg3Nc0kbMzAAAdVFHe" }, { "gaps": [ "Missing parameter details for company_url" ], "pages": [ 1 ], "sourceId": "sds_AF8bRESy69frdnjtCAF2z", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/company_url", "/description", "/operationId" ], "revisionId": "sdrn_nUAt1Ad8MTY5qaVlNUqO9" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_BowKpX7oIEvSZAa5G-8Cj", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description" ], "revisionId": "sdrn_AlkJCvRexbLp1t3wre1uD" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_bygUmn2K86zcEr8uYnytH", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_lRwIurwEjFC6EgANnKCbC" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_fZv-ITvZDV87-KqyW2hgn", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_aohUeFTorAhUkoXJ0nrWa" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_jRl0O0t2JNWjX4MjQ_kC5", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_0KHmU6zKJBn3JfGQhhbYP" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_MagzpRZ5Tm9d-vEaBKRmn", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_pej_Kh1VLu4d3ByQ4BdIs" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_MAxJPNBPJFwSKQLj1M1dr", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_QFW9HQumx231aOJCusPx0" }, { "gaps": [ "Missing explicit parameter definitions in documentation" ], "pages": [], "sourceId": "sds_MV8gWtP36-RZn0HelHkbq", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/company_id", "/description", "/operationId" ], "revisionId": "sdrn_zsd2yxhBG769IpVFIUWRc" }, { "gaps": [ "Missing explicit parameter definitions in documentation" ], "pages": [], "sourceId": "sds_qhTee9rhe4IsP9VM8R0Jx", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/company_url", "/description", "/operationId" ], "revisionId": "sdrn_n1Qua5iIILpqbVggnqZhR" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_QIFfeTcLDOFoTiC9diV0b", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_1pOKvi_ZPvz0xrF_bUbDr" }, { "gaps": [ "Missing response schema details" ], "pages": [ 1 ], "sourceId": "sds_soxpzUWt2CLoTKLGBZfNb", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/company_id", "/description", "/operationId" ], "revisionId": "sdrn_3H-1br_3SJ3ASZfGOL5Yr" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_SWPCFBdhQTXC3OrJ98RML", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_bk6BUY0JsF4ImDRAT3nR8" }, { "gaps": [ "Missing schema definition for response body" ], "pages": [ 1 ], "sourceId": "sds_vaNNaw5q29aKLh-qRSfR0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/company_id", "/description", "/operationId" ], "revisionId": "sdrn_SrJ_OL_N_pZ70W8niC6g0" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_x7ttfFTcDVeDC-z6q5Fme", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_CYVDOGPj9Fd8EmU6tGOk8" } ], "x-zeroclick-services": [ "trustpilot-company-and-reviews" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "trustpilot-company-and-reviews", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "trustpilot-company-and-reviews", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/trustpilot-company-and-reviews/company-reviews": { "get": { "summary": "Company Reviews", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "total_reviews": { "type": "integer", "description": "The total number of reviews available." }, "rating_distribution": { "type": "object", "properties": { "1": { "type": "integer", "description": "The number of 1-star reviews." }, "2": { "type": "integer", "description": "The number of 2-star reviews." }, "3": { "type": "integer", "description": "The number of 3-star reviews." }, "4": { "type": "integer", "description": "The number of 4-star reviews." }, "5": { "type": "integer", "description": "The number of 5-star reviews." } } }, "review_language_distribution": { "type": "object", "properties": { "root": { "type": "integer", "description": "The number of reviews in an unidentified root language." }, "dansk": { "type": "integer", "description": "The number of reviews in Danish." }, "eesti": { "type": "integer", "description": "The number of reviews in Estonian." }, "norsk": { "type": "integer", "description": "The number of reviews in Norwegian." }, "suomi": { "type": "integer", "description": "The number of reviews in Finnish." }, "magyar": { "type": "integer", "description": "The number of reviews in Hungarian." }, "polski": { "type": "integer", "description": "The number of reviews in Polish." }, "Deutsch": { "type": "integer", "description": "The number of reviews in German." }, "English": { "type": "integer", "description": "The number of reviews in English." }, "català": { "type": "integer", "description": "The number of reviews in Catalan." }, "svenska": { "type": "integer", "description": "The number of reviews in Swedish." }, "español": { "type": "integer", "description": "The number of reviews in Spanish." }, "hrvatski": { "type": "integer", "description": "The number of reviews in Croatian." }, "italiano": { "type": "integer", "description": "The number of reviews in Italian." }, "română": { "type": "integer", "description": "The number of reviews in Romanian." }, "français": { "type": "integer", "description": "The number of reviews in French." }, "čeština": { "type": "integer", "description": "The number of reviews in Czech." }, "日本語": { "type": "integer", "description": "The number of reviews in Japanese." }, "Nederlands": { "type": "integer", "description": "The number of reviews in Dutch." }, "português": { "type": "integer", "description": "The number of reviews in Portuguese." }, "עברית": { "type": "integer", "description": "The number of reviews in Hebrew." }, "Tiếng Việt": { "type": "integer", "description": "The number of reviews in Vietnamese." }, "русский": { "type": "integer", "description": "The number of reviews in Russian." }, "Ελληνικά": { "type": "integer", "description": "The number of reviews in Greek." }, "български": { "type": "integer", "description": "The number of reviews in Bulgarian." } } } } }, "status": { "type": "string", "description": "The status of the response." }, "parameters": { "type": "object", "properties": { "page": { "type": "string", "description": "The page number of results." }, "locale": { "type": "string", "description": "The locale for the request." }, "company_domain": { "type": "string", "description": "The domain of the company being queried." } } }, "request_id": { "type": "string", "description": "A unique identifier for the request." } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "company_domain", "schema": { "type": "string" }, "example": "gossby.com", "required": true, "description": "The domain of the company for which to get details." }, { "in": "query", "name": "page", "schema": { "type": "integer", "default": 1 }, "description": "The page to return (each page includes up to 20 results)." }, { "in": "query", "name": "cookie", "schema": { "type": "string" }, "description": "A logged-in user cookie to use. Used for fetching review page greater than 10 since Trustpilot requires login for paginating beyond page 10." }, { "in": "query", "name": "verified", "schema": { "type": "boolean" }, "description": "Only return verified reviews" }, { "in": "query", "name": "with_replies", "schema": { "type": "boolean" }, "description": "Only return reviews with owner replies" }, { "in": "query", "name": "sort", "schema": { "enum": [ "most_relevant", "recency" ], "type": "string", "default": "most_relevant" }, "description": "How to sort the reviews in the results." }, { "in": "query", "name": "date_posted", "schema": { "enum": [ "any", "last_12_months", "last_6_months", "last_3_months", "last_30_days" ], "type": "string", "default": "any" }, "description": "Return reviews posted in specific time ranges." }, { "in": "query", "name": "query", "schema": { "type": "string" }, "description": "Return reviews matching a specific query / keyword." }, { "in": "query", "name": "rating", "schema": { "enum": [ "1", "2", "3", "4", "5" ], "type": "string" }, "description": "Only return reviews with certain ratings. Can take a single value or comma separated list of ratings." }, { "in": "query", "name": "locale", "schema": { "enum": [ "da-DK", "de-AT", "de-CH", "de-DE", "en-AU", "en-CA", "en-GB", "en-IE", "en-NZ", "en-US", "es-ES", "fi-FI", "fr-BE", "nl-BE", "fr-FR", "it-IT", "ja-JP", "nb-NO", "nl-NL", "pl-PL", "pt-BR", "pt-PT", "sv-SE" ], "type": "string", "default": "en-US" }, "description": "Locale code to use. Corresponds to the country selector on the Trustpilot website footer." } ], "description": "Get all company reviews with extensive filtering and capabilities and pagination support. Supports the filters / options seen on Trustpilot company reviews pages (e.g. https://trustpilot.com/review/gossby.com).", "operationId": "trustpilot_company_and_reviews__get__company_reviews", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_0prF_Y5BkmqQXtEQyheXN", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_Z5rvTt1qYfVU6DSLLxPnI" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_1IfgtOxqP1q4cHvJ7VyPY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_mb4oPKVX4C1sgk5EHzdxz" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_2Dc9eyhO3NLPUm0GEbTiV", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_Z1eLurdzog7OgIWS9gcdZ" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_2EOeqrIsWKjYBjoNIGwV0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_ds2DI_Xad11MCFdnoGvH0" }, { "gaps": [ "Missing query parameters for company identification" ], "pages": [ 1 ], "sourceId": "sds_5hlhZJYspBPaHxKN7OhqJ", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_3lrPg3Nc0kbMzAAAdVFHe" }, { "gaps": [ "Missing parameter details for company_url" ], "pages": [ 1 ], "sourceId": "sds_AF8bRESy69frdnjtCAF2z", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/company_url", "/description", "/operationId" ], "revisionId": "sdrn_nUAt1Ad8MTY5qaVlNUqO9" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_BowKpX7oIEvSZAa5G-8Cj", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description" ], "revisionId": "sdrn_AlkJCvRexbLp1t3wre1uD" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_bygUmn2K86zcEr8uYnytH", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_lRwIurwEjFC6EgANnKCbC" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_fZv-ITvZDV87-KqyW2hgn", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_aohUeFTorAhUkoXJ0nrWa" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_jRl0O0t2JNWjX4MjQ_kC5", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_0KHmU6zKJBn3JfGQhhbYP" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_MagzpRZ5Tm9d-vEaBKRmn", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_pej_Kh1VLu4d3ByQ4BdIs" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_MAxJPNBPJFwSKQLj1M1dr", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_QFW9HQumx231aOJCusPx0" }, { "gaps": [ "Missing explicit parameter definitions in documentation" ], "pages": [], "sourceId": "sds_MV8gWtP36-RZn0HelHkbq", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/company_id", "/description", "/operationId" ], "revisionId": "sdrn_zsd2yxhBG769IpVFIUWRc" }, { "gaps": [ "Missing explicit parameter definitions in documentation" ], "pages": [], "sourceId": "sds_qhTee9rhe4IsP9VM8R0Jx", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/company_url", "/description", "/operationId" ], "revisionId": "sdrn_n1Qua5iIILpqbVggnqZhR" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_QIFfeTcLDOFoTiC9diV0b", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_1pOKvi_ZPvz0xrF_bUbDr" }, { "gaps": [ "Missing response schema details" ], "pages": [ 1 ], "sourceId": "sds_soxpzUWt2CLoTKLGBZfNb", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/company_id", "/description", "/operationId" ], "revisionId": "sdrn_3H-1br_3SJ3ASZfGOL5Yr" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_SWPCFBdhQTXC3OrJ98RML", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_bk6BUY0JsF4ImDRAT3nR8" }, { "gaps": [ "Missing schema definition for response body" ], "pages": [ 1 ], "sourceId": "sds_vaNNaw5q29aKLh-qRSfR0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/company_id", "/description", "/operationId" ], "revisionId": "sdrn_SrJ_OL_N_pZ70W8niC6g0" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_x7ttfFTcDVeDC-z6q5Fme", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_CYVDOGPj9Fd8EmU6tGOk8" } ], "x-zeroclick-services": [ "trustpilot-company-and-reviews" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "trustpilot-company-and-reviews", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "trustpilot-company-and-reviews", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/trustpilot-company-and-reviews/company-search": { "get": { "summary": "Company Search", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "companies": { "type": "array", "items": { "type": "object" } }, "total_companies": { "type": "integer", "description": "The total number of companies returned" } } }, "status": { "type": "string", "description": "The status of the response" }, "parameters": { "type": "object", "properties": { "page": { "type": "string", "description": "The page number of the results" }, "query": { "type": "string", "description": "The search query parameter" }, "locale": { "type": "string", "description": "The locale for the request" } } }, "request_id": { "type": "string", "description": "A unique identifier for the request" } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "query", "schema": { "type": "string" }, "example": "bestbuy", "required": true, "description": "Search query / keyword" }, { "in": "query", "name": "page", "schema": { "type": "integer", "default": 1 }, "description": "The page to return (each page includes up to 10 results)." }, { "in": "query", "name": "min_rating", "schema": { "enum": [ "any", "3", "4", "4.5" ], "type": "string", "default": "any" }, "description": "Only return companies with at least the specified rating." }, { "in": "query", "name": "min_review_count", "schema": { "enum": [ "any", "25", "50", "100", "250", "500" ], "type": "string" }, "description": "Only return companies with at least the specified number of reviews." }, { "in": "query", "name": "locale", "schema": { "enum": [ "da-DK", "de-AT", "de-CH", "de-DE", "en-AU", "en-CA", "en-GB", "en-IE", "en-NZ", "en-US", "es-ES", "fi-FI", "fr-BE", "nl-BE", "fr-FR", "it-IT", "ja-JP", "nb-NO", "nl-NL", "pl-PL", "pt-BR", "pt-PT", "sv-SE" ], "type": "string", "default": "en-US" }, "description": "Locale code to use. Corresponds to the country selector on the Trustpilot website footer." } ], "description": "Search for companies / businesses on Trustpilot. Supports pagination and rating and review count filters.", "operationId": "trustpilot_company_and_reviews__get__company_search", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_0prF_Y5BkmqQXtEQyheXN", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_Z5rvTt1qYfVU6DSLLxPnI" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_1IfgtOxqP1q4cHvJ7VyPY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_mb4oPKVX4C1sgk5EHzdxz" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_2Dc9eyhO3NLPUm0GEbTiV", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_Z1eLurdzog7OgIWS9gcdZ" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_2EOeqrIsWKjYBjoNIGwV0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_ds2DI_Xad11MCFdnoGvH0" }, { "gaps": [ "Missing parameter details for query" ], "pages": [ 1 ], "sourceId": "sds_AF8bRESy69frdnjtCAF2z", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_nUAt1Ad8MTY5qaVlNUqO9" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_MagzpRZ5Tm9d-vEaBKRmn", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_pej_Kh1VLu4d3ByQ4BdIs" }, { "gaps": [ "Missing response schema details" ], "pages": [ 1 ], "sourceId": "sds_soxpzUWt2CLoTKLGBZfNb", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_3H-1br_3SJ3ASZfGOL5Yr" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_SWPCFBdhQTXC3OrJ98RML", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_bk6BUY0JsF4ImDRAT3nR8" }, { "gaps": [ "Missing schema definition for response body" ], "pages": [ 1 ], "sourceId": "sds_vaNNaw5q29aKLh-qRSfR0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_SrJ_OL_N_pZ70W8niC6g0" } ], "x-zeroclick-services": [ "trustpilot-company-and-reviews" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "trustpilot-company-and-reviews", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "trustpilot-company-and-reviews", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/trustpilot-company-and-reviews/consumer-details": { "get": { "summary": "Consumer Details", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "consumer": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the consumer" }, "name": { "type": "string", "description": "The name of the consumer" }, "photo": { "type": "string", "description": "The URL of the consumer's profile photo" }, "country": { "type": "string", "description": "The country of the consumer" }, "verified": { "type": "boolean", "description": "Indicates whether the consumer is verified" }, "like_count": { "type": "integer", "description": "The number of likes received by the consumer" }, "read_count": { "type": "integer", "description": "The number of times the consumer's content has been read" }, "review_count": { "type": "integer", "description": "The number of reviews written by the consumer" } } } } }, "status": { "type": "string", "description": "The status of the response" }, "parameters": { "type": "object", "properties": { "locale": { "type": "string", "description": "The locale of the request" }, "consumer_id": { "type": "string", "description": "The unique identifier of the consumer" } } }, "request_id": { "type": "string", "description": "A unique identifier for the request" } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "consumer_id", "schema": { "type": "string" }, "example": "5fafc38b32ed7f0019d27bc5", "required": true, "description": "The ID of the consumer for which to get full details." }, { "in": "query", "name": "locale", "schema": { "enum": [ "da-DK", "de-AT", "de-CH", "de-DE", "en-AU", "en-CA", "en-GB", "en-IE", "en-NZ", "en-US", "es-ES", "fi-FI", "fr-BE", "nl-BE", "fr-FR", "it-IT", "ja-JP", "nb-NO", "nl-NL", "pl-PL", "pt-BR", "pt-PT", "sv-SE" ], "type": "string", "default": "en-US" }, "description": "Locale code to use. Corresponds to the country selector on the Trustpilot website footer." } ], "description": "Get the full details of a consumer.", "operationId": "trustpilot_company_and_reviews__get__consumer_details", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_1IfgtOxqP1q4cHvJ7VyPY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_mb4oPKVX4C1sgk5EHzdxz" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_2Dc9eyhO3NLPUm0GEbTiV", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_Z1eLurdzog7OgIWS9gcdZ" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_2EOeqrIsWKjYBjoNIGwV0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_ds2DI_Xad11MCFdnoGvH0" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_MagzpRZ5Tm9d-vEaBKRmn", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_pej_Kh1VLu4d3ByQ4BdIs" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_SWPCFBdhQTXC3OrJ98RML", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_bk6BUY0JsF4ImDRAT3nR8" } ], "x-zeroclick-services": [ "trustpilot-company-and-reviews" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "trustpilot-company-and-reviews", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "trustpilot-company-and-reviews", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/trustpilot-company-and-reviews/consumer-reviews": { "get": { "summary": "Consumer Reviews", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "consumer": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the consumer" }, "name": { "type": "string", "description": "The name of the consumer" }, "photo": { "type": "string", "description": "The URL to the consumer's profile photo" }, "country": { "type": "string", "description": "The country of the consumer" }, "verified": { "type": "boolean", "description": "Indicates whether the consumer is verified" }, "like_count": { "type": "integer", "description": "The number of likes received by the consumer" }, "read_count": { "type": "integer", "description": "The number of times the consumer's reviews have been read" }, "review_count": { "type": "integer", "description": "The number of reviews written by the consumer" } } } } }, "status": { "type": "string", "description": "The status of the response" }, "parameters": { "type": "object", "properties": { "page": { "type": "string", "description": "The page number of the request" }, "locale": { "type": "string", "description": "The locale of the consumer" }, "consumer_id": { "type": "string", "description": "The ID of the consumer making the request" } } }, "request_id": { "type": "string", "description": "A unique identifier for the request" } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "consumer_id", "schema": { "type": "string" }, "example": "5fafc38b32ed7f0019d27bc5", "required": true, "description": "The ID of the consumer for which to get full details." }, { "in": "query", "name": "page", "schema": { "type": "integer", "default": 1 }, "description": "The page to return (each page includes up to 20 results)." }, { "in": "query", "name": "locale", "schema": { "enum": [ "da-DK", "de-AT", "de-CH", "de-DE", "en-AU", "en-CA", "en-GB", "en-IE", "en-NZ", "en-US", "es-ES", "fi-FI", "fr-BE", "nl-BE", "fr-FR", "it-IT", "ja-JP", "nb-NO", "nl-NL", "pl-PL", "pt-BR", "pt-PT", "sv-SE" ], "type": "string", "default": "en-US" }, "description": "Locale code to use. Corresponds to the country selector on the Trustpilot website footer." } ], "description": "Get all consumer reviews with pagination support.", "operationId": "trustpilot_company_and_reviews__get__consumer_reviews", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_1IfgtOxqP1q4cHvJ7VyPY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_mb4oPKVX4C1sgk5EHzdxz" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_2Dc9eyhO3NLPUm0GEbTiV", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_Z1eLurdzog7OgIWS9gcdZ" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_2EOeqrIsWKjYBjoNIGwV0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_ds2DI_Xad11MCFdnoGvH0" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_MagzpRZ5Tm9d-vEaBKRmn", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_pej_Kh1VLu4d3ByQ4BdIs" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_SWPCFBdhQTXC3OrJ98RML", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_bk6BUY0JsF4ImDRAT3nR8" } ], "x-zeroclick-services": [ "trustpilot-company-and-reviews" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "trustpilot-company-and-reviews", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "trustpilot-company-and-reviews", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/waze/alerts-and-jams": { "get": { "summary": "Alerts and Jams", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "jams": { "type": "array", "items": { "type": "object", "properties": { "city": { "type": "string", "nullable": true, "description": "City of the jam location." }, "type": { "type": "string", "description": "Jam type. Values: NONE, MODERATE, HEAVY, STAND_STILL." }, "level": { "type": "integer", "description": "Waze internal jam level (0–5)." }, "jam_id": { "type": "string", "description": "Unique identifier of the traffic jam." }, "street": { "type": "string", "nullable": true, "description": "Street name of the jam location." }, "country": { "type": "string", "description": "ISO 3166-1 alpha-2 country code of the jam location." }, "severity": { "type": "integer", "description": "Severity score of the jam." }, "speed_kmh": { "type": "number", "description": "Average traffic speed in the jam, km/h." }, "end_location": { "type": "string", "nullable": true, "description": "Description of the jam's end location, when available." }, "delay_seconds": { "type": "integer", "nullable": true, "description": "Estimated delay caused by the jam in seconds. No longer provided by Waze (always null)." }, "length_meters": { "type": "integer", "description": "Length of the jam in meters." }, "block_alert_id": { "type": "string", "nullable": true, "description": "ID of the alert blocking the road, if the jam is caused by a road block." }, "start_location": { "type": "string", "nullable": true, "description": "Description of the jam's start location, when available." }, "block_alert_type": { "type": "string", "nullable": true, "description": "Type of the blocking alert." }, "line_coordinates": { "type": "array", "items": { "type": "object", "properties": { "lat": { "type": "number", "description": "Latitude in decimal degrees." }, "lon": { "type": "number", "description": "Longitude in decimal degrees." } } }, "description": "Polyline of the jam as an ordered list of {lat, lon} points." }, "update_datetime_utc": { "type": "string", "description": "ISO 8601 UTC datetime the jam was last updated." }, "driving_time_seconds": { "type": "integer", "nullable": true, "description": "Time to drive through the jammed stretch in seconds (length / average speed), same as the Waze Live Map \"Driving time\". Null when traffic is stopped." }, "publish_datetime_utc": { "type": "string", "description": "ISO 8601 UTC datetime the jam was first published." }, "block_alert_description": { "type": "string", "nullable": true, "description": "Description of the blocking alert." }, "block_start_datetime_utc": { "type": "string", "nullable": true, "description": "ISO 8601 UTC datetime the block began." }, "block_alert_update_datetime_utc": { "type": "string", "nullable": true, "description": "ISO 8601 UTC datetime the blocking alert was last updated." } } }, "description": "A list of traffic jams reported in the bounding box." }, "alerts": { "type": "array", "items": { "type": "object", "properties": { "city": { "type": "string", "nullable": true, "description": "City of the alert location." }, "type": { "type": "string", "description": "Alert category. Values include: ACCIDENT, HAZARD, JAM, ROAD_CLOSED, POLICE, CONSTRUCTION, MISC." }, "image": { "type": "string", "nullable": true, "description": "URL of an image attached to the alert, when available." }, "street": { "type": "string", "nullable": true, "description": "Street name of the alert location." }, "country": { "type": "string", "description": "ISO 3166-1 alpha-2 country code of the alert location." }, "near_by": { "type": "string", "nullable": true, "description": "Nearby place or landmark, when reported." }, "subtype": { "type": "string", "nullable": true, "description": "More specific alert subtype, when provided." }, "alert_id": { "type": "string", "description": "Unique identifier of the alert." }, "comments": { "type": "array", "items": { "type": "object" }, "description": "User comments left on the alert." }, "latitude": { "type": "number", "description": "Latitude of the alert in decimal degrees." }, "longitude": { "type": "number", "description": "Longitude of the alert in decimal degrees." }, "description": { "type": "string", "nullable": true, "description": "Human-readable description of the alert." }, "report_mood": { "type": "integer", "nullable": true, "description": "Waze reporter mood ID (the avatar mood of the reporting Wazer), passed through unchanged from the raw Waze alert data. Waze currently includes it only on alerts that are the cause of a returned traffic jam (see jams[].block_alert_id); null when Waze does not provide it." }, "reported_by": { "type": "string", "nullable": true, "description": "Reporter of the alert (e.g. a user handle or data source)." }, "num_comments": { "type": "integer", "description": "Number of user comments on the alert." }, "num_thumbs_up": { "type": "integer", "description": "Number of confirmations from other users." }, "alert_confidence": { "type": "integer", "description": "Waze confidence score for the alert." }, "alert_reliability": { "type": "integer", "description": "Waze reliability score for the alert." }, "publish_datetime_utc": { "type": "string", "description": "ISO 8601 UTC datetime the alert was published." } } }, "description": "A list of alerts reported in the bounding box." } } }, "status": { "type": "string", "description": "The status of the request" }, "parameters": { "type": "object", "properties": { "max_jams": { "type": "integer", "description": "The maximum number of traffic jams to return" }, "top_right": { "type": "array", "items": { "type": "string" }, "description": "Coordinates of the top-right corner of the bounding box as [lat, lng] strings." }, "max_alerts": { "type": "integer", "description": "The maximum number of alerts to return" }, "bottom_left": { "type": "array", "items": { "type": "string" }, "description": "Coordinates of the bottom-left corner of the bounding box as [lat, lng] strings." } } }, "request_id": { "type": "string", "description": "A unique identifier for the request" } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "bottom_left", "schema": { "type": "string" }, "example": "40.66615391742187,-74.13732147216798", "required": true, "description": "Bottom-left corner of the geographic rectangular area for which to get alerts and traffic jams. \n Specified as latitude, longitude pair. Required if center and radius are not specified." }, { "in": "query", "name": "top_right", "schema": { "type": "string" }, "example": "40.772787404902594,-73.76818084716798", "required": true, "description": "Top-right corner of the geographic rectangular area for which to get alerts and traffic jams. \n Specified as latitude, longitude pair. Required if center and radius are not specified. Required if center and radius are not specified." }, { "in": "query", "name": "center", "schema": { "type": "string" }, "description": "The center point of the area for which to return alerts and jams - specified as latitude, longitude pair. Required if bottom_left and top_right are not specified." }, { "in": "query", "name": "radius", "schema": { "type": "string" }, "description": "The radius of the area for which to return alerts and jams. Required if bottom_left and top_right are not specified. Required if bottom_left and top_right are not specified." }, { "in": "query", "name": "radius_units", "schema": { "enum": [ "KM", "MI" ], "type": "string", "default": "KM" }, "description": "The unit of measurement for the radius parameter." }, { "in": "query", "name": "max_alerts", "schema": { "type": "integer", "default": 20 }, "description": "Maximum number of alerts to fetch (to avoid fetching alerts set it to 0)." }, { "in": "query", "name": "max_jams", "schema": { "type": "integer", "default": 20 }, "description": "Maximum number of traffic jams to fetch (to avoid fetching traffic jams, set it to 0)." }, { "in": "query", "name": "alert_types", "schema": { "type": "string" }, "description": "Only return alerts of specific types. Multiple alert types can be specified as a comma (,) separated list." }, { "in": "query", "name": "alert_subtypes", "schema": { "type": "string" }, "description": "Only return alerts of specific subtypes types. Multiple alert subtypes can be specified as a comma (,) separated list." } ], "description": "Get real-time alerts data and jams information from Waze in a geographic rectangular area by bottom-left and top-right latitude, longitude pairs. Supports all Waze alert types including: accidents, road blocks, hazards, traffic jams, police, and more.", "operationId": "waze__get__alerts_and_jams", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_0prF_Y5BkmqQXtEQyheXN", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_Z5rvTt1qYfVU6DSLLxPnI" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_1IfgtOxqP1q4cHvJ7VyPY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_mb4oPKVX4C1sgk5EHzdxz" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_2Dc9eyhO3NLPUm0GEbTiV", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_Z1eLurdzog7OgIWS9gcdZ" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_2EOeqrIsWKjYBjoNIGwV0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_ds2DI_Xad11MCFdnoGvH0" }, { "gaps": [ "Missing geographic parameters" ], "pages": [ 1 ], "sourceId": "sds_5hlhZJYspBPaHxKN7OhqJ", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_3lrPg3Nc0kbMzAAAdVFHe" }, { "gaps": [ "Missing parameter details for location" ], "pages": [ 1 ], "sourceId": "sds_AF8bRESy69frdnjtCAF2z", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/location", "/description", "/operationId" ], "revisionId": "sdrn_nUAt1Ad8MTY5qaVlNUqO9" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_BowKpX7oIEvSZAa5G-8Cj", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description" ], "revisionId": "sdrn_AlkJCvRexbLp1t3wre1uD" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_bygUmn2K86zcEr8uYnytH", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_lRwIurwEjFC6EgANnKCbC" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_fZv-ITvZDV87-KqyW2hgn", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_aohUeFTorAhUkoXJ0nrWa" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_jRl0O0t2JNWjX4MjQ_kC5", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_0KHmU6zKJBn3JfGQhhbYP" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_MagzpRZ5Tm9d-vEaBKRmn", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_pej_Kh1VLu4d3ByQ4BdIs" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_MAxJPNBPJFwSKQLj1M1dr", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_QFW9HQumx231aOJCusPx0" }, { "gaps": [ "Missing explicit parameter definitions in documentation" ], "pages": [], "sourceId": "sds_MV8gWtP36-RZn0HelHkbq", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/location", "/description", "/operationId" ], "revisionId": "sdrn_zsd2yxhBG769IpVFIUWRc" }, { "gaps": [ "Missing explicit parameter definitions in documentation" ], "pages": [], "sourceId": "sds_qhTee9rhe4IsP9VM8R0Jx", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/location", "/description", "/operationId" ], "revisionId": "sdrn_n1Qua5iIILpqbVggnqZhR" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_QIFfeTcLDOFoTiC9diV0b", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_1pOKvi_ZPvz0xrF_bUbDr" }, { "gaps": [ "Missing response schema details" ], "pages": [ 1 ], "sourceId": "sds_soxpzUWt2CLoTKLGBZfNb", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/location", "/description", "/operationId" ], "revisionId": "sdrn_3H-1br_3SJ3ASZfGOL5Yr" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_SWPCFBdhQTXC3OrJ98RML", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_bk6BUY0JsF4ImDRAT3nR8" }, { "gaps": [ "Missing parameter details for location format" ], "pages": [ 1 ], "sourceId": "sds_U_Uv6rl9w9MLemG9uo8WH", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/location", "/description", "/operationId" ], "revisionId": "sdrn_UdOxW0io-zRgtahtcrJQi" }, { "gaps": [ "Missing schema definition for response body" ], "pages": [ 1 ], "sourceId": "sds_vaNNaw5q29aKLh-qRSfR0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/location", "/description", "/operationId" ], "revisionId": "sdrn_SrJ_OL_N_pZ70W8niC6g0" } ], "x-zeroclick-services": [ "waze" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "waze", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "waze", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/waze/autocomplete": { "get": { "summary": "Autocomplete", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the location" }, "address": { "type": "string", "description": "The address of the location" }, "latitude": { "type": "number", "description": "The latitude of the location" }, "longitude": { "type": "number", "description": "The longitude of the location" } } } }, "status": { "type": "string", "description": "The status of the response" }, "parameters": { "type": "object", "properties": { "coordinates": { "type": "string", "description": "The coordinates used for the request" } } }, "request_id": { "type": "string", "description": "A unique identifier for the request" } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "q", "schema": { "type": "string" }, "example": "sunn", "required": true, "description": "Free-text geographic query." }, { "in": "query", "name": "language", "schema": { "type": "string" }, "description": "The language of the results. See https://wazeopedia.waze.com/wiki/USA/Countries_and_Languages for a list of supported languages." }, { "in": "query", "name": "coordinates", "schema": { "type": "string" }, "example": "37.376754,-122.023350", "required": true, "description": "Geographic coordinates (latitude, longitude) bias. Highly recommended to use for getting accurate results." } ], "description": "Waze autocomplete/type-ahead functionality for places/POI, locations and addresses. Accepts a query, an optional location bias coordinates, and a language parameter and returns place name, address and location (latitude, longitude pair).", "operationId": "waze__get__autocomplete", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_1IfgtOxqP1q4cHvJ7VyPY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_mb4oPKVX4C1sgk5EHzdxz" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_2Dc9eyhO3NLPUm0GEbTiV", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_Z1eLurdzog7OgIWS9gcdZ" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_2EOeqrIsWKjYBjoNIGwV0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_ds2DI_Xad11MCFdnoGvH0" }, { "gaps": [ "Missing parameter details for query" ], "pages": [ 1 ], "sourceId": "sds_AF8bRESy69frdnjtCAF2z", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/query", "/description", "/operationId" ], "revisionId": "sdrn_nUAt1Ad8MTY5qaVlNUqO9" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_MagzpRZ5Tm9d-vEaBKRmn", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_pej_Kh1VLu4d3ByQ4BdIs" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_SWPCFBdhQTXC3OrJ98RML", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_bk6BUY0JsF4ImDRAT3nR8" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_U_Uv6rl9w9MLemG9uo8WH", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/query", "/description", "/operationId" ], "revisionId": "sdrn_UdOxW0io-zRgtahtcrJQi" } ], "x-zeroclick-services": [ "waze" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "waze", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "waze", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/waze/driving-directions": { "get": { "summary": "Driving Directions", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "jams": { "type": "array", "items": { "type": "object" }, "description": "Traffic jams along the route." }, "alerts": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "Alert category. Values include: ACCIDENT, HAZARD, JAM, ROAD_CLOSED, POLICE, CONSTRUCTION, MISC." }, "subtype": { "type": "string", "nullable": true, "description": "More specific alert subtype." }, "alert_id": { "type": "string", "description": "Unique identifier of the alert." }, "latitude": { "type": "number", "description": "Latitude of the alert in decimal degrees." }, "longitude": { "type": "number", "description": "Longitude of the alert in decimal degrees." } } }, "description": "Alerts along the route." }, "is_hov": { "type": "boolean", "description": "True when the route uses HOV (carpool) lanes." }, "is_toll": { "type": "boolean", "description": "True when the route uses toll roads." }, "is_fastest": { "type": "boolean", "description": "True when this is the fastest of the returned candidate routes." }, "route_name": { "type": "string", "description": "Human-readable route label as displayed by Waze." }, "length_meters": { "type": "integer", "description": "Length of the route in meters." }, "traffic_label": { "type": "string", "description": "Human-readable traffic summary for the route (e.g. 'usual traffic', 'heavy traffic')." }, "duration_seconds": { "type": "integer", "description": "Estimated travel time in seconds." }, "route_coordinates": { "type": "array", "items": { "type": "object", "properties": { "lat": { "type": "number", "description": "Latitude in decimal degrees." }, "lon": { "type": "number", "description": "Longitude in decimal degrees." } } }, "description": "Polyline of the route. Populated only when return_route_coordinates=true; otherwise an empty array." }, "passes_through_danger_area": { "type": "boolean", "description": "True when the route passes through a Waze-flagged danger area." } } }, "description": "Candidate driving routes between the source and destination." }, "status": { "type": "string", "description": "The status of the request" }, "parameters": { "type": "object", "properties": { "source_coordinates": { "type": "string", "description": "The starting location coordinates" }, "destination_coordinates": { "type": "string", "description": "The ending location coordinates" }, "return_route_coordinates": { "type": "boolean", "description": "Indicates if the return route coordinates should be included" } } }, "request_id": { "type": "string", "description": "A unique identifier for the request" } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "source_coordinates", "schema": { "type": "string" }, "example": "32.0852999,34.78176759999999", "required": true, "description": "Geographic coordinates (latitude, longitude pair) of the starting point" }, { "in": "query", "name": "destination_coordinates", "schema": { "type": "string" }, "example": "32.7940463,34.989571", "required": true, "description": "Geographic coordinates (latitude, longitude pair) of the destination" }, { "in": "query", "name": "return_route_coordinates", "schema": { "type": "boolean" }, "description": "Whether to return route coordinate pairs (route_coordinates field)" }, { "in": "query", "name": "arrival_timestamp", "schema": { "type": "number" }, "description": "Unix-timestamp (seconds since epoch) of the arrival time (in case not specified directions will be returned for current time)" } ], "description": "Get routes / driving directions from Waze, including alerts along each possible route. Supports setting the wanted arrival time.", "operationId": "waze__get__driving_directions", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_0prF_Y5BkmqQXtEQyheXN", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_Z5rvTt1qYfVU6DSLLxPnI" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_1IfgtOxqP1q4cHvJ7VyPY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_mb4oPKVX4C1sgk5EHzdxz" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_2Dc9eyhO3NLPUm0GEbTiV", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_Z1eLurdzog7OgIWS9gcdZ" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_2EOeqrIsWKjYBjoNIGwV0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_ds2DI_Xad11MCFdnoGvH0" }, { "gaps": [ "Missing origin and destination parameters" ], "pages": [ 1 ], "sourceId": "sds_5hlhZJYspBPaHxKN7OhqJ", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_3lrPg3Nc0kbMzAAAdVFHe" }, { "gaps": [ "Missing parameter details for origin and destination" ], "pages": [ 1 ], "sourceId": "sds_AF8bRESy69frdnjtCAF2z", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/origin", "/parameters/query/destination", "/description", "/operationId" ], "revisionId": "sdrn_nUAt1Ad8MTY5qaVlNUqO9" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_BowKpX7oIEvSZAa5G-8Cj", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description" ], "revisionId": "sdrn_AlkJCvRexbLp1t3wre1uD" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_bygUmn2K86zcEr8uYnytH", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_lRwIurwEjFC6EgANnKCbC" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_fZv-ITvZDV87-KqyW2hgn", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_aohUeFTorAhUkoXJ0nrWa" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_jRl0O0t2JNWjX4MjQ_kC5", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_0KHmU6zKJBn3JfGQhhbYP" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_MagzpRZ5Tm9d-vEaBKRmn", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_pej_Kh1VLu4d3ByQ4BdIs" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_MAxJPNBPJFwSKQLj1M1dr", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_QFW9HQumx231aOJCusPx0" }, { "gaps": [ "Missing explicit parameter definitions in documentation" ], "pages": [], "sourceId": "sds_MV8gWtP36-RZn0HelHkbq", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/origin", "/parameters/query/destination", "/description", "/operationId" ], "revisionId": "sdrn_zsd2yxhBG769IpVFIUWRc" }, { "gaps": [ "Missing explicit parameter definitions in documentation" ], "pages": [], "sourceId": "sds_qhTee9rhe4IsP9VM8R0Jx", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/origin", "/parameters/query/destination", "/description", "/operationId" ], "revisionId": "sdrn_n1Qua5iIILpqbVggnqZhR" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_QIFfeTcLDOFoTiC9diV0b", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_1pOKvi_ZPvz0xrF_bUbDr" }, { "gaps": [ "Missing response schema details" ], "pages": [ 1 ], "sourceId": "sds_soxpzUWt2CLoTKLGBZfNb", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/origin", "/parameters/query/destination", "/description", "/operationId" ], "revisionId": "sdrn_3H-1br_3SJ3ASZfGOL5Yr" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_SWPCFBdhQTXC3OrJ98RML", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_bk6BUY0JsF4ImDRAT3nR8" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_U_Uv6rl9w9MLemG9uo8WH", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/origin", "/parameters/query/destination", "/description", "/operationId" ], "revisionId": "sdrn_UdOxW0io-zRgtahtcrJQi" }, { "gaps": [ "Missing schema definition for response body" ], "pages": [ 1 ], "sourceId": "sds_vaNNaw5q29aKLh-qRSfR0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/origin", "/parameters/query/destination", "/description", "/operationId" ], "revisionId": "sdrn_SrJ_OL_N_pZ70W8niC6g0" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_x7ttfFTcDVeDC-z6q5Fme", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_CYVDOGPj9Fd8EmU6tGOk8" } ], "x-zeroclick-services": [ "waze" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "waze", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "waze", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/waze/venues": { "get": { "summary": "Venues", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Display name of the venue." }, "state": { "type": "string", "nullable": true, "description": "State or region the venue is located in." }, "country": { "type": "string", "description": "Country the venue is located in." }, "approved": { "type": "boolean", "description": "True when the venue has been approved by Waze moderators." }, "geometry": { "type": "object", "properties": { "type": { "type": "string", "description": "Geometry type. Values: Point, Polygon." }, "coordinates": { "type": "array", "items": {}, "description": "Coordinates of the geometry. For Polygon: an array of linear rings, each a list of [lng, lat] pairs." } }, "description": "GeoJSON-style geometry of the venue." }, "venue_id": { "type": "string", "description": "Unique identifier of the venue." }, "categories": { "type": "array", "items": { "type": "string" }, "description": "Waze category tags for the venue." }, "residential": { "type": "boolean", "description": "True when the venue is a residential location." }, "opening_hours": { "type": "array", "items": { "type": "object" }, "description": "Opening hours of the venue, when provided." }, "google_place_ids": { "type": "array", "items": { "type": "string" }, "description": "Matching Google Place IDs for the venue, when known." } } }, "description": "Venues (places, areas, water bodies, etc.) located inside the bounding box." }, "status": { "type": "string", "description": "The status of the response" }, "parameters": { "type": "object", "properties": { "top_right": { "type": "string", "description": "The top-right coordinate of the area" }, "categories": { "type": "string", "description": "Categories related to the request" }, "bottom_left": { "type": "string", "description": "The bottom-left coordinate of the area" } } }, "request_id": { "type": "string", "description": "A unique identifier for the request" } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "bottom_left", "schema": { "type": "string" }, "example": "48.85100512509277,2.3341819660651026", "required": true, "description": "Bottom-left corner of the geographic rectangular area for which to get venues. Specified as latitude, longitude pair." }, { "in": "query", "name": "top_right", "schema": { "type": "string" }, "example": "48.853125303884686,2.354381771086746", "required": true, "description": "Top-right corner of the geographic rectangular area for which to get venues. Specified as latitude, longitude pair." }, { "in": "query", "name": "categories", "schema": { "type": "string" }, "description": "Only return venues in specific categories. Multiple alert types can be specified as a comma (,) separated list." }, { "in": "query", "name": "zoom_level", "schema": { "type": "string" }, "description": "Waze zoom level from 1-4 (4 is most zoomed in)." } ], "description": "Get venues in geographic rectangular area by bottom-left and top-right latitude, longitude pairs.", "operationId": "waze__get__venues", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_1IfgtOxqP1q4cHvJ7VyPY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_mb4oPKVX4C1sgk5EHzdxz" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_2Dc9eyhO3NLPUm0GEbTiV", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_Z1eLurdzog7OgIWS9gcdZ" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_2EOeqrIsWKjYBjoNIGwV0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_ds2DI_Xad11MCFdnoGvH0" }, { "gaps": [ "Missing parameter details for query" ], "pages": [ 1 ], "sourceId": "sds_AF8bRESy69frdnjtCAF2z", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/query", "/description", "/operationId" ], "revisionId": "sdrn_nUAt1Ad8MTY5qaVlNUqO9" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_MagzpRZ5Tm9d-vEaBKRmn", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_pej_Kh1VLu4d3ByQ4BdIs" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_SWPCFBdhQTXC3OrJ98RML", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_bk6BUY0JsF4ImDRAT3nR8" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_U_Uv6rl9w9MLemG9uo8WH", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/query", "/description", "/operationId" ], "revisionId": "sdrn_UdOxW0io-zRgtahtcrJQi" } ], "x-zeroclick-services": [ "waze" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "waze", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "waze", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/web-search-autocomplete/autocomplete": { "get": { "summary": "Autocomplete", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "required": [ "query", "highlights" ], "properties": { "query": { "type": "string", "description": "The suggested completion of the query." }, "highlights": { "type": "array", "items": { "type": "object", "required": [ "offset", "length" ], "properties": { "length": { "type": "integer", "description": "Length in characters of the matched range." }, "offset": { "type": "integer", "description": "Zero-based character offset where the match starts within the suggestion." } } }, "description": "Character ranges within the suggestion that match the input query (for bold rendering)." }, "entity_image": { "type": "string", "nullable": true, "description": "Primary Knowledge Graph image URL for the entity, when available." }, "entity_title": { "type": "string", "nullable": true, "description": "Knowledge Graph entity title associated with the suggestion, when available." }, "entity_images": { "type": "array", "items": { "type": "string", "description": "Image URL." }, "nullable": true, "description": "Additional Knowledge Graph image URLs for the entity, when available." }, "entity_subtitle": { "type": "string", "nullable": true, "description": "Short Knowledge Graph subtitle / description of the entity (may be empty)." } } }, "description": "List of autocomplete suggestions for the query." }, "status": { "type": "string", "description": "The status of the response" }, "parameters": { "type": "object", "properties": { "query": { "type": "string", "description": "The search query string" }, "region": { "type": "string", "description": "The geographical region for the request" }, "language": { "type": "string", "description": "The language used for the query" }, "user_agent": { "type": "string", "description": "The user agent of the requester" }, "cursor_pointer": { "type": "integer", "description": "A pointer indicating the current position in paginated results" } } }, "request_id": { "type": "string", "description": "A unique identifier for the request" } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "query", "schema": { "type": "string" }, "example": "to", "required": true, "description": "Autocomplete / typeahead search query." }, { "in": "query", "name": "language", "schema": { "type": "string", "default": "en" }, "description": "Set the language of the results. Allowed values: 2-letter language code, see ISO 639-1." }, { "in": "query", "name": "region", "schema": { "type": "string", "default": "us" }, "description": "The country / region from which to make the query. Allowed values: 2-letter country code, see ISO 3166-1 alpha-2." }, { "in": "query", "name": "user_agent", "schema": { "enum": [ "desktop", "mobile" ], "type": "string", "default": "desktop" }, "description": "Device type to use for the search." }, { "in": "query", "name": "cursor_pointer", "schema": { "type": "string" }, "description": "Cursor pointer defines the position of cursor for the query provided, position starts from 0 which is a case where cursor is placed before the query. \n If not provided acts as cursor is placed in the end of query (Google's cp parameter)." } ], "description": "Get query suggestions from Google Search, including Knowledge Graph information when available.", "operationId": "web_search_autocomplete__get__autocomplete", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_0prF_Y5BkmqQXtEQyheXN", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_Z5rvTt1qYfVU6DSLLxPnI" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_1IfgtOxqP1q4cHvJ7VyPY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_mb4oPKVX4C1sgk5EHzdxz" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_2Dc9eyhO3NLPUm0GEbTiV", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_Z1eLurdzog7OgIWS9gcdZ" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_2EOeqrIsWKjYBjoNIGwV0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_ds2DI_Xad11MCFdnoGvH0" }, { "gaps": [ "Missing query parameter" ], "pages": [ 1 ], "sourceId": "sds_5hlhZJYspBPaHxKN7OhqJ", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_3lrPg3Nc0kbMzAAAdVFHe" }, { "gaps": [ "Missing parameter details for query" ], "pages": [ 1 ], "sourceId": "sds_AF8bRESy69frdnjtCAF2z", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_nUAt1Ad8MTY5qaVlNUqO9" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_BowKpX7oIEvSZAa5G-8Cj", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description" ], "revisionId": "sdrn_AlkJCvRexbLp1t3wre1uD" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_bygUmn2K86zcEr8uYnytH", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_lRwIurwEjFC6EgANnKCbC" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_fZv-ITvZDV87-KqyW2hgn", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_aohUeFTorAhUkoXJ0nrWa" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_jRl0O0t2JNWjX4MjQ_kC5", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_0KHmU6zKJBn3JfGQhhbYP" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_MagzpRZ5Tm9d-vEaBKRmn", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_pej_Kh1VLu4d3ByQ4BdIs" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_MAxJPNBPJFwSKQLj1M1dr", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_QFW9HQumx231aOJCusPx0" }, { "gaps": [ "Missing explicit parameter definitions in documentation" ], "pages": [], "sourceId": "sds_qhTee9rhe4IsP9VM8R0Jx", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_n1Qua5iIILpqbVggnqZhR" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_QIFfeTcLDOFoTiC9diV0b", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_1pOKvi_ZPvz0xrF_bUbDr" }, { "gaps": [ "Missing response schema details" ], "pages": [ 1 ], "sourceId": "sds_soxpzUWt2CLoTKLGBZfNb", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_3H-1br_3SJ3ASZfGOL5Yr" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_SWPCFBdhQTXC3OrJ98RML", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_bk6BUY0JsF4ImDRAT3nR8" }, { "gaps": [ "Missing schema definition for response body" ], "pages": [ 1 ], "sourceId": "sds_vaNNaw5q29aKLh-qRSfR0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_SrJ_OL_N_pZ70W8niC6g0" } ], "x-zeroclick-services": [ "web-search-autocomplete" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "web-search-autocomplete", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "web-search-autocomplete", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/website-contacts-scraper/scrape-contacts": { "get": { "summary": "Scrape Contacts from Website", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "query": { "type": "string", "description": "The search query used" }, "domain": { "type": "string", "description": "The domain associated with the query" }, "emails": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string", "description": "The email address found" }, "sources": { "type": "array", "items": { "type": "string" }, "description": "List of source URLs where this email was found." } } } }, "github": { "type": "string", "description": "GitHub profile URL (or null if not found)" }, "tiktok": { "type": "string", "description": "TikTok profile URL (or null if not found)" }, "twitter": { "type": "string", "description": "Twitter/X profile URL (or null if not found)" }, "youtube": { "type": "string", "description": "YouTube channel URL (or null if not found)" }, "facebook": { "type": "string", "description": "Facebook profile URL (or null if not found)" }, "linkedin": { "type": "string", "description": "LinkedIn profile URL (or null if not found)" }, "snapchat": { "type": "string", "description": "Snapchat username (or null if not found)" }, "instagram": { "type": "string", "description": "Instagram profile URL (or null if not found)" }, "pinterest": { "type": "string", "description": "Pinterest profile URL (or null if not found)" }, "phone_numbers": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string", "description": "The phone number found" }, "sources": { "type": "array", "items": { "type": "string" }, "description": "List of source URLs where this phone number was found." } } } } } } }, "status": { "type": "string", "description": "The status of the API response (e.g., success/error)" }, "request_id": { "type": "string", "description": "Unique identifier for the API request" } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "query", "schema": { "type": "string", "example": "wsgr.com", "description": "Domain from which to scrape emails and contacts (e.g. wsgr.com). \n Accepts any valid url and uses its root domain as a starting point for the extraction. \n Support batching of up to 20 domains in a single request, separated by comma (e.g. wsgr.com,other.com). \n Please note that each domain in the request will consume a request credit from the quota." }, "example": "wsgr.com", "required": true }, { "in": "query", "name": "match_email_domain", "schema": { "type": "boolean", "default": false, "description": "Only return emails in the same domain like the one supplied with the query parameter." } }, { "in": "query", "name": "external_matching", "schema": { "type": "boolean", "default": false, "description": "Try to match any web source, in addition to website and social platforms." } } ], "description": "Scrape emails, phone numbers, and social profile links from a website root domain. Supports batching of up to 20 domains in a single request. \n Note that by default, the emails returned by the endpoint are not restricted to match the website domain (after the \"@\"), to restrict emails to the website domain, set the match_email_domain parameter to true (or 1). \n The endpoint also supports external matching of contacts (outside the company website and social profiles) by setting the external_match parameter to true (or 1).", "operationId": "website_contacts_scraper__get__scrape_contacts", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_0prF_Y5BkmqQXtEQyheXN", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_Z5rvTt1qYfVU6DSLLxPnI" }, { "gaps": [ "Missing request body/query parameter details" ], "pages": [ 1 ], "sourceId": "sds_1IfgtOxqP1q4cHvJ7VyPY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/url", "/description", "/operationId" ], "revisionId": "sdrn_mb4oPKVX4C1sgk5EHzdxz" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_2Dc9eyhO3NLPUm0GEbTiV", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_Z1eLurdzog7OgIWS9gcdZ" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_2EOeqrIsWKjYBjoNIGwV0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_ds2DI_Xad11MCFdnoGvH0" }, { "gaps": [ "Missing URL parameter" ], "pages": [ 1 ], "sourceId": "sds_5hlhZJYspBPaHxKN7OhqJ", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_3lrPg3Nc0kbMzAAAdVFHe" }, { "gaps": [ "Missing parameter details for url" ], "pages": [ 1 ], "sourceId": "sds_AF8bRESy69frdnjtCAF2z", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/url", "/description", "/operationId" ], "revisionId": "sdrn_nUAt1Ad8MTY5qaVlNUqO9" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_BowKpX7oIEvSZAa5G-8Cj", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description" ], "revisionId": "sdrn_AlkJCvRexbLp1t3wre1uD" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_bygUmn2K86zcEr8uYnytH", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_lRwIurwEjFC6EgANnKCbC" }, { "gaps": [ "Missing request parameters schema details" ], "pages": [ 1 ], "sourceId": "sds_FK2maa1cDe4qcElj5U3zU", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/url", "/description", "/operationId" ], "revisionId": "sdrn_gZ-rMsS0AnYbgxe2iW2Nm" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_fZv-ITvZDV87-KqyW2hgn", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_aohUeFTorAhUkoXJ0nrWa" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_jRl0O0t2JNWjX4MjQ_kC5", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_0KHmU6zKJBn3JfGQhhbYP" }, { "gaps": [ "Missing parameter definitions and response schema in documentation" ], "pages": [], "sourceId": "sds_MagzpRZ5Tm9d-vEaBKRmn", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/url", "/description", "/operationId" ], "revisionId": "sdrn_pej_Kh1VLu4d3ByQ4BdIs" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_MAxJPNBPJFwSKQLj1M1dr", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_QFW9HQumx231aOJCusPx0" }, { "gaps": [ "Missing explicit parameter definitions in documentation" ], "pages": [], "sourceId": "sds_MV8gWtP36-RZn0HelHkbq", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/url", "/description", "/operationId" ], "revisionId": "sdrn_zsd2yxhBG769IpVFIUWRc" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_QIFfeTcLDOFoTiC9diV0b", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_1pOKvi_ZPvz0xrF_bUbDr" }, { "gaps": [ "Missing explicit request/response schema definitions in documentation." ], "pages": [], "sourceId": "sds_ROjpin-1soeCivIbZLub5", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/url", "/description", "/operationId" ], "revisionId": "sdrn_WrJX2U_i26_CRY3Hi0cz4" }, { "gaps": [ "Missing response schema details" ], "pages": [ 1 ], "sourceId": "sds_soxpzUWt2CLoTKLGBZfNb", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/url", "/description", "/operationId" ], "revisionId": "sdrn_3H-1br_3SJ3ASZfGOL5Yr" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_SWPCFBdhQTXC3OrJ98RML", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_bk6BUY0JsF4ImDRAT3nR8" }, { "gaps": [ "Missing request body/query parameter details" ], "pages": [ 1 ], "sourceId": "sds_t1I2lol_F5DgGpe13n3Xt", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/url", "/description", "/operationId" ], "revisionId": "sdrn_OBuPoRSMenxSJ1CM3zwbN" }, { "gaps": [ "Missing request body/query parameter schema details" ], "pages": [ 1 ], "sourceId": "sds_uqg4RBYIA1YERc8Rjc_2c", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/url", "/description", "/operationId" ], "revisionId": "sdrn_cPgV56wkqJydCcYz3mJU2" }, { "gaps": [ "Missing schema definition for response body" ], "pages": [ 1 ], "sourceId": "sds_vaNNaw5q29aKLh-qRSfR0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/parameters/query/url", "/description", "/operationId" ], "revisionId": "sdrn_SrJ_OL_N_pZ70W8niC6g0" }, { "gaps": [ "Missing parameters and request body schema" ], "pages": [], "sourceId": "sds_vdxxiVsx4OKV5vH7hrhwb", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_46RDkwnCaOF5IxAFfXTW0" }, { "gaps": [ "Missing parameters and request body schema" ], "pages": [ 1 ], "sourceId": "sds_ZS-xdAQ0s8auc1LcI7Ooo", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_7knEBvR-UUuEvVL1C_QLq" } ], "x-zeroclick-services": [ "website-contacts-scraper" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "website-contacts-scraper", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "website-contacts-scraper", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/web-unblocker/request": { "post": { "summary": "Request", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "request_id", "parameters", "data" ], "properties": { "data": { "type": "object", "required": [ "status", "final_url", "headers", "body" ], "properties": { "body": { "type": "string", "description": "Raw response body returned by the target URL (typically HTML)." }, "error": { "type": "string", "nullable": true, "description": "Soft-failure error string returned by the scraper when a non-fatal failure occurred (e.g. selector not found)." }, "status": { "type": "integer", "description": "HTTP status code returned by the target URL." }, "cookies": { "type": "array", "items": { "type": "object", "required": [ "name", "value", "domain" ], "properties": { "name": { "type": "string", "description": "Cookie name." }, "path": { "type": "string", "nullable": true, "description": "Path the cookie is valid for, when set by the server." }, "value": { "type": "string", "description": "Cookie value." }, "domain": { "type": "string", "description": "Domain the cookie is valid for." } } }, "nullable": true, "description": "Cookies set by the target server." }, "headers": { "type": "object", "description": "Response headers returned by the target server, as a key-value map.", "additionalProperties": { "type": "string", "description": "A single response header value." } }, "final_url": { "type": "string", "description": "Final URL after any redirects the target server issued." }, "body_length": { "type": "integer", "nullable": true, "description": "Length in bytes of the returned response body." } } }, "status": { "type": "string", "description": "The status of the API response." }, "parameters": { "type": "object", "properties": { "url": { "type": "string", "description": "The URL that was fetched." }, "method": { "type": "string", "description": "HTTP method used for the request. Values: GET, POST, PUT, PATCH, DELETE." }, "render_js": { "type": "boolean", "description": "Whether JavaScript was rendered before returning the response." }, "wait_until": { "type": "string", "nullable": true, "description": "Page load condition used when JavaScript rendering was enabled. Values: domloaded, load, networkidle." }, "load_images": { "type": "boolean", "nullable": true, "description": "Whether images were loaded during JavaScript rendering." }, "extra_retries": { "type": "boolean", "nullable": true, "description": "Whether extra internal retries were allowed for this request." }, "load_stylesheets": { "type": "boolean", "nullable": true, "description": "Whether stylesheets were loaded during JavaScript rendering." }, "networkidle_timeout": { "type": "number", "nullable": true, "description": "Network idle timeout in seconds when wait_until is networkidle." }, "success_status_codes": { "type": "array", "items": { "type": "integer", "description": "An HTTP status code treated as success." }, "nullable": true, "description": "HTTP status codes considered successful for this request." } }, "description": "The parameters the API received and used for this request, echoed back." }, "request_id": { "type": "string", "description": "A unique ID to trace the API request." } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "description": "Reliably fetch web pages with smart retries, optional JavaScript rendering, fine-grained load controls, and proxy support. Supports all common HTTP methods (GET, POST, PUT, PATCH, and DELETE).", "operationId": "web_unblocker__post__request", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "example": { "url": "https://www.google.com", "render_js": true }, "required": [ "url" ], "properties": { "url": { "type": "string", "description": "The URL to fetch (required)." }, "body": { "type": "string", "description": "Request payload for methods that support a body (POST/PUT/PATCH). Can be a string or a JSON object.\n" }, "proxy": { "type": "string", "description": "Proxy URL to use for the request. If omitted, the API may use internal proxy networks and smart retries.\n" }, "render": { "type": "boolean" }, "cookies": { "type": "array", "items": { "type": "object", "required": [ "name", "value", "domain" ], "properties": { "name": { "type": "string", "description": "Cookie name." }, "path": { "type": "string", "description": "Path the cookie is valid for." }, "value": { "type": "string", "description": "Cookie value." }, "domain": { "type": "string", "description": "Domain the cookie is valid for." } } }, "description": "Cookies to include with the request. Each cookie includes name, value, and domain (required), and path.\n" }, "country": { "enum": [ "any", "us", "uk", "ca" ], "type": "string", "description": "Country to route the request through, so the target site sees a visitor from that country. Omit or use any for the default proxy pool. Ignored when proxy is set.\n" }, "headers": { "type": "object", "description": "HTTP headers to send with the request. Provide as a key-value object.", "additionalProperties": true }, "render_js": { "type": "boolean", "default": false, "description": "Whether to render JavaScript before returning the response. Defaults to false.\n" }, "wait_until": { "enum": [ "domloaded", "load", "networkidle" ], "type": "string", "default": "load", "description": "Page load condition when render_js is enabled. domloaded does not wait for images/subframes/async scripts; load waits for them; networkidle waits for a period of networkidle_timeout with no network connections after the page loads.\n" }, "load_images": { "type": "boolean", "default": false, "description": "Whether to allow loading images when rendering JavaScript. Defaults to false.\n" }, "extra_retries": { "type": "boolean", "default": false, "description": "If true, allows the API to perform additional internal retries when needed. If extra retries are triggered, the request will be charged 2 request credits.\n" }, "load_stylesheets": { "type": "boolean", "default": false, "description": "Whether to allow loading stylesheets when rendering JavaScript. Defaults to false.\n" }, "wait_for_timeout": { "type": "string", "description": "Time in seconds to wait after page load before extracting content." }, "success_selectors": { "type": "string", "description": "Consider the request as successful if at least one of the CSS selectors is found.\n" }, "wait_for_selector": { "type": "string", "description": "CSS selector to wait for before returning content." }, "failiure_selectors": { "type": "string", "description": "Consider the request as failed (and retry in some cases) if at least one of the CSS selectors is found.\n" }, "min_response_length": { "type": "number", "description": "Consider the request as failed (and retry in some cases) if the response body size (in bytes) is smaller than the specified value.\n" }, "networkidle_timeout": { "type": "number", "default": 0.5, "description": "Network idle timeout in seconds when wait_until is set to networkidle. Defaults to 0.5.\n" }, "success_status_codes": { "type": "array", "items": { "type": "number" }, "default": [ 200 ], "description": "Consider the request as successful if the HTTP response status code is included in this list.\n" } } }, "example": { "url": "https://www.google.com", "render_js": true } } } }, "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing detailed schema for response body" ], "pages": [ 1 ], "sourceId": "sds__1fiQu9RHG0jaOVImz_2s", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/required" ], "revisionId": "sdrn_fMzoiFNl9X0S__Sj10MeV" }, { "gaps": [ "Missing request body schema and parameters" ], "pages": [], "sourceId": "sds_-esx5FCC4ULWvRHgqpp1v", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_jYKdoWAEl7S8gKTR2MMVP" }, { "gaps": [ "Missing request body schema and parameters" ], "pages": [ 1 ], "sourceId": "sds_-LRkHZTW3kkFz3P0VCP9x", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_IFNtzsGFVdRfOmGNpEt-c" }, { "gaps": [ "Missing explicit request body schema details in documentation" ], "pages": [], "sourceId": "sds_1_LX_FbWCA7U09K5zzV8z", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/required" ], "revisionId": "sdrn_1Y4Iq_rRp239QLf6anxmA" }, { "gaps": [ "Missing request body schema", "Missing parameters" ], "pages": [], "sourceId": "sds_2mkzMPjBdeReAr1HmDREz", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_c-7MmamthDbtIrwRq96jn" }, { "gaps": [ "Missing explicit schema details in documentation; inferred from standard API patterns." ], "pages": [], "sourceId": "sds_5-N-bD-w4FEvDbPufA7rY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/required" ], "revisionId": "sdrn_JMX_MdcNKNvBSfEXsR78v" }, { "gaps": [ "Missing request body schema", "Missing parameter definitions" ], "pages": [ 1 ], "sourceId": "sds_5fumgq7Dew7p7p505C6Vj", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_UDnMGDO2AU7l2pD7FR4rR" }, { "gaps": [ "Missing request body schema", "Missing parameters" ], "pages": [], "sourceId": "sds_955t3d9uA70qPIwKC9kkP", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_fAv2s8zxL0Eg2O0xmQwzI" }, { "gaps": [ "Missing explicit documentation for request body schema and response structure in provided text." ], "pages": [], "sourceId": "sds_AF8bRESy69frdnjtCAF2z", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/required" ], "revisionId": "sdrn_nUAt1Ad8MTY5qaVlNUqO9" }, { "gaps": [ "Missing request body schema", "Missing parameter definitions" ], "pages": [ 1 ], "sourceId": "sds_AtF5v_vXxTbq1wWfTbZ8p", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_xtbL3_JhQnAYS_6AQGDiQ" }, { "gaps": [ "Missing detailed schema for response body", "Missing authentication details" ], "pages": [], "sourceId": "sds_bygUmn2K86zcEr8uYnytH", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/required" ], "revisionId": "sdrn_lRwIurwEjFC6EgANnKCbC" }, { "gaps": [ "Missing detailed request/response schema definitions in documentation." ], "pages": [], "sourceId": "sds_D1eKbJ9D0SJoHD3LLOLYI", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/required" ], "revisionId": "sdrn_WiAI6D9DA33xLudF2TJIh" }, { "gaps": [ "Missing requestBody schema", "Missing parameter definitions" ], "pages": [], "sourceId": "sds_FK2maa1cDe4qcElj5U3zU", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_gZ-rMsS0AnYbgxe2iW2Nm" }, { "gaps": [ "Missing explicit request body schema details in documentation" ], "pages": [], "sourceId": "sds_fZv-ITvZDV87-KqyW2hgn", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/required" ], "revisionId": "sdrn_aohUeFTorAhUkoXJ0nrWa" }, { "gaps": [ "Missing detailed request/response schema properties beyond url" ], "pages": [ 1 ], "sourceId": "sds_jRl0O0t2JNWjX4MjQ_kC5", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/required" ], "revisionId": "sdrn_0KHmU6zKJBn3JfGQhhbYP" }, { "gaps": [ "Missing explicit request body schema details in documentation", "Missing response schema details" ], "pages": [], "sourceId": "sds_kNNDQzbHD8UafUY8VU2At", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/required" ], "revisionId": "sdrn_CFRFpZthk-T-EyPrsqzIj" }, { "gaps": [ "Missing request body schema", "Missing parameters" ], "pages": [ 1 ], "sourceId": "sds_MagzpRZ5Tm9d-vEaBKRmn", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_pej_Kh1VLu4d3ByQ4BdIs" }, { "gaps": [ "Missing request body schema and parameters" ], "pages": [], "sourceId": "sds_MAxJPNBPJFwSKQLj1M1dr", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_QFW9HQumx231aOJCusPx0" }, { "gaps": [ "Missing request body schema", "Missing parameters" ], "pages": [], "sourceId": "sds_MeUfdaSf30qGBbwR2_Van", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_DgUH3wi-28BNw0nONekhu" }, { "gaps": [ "Missing explicit request body schema details in documentation" ], "pages": [], "sourceId": "sds_oztKPm-kDl07iy0vwLc60", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/required" ], "revisionId": "sdrn_VLRawu6tyKfr0AhBGOcro" }, { "gaps": [ "Missing detailed parameter definitions and response schema." ], "pages": [], "sourceId": "sds_pt9NurvrIG0m5qHbodTXY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/required" ], "revisionId": "sdrn_B6aXroJb6q7sAixORNC4V" }, { "gaps": [ "Missing requestBody schema", "Missing parameters" ], "pages": [ 1 ], "sourceId": "sds_QdbGBVHpS4DPABRrX92IS", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_mU_O3DmPCywqfjxJZfC0a" }, { "gaps": [ "Missing explicit request body schema details in documentation", "Missing response schema details" ], "pages": [], "sourceId": "sds_qhTee9rhe4IsP9VM8R0Jx", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/required" ], "revisionId": "sdrn_n1Qua5iIILpqbVggnqZhR" }, { "gaps": [ "Missing explicit parameter definitions in documentation" ], "pages": [], "sourceId": "sds_ROjpin-1soeCivIbZLub5", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/required" ], "revisionId": "sdrn_WrJX2U_i26_CRY3Hi0cz4" }, { "gaps": [ "Missing request body schema, parameters, and authentication details." ], "pages": [ 1 ], "sourceId": "sds_sfehAR974K7XnlJ2wifV_", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description" ], "revisionId": "sdrn_XNjJhPs6At3Kc74UpKt27" }, { "gaps": [ "Missing request body schema", "Missing parameter definitions" ], "pages": [ 1 ], "sourceId": "sds_soxpzUWt2CLoTKLGBZfNb", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_3H-1br_3SJ3ASZfGOL5Yr" }, { "gaps": [ "Missing explicit request body schema details in documentation" ], "pages": [], "sourceId": "sds_SWPCFBdhQTXC3OrJ98RML", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/required" ], "revisionId": "sdrn_bk6BUY0JsF4ImDRAT3nR8" }, { "gaps": [ "Missing request body schema and parameters" ], "pages": [ 1 ], "sourceId": "sds_UpX4G0QiFQ_cIhdwzu8pk", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_eR8hqN-7MniZX5AeOeQLh" }, { "gaps": [ "Missing explicit request body schema details in documentation", "Missing response schema details" ], "pages": [], "sourceId": "sds_uqg4RBYIA1YERc8Rjc_2c", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/required" ], "revisionId": "sdrn_cPgV56wkqJydCcYz3mJU2" }, { "gaps": [ "Missing detailed request/response schema definitions in documentation." ], "pages": [], "sourceId": "sds_vaNNaw5q29aKLh-qRSfR0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/required" ], "revisionId": "sdrn_SrJ_OL_N_pZ70W8niC6g0" }, { "gaps": [ "Missing request body schema", "Missing parameter definitions" ], "pages": [ 1 ], "sourceId": "sds_wvqPOTBJ3ELhy96dsub_l", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_f7m9IOfd1EwYpLs8JZOMM" }, { "gaps": [ "Missing detailed request/response schema properties beyond url" ], "pages": [ 1 ], "sourceId": "sds_y_pAgcC-xJrVMI2TjrXI0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/required" ], "revisionId": "sdrn_58jSAkKvEcC3bWRtd9F4t" }, { "gaps": [ "Missing explicit request body schema details in documentation" ], "pages": [], "sourceId": "sds_YxKB40zPRwtilOdTUDmjR", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/required" ], "revisionId": "sdrn_4Vk_45589KUwJSyCPBwKV" }, { "gaps": [ "Missing explicit request body schema details in documentation page." ], "pages": [], "sourceId": "sds_ZS-xdAQ0s8auc1LcI7Ooo", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId", "/requestBody/required" ], "revisionId": "sdrn_7knEBvR-UUuEvVL1C_QLq" } ], "x-zeroclick-services": [ "web-unblocker" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "web-unblocker", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "web-unblocker", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/yelp-business-data/business-details": { "get": { "summary": "Business Details", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the business" }, "name": { "type": "string", "description": "The name of the business" }, "alias": { "type": "string", "description": "The alias of the business" }, "phone": { "type": "string", "description": "The phone number of the business" }, "photo": { "type": "string", "description": "The URL of the business photo" }, "rating": { "type": "number", "description": "The rating of the business" }, "address": { "type": "string", "description": "The address of the business" }, "country": { "type": "string", "description": "The country where the business is located" }, "website": { "type": "string", "description": "The website URL of the business" }, "menu_url": { "type": "string", "description": "The URL of the business menu" }, "yelp_menu": { "type": "string", "description": "The URL to the Yelp menu of the business" }, "owner_name": { "type": "string", "description": "The name of the business owner" }, "price_range": { "type": "string", "description": "The price range of the business" }, "review_count": { "type": "integer", "description": "The number of reviews for the business" }, "owner_biography": { "type": "string", "description": "A short biography of the business owner" }, "owner_photo_url": { "type": "string", "description": "The URL of the business owner's photo" }, "business_page_link": { "type": "string", "description": "The link to the business page" } } } }, "status": { "type": "string", "description": "The status of the response" }, "request_id": { "type": "string", "description": "The unique identifier for the request" } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "business_id", "schema": { "type": "string" }, "example": "TRBP1G1l8vZkjgfqdx96Cw", "required": true, "description": "Yelp business id or alias to fetch details for. \n In addition, batching of up to 20 Business Ids or aliases is supported in a single request using a comma separated list (e.g. business_id=id1,id2)." }, { "in": "query", "name": "yelp_domain", "schema": { "enum": [ "yelp.com", "yelp.com.au", "yelp.co.nz", "ms.yelp.my", "yelp.cz", "yelp.dk", "yelp.de", "yelp.at", "de.yelp.ch", "en.yelp.be", "yelp.ca", "en.yelp.com.hk", "en.yelp.my", "en.yelp.com.ph", "yelp.ie", "yelp.com.sg", "en.yelp.ch", "yelp.co.uk", "yelp.com.ar", "yelp.cl", "yelp.es", "yelp.com.mx", "fil.yelp.com.ph", "yelp.fr", "fr.yelp.ca", "fr.yelp.ch", "fr.yelp.be", "yelp.no", "yelp.pl", "yelp.pot", "yelp.com.br", "fi.yelp.fi", "sv.yelp.fi", "yelp.se", "yelp.com.tr", "yelp.co.jp", "zh.yelp.com.hk", "yelp.com.tw" ], "type": "string", "default": "yelp.com" }, "description": "The yelp domain to use for the search." } ], "description": "Fetch a single or multiple business details from Yelp.", "operationId": "yelp_business_data__get__business_details", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_0prF_Y5BkmqQXtEQyheXN", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_Z5rvTt1qYfVU6DSLLxPnI" }, { "gaps": [ "Missing parameter details" ], "pages": [ 1 ], "sourceId": "sds_1IfgtOxqP1q4cHvJ7VyPY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_mb4oPKVX4C1sgk5EHzdxz" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_2Dc9eyhO3NLPUm0GEbTiV", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_Z1eLurdzog7OgIWS9gcdZ" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_2EOeqrIsWKjYBjoNIGwV0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_ds2DI_Xad11MCFdnoGvH0" }, { "gaps": [ "Missing business ID parameter" ], "pages": [ 1 ], "sourceId": "sds_5hlhZJYspBPaHxKN7OhqJ", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_3lrPg3Nc0kbMzAAAdVFHe" }, { "gaps": [ "Missing parameter details for business_id" ], "pages": [ 1 ], "sourceId": "sds_AF8bRESy69frdnjtCAF2z", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_nUAt1Ad8MTY5qaVlNUqO9" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_BowKpX7oIEvSZAa5G-8Cj", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description" ], "revisionId": "sdrn_AlkJCvRexbLp1t3wre1uD" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_bygUmn2K86zcEr8uYnytH", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_lRwIurwEjFC6EgANnKCbC" }, { "gaps": [ "Missing request parameters schema details" ], "pages": [ 1 ], "sourceId": "sds_FK2maa1cDe4qcElj5U3zU", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_gZ-rMsS0AnYbgxe2iW2Nm" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_fZv-ITvZDV87-KqyW2hgn", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_aohUeFTorAhUkoXJ0nrWa" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_jRl0O0t2JNWjX4MjQ_kC5", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_0KHmU6zKJBn3JfGQhhbYP" }, { "gaps": [ "Missing parameter definitions and response schema in documentation" ], "pages": [], "sourceId": "sds_MagzpRZ5Tm9d-vEaBKRmn", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_pej_Kh1VLu4d3ByQ4BdIs" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_MAxJPNBPJFwSKQLj1M1dr", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_QFW9HQumx231aOJCusPx0" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_QIFfeTcLDOFoTiC9diV0b", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_1pOKvi_ZPvz0xrF_bUbDr" }, { "gaps": [ "Missing response schema details" ], "pages": [ 1 ], "sourceId": "sds_soxpzUWt2CLoTKLGBZfNb", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_3H-1br_3SJ3ASZfGOL5Yr" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_SWPCFBdhQTXC3OrJ98RML", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_bk6BUY0JsF4ImDRAT3nR8" }, { "gaps": [ "Missing parameter details" ], "pages": [ 1 ], "sourceId": "sds_t1I2lol_F5DgGpe13n3Xt", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_OBuPoRSMenxSJ1CM3zwbN" }, { "gaps": [ "Missing request body/query parameter schema details" ], "pages": [ 1 ], "sourceId": "sds_uqg4RBYIA1YERc8Rjc_2c", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_cPgV56wkqJydCcYz3mJU2" }, { "gaps": [ "Missing schema definition for response body" ], "pages": [ 1 ], "sourceId": "sds_vaNNaw5q29aKLh-qRSfR0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_SrJ_OL_N_pZ70W8niC6g0" }, { "gaps": [ "Missing parameters" ], "pages": [], "sourceId": "sds_vdxxiVsx4OKV5vH7hrhwb", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_46RDkwnCaOF5IxAFfXTW0" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_x7ttfFTcDVeDC-z6q5Fme", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_CYVDOGPj9Fd8EmU6tGOk8" }, { "gaps": [ "Missing parameters and request body schema" ], "pages": [ 1 ], "sourceId": "sds_ZS-xdAQ0s8auc1LcI7Ooo", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_7knEBvR-UUuEvVL1C_QLq" } ], "x-zeroclick-services": [ "yelp-business-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "yelp-business-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "yelp-business-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/yelp-business-data/business-reviews": { "get": { "summary": "Business Reviews", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "total": { "type": "integer", "description": "The total number of reviews." }, "review_languages": { "type": "array", "items": { "type": "object", "properties": { "count": { "type": "integer", "description": "The number of reviews in this language." }, "language": { "type": "string", "description": "The language of the reviews." } } } } } }, "status": { "type": "string", "description": "The status of the response." }, "request_id": { "type": "string", "description": "A unique identifier for the request." } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "business_id", "schema": { "type": "string" }, "example": "TRBP1G1l8vZkjgfqdx96Cw", "required": true, "description": "Yelp business id or alias to fetch reviews for." }, { "in": "query", "name": "page", "schema": { "type": "integer", "default": 1 }, "description": "Page to return (each page includes up to 10 results)." }, { "in": "query", "name": "page_size", "schema": { "type": "integer", "default": 10 }, "description": "Results page size. Allowed values: 1-45." }, { "in": "query", "name": "num_pages", "schema": { "type": "integer", "default": 1 }, "description": "Number of pages to return, starting from page. Allowed values: 1-10. \n\n **Note:** requests for more than one page are charged 2x." }, { "in": "query", "name": "sort", "schema": { "enum": [ "BEST_MATCH", "NEWEST", "OLDEST", "HIGHEST_RATED", "LOWEST_RATED", "ELITES" ], "type": "string", "default": "BEST_MATCH" }, "description": "How to sort reviews in the results. Note that the ELITES value will cause the API to only return reviews posted by elite members." }, { "in": "query", "name": "query", "schema": { "type": "string" }, "description": "Return reviews matching a text query" }, { "in": "query", "name": "language", "schema": { "type": "string", "default": "en" }, "description": "Only return reviews of a certain language. \n For a list of supported language codes see https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2." } ], "description": "Fetch a single or multiple business review pages from Yelp (each page includes up to 10 reviews).", "operationId": "yelp_business_data__get__business_reviews", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_0prF_Y5BkmqQXtEQyheXN", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_Z5rvTt1qYfVU6DSLLxPnI" }, { "gaps": [ "Missing parameter details" ], "pages": [ 1 ], "sourceId": "sds_1IfgtOxqP1q4cHvJ7VyPY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_mb4oPKVX4C1sgk5EHzdxz" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_2Dc9eyhO3NLPUm0GEbTiV", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_Z1eLurdzog7OgIWS9gcdZ" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_2EOeqrIsWKjYBjoNIGwV0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_ds2DI_Xad11MCFdnoGvH0" }, { "gaps": [ "Missing business ID parameter" ], "pages": [ 1 ], "sourceId": "sds_5hlhZJYspBPaHxKN7OhqJ", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_3lrPg3Nc0kbMzAAAdVFHe" }, { "gaps": [ "Missing parameter details for business_id" ], "pages": [ 1 ], "sourceId": "sds_AF8bRESy69frdnjtCAF2z", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_nUAt1Ad8MTY5qaVlNUqO9" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_BowKpX7oIEvSZAa5G-8Cj", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description" ], "revisionId": "sdrn_AlkJCvRexbLp1t3wre1uD" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_bygUmn2K86zcEr8uYnytH", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_lRwIurwEjFC6EgANnKCbC" }, { "gaps": [ "Missing request parameters schema details" ], "pages": [ 1 ], "sourceId": "sds_FK2maa1cDe4qcElj5U3zU", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_gZ-rMsS0AnYbgxe2iW2Nm" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_fZv-ITvZDV87-KqyW2hgn", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_aohUeFTorAhUkoXJ0nrWa" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_jRl0O0t2JNWjX4MjQ_kC5", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_0KHmU6zKJBn3JfGQhhbYP" }, { "gaps": [ "Missing parameter definitions and response schema in documentation" ], "pages": [], "sourceId": "sds_MagzpRZ5Tm9d-vEaBKRmn", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_pej_Kh1VLu4d3ByQ4BdIs" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_MAxJPNBPJFwSKQLj1M1dr", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_QFW9HQumx231aOJCusPx0" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_QIFfeTcLDOFoTiC9diV0b", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_1pOKvi_ZPvz0xrF_bUbDr" }, { "gaps": [ "Missing response schema details" ], "pages": [ 1 ], "sourceId": "sds_soxpzUWt2CLoTKLGBZfNb", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_3H-1br_3SJ3ASZfGOL5Yr" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_SWPCFBdhQTXC3OrJ98RML", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_bk6BUY0JsF4ImDRAT3nR8" }, { "gaps": [ "Missing parameter details" ], "pages": [ 1 ], "sourceId": "sds_t1I2lol_F5DgGpe13n3Xt", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_OBuPoRSMenxSJ1CM3zwbN" }, { "gaps": [ "Missing request body/query parameter schema details" ], "pages": [ 1 ], "sourceId": "sds_uqg4RBYIA1YERc8Rjc_2c", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_cPgV56wkqJydCcYz3mJU2" }, { "gaps": [ "Missing schema definition for response body" ], "pages": [ 1 ], "sourceId": "sds_vaNNaw5q29aKLh-qRSfR0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_SrJ_OL_N_pZ70W8niC6g0" }, { "gaps": [ "Missing parameters" ], "pages": [], "sourceId": "sds_vdxxiVsx4OKV5vH7hrhwb", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_46RDkwnCaOF5IxAFfXTW0" }, { "gaps": [ "Missing parameters and request body schema" ], "pages": [ 1 ], "sourceId": "sds_ZS-xdAQ0s8auc1LcI7Ooo", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_7knEBvR-UUuEvVL1C_QLq" } ], "x-zeroclick-services": [ "yelp-business-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "yelp-business-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "yelp-business-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/yelp-business-data/business-search": { "get": { "summary": "Business Search", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "required": [ "id", "alias", "name", "business_page_link" ], "properties": { "id": { "type": "string", "description": "Unique Yelp business ID." }, "name": { "type": "string", "description": "Business name." }, "tags": { "type": "array", "items": { "type": "string", "description": "A single Yelp tag." }, "nullable": true, "description": "Additional Yelp tags for the business (e.g. waitlist info)." }, "alias": { "type": "string", "description": "Human-readable Yelp business alias (used in URLs)." }, "phone": { "type": "string", "nullable": true, "description": "Business phone number in E.164 format." }, "photo": { "type": "string", "nullable": true, "description": "URL of the business's lead photo." }, "rating": { "type": "number", "nullable": true, "description": "Average Yelp rating of the business (0-5)." }, "country": { "type": "string", "nullable": true, "description": "ISO 3166-1 alpha-2 country code of the business." }, "website": { "type": "string", "nullable": true, "description": "Business website URL." }, "latitude": { "type": "number", "nullable": true, "description": "Business latitude coordinate." }, "longitude": { "type": "number", "nullable": true, "description": "Business longitude coordinate." }, "categories": { "type": "array", "items": { "type": "object", "required": [ "title" ], "properties": { "url": { "type": "string", "nullable": true, "description": "URL of the Yelp category search results page." }, "title": { "type": "string", "description": "Category label." } } }, "nullable": true, "description": "Yelp categories the business belongs to." }, "price_range": { "type": "string", "nullable": true, "description": "Yelp price range indicator. Values: $, $$, $$$, $$$$." }, "review_count": { "type": "integer", "nullable": true, "description": "Total number of Yelp reviews for the business." }, "neighborhoods": { "type": "array", "items": { "type": "string", "description": "A neighborhood label." }, "nullable": true, "description": "Neighborhood labels Yelp associates with the business." }, "yelp_guaranteed": { "type": "boolean", "nullable": true, "description": "Whether the business participates in Yelp Guaranteed." }, "photos_page_link": { "type": "string", "nullable": true, "description": "URL of the business's Yelp photos page." }, "business_page_link": { "type": "string", "description": "Canonical URL of the business page on Yelp." }, "business_highlights": { "type": "array", "items": { "type": "string", "description": "A single business highlight label." }, "nullable": true, "description": "Highlight tags Yelp surfaces for the business." } } }, "description": "The Yelp businesses matching the query." }, "status": { "type": "string", "description": "The status of the response" }, "request_id": { "type": "string", "description": "A unique identifier for the request" } } } } }, "description": "Successful Response" }, "401": { "description": "Agent identity credential required: register once, then retry with Authorization: Bearer ." }, "403": { "description": "No active plan covers this call; the body lists the plans that do. Buy one with your bearer, then retry." } }, "parameters": [ { "in": "query", "name": "query", "schema": { "type": "string" }, "example": "Pizza", "required": true, "description": "Search query / keyword" }, { "in": "query", "name": "location", "schema": { "type": "string" }, "example": "San Francisco, CA, USA", "required": true, "description": "Search location." }, { "in": "query", "name": "sort_by", "schema": { "enum": [ "RECOMMENDED", "HIGHEST_RATED", "REVIEW_COUNT" ], "type": "string", "default": "RECOMMENDED" }, "description": "Return the results in a specific sort order." }, { "in": "query", "name": "start", "schema": { "type": "integer", "default": 0 }, "description": "Number of results to skip. Mainly used for pagination." }, { "in": "query", "name": "price_range", "schema": { "type": "string" }, "description": "Find business with specific price ranges, specified as a comma delimited list of the following values: $, $$, $$$, $$$$." }, { "in": "query", "name": "yelp_domain", "schema": { "enum": [ "yelp.com", "yelp.com.au", "yelp.co.nz", "ms.yelp.my", "yelp.cz", "yelp.dk", "yelp.de", "yelp.at", "de.yelp.ch", "en.yelp.be", "yelp.ca", "en.yelp.com.hk", "en.yelp.my", "en.yelp.com.ph", "yelp.ie", "yelp.com.sg", "en.yelp.ch", "yelp.co.uk", "yelp.com.ar", "yelp.cl", "yelp.es", "yelp.com.mx", "fil.yelp.com.ph", "yelp.fr", "fr.yelp.ca", "fr.yelp.ch", "fr.yelp.be", "yelp.no", "yelp.pl", "yelp.pot", "yelp.com.br", "fi.yelp.fi", "sv.yelp.fi", "yelp.se", "yelp.com.tr", "yelp.co.jp", "zh.yelp.com.hk", "yelp.com.tw" ], "type": "string", "default": "yelp.com" }, "description": "The yelp domain to use for the search." } ], "description": "Search for Yelp businesses by query / keyword and location.", "operationId": "yelp_business_data__get__business_search", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_L_Fsr74jXxRwFrRFUiukT", "authority": "official", "conflicts": [], "revisionId": "sdrn_k7aDX9EQEDjv-fDfLqcvI" }, { "gaps": [ "Missing query parameters and response schema" ], "pages": [ 1 ], "sourceId": "sds_0prF_Y5BkmqQXtEQyheXN", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_Z5rvTt1qYfVU6DSLLxPnI" }, { "gaps": [ "Missing parameter details" ], "pages": [ 1 ], "sourceId": "sds_1IfgtOxqP1q4cHvJ7VyPY", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_mb4oPKVX4C1sgk5EHzdxz" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_2Dc9eyhO3NLPUm0GEbTiV", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_Z1eLurdzog7OgIWS9gcdZ" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_2EOeqrIsWKjYBjoNIGwV0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_ds2DI_Xad11MCFdnoGvH0" }, { "gaps": [ "Missing parameter details for query" ], "pages": [ 1 ], "sourceId": "sds_AF8bRESy69frdnjtCAF2z", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_nUAt1Ad8MTY5qaVlNUqO9" }, { "gaps": [ "Missing request parameters schema details" ], "pages": [ 1 ], "sourceId": "sds_FK2maa1cDe4qcElj5U3zU", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_gZ-rMsS0AnYbgxe2iW2Nm" }, { "gaps": [ "Missing parameter definitions and response schema in documentation" ], "pages": [], "sourceId": "sds_MagzpRZ5Tm9d-vEaBKRmn", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_pej_Kh1VLu4d3ByQ4BdIs" }, { "gaps": [ "Missing response schema details" ], "pages": [ 1 ], "sourceId": "sds_soxpzUWt2CLoTKLGBZfNb", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_3H-1br_3SJ3ASZfGOL5Yr" }, { "gaps": [ "Missing parameters, request body, and response schema details." ], "pages": [], "sourceId": "sds_SWPCFBdhQTXC3OrJ98RML", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_bk6BUY0JsF4ImDRAT3nR8" }, { "gaps": [ "Missing parameter details" ], "pages": [ 1 ], "sourceId": "sds_t1I2lol_F5DgGpe13n3Xt", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_OBuPoRSMenxSJ1CM3zwbN" }, { "gaps": [ "Missing request body/query parameter schema details" ], "pages": [ 1 ], "sourceId": "sds_uqg4RBYIA1YERc8Rjc_2c", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_cPgV56wkqJydCcYz3mJU2" }, { "gaps": [ "Missing schema definition for response body" ], "pages": [ 1 ], "sourceId": "sds_vaNNaw5q29aKLh-qRSfR0", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_SrJ_OL_N_pZ70W8niC6g0" }, { "gaps": [ "Missing parameters" ], "pages": [], "sourceId": "sds_vdxxiVsx4OKV5vH7hrhwb", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_46RDkwnCaOF5IxAFfXTW0" }, { "gaps": [ "Missing parameters and request body schema" ], "pages": [ 1 ], "sourceId": "sds_ZS-xdAQ0s8auc1LcI7Ooo", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/description", "/operationId" ], "revisionId": "sdrn_7knEBvR-UUuEvVL1C_QLq" } ], "x-zeroclick-services": [ "yelp-business-data" ], "x-payment-info": { "access": "plan", "price": { "mode": "dynamic", "currency": "USD", "min": "0.030000" }, "rates": [ { "service": "yelp-business-data", "meter": "requests", "unit": "request", "unitSize": 10, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "yelp-business-data", "meter": "requests", "quantity": 1 } ] }, "security": [ { "planAccess": [] } ] } }, "/zeroclick/agent/quote": { "post": { "operationId": "sellerAgentQuote", "summary": "Get a free seller API quote and purchase guide", "description": "Describe your task to get the matching API contract, prices, prerequisites and next steps. This is a $0 wallet-proof lookup, not the seller's paid service. No purchase is executed. Without a wallet, use /zeroclick/agent/guide.", "servers": [ { "url": "https://agents.openwebninja.com/zcj/wsqwtmip0rp5" } ], "security": [ { "sellerAgentX402": [] }, { "sellerAgentMpp": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "goal": { "type": "string", "minLength": 1, "maxLength": 2000, "description": "Describe the task and known inputs. Do not include credentials." }, "quantity": { "description": "Number of API calls, not returned items. Omit when unknown; describe desired output in goal.", "type": "integer", "minimum": 1, "maximum": 1000000 }, "budgetUsd": { "description": "Total cash budget in USD. A quote does not authorize spending.", "type": "string", "pattern": "^(0|[1-9]\\d{0,8})(\\.\\d{1,6})?$" }, "budgetExclusive": { "type": "boolean" }, "reviewAfterCalls": { "type": "integer", "minimum": 1, "maximum": 1000000 }, "requirements": { "type": "string", "minLength": 1, "maxLength": 300 }, "humanAvailable": { "description": "Whether a human is in the loop. False recommends anonymous auth for a new autonomous identity; omit when unknown. Executing a human's request without further interruptions does not by itself mean false.", "type": "boolean" }, "payment": { "description": "Known payment method for the eventual purchase, independent of this free lookup's wallet proof.", "type": "string", "enum": [ "x402", "mpp", "card" ] } }, "required": [ "goal" ], "additionalProperties": false }, "example": { "goal": "Find the available services, prices and purchase steps" } } } }, "responses": { "200": { "description": "Task guidance; inspect status before executing anything", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "status": { "type": "string", "enum": [ "quoted", "catalog", "ready", "needs_input", "blocked", "unknown", "unsupported", "unavailable" ] }, "priceUsd": { "type": "string", "const": "0" }, "guide": { "type": "string", "description": "Markdown guidance containing the task result, exact contract, pricing and next steps when available. No purchase is executed." }, "guideUrl": { "type": "string", "format": "uri", "description": "Wallet-free advisor endpoint for further planning or recovery." } }, "required": [ "status", "priceUsd", "guide", "guideUrl" ], "additionalProperties": false } } } }, "402": { "description": "$0 x402 or MPP wallet proof required; sign and retry the same request. No funds are transferred." }, "503": { "description": "Advisor unavailable; use the wallet-free guide or direct storefront references" } }, "x-payment-info": { "access": "payg", "price": { "mode": "fixed", "currency": "USD", "amount": "0" }, "protocols": [ { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } }, { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } } ], "offers": [ { "amount": "0", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "method": "tempo", "intent": "charge", "description": "Free seller advisor lookup" } ] } } } }, "x-zeroclick-navigation-footer": { "instructions": [ "Use this spec if it contains the operation and details you need. Otherwise, search or open a relevant service spec using the links below.", "Find service slugs in x-zeroclick-services or x-payment-info.rates[].service; use them in serviceSpecTemplate, never as request values.", "URL-encode template values. Search is ranked; service, path, and method filters are exact. Filters combine.", "Pages contain up to 10 operations; follow info.x-next or the Link header if you need more results. Shared operations retain all selector values." ], "fullSpec": "https://agents.openwebninja.com/zcj/wsqwtmip0rp5/openapi.json", "services": "https://agents.openwebninja.com/zcj/wsqwtmip0rp5/services", "serviceSpecTemplate": "https://agents.openwebninja.com/zcj/wsqwtmip0rp5/services/{slug}/openapi.json", "searchTemplate": "https://agents.openwebninja.com/zcj/wsqwtmip0rp5/openapi.json?q={text}", "operationTemplate": "https://agents.openwebninja.com/zcj/wsqwtmip0rp5/openapi.json?path={path}&method={method}", "firstPage": "https://agents.openwebninja.com/zcj/wsqwtmip0rp5/openapi.json?page=1" } }