{ "openapi": "3.0.1", "info": { "title": "FRED Federal Reserve Economic Data — 800K+ Time Series", "description": "Extract economic time series from St. Louis Fed FRED API. 800K+ series including GDP, unemployment, CPI, treasury yields, mortgage rates, exchange rates. For macroeconomic dashboards, fintech apps, trading signals, and economic research. Free 32-char API key required.", "version": "0.1", "x-build-id": "exXgTwZcf4GVtBkF2" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/compute-edge~fred-economic-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-compute-edge-fred-economic-scraper", "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/compute-edge~fred-economic-scraper/runs": { "post": { "operationId": "runs-sync-compute-edge-fred-economic-scraper", "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/compute-edge~fred-economic-scraper/run-sync": { "post": { "operationId": "run-sync-compute-edge-fred-economic-scraper", "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": { "apiKey": { "title": "FRED API Key", "type": "string", "description": "Your 32-character FRED API key from https://fredaccount.stlouisfed.org/apikeys. Required." }, "mode": { "title": "Mode", "enum": [ "series_observations", "series_search", "category_series", "releases" ], "type": "string", "description": "Endpoint mode: series_observations (fetch time-series data), series_search (search series by text), category_series (list all series in a category), or releases (list data release schedules).", "default": "series_observations" }, "seriesIds": { "title": "Series IDs (for series_observations)", "type": "string", "description": "Comma-separated FRED series IDs. Examples: GDP, UNRATE, CPIAUCSL, FEDFUNDS, DFF, T10Y2Y, PAYEMS, HOUST, MORTGAGE30US, DGS10, SP500, VIXCLS, UMCSENT, INDPRO, RSAFS, ICSA. Default: GDP. (Used only in series_observations mode.)", "default": "GDP" }, "searchText": { "title": "Search Text (for series_search)", "type": "string", "description": "Free-text search query. Examples: 'unemployment rate', 'inflation', 'treasury yield'. (Used only in series_search mode.)", "default": "" }, "categoryId": { "title": "Category ID (for category_series)", "type": "integer", "description": "FRED category numeric ID. Example: 32991 = 'Money, Banking, & Finance'. (Used only in category_series mode.)", "default": 32991 }, "observationStart": { "title": "Observation Start Date", "type": "string", "description": "Earliest observation date in YYYY-MM-DD format. Leave blank for oldest available data. (series_observations only.)", "default": "" }, "observationEnd": { "title": "Observation End Date", "type": "string", "description": "Latest observation date in YYYY-MM-DD format. Leave blank for most recent data. (series_observations only.)", "default": "" }, "frequency": { "title": "Resample Frequency", "enum": [ "", "d", "w", "bw", "m", "q", "sa", "a" ], "type": "string", "description": "Resample frequency: '' (native), 'd' (daily), 'w' (weekly), 'bw' (biweekly), 'm' (monthly), 'q' (quarterly), 'sa' (semi-annual), 'a' (annual). (series_observations only.)", "default": "" }, "aggregationMethod": { "title": "Aggregation Method", "enum": [ "avg", "sum", "eop" ], "type": "string", "description": "How to aggregate when resampling: 'avg' (average), 'sum' (sum), 'eop' (end of period). (series_observations only.)", "default": "avg" }, "units": { "title": "Units", "enum": [ "lin", "chg", "ch1", "pch", "pc1", "pca", "cch", "cca", "log" ], "type": "string", "description": "Transform units: 'lin' (raw), 'chg' (change), 'ch1' (change-over-1), 'pch' (percent change), 'pc1' (percent change over 1), 'pca' (compound annual pct change), 'cch' (continuously compounded change), 'cca' (continuously compounded annual change), 'log' (natural log). (series_observations only.)", "default": "lin" }, "sortOrder": { "title": "Sort Order", "enum": [ "asc", "desc" ], "type": "string", "description": "Sort observations by date: 'asc' (ascending) or 'desc' (descending).", "default": "desc" }, "maxResults": { "title": "Max Results", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Maximum number of results to fetch. 0 = unlimited (up to API limits: 100,000 for observations, 1,000 for series searches).", "default": 1000 } } }, "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 } } }, "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 } } } } } } } } } }