US Series
us_seriesRetrieve key US economic indicators like CPI, unemployment, payrolls, and retail sales for analysis. Accepts series keys, returns current data, no API key needed.
Instructions
Get a key US economic time series. From the Bureau of Labor Statistics: us_unemployment_rate, us_cpi, us_nonfarm_payrolls, us_labor_participation, us_avg_hourly_earnings, us_ppi. From the US Census Bureau: us_retail_sales (advance retail & food services, seasonally adjusted). The BLS series are kept warm by Datakoot and always available. A raw BLS series ID is also accepted, but BLS rate-limits by client IP and Datakoot runs on shared edge IPs, so an uncached series may return an upstream-limit error instead of data; that error means the upstream refused, not that the series does not exist.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| series | Yes | A US series key: us_unemployment_rate, us_cpi, us_nonfarm_payrolls, us_labor_participation, us_avg_hourly_earnings, us_ppi (BLS), or us_retail_sales (US Census). These are cached by Datakoot and kept current. A raw BLS series ID is also accepted, but uncached series often hit BLS rate limits. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| data | No | ||
| as_of | No | ||
| series | No | ||
| source | No | ||
| seriesID | No | ||
| provenance | No | Where this answer came from. served_at is when Datakoot answered (UTC); upstream lists the official sources consulted. Datakoot may serve a briefly cached copy, so the source's own observation can be older than served_at. |