# BLS Data Scraper | Bureau of Labor Statistics API (`parseforge/bls-scraper`) Actor Scrape US Bureau of Labor Statistics time series data via the official BLS API v2. Export CPI, unemployment rate, employment, PPI and any BLS series to CSV, Excel, JSON or XML. - **URL**: https://apify.com/parseforge/bls-scraper.md - **Developed by:** [ParseForge](https://apify.com/parseforge) (community) - **Categories:** Developer tools, Automation, Other - **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, NaN bookmarks - **User rating**: No ratings yet ## Pricing from $19.00 / 1,000 results This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events. Since this Actor supports Apify Store discounts, the price gets lower the higher subscription plan you have. Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-event ## What's an Apify Actor? Actors are a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases. In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours, and optionally produces a well-defined JSON output, datasets with results, or files in key-value store. In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server. Actors are written with capital "A". ## How to integrate an Actor? If asked about integration, you help developers integrate Actors into their projects. You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready. The best way to integrate Actors is as follows. In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js.md): ```bash npm install apify-client ``` In Python projects, use official [Python client library](https://docs.apify.com/api/client/python.md): ```bash pip install apify-client ``` In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md): ````bash # MacOS / Linux curl -fsSL https://apify.com/install-cli.sh | bash # Windows irm https://apify.com/install-cli.ps1 | iex ```bash In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/platform/integrations/mcp.md). If your project is in a different language, use the [REST API](https://docs.apify.com/api/v2.md). For usage examples, see the [API](#api) section below. For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt). # README ![ParseForge Banner](https://github.com/ParseForge/apify-assets/blob/ad35ccc13ddd068b9d6cba33f323962e39aed5b2/banner.jpg?raw=true) ## πŸ“Š BLS Data Scraper | US Bureau of Labor Statistics API > πŸš€ **Export US economic time series in seconds.** Pull **CPI, unemployment, employment, PPI** and any of the thousands of BLS series for any date range. No API key, no registration, no CSV wrangling. > πŸ•’ **Last updated:** 2026-05-21 Β· **πŸ“Š 9 fields** per record Β· **πŸ“ˆ 500,000+ time series available** Β· **πŸ‡ΊπŸ‡Έ US government official data** Β· **πŸ“… Monthly, quarterly, and annual data** The **BLS Data Scraper** retrieves time series data from the official US Bureau of Labor Statistics API v2 and returns **9 fields per record**, including the series identifier, human-readable title, year, period, value, footnotes, and collection timestamp. The BLS is the principal federal agency responsible for measuring labor market activity, working conditions, price changes, and productivity in the US economy. The database covers **every major US economic indicator** - from consumer price inflation (CPI) and the unemployment rate to nonfarm payroll employment, hourly earnings, and the Producer Price Index. This Actor makes that data downloadable as CSV, Excel, JSON, or XML in seconds. All requests go directly to the official BLS API, so you get authoritative government data with no intermediaries. | 🎯 Target Audience | πŸ’‘ Primary Use Cases | |---|---| | Economists, financial analysts, data journalists, policy researchers, fintech developers, business intelligence teams, academic researchers | Inflation tracking, labor market analysis, economic dashboards, research datasets, financial modeling, policy briefs | --- ### πŸ“‹ What the BLS Data Scraper does Five data collection workflows in a single run: - πŸ“ˆ **CPI tracking.** Pull consumer price inflation month-by-month across any date range with `CUUR0000SA0`. - πŸ’Ό **Unemployment data.** Fetch the official US unemployment rate series with `LNS14000000`. - 🏭 **Employment figures.** Get total nonfarm payroll employment with `CES0000000001`. - πŸ’Ή **Producer prices.** Retrieve the Producer Price Index for Final Demand with `WPUFD4`. - πŸ”’ **Any BLS series.** Supply any valid BLS series ID and retrieve its full historical record. Each record includes the series ID, human-readable series title (for the most popular series), year, period code (M01-M13 for months, Q01-Q05 for quarters, A01 for annual), period name, numeric value, footnotes (such as preliminary or revised data flags), and the timestamp when the record was collected. > πŸ’‘ **Why it matters:** US economic indicators from the BLS are the primary inputs to inflation models, Federal Reserve policy decisions, and labor market research. Building your own pipeline means writing API wrappers, handling pagination, and refreshing by hand. This Actor skips all of that and delivers clean structured records on every run. --- ### 🎬 Full Demo _🚧 Coming soon: a 3-minute walkthrough showing how to go from sign-up to a downloaded economic dataset._ --- ### βš™οΈ Input
InputTypeDefaultBehavior
seriesIdsarray of strings["CUUR0000SA0", "LNS14000000"]BLS series IDs to fetch. Up to 25 per request.
startYearinteger2020First year of data to retrieve.
endYearinteger2024Last year of data to retrieve. Max range: 10 years.
maxItemsinteger10Records to return. Free plan caps at 10, paid plan at 1,000,000.
**Example: CPI and unemployment rate for 2020-2024.** ```json { "seriesIds": ["CUUR0000SA0", "LNS14000000"], "startYear": 2020, "endYear": 2024, "maxItems": 120 } ```` **Example: Employment and wage data for 2022-2024.** ```json { "seriesIds": ["CES0000000001", "CES0500000008", "CES0500000003"], "startYear": 2022, "endYear": 2024, "maxItems": 500 } ``` > ⚠️ **Good to Know:** The BLS public API v2 allows up to 25 series per request and up to 10 years per query without registration. The API can occasionally be slow to respond (government infrastructure) - the Actor automatically retries failed requests up to 10 times with backoff, so slow responses are handled gracefully. *** ### πŸ“Š Output Each record contains **9 fields**. Download the dataset as CSV, Excel, JSON, or XML. #### 🧾 Schema | Field | Type | Example | |---|---|---| | πŸ“Š `seriesId` | string | `"CUUR0000SA0"` | | πŸ“‹ `seriesTitle` | string | null | `"CPI All Urban Consumers, All Items"` | | πŸ“… `year` | string | `"2024"` | | πŸ—“οΈ `period` | string | `"M12"` | | πŸ“† `periodName` | string | `"December"` | | πŸ’Ή `value` | string | `"315.605"` | | πŸ“ `footnotes` | array of strings | `[]` | | πŸ•’ `scrapedAt` | ISO 8601 | `"2026-05-21T23:27:20.537Z"` | | ❌ `error` | string | null | `null` | #### πŸ“¦ Sample records
πŸ“ˆ CPI All Urban Consumers - December 2024 ```json { "seriesId": "CUUR0000SA0", "seriesTitle": "CPI All Urban Consumers, All Items", "year": "2024", "period": "M12", "periodName": "December", "value": "315.605", "footnotes": [], "scrapedAt": "2026-05-21T23:27:20.537Z", "error": null } ```
πŸ’Ό Unemployment Rate - January 2024 ```json { "seriesId": "LNS14000000", "seriesTitle": "Unemployment Rate", "year": "2024", "period": "M01", "periodName": "January", "value": "3.7", "footnotes": [], "scrapedAt": "2026-05-21T23:27:20.537Z", "error": null } ```
πŸ’Ή CPI - Peak pandemic inflation - June 2022 ```json { "seriesId": "CUUR0000SA0", "seriesTitle": "CPI All Urban Consumers, All Items", "year": "2022", "period": "M06", "periodName": "June", "value": "296.311", "footnotes": [], "scrapedAt": "2026-05-21T23:27:20.537Z", "error": null } ```
*** ### ✨ Why choose this Actor | | Capability | |---|---| | πŸ‡ΊπŸ‡Έ | **Official government data.** Direct from the BLS API v2 - the same source cited in every economic report. | | πŸ“Š | **500,000+ series available.** CPI, unemployment, employment, wages, PPI, productivity, and hundreds of niche sub-categories. | | πŸ“… | **Flexible date ranges.** Retrieve monthly data from 1913 to present for most series. | | ⚑ | **Fast.** 10 records in under 5 seconds, 120 records (full 5-year monthly series) in under 2 minutes. | | πŸ” | **Automatic retries.** The Actor handles slow or dropped BLS connections with 10-attempt exponential backoff. | | 🚫 | **No authentication.** Works with the public BLS API. No API key or registration needed. | | πŸ”’ | **Batch requests.** Fetch up to 25 series in a single API call for efficient multi-indicator runs. | > πŸ“Š BLS economic indicators are the foundation of every inflation model, wage study, and labor market report published in the United States. *** ### πŸ“ˆ How it compares to alternatives | Approach | Cost | Coverage | Refresh | Batch | Setup | |---|---|---|---|---|---| | **⭐ BLS Data Scraper** *(this Actor)* | $5 free credit, then pay-per-use | **500,000+ series** | **Live per run** | Up to 25 series at once | ⚑ 2 min | | BLS public data files (direct download) | Free | Full | Periodic releases | No | πŸ•’ Manual parsing | | FRED API (Federal Reserve) | Free with key | Broad, includes BLS | Live | Yes | ⏳ Registration | | Commercial data vendors | $100+/month | Broad | Daily | Yes | 🐒 Contracts | | Manual BLS website browsing | Free | Full | Per visit | No | πŸ•’ Hours | Pick this Actor when you need clean structured records, no manual work, and no pipeline maintenance. *** ### πŸš€ How to use 1. πŸ“ **Sign up.** [Create a free account with $5 credit](https://console.apify.com/sign-up?fpr=vmoqkp) (takes 2 minutes). 2. 🌐 **Open the Actor.** Go to the BLS Data Scraper page on the Apify Store. 3. 🎯 **Set input.** Enter the BLS series IDs you want, choose a start/end year, and set `maxItems`. 4. πŸš€ **Run it.** Click **Start** and let the Actor collect your data. 5. πŸ“₯ **Download.** Grab your results in the **Dataset** tab as CSV, Excel, JSON, or XML. > ⏱️ Total time from signup to downloaded dataset: **3-5 minutes.** No coding required. *** ### πŸ’Ό Business use cases
#### πŸ“ˆ Financial Analysis and Fintech - Real-time CPI feeds for inflation-linked products - Unemployment rate inputs for credit risk models - Historical wage data for compensation benchmarking - PPI feeds for supply chain cost modeling #### πŸ“° Data Journalism and Policy - Inflation charts from authoritative BLS source data - Labor market trend analysis for policy briefs - Monthly economic dashboard refreshes - Recession indicator monitoring (employment + unemployment)
#### πŸŽ“ Academic Research - Clean monthly datasets for econometric models - Reproducible studies citing official BLS data - Comparative economic analysis across decades - Training sets for economic forecasting ML models #### 🏒 Business Intelligence - Inflation-adjusted pricing model inputs - Wage benchmarking against national averages - Economic condition indicators for strategic planning - Regional labor market comparisons for site selection
*** ### πŸ”Œ Automating BLS Data Scraper Control the scraper programmatically for scheduled runs and pipeline integrations: - 🟒 **Node.js.** Install the `apify-client` NPM package. - 🐍 **Python.** Use the `apify-client` PyPI package. - πŸ“š See the [Apify API documentation](https://docs.apify.com/api/v2) for full details. The [Apify Schedules feature](https://docs.apify.com/platform/schedules) lets you trigger this Actor on any cron interval. Monthly runs aligned with BLS release dates keep your downstream databases in sync automatically with the latest CPI, employment, and wage figures. *** ### 🌟 Beyond business use cases Data like this powers more than commercial workflows. The same structured records support research, education, civic projects, and personal initiatives.
#### πŸŽ“ Research and academia - Econometric analysis using official US government data - Longitudinal studies on inflation, wages, and employment - Reproducible research with citable BLS source data - Teaching economic concepts with real historical datasets #### 🎨 Personal and creative - Personal finance dashboards tracking real inflation - Side projects visualizing historical economic cycles - Portfolio demos combining economic and market data - Hobby economic blogs backed by authoritative sources
#### 🀝 Non-profit and civic - Transparency reports on local vs national inflation - Policy advocacy backed by official labor statistics - Investigative journalism on wage stagnation trends - Community economic impact studies and grant proposals #### πŸ§ͺ Experimentation - Train economic forecasting and anomaly-detection models - Validate fintech product hypotheses with real cycle data - Prototype economic alert pipelines on real BLS releases - Test data visualization libraries with authoritative time series
*** ### πŸ€– Ask an AI assistant about this scraper Open a ready-to-send prompt about this ParseForge actor in the AI of your choice: - πŸ’¬ [**ChatGPT**](https://chat.openai.com/?q=How%20do%20I%20use%20the%20BLS%20Data%20Scraper%20by%20ParseForge%20on%20Apify%3F%20Show%20me%20input%20examples%2C%20output%20fields%2C%20common%20use%20cases%2C%20and%20how%20to%20integrate%20it%20into%20a%20workflow.) - 🧠 [**Claude**](https://claude.ai/new?q=How%20do%20I%20use%20the%20BLS%20Data%20Scraper%20by%20ParseForge%20on%20Apify%3F%20Show%20me%20input%20examples%2C%20output%20fields%2C%20common%20use%20cases%2C%20and%20how%20to%20integrate%20it%20into%20a%20workflow.) - πŸ” [**Perplexity**](https://perplexity.ai/search?q=How%20do%20I%20use%20the%20BLS%20Data%20Scraper%20by%20ParseForge%20on%20Apify%3F%20Show%20me%20input%20examples%2C%20output%20fields%2C%20common%20use%20cases%2C%20and%20how%20to%20integrate%20it%20into%20a%20workflow.) - πŸ…’ [**Copilot**](https://copilot.microsoft.com/?q=How%20do%20I%20use%20the%20BLS%20Data%20Scraper%20by%20ParseForge%20on%20Apify%3F%20Show%20me%20input%20examples%2C%20output%20fields%2C%20common%20use%20cases%2C%20and%20how%20to%20integrate%20it%20into%20a%20workflow.) *** ### ❓ Frequently Asked Questions #### 🧩 How does it work? Enter the BLS series IDs you want, set a date range (start year / end year), and click Start. The Actor sends a POST request to the official BLS API v2, receives the time series data, and emits one record per data point (one month, quarter, or year). No browser automation, no captchas, no manual steps. #### πŸ“ Where does the data come from? Directly from the US Bureau of Labor Statistics official API at `api.bls.gov/publicAPI/v2`. The BLS is the principal federal statistical agency measuring labor market activity, price changes, and productivity in the US economy. #### πŸ”’ How do I find BLS series IDs? Visit the [BLS Data Finder](https://www.bls.gov/data/) and browse to the dataset you need. Each series has an ID shown in the URL or data table. Popular IDs: `CUUR0000SA0` (CPI), `LNS14000000` (Unemployment Rate), `CES0000000001` (Nonfarm Employment), `WPUFD4` (PPI). #### πŸ“… How far back does the data go? Most BLS series go back decades. The CPI series starts in 1913, unemployment goes to 1948. The public API allows up to 10 years per request - for longer ranges, run multiple requests with different date windows. #### πŸ” How often is the data updated? The BLS releases most major series monthly. Running this Actor immediately after a BLS release (usually the second week of each month for CPI) gives you the freshest data. Every run fetches live data from the official API. #### ⏰ Can I schedule regular runs? Yes. Use Apify Schedules to run this Actor on any cron interval. Set a monthly schedule aligned with BLS release dates to automatically push fresh economic indicators to your database or dashboard. #### 🐒 Why does it sometimes take longer to respond? The BLS API is government infrastructure and can be slow to respond (response times of 60-90 seconds are observed). The Actor automatically retries failed connections up to 10 times with exponential backoff, so a run that looks slow is working correctly. #### πŸ’³ Do I need a paid Apify plan? No. The free Apify plan is enough for testing and small runs (10 records per run). A paid plan lifts the limit and gives you access to scheduling, higher concurrency, and larger datasets. #### πŸ” What if a run fails? Apify automatically retries transient errors. If a run fails, inspect the log in the Runs tab, confirm the series IDs are valid, and re-run. Partial datasets from failed runs are preserved so you never lose progress. #### πŸ”‘ Do I need a BLS API key? No. The public BLS API v2 works without registration for up to 25 series per request and 500 queries per day per IP. For higher limits, you can register at bls.gov for a free API key and pass it as an input in a future version. #### πŸ†˜ What if I need help? Our support team is here to help. Contact us through the Apify platform or use the Tally form linked below. *** ### πŸ”Œ Integrate with any app BLS Data Scraper connects to any cloud service via [Apify integrations](https://apify.com/integrations): - [**Make**](https://docs.apify.com/platform/integrations/make) - Automate multi-step economic workflows - [**Zapier**](https://docs.apify.com/platform/integrations/zapier) - Connect with 5,000+ apps - [**Slack**](https://docs.apify.com/platform/integrations/slack) - Get run notifications in your channels - [**Airbyte**](https://docs.apify.com/platform/integrations/airbyte) - Pipe BLS data into your warehouse - [**GitHub**](https://docs.apify.com/platform/integrations/github) - Trigger runs from commits and releases - [**Google Drive**](https://docs.apify.com/platform/integrations/drive) - Export datasets straight to Sheets You can also use webhooks to trigger downstream actions when a run finishes. Push fresh CPI or employment data into your product backend, or alert your team in Slack when a new BLS release is available. *** ### πŸ”— Recommended Actors | Actor | Description | |---|---| | [**🌿 EPA AQS Air Quality Scraper**](https://apify.com/parseforge/epa-aqs-air-quality-scraper) | US EPA air quality measurements by location and pollutant | | [**πŸ’€ CDC WONDER Mortality Scraper**](https://apify.com/parseforge/cdc-wonder-mortality-scraper) | US mortality statistics from the CDC WONDER database | | [**🏠 HUD User Data Scraper**](https://apify.com/parseforge/hud-user-data-scraper) | US housing and urban development datasets | | [**βš–οΈ USPTO Patent Assignments Scraper**](https://apify.com/parseforge/uspto-patent-assignments-scraper) | Patent assignment records from the US Patent Office | | [**πŸ“‘ FCC Broadband Map Scraper**](https://apify.com/parseforge/fcc-broadband-map-scraper) | US broadband availability and coverage data | > πŸ’‘ **Pro Tip:** browse the complete [ParseForge collection](https://apify.com/parseforge) for more US government data scrapers. *** **πŸ†˜ Need Help?** [**Open our contact form**](https://tally.so/r/BzdKgA) to request a new scraper, propose a custom data project, or report an issue. *** *This Actor uses the official, publicly accessible BLS API v2 (api.bls.gov). Data is owned by the US Bureau of Labor Statistics and is in the public domain. The Actor is not affiliated with, endorsed by, or officially connected to the US Bureau of Labor Statistics or the US Department of Labor.* # Actor input Schema ## `seriesIds` (type: `array`): BLS series IDs to fetch. Examples: CUUR0000SA0 (CPI), LNS14000000 (Unemployment Rate), CES0000000001 (Nonfarm Employment), WPUFD4 (PPI). Up to 25 series per request. ## `startYear` (type: `integer`): First year of data to retrieve (e.g. 2020). Max range: 10 years per request for unregistered use. ## `endYear` (type: `integer`): Last year of data to retrieve (e.g. 2024). ## `maxItems` (type: `integer`): Free users: Limited to 10 items (preview). Paid users: Optional, max 1,000,000 ## Actor input object example ```json { "seriesIds": [ "CUUR0000SA0", "LNS14000000" ], "startYear": 2020, "endYear": 2024, "maxItems": 10 } ``` # Actor output Schema ## `results` (type: `string`): No description # API You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup. ## JavaScript example ```javascript import { ApifyClient } from 'apify-client'; // Initialize the ApifyClient with your Apify API token // Replace the '' with your token const client = new ApifyClient({ token: '', }); // Prepare Actor input const input = { "seriesIds": [ "CUUR0000SA0", "LNS14000000" ], "startYear": 2020, "endYear": 2024, "maxItems": 10 }; // Run the Actor and wait for it to finish const run = await client.actor("parseforge/bls-scraper").call(input); // Fetch and print Actor results from the run's dataset (if any) console.log('Results from dataset'); console.log(`πŸ’Ύ Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`); const { items } = await client.dataset(run.defaultDatasetId).listItems(); items.forEach((item) => { console.dir(item); }); // πŸ“š Want to learn more πŸ“–? Go to β†’ https://docs.apify.com/api/client/js/docs ``` ## Python example ```python from apify_client import ApifyClient # Initialize the ApifyClient with your Apify API token # Replace '' with your token. client = ApifyClient("") # Prepare the Actor input run_input = { "seriesIds": [ "CUUR0000SA0", "LNS14000000", ], "startYear": 2020, "endYear": 2024, "maxItems": 10, } # Run the Actor and wait for it to finish run = client.actor("parseforge/bls-scraper").call(run_input=run_input) # Fetch and print Actor results from the run's dataset (if there are any) print("πŸ’Ύ Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"]) for item in client.dataset(run["defaultDatasetId"]).iterate_items(): print(item) # πŸ“š Want to learn more πŸ“–? Go to β†’ https://docs.apify.com/api/client/python/docs/quick-start ``` ## CLI example ```bash echo '{ "seriesIds": [ "CUUR0000SA0", "LNS14000000" ], "startYear": 2020, "endYear": 2024, "maxItems": 10 }' | apify call parseforge/bls-scraper --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=parseforge/bls-scraper", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "BLS Data Scraper | Bureau of Labor Statistics API", "description": "Scrape US Bureau of Labor Statistics time series data via the official BLS API v2. Export CPI, unemployment rate, employment, PPI and any BLS series to CSV, Excel, JSON or XML.", "version": "0.1", "x-build-id": "cKy2X9mII8GrTs9cx" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/parseforge~bls-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-parseforge-bls-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/parseforge~bls-scraper/runs": { "post": { "operationId": "runs-sync-parseforge-bls-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/parseforge~bls-scraper/run-sync": { "post": { "operationId": "run-sync-parseforge-bls-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", "required": [ "seriesIds" ], "properties": { "seriesIds": { "title": "Series IDs", "type": "array", "description": "BLS series IDs to fetch. Examples: CUUR0000SA0 (CPI), LNS14000000 (Unemployment Rate), CES0000000001 (Nonfarm Employment), WPUFD4 (PPI). Up to 25 series per request.", "items": { "type": "string" } }, "startYear": { "title": "Start Year", "minimum": 1900, "maximum": 2100, "type": "integer", "description": "First year of data to retrieve (e.g. 2020). Max range: 10 years per request for unregistered use." }, "endYear": { "title": "End Year", "minimum": 1900, "maximum": 2100, "type": "integer", "description": "Last year of data to retrieve (e.g. 2024)." }, "maxItems": { "title": "Max Items", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Free users: Limited to 10 items (preview). Paid users: Optional, max 1,000,000" } } }, "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 } } } } } } } } } } ```