# federalregister.document

**stable** **Standard**

One Federal Register document by document number.

`GET /v1/federalregister/document`

## What you get

One Federalregister record in Onekey's unified shape, in `data`. If the record does not exist you get a `404 not_found` and are not charged.

## What it costs

- **Standard · 1 credit** for a fresh fetch, charged only when it succeeds.
- **Free when served from cache (0.2 credit for a cached response over 100 KB).**
- **Free** if the request is invalid (never charged) or the source fails or reports not found (refunded).

## Parameters

| Name | Type | Required | Default | What it is | Constraints |
| --- | --- | --- | --- | --- | --- |
| `number` | string | yes | (required) | Document number, e.g. 2024-00001 | max 20 chars; must match `[A-Za-z0-9-]{5,20}`; trimmed |

## Request

```bash
curl "https://api.onekey.dev/v1/federalregister/document?number=2024-00001" \
  -H "x-api-key: YOUR_API_KEY"
```

```python
import requests

res = requests.get(
    "https://api.onekey.dev/v1/federalregister/document",
    params={"number": "2024-00001"},
    headers={"x-api-key": "YOUR_API_KEY"},
)
body = res.json()

if body["success"]:
    print(body["data"])
else:
    print(body["error"]["code"], body["error"]["message"])
```

```javascript
const params = new URLSearchParams({ number: "2024-00001" });
const res = await fetch(`https://api.onekey.dev/v1/federalregister/document?${params}`, {
  headers: { "x-api-key": "YOUR_API_KEY" },
});
const body = await res.json();

if (body.success) console.log(body.data);
else console.error(body.error.code, body.error.message);
```

## Recorded response

A real Federalregister response, recorded and returned in Onekey's shape. Fields the platform does not provide are `null`.

```json
{
  "success": true,
  "data": {
    "content": {
      "id": "2024-00001",
      "title": "Privacy Act of 1974; System of Records",
      "text": "In accordance with the Privacy Act of 1974, we are issuing public notice of our intent to modify our existing systems of records listed below under the System Name and Number section. This notice publishes details of the modified systems as set forth below under the caption, SUPPLEMENTARY INFORMATION.",
      "url": "https://www.federalregister.gov/documents/2024/01/05/2024-00001/privacy-act-of-1974-system-of-records",
      "createdAt": "2024-01-05T00:00:00Z"
    },
    "entity": {
      "category": "Notice"
    },
    "author": {
      "displayName": "Social Security Administration",
      "username": "social-security-administration"
    },
    "media": {
      "url": "https://www.govinfo.gov/content/pkg/FR-2024-01-05/pdf/2024-00001.pdf"
    },
    "ext": {
      "pages": 2
    }
  },
  "metadata": {
    "platform": "federalregister",
    "endpoint": "document",
    "cached": false,
    "stale": false,
    "age_s": 0,
    "fetched_at": "2026-01-01T12:00:00+00:00",
    "credits_charged": 1,
    "request_id": "7f3a9c2e5b1d4c8fa2e6d0b9c4f18e37"
  },
  "error": null
}
```

## Field mapping

How this endpoint's source fields become Onekey's [unified schema](https://onekey.dev/docs/schema.md). Fields the source lacks come back as `null`.

| Source path | Onekey field | Transform |
| --- | --- | --- |
| `document_number` | `content.id` | - |
| `title` | `content.title` | - |
| `abstract` | `content.text` | - |
| `html_url` | `content.url` | `safeUrl` |
| `publication_date` | `content.createdAt` | `toIsoDate` |
| `type` | `entity.category` | - |
| `agencies.0.name` | `author.displayName` | - |
| `agencies.0.slug` | `author.username` | - |
| `pdf_url` | `media.url` | `safeUrl` |
| `page_length` | `ext.pages` | `toNumber` |

## Caching and freshness

- Fresh for about 30 minutes. Repeat calls in that window are served from cache and are free.
- Between 30 minutes and 6 hours the cached copy is still served instantly and marked `stale: true` while Onekey refreshes it in the background.
- If the source is down when a refresh is needed, the last copy can be served for up to 1 day more (marked stale).
- A "not found" is remembered for 5 minutes and is free.
- The cache is shared across all customers, which is what keeps repeat calls cheap.

## What can go wrong

| Status | Code | What to do |
| --- | --- | --- |
| 401 | `unauthorized` | Check the `x-api-key` header. |
| 402 | `insufficient_credits` | [Add credits](https://onekey.dev/pricing); your balance must cover the price. |
| 404 | `not_found` | That record does not exist. Free; do not retry. |
| 422 | `invalid_params` | Fix the parameters using the table above. Free. |
| 429 | `rate_limited` | Wait `Retry-After` seconds, then retry. |
| 502 | `upstream_error` | The source failed. Refunded; retry with backoff. |

See [Errors](https://onekey.dev/docs/errors.md) for the full list and retry guidance.

Status: stable (verified against the live source).