Response Format

Response Schema

Every successful response (200 OK) from any data endpoint uses the same JSON envelope. Schema version is 1.0.

Full response example

{
  "status": "OK",
  "message": "Data retrieved successfully",
  "meta": {
    "schema_version": "1.0",
    "frequency": "Weekly",
    "fields": {
      "date": "string (YYYY-MM-DD)",
      "series": "string",
      "value": "numerical string"
    }
  },
  "pagination": {
    "count": "52",
    "next_url": "/economic-data/ui_weekly_claims?series=initial_claims_sa&date_from=2025-01-01&date_to=2026-01-01&token_id=7c1b453e164b..."
  },
  "data": [
    {
      "date": "2025-01-04",
      "series": "initial_claims_sa",
      "value": "211000"
    },
    {
      "date": "2025-01-11",
      "series": "initial_claims_sa",
      "value": "203000"
    }
  ]
}

Top-level fields

Field	Type	Description
`status`	string	`"OK"` on success
`message`	string	Human-readable status message
`meta`	object	Schema and field metadata (see below)
`pagination`	object	Page count and next-page link (see below)
`data`	array	Array of data records

The `meta` object

Field	Type	Description
`schema_version`	string	Response schema version (currently `"1.0"`)
`frequency`	string	Data frequency: `"Daily"`, `"Weekly"`, or `"Monthly"`
`fields`	object	Describes the type of each field in the `data` array records

The `pagination` object

Field	Type	Description
`count`	string	Number of records in the current page
`next_url`	string \| null	Relative URL for the next page, or `null` when no more results remain. See Pagination.

Data records

Each element in the data array contains three fields:

Field	Type	Description
`date`	string	Observation date in `YYYY-MM-DD` format
`series`	string	The series code you requested
`value`	string	Numerical value represented as a string

Frequency by endpoint

The meta.frequency value depends on the endpoint:

Endpoint	Frequency
`ui_weekly_claims`	Weekly
`jolts`	Monthly
`ui_state_weekly_claims`	Weekly
`personal_income_and_outlays`	Monthly
`us_exports`	Monthly
`factors_affecting_reserve_balances`	Weekly
`us_debt`	Daily