{ "openapi": "3.0.1", "info": { "title": "Google Trends Scraper - Pay Only for Results", "description": "Google Trends data as clean JSON, CSV or Excel: interest over time, interest by region down to metro areas, related queries, and a trend summary per term. Failed lookups are never charged, and most no-data answers are free.", "version": "0.1", "x-build-id": "hIt66BTkaaS6tDxle" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/mongoose_atl~google-trends-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-mongoose_atl-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/mongoose_atl~google-trends-scraper/runs": { "post": { "operationId": "runs-sync-mongoose_atl-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/mongoose_atl~google-trends-scraper/run-sync": { "post": { "operationId": "run-sync-mongoose_atl-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", "required": [ "searchTerms" ], "properties": { "searchTerms": { "title": "Search terms", "type": "array", "description": "One search term per line. Each line produces one result. To compare terms against each other on the same 0-100 scale, put up to 5 on one line separated by commas, for example: pickleball, padel, tennis", "items": { "type": "string" } }, "geo": { "title": "Region", "type": "string", "description": "Region code, for example US, GB, DE or US-GA for a US state. Leave empty for worldwide.", "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": "How far back to look. Ignored when a custom time range is set.", "default": "today 12-m" }, "customTimeRange": { "title": "Custom time range", "type": "string", "description": "Optional. Start and end date separated by a space, for example: 2024-01-01 2024-12-31. Overrides the time range above." }, "searchType": { "title": "Search type", "enum": [ "web", "images", "news", "youtube", "shopping" ], "type": "string", "description": "Which Google search the interest is measured on.", "default": "web" }, "category": { "title": "Category", "minimum": 0, "type": "integer", "description": "Google Trends category number. 0 means all categories.", "default": 0 }, "language": { "title": "Language", "type": "string", "description": "Language for region names and date labels, for example en-US, de or es.", "default": "en-US" }, "includeInterestOverTime": { "title": "Interest over time", "type": "boolean", "description": "The 0-100 interest line for each term across the time range.", "default": true }, "includeInterestByRegion": { "title": "Interest by region", "type": "boolean", "description": "Interest broken down by country, state or region.", "default": true }, "includeRelatedQueries": { "title": "Related queries", "type": "boolean", "description": "Top and rising searches made by people who searched for each term.", "default": true }, "regionDetail": { "title": "Region detail", "enum": [ "default", "country", "region", "metro", "city" ], "type": "string", "description": "Experimental. How fine-grained the interest-by-region rows should be. The default returns countries for a worldwide search, and states or provinces when a region is set. If Google refuses the level you ask for, its default is returned and the result says so.", "default": "default" }, "maxAttempts": { "title": "Attempts per search term", "minimum": 1, "maximum": 10, "type": "integer", "description": "How many fresh connections to try before a search term is reported as failed. Failed search terms are never charged.", "default": 4 }, "retryFailed": { "title": "Retry failed search terms at the end", "type": "boolean", "description": "Google throttles in waves. When on, search terms that failed are tried once more after all the others have finished, about 15 seconds later. They are still charged only if they succeed.", "default": true }, "queryTimeoutSecs": { "title": "Time limit per search term (seconds)", "minimum": 10, "maximum": 600, "type": "integer", "description": "A search term that is not finished within this time is reported as failed and is not charged.", "default": 60 }, "maxConcurrency": { "title": "Search terms in parallel", "minimum": 1, "maximum": 10, "type": "integer", "description": "How many search terms to work on at once. Higher is faster but makes blocks by Google more likely.", "default": 3 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Google limits repeated requests from one address, so a proxy is required. Datacenter proxies are the cheapest. If many search terms fail, switch to residential proxies.", "default": { "useApifyProxy": true } }, "debugMode": { "title": "Debug mode", "type": "boolean", "description": "Adds a debug field to each result showing the chart requests Google issued. For troubleshooting only.", "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 } } } } } } } } } }