{ "openapi": "3.0.1", "info": { "title": "Google Trends Scraper - Interest, Regions, Related & Trending", "description": "Every Google Trends signal in one run and one schema: interest over time, interest by region and city, top and rising related queries, compare up to five keywords on one scale, and Trending Now with news. A keyword with no data is free; no run-start fee.", "version": "1.0", "x-build-id": "KCxcdKyFjv8DRI1Oa" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/vonsensey~google-trends-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-vonsensey-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/vonsensey~google-trends-scraper/runs": { "post": { "operationId": "runs-sync-vonsensey-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/vonsensey~google-trends-scraper/run-sync": { "post": { "operationId": "run-sync-vonsensey-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": { "mode": { "title": "What to scrape", "enum": [ "explore", "trending" ], "type": "string", "description": "**Explore** turns each keyword into a full report: interest over time, interest by region, related queries and (where Google provides them) related topics. **Trending Now** returns the currently trending searches for a country, with search volume and news.", "default": "explore" }, "keywords": { "title": "Keywords", "type": "array", "description": "One search term per line - or a Google topic id such as /m/05p0rrx (Bitcoin) for a concept rather than a phrase. Each keyword becomes one report per country and time range. Used in Explore mode.", "default": [ "chatgpt", "claude ai" ], "items": { "type": "string" } }, "compareKeywords": { "title": "Compare keywords on one shared scale", "type": "boolean", "description": "Off: each keyword is measured on its own 0-100 scale. On: keywords are compared in groups of up to five in a single request, so their values share one scale and are directly comparable - each report then lists the others it was compared with.", "default": false }, "geo": { "title": "Country or region", "type": "string", "description": "Leave empty for worldwide. An ISO country code like US or GB, or a subregion like US-CA. Used in Explore mode.", "default": "" }, "geos": { "title": "Several countries at once", "type": "array", "description": "Optional. One country or region code per line to run every keyword against several places in one go - each place is a separate report. Overrides the single country field above when set.", "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", "custom" ], "type": "string", "description": "The window each interest-over-time series covers. Google picks the bucket size (hour, day, week, month) from the span. Choose Custom to give your own dates below.", "default": "today 12-m" }, "customRange": { "title": "Custom date range", "type": "string", "description": "Only used when Time range is Custom. Two dates as YYYY-MM-DD YYYY-MM-DD, for example 2024-01-01 2024-06-30. An unusable range is reported as a free row rather than quietly replaced with a default.", "default": "" }, "category": { "title": "Category", "minimum": 0, "type": "integer", "description": "Google Trends category id to narrow the topic - 0 means all categories. For example 5 is Computers & Electronics. Leave at 0 unless you know the id you want.", "default": 0 }, "property": { "title": "Google property", "enum": [ "", "images", "news", "youtube", "froogle" ], "type": "string", "description": "Which Google surface to measure interest on: web search, Images, News, YouTube or Shopping.", "default": "" }, "regionResolution": { "title": "Region breakdown", "enum": [ "country", "region", "city", "dma" ], "type": "string", "description": "How finely to break interest down by place: whole countries, subregions/states, metro areas (US only), or cities. City data is precise but sparse - Google returns it for only a handful of places, and empty places are left out.", "default": "region" }, "includeRegions": { "title": "Include interest by region", "type": "boolean", "description": "Add the interest-by-place breakdown to each report. Turning a section off shortens the run but never changes the price - one report is one report.", "default": true }, "includeRelatedQueries": { "title": "Include related and rising queries", "type": "boolean", "description": "Add the top and rising related searches to each report, with breakout terms flagged. This is the section most buyers want.", "default": true }, "includeRelatedTopics": { "title": "Include related topics where available", "type": "boolean", "description": "Add related topics (Knowledge Graph entities) where Google provides them. Off by default because the related-topics section was empty in every session we measured; when it is empty the report says so rather than inventing rows.", "default": false }, "maxRelated": { "title": "Related rows kept per list", "minimum": 1, "maximum": 25, "type": "integer", "description": "How many entries to keep from each related list (top and rising). Google returns up to 25.", "default": 25 }, "explodeRows": { "title": "Also emit flat child rows", "type": "boolean", "description": "In addition to the bundled report, emit one free flat row per timeline point, region, related query and related topic - handy for a tidy CSV. Child rows are never charged; the bundled report is the billed unit.", "default": false }, "trendingGeos": { "title": "Countries for Trending Now", "type": "array", "description": "One country code per line. Trending Now returns the currently trending searches for each. Used in Trending Now mode.", "default": [ "US" ], "items": { "type": "string" } }, "trendingHours": { "title": "Trending window", "enum": [ "4", "24", "48", "168" ], "type": "string", "description": "How far back the trending list reaches: the last 4, 24, 48 or 168 hours (7 days). A longer window returns more terms.", "default": "24" }, "includeTrendingNews": { "title": "Include news for trending terms", "type": "boolean", "description": "Attach the latest news headlines, links, sources and timestamps to each trending term.", "default": true }, "language": { "title": "Language for labels", "type": "string", "description": "Locale for place names and text labels, such as en-US or de. Times are always reported in UTC.", "default": "en-US" }, "onlyNewSinceLastRun": { "title": "Only bill rows that are new since the last run", "type": "boolean", "description": "For a schedule. Trending Now: a term already delivered by an earlier run of this feed is skipped and not charged again. Explore: a report billed by this feed in the last 12 hours is skipped, so a daily 12-month run re-bills each day by design - the snapshot moved.", "default": false }, "stateName": { "title": "Feed name", "type": "string", "description": "Names the memory used by 'only new since the last run'. Give two schedules two different names and they track separately; leave it empty to share one feed.", "default": "" }, "maxReports": { "title": "Max keyword reports for the run", "minimum": 1, "type": "integer", "description": "A hard ceiling on billable reports across the whole run. Explore mode only.", "default": 500 }, "maxTrendingTerms": { "title": "Max trending terms for the run", "minimum": 1, "type": "integer", "description": "A hard ceiling on billable trending terms across the whole run. Trending Now mode only.", "default": 500 }, "maxCostUsd": { "title": "Stop after this much spend (USD)", "minimum": 0, "type": "number", "description": "A hard ceiling on what this run can cost, charged at your own plan's tier price. Leave at 0 for no ceiling.", "default": 0 } } }, "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 } } }, "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 } } } } } } } } } }