{ "openapi": "3.0.1", "info": { "title": "CPI Inflation Data: US, UK, EU, Canada, Australia", "description": "Latest consumer price index (CPI) and inflation rate data from official statistics offices: ONS, Statistics Canada, ABS, Eurostat HICP and OECD (US, China, India, Brazil, Korea). Monthly economic data and macroeconomic indicators: year-on-year and month-on-month change, release date and source link.", "version": "0.1", "x-build-id": "wj7OhOkebbBpKPdGL" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/maliksaid~inflation-cpi-tracker/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-maliksaid-inflation-cpi-tracker", "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/maliksaid~inflation-cpi-tracker/runs": { "post": { "operationId": "runs-sync-maliksaid-inflation-cpi-tracker", "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/maliksaid~inflation-cpi-tracker/run-sync": { "post": { "operationId": "run-sync-maliksaid-inflation-cpi-tracker", "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": { "countries": { "title": "Countries", "type": "array", "description": "Keep only these countries. Use two-letter codes (US, GB, DE), three-letter codes (USA, GBR) or English names. EU and EA give the European Union and euro area totals. Leave empty for every country.", "default": [], "items": { "type": "string" } }, "sources": { "title": "Statistics sources", "type": "array", "description": "Which sources to read. Leave empty for all five.", "items": { "type": "string", "enum": [ "ONS", "STATCAN", "ABS", "EUROSTAT", "OECD" ], "enumTitles": [ "UK Office for National Statistics (CPI)", "Statistics Canada (CPI)", "Australian Bureau of Statistics (monthly CPI)", "Eurostat (HICP for EU and other European countries)", "OECD prices database (US, Korea, China, India, Brazil and other countries)" ] }, "default": [] }, "categories": { "title": "Price categories", "type": "array", "description": "Which price indexes to return. All items is the headline CPI. Core is all items less food and energy (each office's own definition). Leave empty for all items only. Not every country publishes every category; see the README table.", "items": { "type": "string", "enum": [ "all-items", "core", "food", "energy" ], "enumTitles": [ "All items (headline CPI)", "Core (excluding food and energy)", "Food and non-alcoholic beverages", "Energy" ] }, "default": [ "all-items" ] }, "latestOnly": { "title": "Latest month only", "type": "boolean", "description": "Return only the newest month for each country inside the period window.", "default": true }, "monthsBack": { "title": "Months back", "minimum": 0, "maximum": 600, "type": "integer", "description": "Period window: return months from this many months ago up to the newest. Ignored when you set a start month.", "default": 12 }, "fromPeriod": { "title": "Start month", "pattern": "^$|^\\d{4}-(0[1-9]|1[0-2])$", "type": "string", "description": "Optional. First month to return, as YYYY-MM, for example 2024-01." }, "toPeriod": { "title": "End month", "pattern": "^$|^\\d{4}-(0[1-9]|1[0-2])$", "type": "string", "description": "Optional. Last month to return, as YYYY-MM. Leave empty for the newest month." }, "monitorMode": { "title": "Monitor mode (only new releases)", "type": "boolean", "description": "Return only country-months that earlier monitor-mode runs with the same monitor name did not return. Schedule the Actor with this on to get each new CPI release once.", "default": false }, "monitorName": { "title": "Monitor name", "type": "string", "description": "Name of the memory that monitor mode uses. Use a different name for each separate watch list. Inputs that still send the old field `stateKey` keep working.", "default": "default" }, "maxItems": { "title": "Maximum rows", "minimum": 0, "type": "integer", "description": "Stop after saving this many rows. The default keeps test runs short and cheap. Set 0 for no limit.", "default": 100 } } }, "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 } } } } } } } } } }