{ "openapi": "3.0.1", "info": { "title": "Google Trends Scraper", "description": "Search interest over time, by region, plus related queries and what is trending now. Rotates sessions so rate limits do not fail your run. Charges only for rows it delivers.", "version": "0.1", "x-build-id": "Cf5DR8tpJ3pvcT6oQ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/munin~google-trends-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-munin-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/munin~google-trends-scraper/runs": { "post": { "operationId": "runs-sync-munin-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/munin~google-trends-scraper/run-sync": { "post": { "operationId": "run-sync-munin-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": "Terms to measure search interest for. One row per term per data point. Leave empty if you only want the \"Trending now\" lists below.", "items": { "type": "string" } }, "compareAsOneChart": { "title": "Compare terms against each other", "type": "boolean", "description": "Off (default): every term is measured on its own scale, so numbers stay comparable across runs. On: terms are put on one shared 0-100 scale, the way the Compare tab on Google Trends works. Google allows 5 terms per comparison, so longer lists are split into groups of 5.", "default": false }, "geos": { "title": "Countries or regions", "type": "array", "description": "ISO codes such as US, GB, JP, DE-BY, US-CA. Use an empty string for worldwide. Every term is fetched for every entry here.", "default": [ "" ], "items": { "type": "string" } }, "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": "The period to measure. Weekly points for a year or more, daily for 90 days or less, hourly for 7 days or less.", "default": "today 12-m" }, "customTimeRange": { "title": "Custom time range", "type": "string", "description": "Overrides the dropdown above. Format: YYYY-MM-DD YYYY-MM-DD, for example 2024-01-01 2024-12-31." }, "category": { "title": "Category", "type": "integer", "description": "Google Trends category ID, 0 for all categories. Useful when a word means two things, for example 47 (Autos & Vehicles) for \"jaguar\".", "default": 0 }, "property": { "title": "Google property", "enum": [ "web", "images", "news", "froogle", "youtube" ], "type": "string", "description": "Which Google surface the search interest comes from.", "default": "web" }, "outputs": { "title": "Data to collect", "type": "array", "description": "Related topics is not offered. Google's public endpoint returns it empty for every keyword on this access path, and we do not fake data.", "items": { "type": "string", "enum": [ "interestOverTime", "interestByRegion", "relatedQueries" ], "enumTitles": [ "Interest over time", "Interest by region", "Related queries (top and rising)" ] }, "default": [ "interestOverTime", "relatedQueries" ] }, "geoResolution": { "title": "Region detail", "enum": [ "auto", "COUNTRY", "REGION", "CITY", "DMA" ], "type": "string", "description": "Only applies to \"Interest by region\". Auto uses states or regions when you picked a country, and countries when you picked worldwide.", "default": "auto" }, "trendingNowGeos": { "title": "Trending now: countries", "type": "array", "description": "Returns what is searched right now in each country, with the news stories behind each one. Independent of the search terms above.", "items": { "type": "string" } }, "language": { "title": "Language", "type": "string", "description": "Language of region names and related queries, as a locale like en-US or ja.", "default": "en-US" }, "timezoneOffsetMinutes": { "title": "Timezone offset (minutes)", "type": "integer", "description": "Shifts which local day an hourly or daily data point falls in. 0 is UTC.", "default": 0 }, "maxItemsPerSource": { "title": "Max rows per term", "minimum": 0, "type": "integer", "description": "0 means no limit.", "default": 0 }, "maxItems": { "title": "Max rows in total", "minimum": 0, "type": "integer", "description": "Hard stop for the whole run, so you can cap what you spend. 0 means no limit.", "default": 0 }, "maxConcurrency": { "title": "Parallel requests", "minimum": 1, "maximum": 8, "type": "integer", "description": "Higher is faster but meets Google's rate limit sooner. The run recovers from rate limits on its own; this only changes how often it has to.", "default": 3 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Google Trends refuses datacenter traffic on most endpoints. Residential proxy is the default and is what makes the run succeed.", "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 } } } } } } } } } }