get_snapshot
Read-onlyIdempotent
PAID ($0.02). Snapshot of every series for every country in one call. Pass api_key if you have one (instant card checkout at /pricing); otherwise the response explains how to pay via x402. Every GH 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 |
|---|---|---|---|
| api_key | No | API key |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| error | No | Present on a free refusal or error; no charge | |
| result | No | One entry per country; every series value carries confidence_label, coverage_label and label_basis | |
| countries | No | ||
| no_charge | No | ||
| price_usd | No | ||
| disclaimer | No | ||
| how_to_pay | No | ||
| bind_series | No | ||
| explanation | No | ||
| x_next_bind | No | ||
| http_endpoint | No | ||
| payment_required | No | true when the call needs payment; how_to_pay explains x402 or card |