{ "openapi": "3.0.1", "info": { "title": "Google Trends Scraper: Real Data, No Fake Spikes, Any Country", "description": "Interest over time, interest by state or city, related queries and related topics from Google Trends, for any search term, place and time range. Pay only for terms that return data.", "version": "0.1", "x-build-id": "aXRdzdiLwteWu5yAR" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/trueline-data~google-trends-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-trueline-data-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/trueline-data~google-trends-scraper/runs": { "post": { "operationId": "runs-sync-trueline-data-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/trueline-data~google-trends-scraper/run-sync": { "post": { "operationId": "run-sync-trueline-data-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.", "items": { "type": "string" } }, "geo": { "title": "Location", "type": "string", "description": "Country or region code: US, GB, DE, US-FL, US-TX. Leave empty for worldwide.", "default": "US" }, "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 look at. A custom range below overrides this.", "default": "today 12-m" }, "customTimeRange": { "title": "Custom time range", "type": "string", "description": "Two dates, like 2024-01-01 2024-12-31. Overrides the time range above." }, "searchType": { "title": "Search type", "enum": [ "web", "images", "news", "shopping", "youtube" ], "type": "string", "description": "Which Google search to measure: web, images, news, Google Shopping or YouTube.", "default": "web" }, "category": { "title": "Category id", "type": "integer", "description": "Google Trends category number. 0 means all categories.", "default": 0 }, "compareTerms": { "title": "Compare terms against each other", "type": "boolean", "description": "On: terms are compared in groups of 5 on one shared 0-100 scale, like the Compare box on Google Trends. Off: each term gets its own 0-100 scale.", "default": false }, "interestOverTime": { "title": "Interest over time", "type": "boolean", "description": "A 0-100 value for each day, week or month.", "default": true }, "interestByRegion": { "title": "Interest by region", "type": "boolean", "description": "A 0-100 value for each state, region or city.", "default": true }, "regionResolution": { "title": "Region detail", "enum": [ "COUNTRY", "REGION", "DMA", "CITY" ], "type": "string", "description": "Leave empty to choose automatically: countries for worldwide, states for a country, cities for a state." }, "relatedQueries": { "title": "Related queries", "type": "boolean", "description": "Top and rising searches people also make.", "default": true }, "relatedTopics": { "title": "Related topics", "type": "boolean", "description": "Top and rising topics people also search.", "default": false }, "maxConcurrency": { "title": "Requests at the same time", "minimum": 1, "maximum": 10, "type": "integer", "description": "Google Trends limits fast traffic. 3 is safe.", "default": 3 }, "maxRetries": { "title": "Retries per term", "minimum": 0, "maximum": 10, "type": "integer", "description": "Each retry uses a new IP address.", "default": 5 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Residential IPs get clean answers. From datacenter IPs Google Trends sometimes returns noise for low-volume terms.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "US" } } } }, "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 } } } } } } } } } }