# Federal Register on Onekey

> 6 endpoints for Federal Register (6 stable, 0 beta), 1 to 5 credits each. Category: Government & public data. 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/federalregister
Reference (Markdown): https://onekey.dev/docs/api/federalregister.md
All docs: https://onekey.dev/llms.txt

## Canonical fields returned

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

- `author.displayName` (string): 4
- `content.createdAt` (ISO 8601 date): 4
- `content.id` (string): 4
- `content.title` (string): 4
- `content.url` (URL): 4
- `entity.category` (string): 4
- `author.username` (string): 3
- `content.text` (string): 3
- `media.url` (URL): 3
- `entity.description` (string): 2
- `entity.id` (string): 2
- `entity.name` (string): 2
- `entity.url` (URL): 2
- `entity.date` (ISO 8601 date): 1
- `media.thumbnailUrl` (URL): 1
- plus 3 platform-specific fields under `ext.`

## Endpoints

### federalregister.agencies

All agencies publishing in the Federal Register.
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/federalregister/agencies` with header `x-api-key: YOUR_API_KEY`
- Parameters: none
- Fields returned: `entity.id`, `entity.name`, `entity.description`, `entity.url`, `ext.symbol`, `ext.parentId`
- Reference: https://onekey.dev/docs/api/federalregister/agencies.md

### federalregister.agency

One agency by slug.
- Price: 1 credit per fresh call. Status: stable. Returns: one record.
- Request: `GET https://api.onekey.dev/v1/federalregister/agency?slug=environmental-protection-agency` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `slug` (string, required): Agency slug
- Fields returned: `entity.id`, `entity.name`, `entity.description`, `entity.url`, `media.thumbnailUrl`, `ext.symbol`
- Reference: https://onekey.dev/docs/api/federalregister/agency.md

### federalregister.document

One Federal Register document by document number.
- Price: 1 credit per fresh call. Status: stable. Returns: one record.
- Request: `GET https://api.onekey.dev/v1/federalregister/document?number=2024-00001` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `number` (string, required): Document number, e.g. 2024-00001
- Fields returned: `content.id`, `content.title`, `content.text`, `content.url`, `content.createdAt`, `entity.category`, `author.displayName`, `author.username`, `media.url`, `ext.pages`
- Reference: https://onekey.dev/docs/api/federalregister/document.md

### federalregister.latest

Latest Federal Register documents.
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/federalregister/latest?per_page=5` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `per_page` (string, optional, default 20): Rows (1-100)
- Fields returned: `content.id`, `content.title`, `content.text`, `content.url`, `content.createdAt`, `entity.category`, `author.displayName`, `author.username`, `media.url`, `ext.pages`
- Reference: https://onekey.dev/docs/api/federalregister/latest.md

### federalregister.public_inspection

Documents currently on public inspection.
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/federalregister/public_inspection` with header `x-api-key: YOUR_API_KEY`
- Parameters: none
- Fields returned: `content.id`, `content.title`, `content.url`, `content.createdAt`, `entity.category`, `author.displayName`, `entity.date`
- Reference: https://onekey.dev/docs/api/federalregister/public_inspection.md

### federalregister.search

Search Federal Register documents by term.
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/federalregister/search?q=climate&per_page=5` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `q` (string, required): Search text
  - `per_page` (string, optional, default 20): Rows (1-100)
- Fields returned: `content.id`, `content.title`, `content.text`, `content.url`, `content.createdAt`, `entity.category`, `author.displayName`, `author.username`, `media.url`, `ext.pages`
- Reference: https://onekey.dev/docs/api/federalregister/search.md

## Sample request

```bash
curl "https://api.onekey.dev/v1/federalregister/agency?slug=environmental-protection-agency" \
  -H "x-api-key: YOUR_API_KEY"
```