{ "openapi": "3.0.1", "info": { "title": "Google Trends Scraper", "description": "Get Google Trends data for up to 5 compared keywords: interest over time, interest by region, related queries and topics, plus daily trending searches by country. Pay only for results returned.", "version": "0.1", "x-build-id": "fo9FrjgvW6Cx9Si40" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/muhammad_noman_riaz~google-trends-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-muhammad_noman_riaz-google-trends-scraper", "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/muhammad_noman_riaz~google-trends-scraper/runs": { "post": { "operationId": "runs-sync-muhammad_noman_riaz-google-trends-scraper", "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/muhammad_noman_riaz~google-trends-scraper/run-sync": { "post": { "operationId": "run-sync-muhammad_noman_riaz-google-trends-scraper", "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", "properties": { "searchTerms": { "title": "Search terms", "type": "array", "description": "Keywords to look up on Google Trends. With Compare terms on, up to 5 terms are compared in one request, like the Trends website. More than 5 are split into groups of 5.", "items": { "type": "string" } }, "compareTerms": { "title": "Compare terms", "type": "boolean", "description": "On: all terms (up to 5) share one scale and come back as one comparison result. Off: each term is looked up on its own and returns its own result.", "default": true }, "geo": { "title": "Country (geo)", "type": "string", "description": "Two-letter country code such as US, GB or DE, or a region code such as US-CA. Leave empty for worldwide. Trending searches need a country.", "default": "" }, "timeRange": { "title": "Time range", "enum": [ "now 1-H", "now 4-H", "now 1-d", "now 7-d", "today 1-m", "today 3-m", "today 12-m", "today 5-y", "all" ], "type": "string", "description": "Period to analyze. Ignored when Custom time range is filled in.", "default": "today 12-m" }, "customTimeRange": { "title": "Custom time range", "pattern": "^([0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{4}-[0-9]{2}-[0-9]{2})?$", "type": "string", "description": "Optional exact dates as \"YYYY-MM-DD YYYY-MM-DD\", for example \"2024-01-01 2024-06-30\". Overrides Time range." }, "category": { "title": "Category", "minimum": 0, "type": "integer", "description": "Google Trends category ID. 0 means all categories. The ID is the cat= value in a Google Trends URL.", "default": 0 }, "property": { "title": "Search type", "enum": [ "", "images", "news", "froogle", "youtube" ], "type": "string", "description": "Which Google search to analyze.", "default": "" }, "includeInterestOverTime": { "title": "Interest over time", "type": "boolean", "description": "Adds the timeline of relative interest (0 to 100).", "default": true }, "includeInterestByRegion": { "title": "Interest by region", "type": "boolean", "description": "Adds interest per country (worldwide) or per subregion (when a country is set).", "default": true }, "includeRelatedQueries": { "title": "Related queries", "type": "boolean", "description": "Adds top and rising related queries for each term.", "default": true }, "includeRelatedTopics": { "title": "Related topics (experimental)", "type": "boolean", "description": "Adds top and rising related topics. Google only offers these for single terms, so they are skipped in comparisons. In our tests Google returned an empty topics list to automated requests, so expect it to often be empty.", "default": false }, "includeTrendingNow": { "title": "Trending searches", "type": "boolean", "description": "Also returns the current trending searches for the chosen country, with approximate search volume and news links. Each trending search is one result.", "default": false }, "maxRequestRetries": { "title": "Max request retries", "minimum": 1, "maximum": 20, "type": "integer", "description": "How many times a request is tried, each time on a new proxy IP, before it is skipped.", "default": 6 }, "proxy": { "title": "Proxy configuration", "type": "object", "description": "Proxy used for requests. Residential proxies are recommended because Google Trends rate-limits quickly.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } } } }, "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 } } } } } } } } } }