Charts
Distribution Chart
Bucketed distribution snapshots.
Page Sections
GET
/charts/distribution
Full URL: https://forcex.com/xtract/v1/litecoin/charts/distribution
Credit cost: 5 credits.
curl -H "Authorization: Bearer fx_live_************" \
"https://forcex.com/xtract/v1/litecoin/charts/distribution?type=balance&window=year"Parameters
| Name | Location | Required | Type | Description |
|---|---|---|---|---|
type | query | yes | string | — |
window | query | no | string matching `^(1d|7d|30d|year)$`, default `year` | Snapshot window. `year` is the supported and default value (a balance distribution is a state snapshot); legacy 1d/7d/30d return 503 data_unavailable. |
include_current | query | no | boolean, default `False` | Attach the additive `current` member: the in-progress current window and/or state snapshots with explicit as-of provenance (height, hash, time, stability). Defaults to false — the pre-existing response is byte-identical when omitted. Unsupported current calculations return an explicit `status=unavailable` object with a governed `reason_code`; nothing is fabricated. |
Request Body
No request body.
Example Response
Representative trimmed response. Use the OpenAPI schema for the exhaustive field contract.
{
"data": [
{
"bucket_label": "1-10 LTC",
"address_count": 12450,
"total_value_atomic_units": 482000000000
}
],
"meta": {
"served_from": "indexed_store",
"methodology_version": "v1_balance_distribution",
"credit_cost": 2
}
}Documented Responses
| Status | Description |
|---|---|
200 | Successful Response |
400 | Bad request. The `error.code` field identifies the specific cause: `bad_request` (general validation failure, including malformed dates, out-of-order ranges, and request-body validation), `range_too_large` (date range exceeds the per-grain cap), `ambiguous_time_range` (legacy `from`/`to` and new `start`/`end` supplied with differing values), or `invalid_include` (unsupported expansion in `?include=`). |
401 | Authentication required, or the supplied Bearer token is invalid or revoked. `error.code` = `auth_required`. |
402 | Payment-tier gate. `error.code` identifies which gate fired: `subscription_required` (no active subscription on the account), `subscription_inactive` (subscription exists but is not active), `include_all_requires_paid_tier` (Free-tier keys cannot request `?include=all`), `include_set_requires_paid_tier` (the requested include set exceeds the per-request cost cap for Free-tier keys), `historical_scan_requires_paid_tier` (legacy test keys cannot scan outside the recent window), or `deep_pagination_requires_paid_tier` (Free-tier keys cannot page beyond the depth cap). |
403 | Authenticated but the key lacks the required scope. `error.code` = `scope_insufficient`. |
422 | Defense-in-depth: the runtime maps standard request-shape validation errors to 400, so partners normally see 400 instead of 422. This status is declared so any edge-case validation path that bypasses the override is still typed. |
429 | Rate limit or credit budget exceeded. `error.code` identifies the window: `rate_limit_exceeded` (per-second or per-minute), `quota_exceeded_daily` (Free-tier per-day budget), or `quota_exceeded` (per-subscription-period). The body carries a `window` field (`second`, `minute`, `day`, or `month`) naming the failing limit. Responses include the standard `Retry-After` header. |
500 | Internal server error. `error.code` = `internal_error`. Reference `meta.request_id` when contacting support. |
503 | Service or downstream data store is temporarily unavailable, or the endpoint is not implemented in this API version. `error.code` identifies the cause: `data_unavailable` (chain tip not yet populated), `audit_unavailable` (request completed but audit could not be acknowledged — safe to retry), `plan_misconfigured` (operational issue on the API side; not a tier problem), or `endpoint_not_available` (the route is reserved and not yet served in this version). |
Integration Notes
- `type=balance` with `window=year` is the supported and DEFAULT shape (the default window changed from the unsupported `30d` to `year` on 2026-08-08 — an omitted-window request now returns data and is charged as a normal successful call).
- A balance distribution is a state snapshot, not a time-window sum; legacy `1d`/`7d`/`30d` values remain accepted for compatibility and return the governed `503 data_unavailable`.
- `include_current=true` returns an explicit `status=unavailable` current window (`exact_aggregation_unavailable`): no governed intraday distribution source exists, and nothing is fabricated.
- `include_current` and `current_metrics` add no charge in this schedule — live current objects are included in the route price (a governed product decision; any later surcharge would be a separately versioned contract change).