{ "openapi": "3.0.1", "info": { "title": "France Fuel Prices: Every Station, Live (prix-carburants)", "description": "Live fuel prices for every petrol station in France from the official prix-carburants open data feed. Search near an address, by postcode, city or department; get Gazole, SP95, SP98, E10, E85 and GPLc prices, cheapest ranking, shortages and services. Price-change alerts. Pay per station.", "version": "1.0", "x-build-id": "Svr7QXT2Ve8UVB9D3" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/datacraft-studio~france-fuel-prices/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-datacraft-studio-france-fuel-prices", "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/datacraft-studio~france-fuel-prices/runs": { "post": { "operationId": "runs-sync-datacraft-studio-france-fuel-prices", "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/datacraft-studio~france-fuel-prices/run-sync": { "post": { "operationId": "run-sync-datacraft-studio-france-fuel-prices", "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": { "nearAddress": { "title": "Near this address", "type": "string", "description": "Any French address, place or city, e.g. \"Place Bellecour, Lyon\". Stations within the radius are returned, nearest first." }, "radiusKm": { "title": "Radius (km)", "minimum": 1, "maximum": 200, "type": "integer", "description": "Search radius around the address or the coordinates.", "default": 10 }, "latitude": { "title": "Latitude", "type": "string", "description": "Optional instead of an address, e.g. 45.7576." }, "longitude": { "title": "Longitude", "type": "string", "description": "Optional instead of an address, e.g. 4.8317." }, "postcodes": { "title": "Postcodes", "type": "array", "description": "5-digit French postcodes, e.g. 75015.", "items": { "type": "string" } }, "cities": { "title": "Cities", "type": "array", "description": "City names (accents and case ignored). Best combined with a department to stay fast.", "items": { "type": "string" } }, "departments": { "title": "Departments", "type": "array", "description": "Department codes such as 75, 69, 2A or 974.", "items": { "type": "string" } }, "stationIds": { "title": "Station ids", "type": "array", "description": "Track specific stations by their official id (stationId in the output).", "items": { "type": "string" } }, "allFrance": { "title": "All of France", "type": "boolean", "description": "Return every station in France (about 10,000) when no area is set.", "default": false }, "fuels": { "title": "Fuels", "type": "array", "description": "Gazole (diesel), SP95, SP98, E10, E85, GPLc. Empty means all fuels.", "items": { "type": "string" } }, "onlyAvailable": { "title": "Only stations selling these fuels", "type": "boolean", "description": "Skip stations with no current price for any of the chosen fuels.", "default": true }, "maxPriceAgeDays": { "title": "Max price age (days)", "minimum": 0, "maximum": 365, "type": "integer", "description": "Prices older than this are flagged as stale and left out of rankings and statistics. 0 disables the check.", "default": 7 }, "sortBy": { "title": "Sort by", "type": "string", "description": "\"distance\" or a fuel name (cheapest first). Default: distance for address searches, otherwise the first chosen fuel." }, "onlyPriceChanges": { "title": "Only stations whose prices changed", "type": "boolean", "description": "Price alert mode for scheduled runs: skip stations whose prices are the same as in the previous run with the same state store. Previous prices are included.", "default": false }, "stateStoreName": { "title": "State store name", "type": "string", "description": "Named key-value store that remembers prices for the alert mode. Use one name per watch list.", "default": "france-fuel-prices-state" }, "includeOpeningHours": { "title": "Include opening hours", "type": "boolean", "description": "Add the weekly opening hours of each station.", "default": false }, "maxItems": { "title": "Max stations", "minimum": 1, "maximum": 15000, "type": "integer", "description": "Stop after this many stations. This caps the cost of a run.", "default": 200 } } }, "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 } } } } } } } } } }