{ "openapi": "3.0.1", "info": { "title": "Google Trends Scraper: Interest Over Time, Regions & Queries", "description": "Google Trends data that arrives or tells you why not. Interest over time, interest by region, related queries and related topics for up to 5 compared terms, with batching for longer lists. Retries 429s with fresh sessions, never loops, and you pay only for rows delivered.", "version": "1.0", "x-build-id": "W0qP0v7uo8E2NOMcn" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/private_image_hg9~google-trends-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-private_image_hg9-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/private_image_hg9~google-trends-scraper/runs": { "post": { "operationId": "runs-sync-private_image_hg9-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/private_image_hg9~google-trends-scraper/run-sync": { "post": { "operationId": "run-sync-private_image_hg9-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": "Words or phrases to look up, e.g. \"coffee\", \"tea\". Up to 5 terms are compared with each other in one Google Trends request, exactly like the Compare box on the website. Longer lists are split into groups of 5 (see Anchor term). Up to 100 terms per run.", "items": { "type": "string" } }, "geo": { "title": "Location", "type": "string", "description": "Country or region code as Google Trends uses it: \"US\", \"GB\", \"DE\", a state like \"US-CA\", or a US metro like \"US-NY-501\". Leave blank for worldwide." }, "timeRange": { "title": "Time range", "enum": [ "past-hour", "past-4-hours", "past-day", "past-7-days", "past-30-days", "past-90-days", "past-12-months", "past-5-years", "all", "custom" ], "type": "string", "description": "The same presets as the Google Trends website. Choose Custom to enter your own dates below.", "default": "past-12-months" }, "customTimeRange": { "title": "Custom time range", "type": "string", "description": "Used when Time range is Custom. Start and end date separated by a space: \"2024-01-01 2024-06-30\". Data starts on 2004-01-01." }, "category": { "title": "Category", "minimum": 0, "type": "integer", "description": "Google Trends category id, e.g. 71 for Food & Drink or 7 for Finance. 0 means all categories.", "default": 0 }, "property": { "title": "Google property", "enum": [ "web", "images", "news", "youtube", "froogle" ], "type": "string", "description": "Which Google search to measure.", "default": "web" }, "interestOverTime": { "title": "Interest over time", "type": "boolean", "description": "One row per term per time point, with the 0 to 100 value and whether the period is still partial.", "default": true }, "interestByRegion": { "title": "Interest by region", "type": "boolean", "description": "One row per term per country (worldwide) or subregion (for a country). Regions without data are left out.", "default": true }, "relatedQueries": { "title": "Related queries (top and rising)", "type": "boolean", "description": "Searches people also made, with Google's top and rising lists.", "default": true }, "relatedTopics": { "title": "Related topics (top and rising)", "type": "boolean", "description": "Topics (people, places, things) people also searched for, with their Knowledge Graph id.", "default": true }, "anchorTerm": { "title": "Anchor term for long lists", "type": "string", "description": "Only used with more than 5 terms. Without an anchor, each group of 5 is its own comparison and values are 0 to 100 within that group only. With an anchor, every group is the anchor plus 4 other terms, and each row gets a scaledValue that puts all groups on the first group's scale. Pick a steady, popular term. It is added to your terms if missing." }, "useApifyProxy": { "title": "Use Apify Proxy", "type": "boolean", "description": "Send requests through Apify Proxy. Each 429 streak switches to a new proxy IP. Turn off only if you run the Actor on your own machine.", "default": true }, "proxyGroups": { "title": "Proxy groups", "type": "array", "description": "Apify Proxy groups to use, e.g. RESIDENTIAL. Leave empty for automatic datacenter proxies. Residential proxies get rate limited by Google far less often.", "items": { "type": "string" } }, "maxRetries": { "title": "Retries per request", "minimum": 0, "maximum": 10, "type": "integer", "description": "How many times one request is retried after a 429, a server error or a timeout. Waits grow from about 2 seconds, with random jitter.", "default": 4 }, "requestTimeoutSecs": { "title": "Request timeout (seconds)", "minimum": 5, "maximum": 120, "type": "integer", "description": "Give up on one answer from Google after this long, then retry.", "default": 30 }, "maxRunSecs": { "title": "Run time limit (seconds)", "minimum": 10, "maximum": 3600, "type": "integer", "description": "Hard limit for the whole run. No request or retry starts after it, so a run can never loop. Rows already saved are kept.", "default": 600 } } }, "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 } } } } } } } } } }