{ "openapi": "3.0.1", "info": { "title": "Google Trends Scraper", "description": "Extract Google Trends data: interest over time, interest by region, related queries, and Trending Now searches with news articles, plus category and location lists.", "version": "1.0", "x-build-id": "EcoQmzRaYiA4ah9a6" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/crawlstone~google-trends-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-crawlstone-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/crawlstone~google-trends-scraper/runs": { "post": { "operationId": "runs-sync-crawlstone-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/crawlstone~google-trends-scraper/run-sync": { "post": { "operationId": "run-sync-crawlstone-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": [ "mode", "geo" ], "properties": { "mode": { "title": "Mode", "enum": [ "explore", "trendingNow", "exploreCategories", "exploreGeos" ], "type": "string", "description": "Choose what to collect. Only the fields used by the selected mode are read; the others are ignored.", "default": "explore" }, "geo": { "title": "Location", "minLength": 1, "type": "string", "description": "Used by explore and trendingNow. Enter a Google Trends location code such as US, GB, or US-CA; run List Explore locations to see every supported code. Use WW for worldwide in explore; trendingNow does not support worldwide and rejects WW.", "default": "US" }, "searchQueries": { "title": "Search queries", "maxItems": 100, "type": "array", "description": "Required for explore. Enter 1–100 lines. Each line is one Google Trends comparison: separate up to 5 terms with commas, for example bitcoin, ethereum.", "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", "custom" ], "type": "string", "description": "Used by explore. Choose a Google Trends preset, or Custom range to use the custom time range below.", "default": "today 12-m" }, "customTimeRange": { "title": "Custom time range", "type": "string", "description": "Required when Time range is Custom range, and ignored otherwise. Enter a start and end date as YYYY-MM-DD YYYY-MM-DD; the start must not be after the end." }, "category": { "title": "Category", "minimum": 0, "type": "integer", "description": "Used by explore. Google Trends category ID; 0 means all categories. Run List Explore categories to see every ID.", "default": 0 }, "property": { "title": "Search type", "enum": [ "", "images", "news", "youtube", "froogle" ], "type": "string", "description": "Used by explore. Choose which Google search the interest comes from.", "default": "" }, "includeInterestOverTime": { "title": "Interest over time", "type": "boolean", "description": "Used by explore. Return one interest-over-time row per query line. Keep at least one result type enabled.", "default": true }, "includeInterestByRegion": { "title": "Interest by region", "type": "boolean", "description": "Used by explore. Return one interest-by-region row per query line. Keep at least one result type enabled.", "default": true }, "includeRelatedQueries": { "title": "Related queries", "type": "boolean", "description": "Used by explore. Return one related-queries row per term. Keep at least one result type enabled.", "default": true }, "regionResolution": { "title": "Region resolution", "enum": [ "", "COUNTRY", "REGION", "DMA", "CITY" ], "type": "string", "description": "Used by explore for interest by region. Leave as Google default, or choose a level; Google rejects levels that do not fit the location.", "default": "" }, "hours": { "title": "Trending period", "enum": [ "4", "24", "48", "168" ], "type": "string", "description": "Used by trendingNow. How far back to look for trending searches.", "default": "24" }, "maxArticlesPerTrend": { "title": "Maximum articles per trend", "minimum": 0, "maximum": 30, "type": "integer", "description": "Used by trendingNow. Number of news articles to return for each trend, 0–30. When Trending period is Past 7 days, at most 3 is allowed.", "default": 3 } } }, "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 } } } } } } } } } }