{ "openapi": "3.0.1", "info": { "title": "PrismCrawl Google Search API", "description": "Run live Google searches through the PrismCrawl API and receive normalized search results, SERP features, and pagination metadata.", "version": "0.1", "x-build-id": "2Z906wK1JyPL2BHWH" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/prismcrawl~prismcrawl-google-search-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-prismcrawl-prismcrawl-google-search-api", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/prismcrawl~prismcrawl-google-search-api/runs": { "post": { "operationId": "runs-sync-prismcrawl-prismcrawl-google-search-api", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/prismcrawl~prismcrawl-google-search-api/run-sync": { "post": { "operationId": "run-sync-prismcrawl-prismcrawl-google-search-api", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "required": [ "prismcrawlApiKey", "query" ], "properties": { "prismcrawlApiKey": { "title": "PrismCrawl API key", "type": "string", "description": "Your PrismCrawl API key, sent to PrismCrawl as the x-api-key header. Create or rotate it in the PrismCrawl dashboard; new accounts get 100 free credits. The key is stored encrypted by Apify and is never logged or written to the dataset." }, "query": { "title": "Search query", "type": "string", "description": "What to search for on Google, exactly as you would type it into the search box. Search operators such as site: work as usual. Limited to 8,192 UTF-8 bytes." }, "maxPages": { "title": "Maximum result pages", "minimum": 1, "maximum": 10, "type": "integer", "description": "How many Google result pages to fetch. The Actor stops early when PrismCrawl reports there is no next page. Each page is a separate PrismCrawl search and uses one credit.", "default": 1 }, "start": { "title": "Start offset", "minimum": 0, "type": "integer", "description": "Zero-based result offset for the first page (for example 10 starts at the second page). Leave empty to start at the first result. Later pages advance the offset by 10." }, "gl": { "title": "Country (gl)", "enum": [ "ad", "ae", "af", "ag", "ai", "al", "am", "an", "ao", "aq", "ar", "as", "at", "au", "aw", "ax", "az", "ba", "bb", "bd", "be", "bf", "bg", "bh", "bi", "bj", "bl", "bm", "bn", "bo", "bq", "br", "bs", "bt", "bv", "bw", "by", "bz", "ca", "cc", "cd", "cf", "cg", "ch", "ci", "ck", "cl", "cm", "cn", "co", "cr", "cs", "cu", "cv", "cw", "cx", "cy", "cz", "de", "dj", "dk", "dm", "do", "dz", "ec", "ee", "eg", "eh", "er", "es", "et", "fi", "fj", "fk", "fm", "fo", "fr", "ga", "gb", "gd", "ge", "gf", "gg", "gh", "gi", "gl", "gm", "gn", "gp", "gq", "gr", "gs", "gt", "gu", "gw", "gy", "hk", "hm", "hn", "hr", "ht", "hu", "id", "ie", "il", "im", "in", "io", "iq", "ir", "is", "it", "je", "jm", "jo", "jp", "ke", "kg", "kh", "ki", "km", "kn", "kp", "kr", "kw", "ky", "kz", "la", "lb", "lc", "li", "lk", "lr", "ls", "lt", "lu", "lv", "ly", "ma", "mc", "md", "me", "mf", "mg", "mh", "mk", "ml", "mm", "mn", "mo", "mp", "mq", "mr", "ms", "mt", "mu", "mv", "mw", "mx", "my", "mz", "na", "nc", "ne", "nf", "ng", "ni", "nl", "no", "np", "nr", "nu", "nz", "om", "pa", "pe", "pf", "pg", "ph", "pk", "pl", "pm", "pn", "pr", "ps", "pt", "pw", "py", "qa", "re", "ro", "rs", "ru", "rw", "sa", "sb", "sc", "sd", "se", "sg", "sh", "si", "sj", "sk", "sl", "sm", "sn", "so", "sr", "ss", "st", "sv", "sx", "sy", "sz", "tc", "td", "tf", "tg", "th", "tj", "tk", "tl", "tm", "tn", "to", "tr", "tt", "tv", "tw", "tz", "ua", "ug", "uk", "um", "us", "uy", "uz", "va", "vc", "ve", "vg", "vi", "vn", "vu", "wf", "ws", "ye", "yt", "za", "zm", "zw" ], "type": "string", "description": "Two-letter Google result-country code. Results from this country are boosted rather than strictly filtered. To restrict results to documents from a country, use Restrict to countries (cr).", "default": "us" }, "hl": { "title": "Interface language (hl)", "enum": [ "af", "sq", "am", "ar", "hy", "az", "bn", "bg", "my", "ca", "zh-CN", "zh-TW", "hr", "cs", "da", "nl", "en-GB", "en", "en-US", "et", "fil", "fi", "fr-CA", "fr", "ka", "de", "el", "gu", "iw", "he", "hi", "hu", "is", "id", "it", "ja", "kn", "kk", "km", "ko", "ky", "lo", "lv", "lt", "mk", "ms", "ml", "mr", "mn", "ne", "no", "fa", "pl", "pt-BR", "pt-PT", "pa", "ro", "ru", "sr-Latn", "sr", "si", "sk", "sl", "es-419", "es", "sw", "sv", "ta", "te", "th", "tr", "uk", "ur", "uz", "vi", "cy" ], "type": "string", "description": "Google interface language. It can also influence which results are chosen for international queries. To restrict results to documents in a language, use Restrict to languages (lr).", "default": "en-US" }, "google_domain": { "title": "Google domain", "enum": [ "google.com", "google.ad", "google.ae", "google.com.af", "google.com.ag", "google.al", "google.am", "google.co.ao", "google.com.ar", "google.as", "google.at", "google.com.au", "google.az", "google.ba", "google.com.bd", "google.be", "google.bf", "google.bg", "google.com.bh", "google.bi", "google.bj", "google.com.bn", "google.com.bo", "google.com.br", "google.bs", "google.bt", "google.co.bw", "google.by", "google.com.bz", "google.ca", "google.cd", "google.cf", "google.cg", "google.ch", "google.ci", "google.co.ck", "google.cl", "google.cm", "google.com.co", "google.co.cr", "google.com.cu", "google.cv", "google.com.cy", "google.cz", "google.de", "google.dj", "google.dk", "google.dm", "google.com.do", "google.dz", "google.com.ec", "google.ee", "google.com.eg", "google.es", "google.com.et", "google.fi", "google.com.fj", "google.fm", "google.fr", "google.ga", "google.ge", "google.gg", "google.com.gh", "google.com.gi", "google.gl", "google.gm", "google.gr", "google.com.gt", "google.gy", "google.com.hk", "google.hn", "google.hr", "google.ht", "google.hu", "google.co.id", "google.ie", "google.co.il", "google.im", "google.co.in", "google.iq", "google.is", "google.it", "google.je", "google.com.jm", "google.jo", "google.co.jp", "google.co.ke", "google.com.kh", "google.ki", "google.kg", "google.co.kr", "google.com.kw", "google.kz", "google.la", "google.com.lb", "google.li", "google.lk", "google.co.ls", "google.lt", "google.lu", "google.lv", "google.com.ly", "google.co.ma", "google.md", "google.me", "google.mg", "google.mk", "google.ml", "google.com.mm", "google.mn", "google.com.mt", "google.mu", "google.mv", "google.mw", "google.com.mx", "google.com.my", "google.co.mz", "google.com.na", "google.com.ng", "google.com.ni", "google.ne", "google.nl", "google.no", "google.com.np", "google.nr", "google.nu", "google.co.nz", "google.com.om", "google.com.pa", "google.com.pe", "google.com.pg", "google.com.ph", "google.com.pk", "google.pl", "google.pn", "google.com.pr", "google.ps", "google.pt", "google.com.py", "google.com.qa", "google.ro", "google.ru", "google.rw", "google.com.sa", "google.com.sb", "google.sc", "google.se", "google.com.sg", "google.sh", "google.si", "google.sk", "google.com.sl", "google.sn", "google.so", "google.sm", "google.sr", "google.st", "google.com.sv", "google.td", "google.tg", "google.co.th", "google.com.tj", "google.tl", "google.tm", "google.tn", "google.to", "google.com.tr", "google.tt", "google.com.tw", "google.co.tz", "google.com.ua", "google.co.ug", "google.co.uk", "google.com.uy", "google.co.uz", "google.com.vc", "google.co.ve", "google.co.vi", "google.com.vn", "google.vu", "google.ws", "google.rs", "google.co.za", "google.co.zm", "google.co.zw", "google.cat" ], "type": "string", "description": "The Google domain to search, for example google.co.uk. This is independent of country, language, and location.", "default": "google.com" }, "location": { "title": "Location", "type": "string", "description": "Search as if from a named place, for example Baltimore,Maryland,United States. The value must be an active Canonical Name from Google's geo-target list. Cannot be combined with coordinates or UULE." }, "latitude": { "title": "Latitude", "minimum": -90, "maximum": 90, "type": "number", "description": "Searcher latitude, for example 39.2904. Set together with longitude. Cannot be combined with location or UULE." }, "longitude": { "title": "Longitude", "minimum": -180, "maximum": 180, "type": "number", "description": "Searcher longitude, for example -76.6122. Set together with latitude." }, "radius": { "title": "Radius (meters)", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Bias results to within this many meters of the coordinates; results outside it may still appear. Requires latitude and longitude. Maximum 199 for desktop or no device, 1,000 for mobile or tablet." }, "device": { "title": "Device", "enum": [ "mobile", "tablet", "desktop" ], "type": "string", "description": "Search as a desktop, mobile, or tablet device. Rankings and SERP features can differ by device. Leave empty for PrismCrawl's default." }, "tbm": { "title": "Search vertical (tbm)", "enum": [ "nws", "vid", "isch", "shop", "lcl", "bks" ], "type": "string", "description": "Search a Google vertical instead of the regular results page. Leave empty for regular web results. Cannot be combined with Search tab (udm)." }, "udm": { "title": "Search tab (udm)", "enum": [ "1", "2", "6", "7", "12", "14", "28", "36", "50" ], "type": "string", "description": "Select a Google search tab by its numeric udm value, for example Web (links only) or AI Mode. Availability varies by market. Cannot be combined with Search vertical (tbm)." }, "tbs": { "title": "Time and advanced filters (tbs)", "maxLength": 512, "type": "string", "description": "Google's native advanced-filter string. Common time filters: qdr:h (past hour), qdr:d (past day), qdr:w (past week), qdr:m (past month), qdr:y (past year); add a number for multiples, e.g. qdr:m6. Custom range: cdr:1,cd_min:8/1/2026,cd_max:8/12/2026. Sort by date (News): sbd:1. Supported filters vary by vertical and market." }, "safe": { "title": "SafeSearch", "enum": [ "active", "off" ], "type": "string", "description": "Turn Google's SafeSearch filtering on or request unfiltered results. Leave empty for Google's default." }, "lr": { "title": "Restrict to languages (lr)", "pattern": "^lang_[a-z]{2,3}(\\|lang_[a-z]{2,3})*$", "type": "string", "description": "Only return documents in these languages, using lang_<code> syntax. Separate alternatives with |, e.g. lang_fr|lang_de." }, "cr": { "title": "Restrict to countries (cr)", "pattern": "^country[A-Za-z]{2}(\\|country[A-Za-z]{2})*$", "type": "string", "description": "Only return documents from these countries, using country<CC> syntax. Separate alternatives with |, e.g. countryUS|countryCA." }, "uule": { "title": "Encoded location (uule)", "pattern": "^[wa]\\+[A-Za-z0-9+/]+={0,2}$", "type": "string", "description": "A raw Google-encoded location (starting with w+ or a+), forwarded unchanged. Google may ignore unsupported values. Prefer Location unless you already have UULE strings. Cannot be combined with location or coordinates." }, "nfpr": { "title": "Spelling correction (nfpr)", "enum": [ "1", "0" ], "type": "string", "description": "Whether Google may automatically correct the spelling of your query." }, "filter": { "title": "Duplicate filtering (filter)", "enum": [ "1", "0" ], "type": "string", "description": "Request Google's duplicate-result filtering on or off. Google does not guarantee this for regular search pages." }, "pws": { "title": "Personalization (pws)", "enum": [ "0", "1" ], "type": "string", "description": "Ask Google to turn personalization off or permit it. This does not disable location, language, or device effects." }, "zero_trace": { "title": "Zero trace", "type": "boolean", "description": "When enabled, PrismCrawl does not store the source HTML or parsed JSON for these searches; only audit and billing metadata is kept. Results still appear in this Actor's dataset.", "default": false } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }