{ "openapi": "3.0.1", "info": { "title": "Gas Prices API - US Gasoline & Diesel by State, Weekly Histo", "description": "Official US gas prices as JSON, no API key: weekly retail regular, midgrade, premium gasoline and diesel prices (USD/gallon) for the US, 10 PADD regions, 9 states and 10 cities from the EIA survey, with week-over-week and year-over-year change, 52-week high/low, history since 1990 (weekly, monthly o", "version": "0.1", "x-build-id": "yfBKYiF3WD2Gi6bya" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/martin10291~us-gas-prices-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-martin10291-us-gas-prices-api", "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/martin10291~us-gas-prices-api/runs": { "post": { "operationId": "runs-sync-martin10291-us-gas-prices-api", "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/martin10291~us-gas-prices-api/run-sync": { "post": { "operationId": "run-sync-martin10291-us-gas-prices-api", "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": "Mode", "enum": [ "latest", "history", "trip", "areas" ], "type": "string", "description": "latest = newest weekly price per area and fuel with weekly/yearly change and 52-week high/low; history = price series between startDate and endDate (weekly, or monthly/yearly averages); trip = fuel cost of a trip from distance and fuel economy at the current local price; areas = list of covered areas, fuels and first week.", "default": "latest" }, "areas": { "title": "Areas", "type": "array", "description": "US, PADD1..PADD5 (East Coast, Midwest, Gulf Coast, Rocky Mountain, West Coast), PADD1A/1B/1C, PADD5XCA, states CA CO FL MA MN NY OH TX WA, cities BOS CHI CLE DEN HOU LAX MIA NYC SFO SEA, or names like 'California' / 'New York City'. 'all' = every area. Empty = all areas for latest, US for history and trip.", "items": { "type": "string" } }, "fuels": { "title": "Fuels", "type": "array", "description": "regular, midgrade, premium, allGrades, diesel ('all' = every fuel). Empty = regular + diesel for latest, regular for history and trip. Diesel is published for US, PADD regions, CA and PADD5XCA.", "items": { "type": "string" } }, "sort": { "title": "Sort (latest)", "enum": [ "area", "priceAsc", "priceDesc", "changeWeek" ], "type": "string", "description": "latest mode: area order (default), cheapest first, most expensive first, or biggest weekly rise first.", "default": "area" }, "startDate": { "title": "Start date (history)", "type": "string", "description": "history mode: first week, YYYY-MM-DD (or YYYY / YYYY-MM). Default one year ago. Gasoline from 1990/1994, diesel from 1994." }, "endDate": { "title": "End date (history)", "type": "string", "description": "history mode: last week, YYYY-MM-DD. Default latest." }, "interval": { "title": "Interval (history)", "enum": [ "weekly", "monthly", "yearly" ], "type": "string", "description": "history mode: weekly survey values, or monthly / yearly averages of the weekly values.", "default": "weekly" }, "distanceMiles": { "title": "Distance in miles (trip)", "type": "number", "description": "trip mode: trip distance in miles (or use distanceKm)." }, "distanceKm": { "title": "Distance in km (trip)", "type": "number", "description": "trip mode: trip distance in kilometers (used when distanceMiles is empty)." }, "mpg": { "title": "Miles per gallon (trip)", "type": "number", "description": "trip mode: vehicle fuel economy in US mpg. Default 25 when litersPer100km is also empty." }, "litersPer100km": { "title": "Liters per 100 km (trip)", "type": "number", "description": "trip mode: fuel economy in L/100 km (used when mpg is empty)." }, "limit": { "title": "Max rows", "minimum": 1, "maximum": 20000, "type": "integer", "description": "Maximum rows returned (1-20000). Default 1000.", "default": 1000 }, "onlyNew": { "title": "Only new weeks (monitor)", "type": "boolean", "description": "Return only rows not returned before for this Monitor ID, e.g. schedule weekly to get each new EIA release once.", "default": false }, "monitorId": { "title": "Monitor ID", "type": "string", "description": "Name of the monitor state used by onlyNew. Different IDs keep separate memories." } } }, "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 } } } } } } } } } }