Docs
View as Markdown

federalregister.agencies

stable Advanced

All agencies publishing in the Federal Register.

GET /v1/federalregister/agencies

What you get#

A list of Federalregister results in Onekey's unified shape, in data (an array). An empty array is a normal, successful answer and is charged like any other; a source that reports "nothing found" as an error returns a free 404 not_found instead.

What it costs#

  • Advanced · 5 credits 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#

This endpoint takes no parameters.

Request#

curl "https://api.onekey.dev/v1/federalregister/agencies" \
  -H "x-api-key: YOUR_API_KEY"

Try it

Add your key to run this call right here. No key? Get one free. The key stays in this tab.

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": [
    {
      "entity": {
        "id": "action",
        "name": "ACTION",
        "description": "ACTION was established by Reorganization Plan No. 1 of 1971, effective July 1, 1971. \r\n\r\nACTION's purpose was to mobilize Americans for voluntary service throughout the United States and in developing countries overseas through programs which help meet basic human needs and support the self-help efforts of low-income individuals and communities.\r\n\r\nACTION's functions relating to SCORE and ACT prog",
        "url": "https://www.federalregister.gov/agencies/action"
      },
      "ext": {
        "symbol": "ACTION",
        "parentId": null
      }
    },
    {
      "entity": {
        "id": "administration-office-executive-office-of-the-president",
        "name": "Administration Office, Executive Office of the President",
        "description": "The Office of Administration (OA) was created by Reorganization Plan No. 1 of 1977 and Executive Order 12028. As a component of the Executive Office of the President, the Office's primary function is to provide common administrative and support services for the various agencies and offices of the EOP.\r\n\r\n",
        "url": "https://www.federalregister.gov/agencies/administration-office-executive-office-of-the-president"
      },
      "ext": {
        "symbol": "OA",
        "parentId": 538
      }
    }
  ],
  "metadata": {
    "platform": "federalregister",
    "endpoint": "agencies",
    "cached": false,
    "stale": false,
    "age_s": 0,
    "fetched_at": "2026-01-01T12:00:00+00:00",
    "credits_charged": 5,
    "request_id": "7f3a9c2e5b1d4c8fa2e6d0b9c4f18e37"
  },
  "error": null
}

Field mapping#

How this endpoint's source fields become Onekey's unified schema. Fields the source lacks come back as null.

Source pathOnekey fieldTransform
slugentity.id-
nameentity.name-
short_nameext.symbol-
descriptionentity.description-
urlentity.urlsafeUrl
parent_idext.parentIdtoNumber

Caching and freshness#

  • Fresh for about 1 hour. Repeat calls in that window are served from cache and are free.
  • Between 1 hour and 1 day 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#

StatusCodeWhat to do
401unauthorizedCheck the x-api-key header.
402insufficient_creditsAdd credits; your balance must cover the price.
404not_foundUnknown endpoint path.
422invalid_paramsFix the parameters using the table above. Free.
429rate_limitedWait Retry-After seconds, then retry.
502upstream_errorThe source failed. Refunded; retry with backoff.

See Errors for the full list and retry guidance.

Status: stable (verified against the live source).