{ "openapi": "3.0.1", "info": { "title": "US Economic Calendar API - CPI, Jobs, FOMC, GDP", "description": "US economic release calendar from official sources (BLS, BEA, Census, DOL, Federal Reserve, Treasury): CPI, jobs report, FOMC, GDP, PCE, claims, auctions, with actuals.", "version": "0.1", "x-build-id": "fDeRpS8tjpKqpiy9S" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/bigdavidson~us-economic-calendar/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-bigdavidson-us-economic-calendar", "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/bigdavidson~us-economic-calendar/runs": { "post": { "operationId": "runs-sync-bigdavidson-us-economic-calendar", "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/bigdavidson~us-economic-calendar/run-sync": { "post": { "operationId": "run-sync-bigdavidson-us-economic-calendar", "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": { "dateFrom": { "title": "From date (ET)", "type": "string", "description": "First release date to include, US Eastern. YYYY-MM-DD, or relative: 'today', 'yesterday', '-7d', '+3d'. Empty = today." }, "dateTo": { "title": "To date (ET)", "type": "string", "description": "Last release date to include (inclusive). YYYY-MM-DD or relative ('+14d', '2w', 'next month'). Empty = 14 days after the From date, or 95 days when Event keywords are set (so ['CPI'] or ['FOMC'] reaches the next release). Max range 400 days." }, "agencies": { "title": "Agencies", "type": "array", "description": "Which official sources to include. Any of: BLS (CPI, PPI, jobs report, JOLTS), BEA (GDP, PCE, trade), Census (retail sales, housing, durable goods), DOL (weekly jobless claims), Fed (FOMC decisions, press conferences, minutes, Beige Book), Treasury (auctions). Case-insensitive; aliases like 'FOMC' or 'auctions' work. Empty = all. If no name is recognised, the run returns only a free notice and charges nothing.", "items": { "type": "string" }, "default": [] }, "importance": { "title": "Minimum importance", "type": "string", "description": "'high' = market movers only (CPI, jobs, GDP, PCE, retail sales, PPI, JOLTS, FOMC). 'medium' = also claims, ECI, housing, durable goods, trade, industrial production, Beige Book, 2-30 year note/bond auctions. 'low' = everything (bill auctions, regional/state data, niche releases). Default 'medium'." }, "events": { "title": "Event keywords (optional)", "type": "array", "description": "Keep only events matching any keyword, e.g. ['CPI', 'jobs report', 'FOMC', 'GDP', 'claims', '10-year']. Case-insensitive; every word of a keyword must start a word of the event name, main official title, category or common aliases (nfp, payrolls, inflation, fed, auction). Filler words are ignored ('next CPI release' = 'CPI', 'fed meeting' finds FOMC decisions), 'and'/'or' split alternatives, '10y' = '10-year'. With keywords and no To date, the window is 95 days, so the first upcoming row is the next release. Empty = no keyword filter.", "items": { "type": "string" }, "default": [] }, "includeActuals": { "title": "Include actual / previous values", "type": "boolean", "description": "For released events, fill actual and previous: BLS releases via the keyless BLS API (cached), weekly claims from DOL, Treasury auction results (high yield/rate, bid-to-cover), FOMC target range from federalreserve.gov. GDP, PCE, retail sales, housing and other BEA/Census figures and Fed industrial production need a free FRED API key (below). Older periods carry today's revised figures (see actual_vintage), not first prints. No extra charge.", "default": true }, "maxRecords": { "title": "Max rows (optional)", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Stop after this many calendar rows (each costs $0.002). Empty = all matching rows. Rows are sorted by release time, so the earliest events are kept." }, "fredApiKey": { "title": "FRED API key (optional)", "type": "string", "description": "Your own free key from fred.stlouisfed.org (32 lowercase letters/digits). Enables actual/previous for GDP, PCE, retail sales, durable goods, housing, trade, industrial production, and a fallback for BLS and jobless claims. Used only for your run; never logged." }, "blsApiKey": { "title": "BLS API key (optional)", "type": "string", "description": "Your own free BLS registration key (bls.gov/developers). Raises the BLS limit from 25 to 500 requests/day. Without it the keyless BLS API is used and cached between runs." } } }, "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 } } } } } } } } } }