# FRED on Onekey

> 4 endpoints for FRED (0 stable, 4 beta), 1 to 5 credits each. Category: Finance & markets. One key, one JSON shape.

Base URL: https://api.onekey.dev
Auth: header `x-api-key: <key>`. Call shape: `GET /v1/{platform}/{endpoint}?{params}`.
Every response is `{success, data, metadata, error}`; check `success` first. Cost is in `metadata.credits_charged`. Free when served from cache (0.2 credit for a cached response over 100 KB). Failed and not-found calls are refunded.
Status: stable = verified against the live source; beta = not yet verified, fields may be missing.

Page: https://onekey.dev/platforms/fred
Reference (Markdown): https://onekey.dev/docs/api/fred.md
All docs: https://onekey.dev/llms.txt

## Canonical fields returned

Unified-schema fields (same names on every platform), with how many of the 4 mapped FRED endpoints return each:

- `entity.category` (string): 3
- `entity.id` (string): 3
- `entity.name` (string): 3
- `entity.date` (ISO 8601 date): 2
- `entity.stats.popularity` (number): 2
- `entity.createdAt` (ISO 8601 date): 1
- `entity.description` (string): 1
- plus 2 platform-specific fields under `ext.`

## Endpoints

### fred.category_series

Series in a FRED category.
- Price: 5 credits per fresh call. Status: beta. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/fred/category_series?category_id=125&limit=5` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `category_id` (string, required): Category id
  - `limit` (string, optional, default 20): Rows (1-100)
- Fields returned: `entity.id`, `entity.name`, `entity.category`, `ext.units`
- Reference: https://onekey.dev/docs/api/fred/category_series.md

### fred.observations

FRED observations (latest first).
- Price: 5 credits per fresh call. Status: beta. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/fred/observations?series_id=UNRATE&limit=5` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `series_id` (string, required): FRED series id, e.g. GDP, UNRATE, DGS10
  - `limit` (string, optional, default 60): Rows (1-1000)
- Fields returned: `entity.date`, `ext.value`
- Reference: https://onekey.dev/docs/api/fred/observations.md

### fred.search

Search FRED series by text.
- Price: 5 credits per fresh call. Status: beta. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/fred/search?q=unemployment&limit=5` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `q` (string, required): Search text
  - `limit` (string, optional, default 20): Rows (1-100)
- Fields returned: `entity.id`, `entity.name`, `entity.category`, `entity.stats.popularity`, `ext.units`
- Reference: https://onekey.dev/docs/api/fred/search.md

### fred.series

FRED series metadata (title, units, frequency).
- Price: 1 credit per fresh call. Status: beta. Returns: one record.
- Request: `GET https://api.onekey.dev/v1/fred/series?series_id=GDP` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `series_id` (string, required): FRED series id, e.g. GDP, UNRATE, DGS10
- Fields returned: `entity.id`, `entity.name`, `entity.description`, `entity.category`, `entity.createdAt`, `entity.date`, `entity.stats.popularity`, `ext.units`
- Reference: https://onekey.dev/docs/api/fred/series.md

## Sample request

```bash
curl "https://api.onekey.dev/v1/fred/series?series_id=GDP" \
  -H "x-api-key: YOUR_API_KEY"
```