{ "openapi": "3.0.1", "info": { "title": "German Air Quality Index & Pollutants (Umweltbundesamt)", "description": "Official hourly air quality for about 400 German measuring stations from the Umweltbundesamt: air quality index plus NO2, PM10, PM2.5, ozone, SO2 and CO. Latest hour or any period since 2016, by state, city or near a location.", "version": "1.0", "x-build-id": "rjUNJeDEaGMsQ9Wcf" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/opendata-souce2026~german-air-quality-uba/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-opendata-souce2026-german-air-quality-uba", "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/opendata-souce2026~german-air-quality-uba/runs": { "post": { "operationId": "runs-sync-opendata-souce2026-german-air-quality-uba", "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/opendata-souce2026~german-air-quality-uba/run-sync": { "post": { "operationId": "run-sync-opendata-souce2026-german-air-quality-uba", "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": { "period": { "title": "Time period", "enum": [ "latest", "last24Hours", "last7Days", "custom" ], "type": "string", "description": "Latest = the most recent published hour for every station. Data is updated hourly and goes back to 2016.", "default": "latest" }, "startDate": { "title": "Start date (custom period)", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Format YYYY-MM-DD. Earliest: 2016-01-01." }, "endDate": { "title": "End date (custom period, inclusive)", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Format YYYY-MM-DD. Defaults to today." }, "states": { "title": "Federal states", "type": "array", "description": "Only stations in these states. Leave empty for all of Germany.", "items": { "type": "string", "enum": [ "BW", "BY", "BE", "BB", "HB", "HH", "HE", "MV", "NI", "NW", "RP", "SL", "SN", "ST", "SH", "TH", "UB" ], "enumTitles": [ "Baden-Württemberg", "Bayern", "Berlin", "Brandenburg", "Bremen", "Hamburg", "Hessen", "Mecklenburg-Vorpommern", "Niedersachsen", "Nordrhein-Westfalen", "Rheinland-Pfalz", "Saarland", "Sachsen", "Sachsen-Anhalt", "Schleswig-Holstein", "Thüringen", "Federal network (UBA)" ] } }, "city": { "title": "City or station name contains", "type": "string", "description": "For example \"München\", \"Berlin\" or \"Osnabrück\". Case-insensitive." }, "stationCodes": { "title": "Station codes", "type": "array", "description": "Exact station codes, e.g. DEBE010. Leave empty for all.", "items": { "type": "string" } }, "latitude": { "title": "Latitude (near a location)", "type": "string", "description": "With longitude, sorts stations by distance and adds a distanceKm field. Example: 52.52" }, "longitude": { "title": "Longitude (near a location)", "type": "string", "description": "Example: 13.405" }, "radiusKm": { "title": "Radius (km)", "minimum": 1, "type": "integer", "description": "Only stations within this distance of the location above." }, "maxStations": { "title": "Nearest N stations", "minimum": 1, "type": "integer", "description": "Keep only the N stations closest to the location above." }, "maxRows": { "title": "Maximum rows", "minimum": 1, "type": "integer", "description": "Safety limit for very long custom periods.", "default": 100000 } } }, "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 } } } } } } } } } }