Economic and market series
Reference series are published measures that are observed rather than traded: economic statistics, interest rates, yields and spreads, index levels and volatility indices, and physical quantities. The rates, credit, and volatility views are on rates, credit, and volatility.
Routes
| you need | route |
|---|---|
| search or list series | GET /v1/series |
| one series: its latest observation, or its quote | GET /v1/series/{key} |
| a value series' observations | GET /v1/series/{key}/observations |
| a value series' projections and forecasts | GET /v1/series/{key}/projections |
| a bar series' daily bars and indicators | GET /v1/series/{key}/history, GET /v1/series/{key}/technicals |
Every parameter and response schema is in the API reference.
Series kinds and keys
Each series is one concept with one key, such as series:us.cpi.all_items.sa
(instrument keys). Its kind is its instrument_type:
| kind | what it holds | example |
|---|---|---|
economic | economic statistics: prices, employment, output | series:us.cpi.all_items.sa |
rate | interest rates, yields, and spreads | series:us.treasury.spread.10y_2y |
index | index levels and volatility indices | series:us.equity_index.sp500 |
physical | physical quantities (commodity supply and demand) | series:us.crude_oil.stocks.commercial.nsa |
GET /v1/series lists every series, filtered by instrument_type, asset_class, asset_subclass, category, or q.
Series shapes
A series is served in one shape, stated as shape in its series block:
shape | what one item is | routes | explained on |
|---|---|---|---|
values | an observation of a period (a month, a quarter, a week) | /observations, /projections | series values |
bars | a daily market bar | /history, /technicals | price history, technical indicators |
GET /v1/series/{key} answers a value series with its latest observation, and a bar series with its quote. A route of
the other shape answers 404 not_supported and names the right one.
curl "https://api.tauric.ai/v1/series/us.cpi.all_items.sa/observations?limit=12" \
-H "Authorization: Bearer $TAURIC_API_KEY"
curl "https://api.tauric.ai/v1/series/us.equity_index.sp500/history" \
-H "Authorization: Bearer $TAURIC_API_KEY"
Labor and price statistics
Many economic series are labor and price statistics; GET /v1/series?instrument_type=economic lists them.
Revision status
Each value carries its revision status: preliminary or revised. When none is stated, status is null; do not
read that as final. A period the publisher states has no value is listed in missing, as is a withdrawn value
(series values).
Units
Each series carries its machine-readable unit (index, percent, US dollars per hour, hours). as_published
holds the published unit words.
Release times
A new value is published, usually at 08:30 or 10:00 New York time, sometimes later. refreshed_at says when a value was last updated or confirmed. A revision to any period is served within a day.
Values missing from the latest publication
When the latest publication no longer carries a value, the value is still served as last published, and so is a change or other figure derived from it (commodity supply and demand has an example).
Projections
GET /v1/series/{key}/projections serves what a value series holds that is not an observation
(served periods), such as the potential-GDP quarters
to 2036 (model_output) or a projected marketing year (projection). known_at reads the projections as they
were held at an instant. A series that holds none answers an empty list.
Publication lag and freshness
A value series states its publication lag in freshness.through and freshness.publication_lag_days
(freshness), on every macro snapshot member and every /v1/series/{key}
and /observations answer. The Treasury views carry publication_lag_days beside curve_date. Compare through before you combine two series
(the Treasury yield curve has an example).