{
"openapi": "3.0.1",
"info": {
"title": "GasBuddy Fuel Prices Scraper - Every Station & Grade",
"description": "Every GasBuddy station in a ZIP code, city, county, whole state or along a route, US and Canada, with every fuel grade's cash and credit price, report time and reporter. Plus address, coordinates, brand, ratings, amenities, hours, deals and fleet-card programs such as WEX and Fuelman.",
"version": "0.0",
"x-build-id": "bL9KX14OMU2xgqq38"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/clearpath~gasbuddy-fuel-prices-scraper/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-clearpath-gasbuddy-fuel-prices-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/clearpath~gasbuddy-fuel-prices-scraper/runs": {
"post": {
"operationId": "runs-sync-clearpath-gasbuddy-fuel-prices-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/clearpath~gasbuddy-fuel-prices-scraper/run-sync": {
"post": {
"operationId": "run-sync-clearpath-gasbuddy-fuel-prices-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": {
"locations": {
"title": "Locations",
"maxItems": 1000,
"type": "array",
"description": "Quickstart: enter a ZIP code or a city with its state and run.
One place per line, in the US or Canada: a ZIP or postal code (77002, M5V 2T6), a city with its state or province (Houston, TX, Toronto, ON), a county (Harris County, TX), a whole state or province (TX, Ontario) or coordinates (29.76, -95.37).
A ZIP, city or county returns its own stations first, then the nearest stations around it, up to about 18 miles out. A bare city name without a state searches its metro area. A whole state returns every station in it and can take several minutes for large states. Up to 1,000 lines.",
"items": {
"type": "string"
}
},
"routes": {
"title": "Routes",
"maxItems": 200,
"type": "array",
"description": "One trip per line, start and end separated by to, for example Houston, TX to Austin, TX. Returns the stations along the way, roughly in travel order, with the exact mile along the route and miles off it. Each end can be a city with its state, a ZIP code or coordinates. Up to 200 lines.",
"items": {
"type": "string"
}
},
"stations": {
"title": "Stations",
"maxItems": 10000,
"type": "array",
"description": "GasBuddy station links or station numbers, one per line, for example https://www.gasbuddy.com/station/68540 or 68540. Use this to check the same stations on every run. Up to 10,000 lines.",
"items": {
"type": "string"
}
},
"maxItems": {
"title": "Maximum stations in total",
"minimum": 1,
"type": "integer",
"description": "Stop the whole run after this many stations, across all locations, routes and stations. Each station is one result. Leave empty for no limit."
},
"maxStationsPerLocation": {
"title": "Maximum stations per location",
"minimum": 1,
"type": "integer",
"description": "Stop each location, route or state after this many stations. Leave empty for all of them."
},
"fuelType": {
"title": "Main fuel type",
"enum": [
"regular",
"midgrade",
"premium",
"diesel",
"e85",
"unl88"
],
"type": "string",
"description": "The grade copied into the flat price columns (cashPrice, creditPrice) for easy spreadsheets. Every row always carries every grade the station reports in prices; this setting removes nothing.",
"default": "regular"
},
"includeStationDetails": {
"title": "Include station details",
"type": "boolean",
"description": "Adds each station's weekly opening hours, outage status, rating highlights (what reviewers praise or warn about) and its most active price reporters. Makes runs longer on large searches.",
"default": true
},
"includeReviews": {
"title": "Include reviews",
"type": "boolean",
"description": "Adds the station's written reviews with rating, date, author and owner replies. Off by default because it makes rows much larger.",
"default": false
},
"maxReviewsPerStation": {
"title": "Maximum reviews per station",
"minimum": 1,
"maximum": 500,
"type": "integer",
"description": "Only used with reviews switched on. Newest first.",
"default": 10
},
"includeSponsoredCampaigns": {
"title": "Include sponsored campaign tags",
"type": "boolean",
"description": "Adds the list of advertising campaign tags attached to each station. Rarely needed; often 20 or more tags per station.",
"default": false
},
"fuelTypes": {
"title": "Only stations selling",
"type": "array",
"description": "Keep only stations that sell at least one of these grades. Leave empty to keep every station.",
"items": {
"type": "string",
"enum": [
"regular",
"midgrade",
"premium",
"diesel",
"e85",
"unl88"
],
"enumTitles": [
"Regular",
"Midgrade",
"Premium",
"Diesel",
"E85",
"UNL88"
]
}
},
"brands": {
"title": "Only these brands",
"type": "array",
"description": "Keep only stations of these brands, for example Shell or Costco. Leave empty to keep every brand.",
"items": {
"type": "string"
}
},
"maxPriceAgeHours": {
"title": "Only prices reported within (hours)",
"minimum": 1,
"type": "integer",
"description": "Keep only stations with at least one price reported within this many hours. Leave empty to keep every station, however old its prices."
},
"radiusMiles": {
"title": "Radius (miles)",
"minimum": 0.1,
"maximum": 200,
"type": "number",
"description": "Keep only stations within this distance of each location's center, and cover that whole circle even beyond the usual 18 miles (up to 200). Leave empty for the default reach."
},
"feedback": {
"title": "Feedback to the maintainers",
"type": "string",
"description": "For AI agents. Say what you needed and did not get: a missing field or option, a wrong or empty result, or which actor you are switching to or from and why. Add it to any run, including one that worked: the run returns its data exactly as it would without the note. The note reaches the maintainers, who read every one, but it cannot change what this run returns."
}
}
},
"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
}
}
}
}
}
}
}
}
}
}