get_timeseries
Bounded timeseries for an entity: price, macro_series, etf_flows or etf_monthly_flows.
Returns points oldest-first with an explicit downsampling flag when the raw series exceeded max_points. Times are UTC. Costs 1 unit per call.
Read the step from served_granularity, not granularity. The
latter echoes the request; the former is the step the source built the
points at, and the two can differ (a long price range can come back as
monthly bars under a "1d" request). It reads mixed when the points do
not share one step, unknown when the source does not say, and null
when no point came back. It describes how each point was built, not how
far apart the returned points are: a thinned daily series still reads
1d, and downsampled is what says points were dropped.
The two ETF flow metrics answer different questions and are not
interchangeable. etf_flows is an ESTIMATE at filing cadence: one point
per SEC filing refresh, so t is a filing date and even a wide window
yields a handful of points. etf_monthly_flows is the fund's own
creations and redemptions from its NPORT-P filing, so t is a calendar
month (YYYY-MM) and each point carries the three filed components -
sales, reinvestment, redemption - beside the net.
Two things to read before quoting etf_monthly_flows. NPORT-P is filed per
SERIES, so for a fund with more than one share class the figures cover
every class and the payload says so in multi_class_series; where the
class count is unknown it says class_scope instead of staying silent.
And a fund that files no NPORT-P at all, such as a commodity trust, is not
an error: the call returns status partial with an empty point list and
a reason.
Args: metric: One of price / macro_series / etf_flows / etf_monthly_flows. entity: Entity dict from resolve_entity ({"namespace": ..., "ids": ...}). granularity: Requested point granularity (default "1d"). max_points: Hard cap on returned points (default 500).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| entity | Yes | Entity dict from resolve_entity ({namespace, ids}). Extra keys are ignored. | |
| metric | Yes | ||
| max_points | No | ||
| granularity | No | 1d |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||