Docs
View as Markdown

treasury.interest_expense

stable Advanced

Interest expense on the public debt by security type.

GET /v1/treasury/interest_expense

What you get#

A list of Treasury 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#

NameTypeRequiredDefaultWhat it isConstraints
sizestringno10Rows (1-100)max 3 chars; must match [1-9]\d?|100; trimmed

Request#

curl "https://api.onekey.dev/v1/treasury/interest_expense?size=5" \
  -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 Treasury response, recorded and returned in Onekey's shape. Fields the platform does not provide are null.

json
{
  "success": true,
  "data": [
    {
      "entity": {
        "date": "2026-08-31T00:00:00Z",
        "name": "Treasury Notes",
        "category": "INTEREST EXPENSE ON PUBLIC ISSUES"
      },
      "ext": {
        "monthExpense": 44307873395.41,
        "fytdExpense": 454797399349.12
      }
    },
    {
      "entity": {
        "date": "2026-08-31T00:00:00Z",
        "name": "Treasury Bonds",
        "category": "INTEREST EXPENSE ON PUBLIC ISSUES"
      },
      "ext": {
        "monthExpense": 15730057453.14,
        "fytdExpense": 162876736087.98
      }
    }
  ],
  "metadata": {
    "platform": "treasury",
    "endpoint": "interest_expense",
    "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
record_dateentity.datetoIsoDate
expense_type_descentity.name-
expense_catg_descentity.category-
month_expense_amtext.monthExpensetoNumber
fytd_expense_amtext.fytdExpensetoNumber

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).