Bea
BEA regional income — state and county personal income, from the bulk zips.
Regional
/v1/finance:bea/regionalParameters
| Name | Type | In | Description |
|---|---|---|---|
| archive | string | query | Regional dataset archive — CAINC1 (annual county and state personal income), sqinc (quarterly state income), CAINC4, CAINC30 and the rest of the CA/SA/SQ family. Default CAINC1. |
| table | string | query | Table inside the archive, when it holds more than one. Default the first. |
| geo | string | query | Two-letter state code for the per-state file, or ALL_AREAS for every area in one. Default ALL_AREAS. |
| area | string | query | Case-insensitive filter over the area name and FIPS code. |
| line | number | query | Only the rows carrying this LineCode — 1 is total personal income in most tables. |
| from | string | query | Earliest period — a year for annual archives, 2020Q1 for quarterly ones. |
| to | string | query | Latest period, same format as `from`. |
| length | number | query | Rows to return. Default 100, max 2000. |
Example response
{"project":"finance:bea", "data": {"to":null,"geo":"ALL_AREAS","area":null,"from":null,"line":null,"count":100,"entry":"CAINC1__ALL_AREAS_1969_2024.csv", "items": [ {"unit":"Thousands of dollars","count":56,"table":"CAINC1","region":null, "values": [ {"value":24897613000,"period":"2024" }, {"value":23577208000,"period":"2023" }, {"value":22144814000,"period":"2022" } ],"geoFips":"00000","geoName":"United States","lineCode":1,"description":"Personal income (thousands of dollars)","latestValue":24897613000,"latestPeriod":"2024","industryClassification":"..." }, {"unit":"Number of persons","count":56,"table":"CAINC1","region":null, "values": [ {"value":340110988,"period":"2024" }, {"value":336806231,"period":"2023" }, {"value":334017321,"period":"2022" } ],"geoFips":"00000","geoName":"United States","lineCode":2,"description":"Population (persons) 1/","latestValue":340110988,"latestPeriod":"2024","industryClassification":"..." }, {"unit":"Dollars","count":56,"table":"CAINC1","region":null, "values": [ {"value":73204,"period":"2024" }, {"value":70002,"period":"2023" }, {"value":66298,"period":"2022" } ],"geoFips":"00000","geoName":"United States","lineCode":3,"description":"Per capita personal income (dollars) 2/","latestValue":73204,"latestPeriod":"2024","industryClassification":"..." } ],"table":"CAINC1","total":9627, "tables": [ "CAINC1" ],"archive":"CAINC1","dataset":"regional", "periods": [ "1969", "1970", "1971" ],"provider":"bea" },"timestamp":"2026-08-21T02:22:43Z"}
Errors
- 401Missing or invalid x-api-key
- 404Not found or private
- 429Rate limit or monthly quota reached
Series
The BEA's NIPA series register — 10,781 series with their labels, metrics and
/v1/finance:bea/seriesParameters
| Name | Type | In | Description |
|---|---|---|---|
| query | string | query | Case-insensitive filter over the series code, label and metric. |
| series | string | query | Exact series codes, comma-separated. Overrides `query`. |
| table | string | query | Only series that appear on this table. |
| metric | string | query | Only series whose metric matches, case-insensitive substring. |
| length | number | query | Series to return. Default 100, max 2000. |
Example response
{"project":"finance:bea", "data": {"count":46, "items": [ {"label":"Gross domestic product","metric":"Fisher Quantity Index","series":"A191RA","parents":[], "appearsOn": [ {"line":1,"table":"T10103" }, {"line":1,"table":"T10203" }, {"line":1,"table":"T10303" } ],"calculation":"Level","defaultScale":0 }, {"label":"Gross domestic product","metric":"Current Dollars","series":"A191RC", "parents": [ "A001RC", "A712RC", "A962RC" ], "appearsOn": [ {"line":1,"table":"OECD10205" }, {"line":1,"table":"T10105" }, {"line":1,"table":"T10205" } ],"calculation":"Level","defaultScale":-6 }, {"label":"Gross domestic product","metric":"Chained Dollar IPDs","series":"A191RD","parents":[], "appearsOn": [ {"line":1,"table":"T10109" } ],"calculation":"Level","defaultScale":0 } ],"query":"gross domestic product","table":null,"total":46,"metric":null,"series":null,"dataset":"series","provider":"bea","registered":10781 },"timestamp":"2026-08-21T02:22:43Z"}
Errors
- 401Missing or invalid x-api-key
- 404Not found or private
- 429Rate limit or monthly quota reached
Gdp
US gross domestic product — the GDP cut of the NIPA flat files.
/v1/finance:bea/gdpParameters
| Name | Type | In | Description |
|---|---|---|---|
| measure | enum | query | Which cut: level, change, contribution. Default change. One of level, change, contribution. |
| frequency | enum | query | A annual, Q quarterly, M monthly. Default Q. Contributions and chained dollars are quarterly and annual only. One of A, Q, M. |
| from | string | query | Earliest period in the file's own format — 2020 for annual, 2020Q1 for quarterly, 2020M01 for monthly. |
| to | string | query | Latest period, same format as `from`. |
| length | number | query | Observations per series, newest first. Default 40, max 20000. |
Example response
{"project":"finance:bea", "data": {"to":null,"from":null,"count":3, "items": [ {"count":40,"label":"Gross domestic product","total":317,"metric":"Fisher Quantity Index","series":"A191RL", "values": [ {"value":1.5,"period":"2026Q2" }, {"value":2.1,"period":"2026Q1" }, {"value":0.5,"period":"2025Q4" }, {"value":4.4,"period":"2025Q3" }, {"value":3.8,"period":"2025Q2" }, {"value":-0.6,"period":"2025Q1" }, {"value":1.9,"period":"2024Q4" }, {"value":3.3,"period":"2024Q3" } ],"calculation":"Percent change, annual rate","latestValue":1.5,"defaultScale":0,"latestPeriod":"2026Q2" }, {"count":40,"label":"Gross domestic product, current dollars","total":317,"metric":"Current Dollars","series":"A191RP", "values": [ {"value":7.9,"period":"2026Q2" }, {"value":5.8,"period":"2026Q1" }, {"value":4.2,"period":"2025Q4" }, {"value":8.3,"period":"2025Q3" }, {"value":6,"period":"2025Q2" }, {"value":2.9,"period":"2025Q1" }, {"value":4.3,"period":"2024Q4" }, {"value":5.1,"period":"2024Q3" } ],"calculation":"Percent change, annual rate","latestValue":7.9,"defaultScale":0,"latestPeriod":"2026Q2" }, {"count":40,"label":"Gross domestic product","total":317,"metric":"Fisher Price Index","series":"A191RV", "values": [ {"value":6.2,"period":"2026Q2" }, {"value":3.6,"period":"2026Q1" }, {"value":3.7,"period":"2025Q4" }, {"value":3.8,"period":"2025Q3" }, {"value":2.1,"period":"2025Q2" }, {"value":3.6,"period":"2025Q1" }, {"value":2.4,"period":"2024Q4" }, {"value":1.8,"period":"2024Q3" } ],"calculation":"Percent change, annual rate","latestValue":6.2,"defaultScale":0,"latestPeriod":"2026Q2" } ],"total":951, "series": [ "A191RL", "A191RP", "A191RV" ],"dataset":"gdp","measure":"change","missing":[],"provider":"bea", "resolved": [ "A191RL", "A191RP", "A191RV" ],"frequency":"Q","truncated":false },"timestamp":"2026-08-21T02:22:43Z"}
Errors
- 401Missing or invalid x-api-key
- 404Not found or private
- 429Rate limit or monthly quota reached
Nipa
Dated observations for any NIPA series, from the BEA's flat files.
/v1/finance:bea/nipaParameters
| Name | Type | In | Description |
|---|---|---|---|
| series | string | query | NIPA series codes, comma-separated, up to 25. `series` and `tables` find them. Default A191RL (real GDP, percent change, annual rate). |
| frequency | enum | query | A annual, Q quarterly, M monthly. Default Q. Not every series exists at every frequency. One of A, Q, M. |
| from | string | query | Earliest period in the file's own format — 2020 for annual, 2020Q1 for quarterly, 2020M01 for monthly. |
| to | string | query | Latest period, same format as `from`. |
| length | number | query | Observations per series, newest first. Default 40, max 20000. |
Example response
{"project":"finance:bea", "data": {"to":null,"from":null,"count":2, "items": [ {"count":40,"label":"Gross domestic product","total":317,"metric":"Fisher Quantity Index","series":"A191RL", "values": [ {"value":1.5,"period":"2026Q2" }, {"value":2.1,"period":"2026Q1" }, {"value":0.5,"period":"2025Q4" }, {"value":4.4,"period":"2025Q3" }, {"value":3.8,"period":"2025Q2" }, {"value":-0.6,"period":"2025Q1" }, {"value":1.9,"period":"2024Q4" }, {"value":3.3,"period":"2024Q3" } ],"calculation":"Percent change, annual rate","latestValue":1.5,"defaultScale":0,"latestPeriod":"2026Q2" }, {"count":40,"label":"Gross domestic product","total":318,"metric":"Current Dollars","series":"A191RC", "values": [ {"value":32475210,"period":"2026Q2" }, {"value":31865721,"period":"2026Q1" }, {"value":31422526,"period":"2025Q4" }, {"value":31098027,"period":"2025Q3" }, {"value":30485729,"period":"2025Q2" }, {"value":30042113,"period":"2025Q1" }, {"value":29825182,"period":"2024Q4" }, {"value":29511664,"period":"2024Q3" } ],"calculation":"Level","latestValue":32475210,"defaultScale":-6,"latestPeriod":"2026Q2" } ],"total":635, "series": [ "A191RL", "A191RC" ],"dataset":"nipa","missing":[],"provider":"bea", "resolved": [ "A191RL", "A191RC" ],"frequency":"Q","truncated":false },"timestamp":"2026-08-21T02:22:43Z"}
Errors
- 401Missing or invalid x-api-key
- 404Not found or private
- 429Rate limit or monthly quota reached
Tables
The BEA's NIPA table register — the table ids `series` joins against.
/v1/finance:bea/tablesParameters
| Name | Type | In | Description |
|---|---|---|---|
| query | string | query | Case-insensitive filter over the table id and title. |
| length | number | query | Tables to return. Default 200, max 1000. |
Example response
{"project":"finance:bea", "data": {"count":45, "items": [ {"table":"T10101","title":"Table 1.1.1. Percent Change From Preceding Period in Real Gross Domestic Product" }, {"table":"T10102","title":"Table 1.1.2. Contributions to Percent Change in Real Gross Domestic Product" }, {"table":"T10103","title":"Table 1.1.3. Real Gross Domestic Product, Quantity Indexes" }, {"table":"T10104","title":"Table 1.1.4. Price Indexes for Gross Domestic Product" }, {"table":"T10105","title":"Table 1.1.5. Gross Domestic Product" }, {"table":"T10106","title":"Table 1.1.6. Real Gross Domestic Product, Chained Dollars" }, {"table":"T10107","title":"Table 1.1.7. Percent Change From Preceding Period in Prices for Gross Domestic Product" }, {"table":"T10108","title":"Table 1.1.8. Contributions to Percent Change in the Gross Domestic Product Price Index" } ],"query":"gross domestic product","total":45,"dataset":"tables","provider":"bea" },"timestamp":"2026-08-21T02:22:43Z"}
Errors
- 401Missing or invalid x-api-key
- 404Not found or private
- 429Rate limit or monthly quota reached
Pce
US personal consumption expenditures — the PCE cut of the NIPA flat files.
/v1/finance:bea/pceParameters
| Name | Type | In | Description |
|---|---|---|---|
| measure | enum | query | Which cut: level, change, contribution. Default change. One of level, change, contribution. |
| frequency | enum | query | A annual, Q quarterly, M monthly. Default Q. Every PCE measure here is published at all three. One of A, Q, M. |
| from | string | query | Earliest period in the file's own format — 2020 for annual, 2020Q1 for quarterly, 2020M01 for monthly. |
| to | string | query | Latest period, same format as `from`. |
| length | number | query | Observations per series, newest first. Default 40, max 20000. |
Example response
{"project":"finance:bea", "data": {"to":null,"from":null,"count":3, "items": [ {"count":40,"label":"Personal consumption expenditures","total":317,"metric":"Fisher Quantity Index","series":"DPCERL", "values": [ {"value":3.2,"period":"2026Q2" }, {"value":0.5,"period":"2026Q1" }, {"value":1.9,"period":"2025Q4" }, {"value":3.5,"period":"2025Q3" }, {"value":2.5,"period":"2025Q2" }, {"value":0.6,"period":"2025Q1" }, {"value":3.9,"period":"2024Q4" }, {"value":4,"period":"2024Q3" } ],"calculation":"Percent change, annual rate","latestValue":3.2,"defaultScale":0,"latestPeriod":"2026Q2" }, {"count":40,"label":"Personal consumption expenditures","total":317,"metric":"Fisher Price Index","series":"DPCERV", "values": [ {"value":5.1,"period":"2026Q2" }, {"value":4.6,"period":"2026Q1" }, {"value":2.9,"period":"2025Q4" }, {"value":2.8,"period":"2025Q3" }, {"value":2.1,"period":"2025Q2" }, {"value":3.4,"period":"2025Q1" }, {"value":2.5,"period":"2024Q4" }, {"value":1.7,"period":"2024Q3" } ],"calculation":"Percent change, annual rate","latestValue":5.1,"defaultScale":0,"latestPeriod":"2026Q2" }, {"count":40,"label":"Personal consumption expenditures (PCE)","total":314,"metric":"Fisher Quantity Index","series":"DPCERO", "values": [ {"value":2.3,"period":"2026Q2" }, {"value":2.1,"period":"2026Q1" }, {"value":2.1,"period":"2025Q4" }, {"value":2.6,"period":"2025Q3" }, {"value":2.7,"period":"2025Q2" }, {"value":3.1,"period":"2025Q1" }, {"value":3.4,"period":"2024Q4" }, {"value":3.2,"period":"2024Q3" } ],"calculation":"Percent change, year ago","latestValue":2.3,"defaultScale":0,"latestPeriod":"2026Q2" } ],"total":948, "series": [ "DPCERL", "DPCERV", "DPCERO" ],"dataset":"pce","measure":"change","missing":[],"provider":"bea", "resolved": [ "DPCERL", "DPCERV", "DPCERO" ],"frequency":"Q","truncated":false },"timestamp":"2026-08-21T02:22:43Z"}
Errors
- 401Missing or invalid x-api-key
- 404Not found or private
- 429Rate limit or monthly quota reached
Try it
Live request with your key
const data = await client.run( "finance:bea", "regional", { archive: "CAINC1", table: "SQINC1", geo: "WA", area: "Seattle", line: 1, from: "2020", to: "2024", length: 50 });
Bea
BEA regional income — state and county personal income, from the bulk zips.
/v1/…bea/regionalTry it
Parameters
archive
string · query · optional
Regional dataset archive — CAINC1 (annual county and state personal income), sqinc (quarterly state income), CAINC4, CAINC30 and the rest of the CA/SA/SQ family. Default CAINC1.
table
string · query · optional
Table inside the archive, when it holds more than one. Default the first.
geo
string · query · optional
Two-letter state code for the per-state file, or ALL_AREAS for every area in one. Default ALL_AREAS.
area
string · query · optional
Case-insensitive filter over the area name and FIPS code.
line
number · query · optional
Only the rows carrying this LineCode — 1 is total personal income in most tables.
from
string · query · optional
Earliest period — a year for annual archives, 2020Q1 for quarterly ones.
to
string · query · optional
Latest period, same format as `from`.
length
number · query · optional
Rows to return. Default 100, max 2000.
Example response
{"project":"finance:bea", "data": {"to":null,"geo":"ALL_AREAS","area":null,"from":null,"line":null,"count":100,"entry":"CAINC1__ALL_AREAS_1969_2024.csv", "items": [ {"unit":"Thousands of dollars","count":56,"table":"CAINC1","region":null, "values": [ {"value":24897613000,"period":"2024" }, {"value":23577208000,"period":"2023" }, {"value":22144814000,"period":"2022" } ],"geoFips":"00000","geoName":"United States","lineCode":1,"description":"Personal income (thousands of dollars)","latestValue":24897613000,"latestPeriod":"2024","industryClassification":"..." }, {"unit":"Number of persons","count":56,"table":"CAINC1","region":null, "values": [ {"value":340110988,"period":"2024" }, {"value":336806231,"period":"2023" }, {"value":334017321,"period":"2022" } ],"geoFips":"00000","geoName":"United States","lineCode":2,"description":"Population (persons) 1/","latestValue":340110988,"latestPeriod":"2024","industryClassification":"..." }, {"unit":"Dollars","count":56,"table":"CAINC1","region":null, "values": [ {"value":73204,"period":"2024" }, {"value":70002,"period":"2023" }, {"value":66298,"period":"2022" } ],"geoFips":"00000","geoName":"United States","lineCode":3,"description":"Per capita personal income (dollars) 2/","latestValue":73204,"latestPeriod":"2024","industryClassification":"..." } ],"table":"CAINC1","total":9627, "tables": [ "CAINC1" ],"archive":"CAINC1","dataset":"regional", "periods": [ "1969", "1970", "1971" ],"provider":"bea" },"timestamp":"2026-08-21T02:22:43Z"}
Errors
- 401Missing or invalid x-api-key
- 404Not found or private
- 429Rate limit or monthly quota reached
Code
const data = await client.run( "finance:bea", "regional", { archive: "CAINC1", table: "SQINC1", geo: "WA", area: "Seattle", line: 1, from: "2020", to: "2024", length: 50 });