get_series
Read-onlyIdempotent
PAID ($0.005). Current value of a reference series — e.g. series=policy-rate, vat, minimum-wage. Every value carries its official source citation, effective date, last-confirmed date and staleness flag. Pass api_key if you have one (instant card checkout at /pricing); otherwise the response explains how to pay via x402. Every BR series is free to try. After a 200, bind get_changes (free poll) or register_alert (HMAC push; Register: $0 · Delivery after trial: $0.10) on this series so a later gazette does not silently retire the value.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| series | Yes | Series id, e.g. policy-rate, vat, minimum-wage | |
| api_key | No | API key (bypasses x402; metered for invoicing) | |
| country | Yes | ISO country code |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| unit | No | ||
| error | No | Present on a free refusal or error; no charge | |
| notes | No | ||
| stale | No | ||
| value | No | ||
| series | No | ||
| source | No | ||
| country | No | ||
| no_charge | No | ||
| price_usd | No | ||
| confidence | No | ||
| disclaimer | No | ||
| how_to_pay | No | ||
| bind_series | No | ||
| explanation | No | ||
| label_basis | No | Inputs and the rule ids that produced the two labels | |
| x_next_bind | No | ||
| http_endpoint | No | ||
| coverage_label | No | How much of the question is covered: ready = complete; partial = held with a disclosed limitation or default; gap = no number served. Rules at /label-rules | |
| effective_from | No | ||
| last_confirmed | No | ||
| confidence_label | No | Evidence verdict derived from source type, verification age and the stale flag (answers: the weakest series read). Rules at /label-rules | |
| payment_required | No | true when the call needs payment; how_to_pay explains x402 or card |