Skip to main content
GET
Read a saved market definition
Use the market_id returned by FHFA market discovery to read your account’s saved state-market definition. This costs one credit and does not fetch a fresh index series. The observation expires after 24 hours; use getMarketSeries for quarterly index values.

Authorizations

x-api-key
string
header
required

Path Parameters

market_id
string
required
Minimum string length: 1

Query Parameters

fields
string

Response-only comma-separated field paths relative to data items; up to 32 paths. Source requests and billing are unchanged.

Maximum string length: 4127
format
enum<string>
default:json

Response-only export format. JSON retains the envelope; CSV/NDJSON contain data records, with request/credit metadata in headers. Errors stay JSON.

Available options:
json,
csv,
ndjson

Response

Source observation; inspect meta for evidence and completeness.

data
object
required
meta
object
required