> ## Documentation Index
> Fetch the complete documentation index at: https://doc.astreus.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Federal Reserve financials

> The Federal Reserve Banks' balance sheet and income statement (United States only).



## OpenAPI

````yaml https://astreus.ai/openapi.json get /api/v1/countries/{iso}/fed-financials
openapi: 3.1.0
info:
  title: Astreus API
  version: '2026-11-11'
  description: >-
    Astreus is a financial data terminal that turns the world's unstructured
    financial disclosure into structured, traceable data. It reads what
    companies, exchanges and central banks publish — annual and interim reports,
    SEC filings, results announcements, investor presentations, earnings calls,
    8-Ks, regulator notices and policy text — across the United States, the Gulf
    (Tadawul, DFM, ADX, Boursa Kuwait, QSE), Japan, Taiwan, Korea, the UK and
    Europe, and serves it as data a program can trust: standardized financial
    statements (annual, quarterly, semiannual), segments and KPIs, the tables
    inside the notes, filing sections as text, investor decks page by page,
    earnings-call transcripts and audio, span-anchored observations, management
    guidance scored against outcomes, typed 8-K events, an attributed intraday
    news tape, insider and 13F ownership, a people registry, macro series (the
    current vintage: the latest published value for each period) and
    central-bank text, benchmark, commodity and compute-price series, and a
    source-linked claim graph with declared validation limits. Use `fact-source`
    and document metadata to retain available provenance. Publication and
    entitlement gates apply per dataset; inspect availability and tool
    limitations.


    Coverage is published live: `GET /api/v1/landing/coverage` (no key) returns
    every market served with company counts, history depth, completeness and
    periods held per data type — ask it before answering "what do you cover?".
    `{id}` is a ticker, a numeric SEC CIK, or a platform key for a non-SEC
    issuer (XSAU000001) — the `cik` field of the company payload. Human-readable
    guides: https://doc.astreus.ai (coverage at /coverage, data catalog at
    /data-catalog).


    Tiers: `public` endpoints need no credentials. Everything else takes an
    **API key** — create one on the Developers page in the terminal
    (https://astreus.ai/developers) and send it as `X-API-KEY: pk_live_...` (or
    `Authorization: Bearer pk_live_...`). Signed-in terminal sessions may use
    their Cognito ID token instead.


    Rate limits and quotas are per plan (fixed UTC windows): Free — 30 req/min,
    250 req/day; Build — 300 req/min, 100,000 req/month; Scale — custom. Build,
    Scale and prepaid credits are set up with sales
    (https://astreus.ai/contact), not self-serve. Responses carry RateLimit-*,
    X-Quota-* and, when credits pay, X-Billing-Source/X-Credits-Remaining-USD
    headers; a 429 carries `Retry-After` and a machine `code` of rate_limited or
    quota_exceeded (with sales_email).


    Server-side use: `/api/v1` sends no CORS headers, so a browser page on
    another origin cannot call it. Call it from a server, a script or an agent,
    and keep the key there.


    Versioning: `info.version` is the UTC date the contract last changed, and
    every response carries it in `x-astreus-api-version`. Within `/api/v1`
    changes are additive; a field or parameter that will go is marked
    `deprecated` first and kept for at least 90 days. Policy:
    https://doc.astreus.ai/versioning.


    Not investment advice. See /terms.
  contact:
    email: saif@astreus.ai
  termsOfService: https://astreus.ai/terms
  license:
    name: 'Proprietary: Astreus terms of service'
    url: https://astreus.ai/terms
servers:
  - url: https://astreus.ai
security: []
tags:
  - name: Search & Meta
    description: Entity resolution and platform metadata.
  - name: Company Data
    description: Profiles, structure, leadership, calendars.
  - name: Geo & Assets
    description: >-
      Physical assets on the map — what a company owns, operates or develops,
      where, since when, at what location precision, and the source behind each
      fact.
  - name: Financial Statements
    description: >-
      Standardized XBRL-derived statements — every line traceable to its filing
      via fact provenance.
  - name: SEC Filings
    description: >-
      The filing index and documents (SEC and exchange-published), parsed
      section text, and the tables inside the notes as gated grids and series.
  - name: 8-K Events
    description: >-
      Material events: 8-K items and exchange disclosures by item code,
      filterable by family, with extracted item text.
  - name: News
    description: >-
      The intraday news tape: filings, releases and licensed wires with source
      attribution, storylines and topics.
  - name: Transcripts & Calls
    description: Earnings-call transcripts, span-anchored observations, IR decks.
  - name: Guidance & Scorecards
    description: What management promised vs. what happened.
  - name: Ownership & Insiders
    description: 13F holders, Forms 3/4/5, the people registry.
  - name: Macro
    description: >-
      Economic series (the current vintage: the latest published value for each
      period) and central-bank text.
  - name: Market Data
    description: Daily bars for stocks, benchmarks, commodities and compute.
  - name: Intelligence
    description: Narratives and source-linked claims with declared validation status.
  - name: Analytics
    description: Charting over any catalog series.
paths:
  /api/v1/countries/{iso}/fed-financials:
    get:
      tags:
        - Macro
      summary: Federal Reserve financials
      description: >-
        The Federal Reserve Banks' balance sheet and income statement (United
        States only).
      operationId: get-federal-reserve-financials
      parameters:
        - name: iso
          in: path
          required: true
          description: ISO 3166-1 alpha-2 country code (e.g. US).
          schema:
            type: string
        - name: entity
          in: query
          description: '`combined` (default) or one Reserve Bank.'
          schema:
            type: string
        - name: period
          in: query
          description: Column cadence.
          schema:
            type: string
            enum:
              - annual
              - quarterly
            default: annual
        - name: statement
          in: query
          description: One statement.
          schema:
            type: string
            enum:
              - balance_sheet
              - income_statement
              - income_summary
        - name: from
          in: query
          description: First period end, YYYY-MM-DD.
          schema:
            type: string
            format: date
        - name: to
          in: query
          description: Last period end, YYYY-MM-DD.
          schema:
            type: string
            format: date
        - name: last
          in: query
          description: Newest N columns in the window, 1–200.
          schema:
            type: integer
            minimum: 1
            maximum: 200
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  entity:
                    type: string
                  entityLabel:
                    type: string
                  entities:
                    type: array
                    items:
                      type: object
                      properties:
                        key:
                          type: string
                        label:
                          type: string
                        firstPeriod:
                          type: string
                          format: date
                        lastPeriod:
                          type: string
                          format: date
                        hasQuarterly:
                          type: boolean
                  periodType:
                    type: string
                  unit:
                    type: string
                  statements:
                    type: object
                    properties:
                      income_statement:
                        type: object
                        properties:
                          columns:
                            type: array
                            items:
                              type: object
                              properties:
                                key:
                                  type: string
                                endDate:
                                  type: string
                                  format: date
                                durationMonths:
                                  type: integer
                                derived:
                                  type: boolean
                                sources:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      url:
                                        type: string
                                      kind:
                                        type: string
                          rows:
                            type: array
                            items:
                              type: object
                              properties:
                                key:
                                  type: string
                                label:
                                  type: string
                                fullLabel:
                                  type: string
                                depth:
                                  type: integer
                                header:
                                  type: boolean
                                total:
                                  type: boolean
                                values:
                                  type: object
                                  properties:
                                    FY2024:
                                      type: integer
                                    FY2025:
                                      type: integer
                      balance_sheet:
                        type: object
                        properties:
                          columns:
                            type: array
                            items:
                              type: object
                              properties:
                                key:
                                  type: string
                                endDate:
                                  type: string
                                  format: date
                                durationMonths:
                                  type: integer
                                derived:
                                  type: boolean
                                sources:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      url:
                                        type: string
                                      kind:
                                        type: string
                          rows:
                            type: array
                            items:
                              type: object
                              properties:
                                key:
                                  type: string
                                label:
                                  type: string
                                fullLabel:
                                  type: string
                                depth:
                                  type: integer
                                header:
                                  type: boolean
                                total:
                                  type: boolean
                                values:
                                  type: object
                                  properties:
                                    FY2024:
                                      type: integer
                                    FY2025:
                                      type: integer
                      income_summary:
                        type: object
                        properties:
                          columns:
                            type: array
                            items:
                              type: object
                              properties:
                                key:
                                  type: string
                                endDate:
                                  type: string
                                  format: date
                                durationMonths:
                                  type: integer
                                derived:
                                  type: boolean
                                sources:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      url:
                                        type: string
                                      kind:
                                        type: string
                          rows:
                            type: array
                            items:
                              type: object
                              properties:
                                key:
                                  type: string
                                label:
                                  type: string
                                fullLabel:
                                  type: string
                                depth:
                                  type: integer
                                header:
                                  type: boolean
                                total:
                                  type: boolean
                                values:
                                  type: object
                                  properties:
                                    FY2023:
                                      type: number
                                    FY2024:
                                      type: number
                  noteRefs:
                    type: object
                    properties:
                      balance_sheet:
                        type: object
                        properties:
                          accrued_benefit_costs:
                            type: string
                          bank_premises_and_equipment_net:
                            type: string
                          capital_paid_in:
                            type: string
                          consolidated_variable_interest_entities_assets_held_net:
                            type: string
                          consolidated_variable_interest_entities_formed_to_administer_credit_and_liquidity_facilities_non_controlling_interest:
                            type: string
                          consolidated_variable_interest_entities_other_liabilities:
                            type: string
                          deferred_asset_remittances_to_the_treasury:
                            type: string
                          deposits.depository_institutions:
                            type: string
                          deposit_treasury_funding_of_lending_facility_credit_protection:
                            type: string
                          federal_reserve_notes_outstanding_net:
                            type: string
                          foreign_currency_denominated_investments_net:
                            type: string
                          loans:
                            type: string
                          loans.other_loans:
                            type: string
                          loans_to_depository_institutions:
                            type: string
                          prepaid_pension_benefit_costs:
                            type: string
                          surplus:
                            type: string
                          system_open_market_account.accrued_interest_receivable:
                            type: string
                          system_open_market_account.central_bank_liquidity_swaps:
                            type: string
                          system_open_market_account.federal_agency_and_government_sponsored_enterprise_mortgage_backed_securities_net:
                            type: string
                          system_open_market_account.government_sponsored_enterprise_debt_securities_net:
                            type: string
                          system_open_market_account.other_assets:
                            type: string
                          system_open_market_account.other_liabilities:
                            type: string
                          system_open_market_account.securities_purchased_under_agreements_to_resell:
                            type: string
                          system_open_market_account.securities_sold_under_agreements_to_repurchase:
                            type: string
                          system_open_market_account.treasury_securities_net:
                            type: string
                          treasury_general_account:
                            type: string
                      income_statement:
                        type: object
                        properties:
                          board_of_governors_operating_expenses_and_currency_costs:
                            type: string
                          bureau_of_consumer_financial_protection:
                            type: string
                          central_bank_liquidity_swaps:
                            type: string
                          change_in_actuarial_gains_related_to_benefit_plans:
                            type: string
                          change_in_prior_service_costs_related_to_benefit_plans:
                            type: string
                          consolidated_variable_interest_entities_gains_net:
                            type: string
                          consolidated_variable_interest_entities_income_net:
                            type: string
                          consolidated_variable_interest_entities_non_controlling_interest_income_net:
                            type: string
                          depository_institutions_and_others:
                            type: string
                          earnings_remittances_to_the_treasury_net:
                            type: string
                          equipment:
                            type: string
                          federal_agency_and_government_sponsored_enterprise_mortgage_backed_securities_gains_net:
                            type: string
                          federal_agency_and_government_sponsored_enterprise_mortgage_backed_securities_net:
                            type: string
                          foreign_currency_denominated_investments_net:
                            type: string
                          foreign_currency_translation_gains_net:
                            type: string
                          government_sponsored_enterprise_debt_securities_net:
                            type: string
                          income_from_investments_held_by_consolidated_variable_interest_entities_net:
                            type: string
                          income_from_services:
                            type: string
                          interest_expense.system_open_market_account.other:
                            type: string
                          interest_on_federal_reserve_notes:
                            type: string
                          investments_held_by_consolidated_variable_interest_entities:
                            type: string
                          investments_held_by_consolidated_variable_interest_entities_gains_net:
                            type: string
                          loans:
                            type: string
                          loans_to_depository_institutions:
                            type: string
                          net_periodic_pension_expense:
                            type: string
                          occupancy:
                            type: string
                          operating_expenses.other:
                            type: string
                          other_components_of_net_benefit_costs:
                            type: string
                          other_income.system_open_market_account.other:
                            type: string
                          other_income.system_open_market_account.other#2:
                            type: string
                          other_loans:
                            type: string
                          payments_to_u_s_treasury_as_required_by_statute:
                            type: string
                          reimbursable_services_to_government_agencies:
                            type: string
                          required_by_the_federal_reserve_act_as_amended_by_the_fast_act:
                            type: string
                          salaries_and_benefits:
                            type: string
                          securities_purchased_under_agreements_to_resell:
                            type: string
                          securities_sold_under_agreements_to_repurchase:
                            type: string
                          system_pension_service_cost:
                            type: string
                          treasury_securities_gains_net:
                            type: string
                          treasury_securities_net:
                            type: string
                  quality:
                    type: object
                    properties:
                      documentsListed:
                        type: integer
                      documentsStored:
                        type: integer
                      documentsServed:
                        type: integer
                      errata:
                        type: array
                        items:
                          type: object
                          properties:
                            statement:
                              type: string
                            period:
                              type: string
                              format: date
                            subject:
                              type: string
                            detail:
                              type: string
                            printed:
                              type: integer
                            corrected:
                              type: integer
                            sourceUrl:
                              type: string
                      withheld:
                        type: array
                        items:
                          type: object
                          properties:
                            statement:
                              type: string
                            period:
                              type: string
                              format: date
                            subject:
                              type: string
                            detail:
                              type: string
                            printed:
                              type: 'null'
                            corrected:
                              type: 'null'
                            sourceUrl:
                              type: string
                description: >-
                  Inferred from captured responses: every field shown was
                  returned by a real call; a field may be absent or null on
                  other calls.
                x-schema-source: inferred
              example:
                entity: combined
                entityLabel: Federal Reserve Banks (combined)
                entities:
                  - key: combined
                    label: Federal Reserve Banks (combined)
                    firstPeriod: '1915-12-31'
                    lastPeriod: '2026-06-30'
                    hasQuarterly: true
                  - key: boston
                    label: Federal Reserve Bank of Boston
                    firstPeriod: '1995-12-31'
                    lastPeriod: '2025-12-31'
                    hasQuarterly: false
                periodType: annual
                unit: USD millions
                statements:
                  income_statement:
                    columns:
                      - key: FY2024
                        endDate: '2024-12-31'
                        durationMonths: 12
                        derived: false
                        sources:
                          - url: >-
                              https://www.federalreserve.gov/aboutthefed/files/combinedfinstmt2025.pdf
                            kind: annual_audited
                      - key: FY2025
                        endDate: '2025-12-31'
                        durationMonths: 12
                        derived: false
                        sources:
                          - url: >-
                              https://www.federalreserve.gov/aboutthefed/files/combinedfinstmt2025.pdf
                            kind: annual_audited
                    rows:
                      - key: hdr:0:0
                        label: Interest income
                        fullLabel: Interest income
                        depth: 0
                        header: true
                        total: false
                        values: {}
                      - key: loans_to_depository_institutions
                        label: Loans to depository institutions
                        fullLabel: Loans to depository institutions
                        depth: 2
                        header: false
                        total: false
                        values:
                          FY2024: 204
                          FY2025: 203
                  balance_sheet:
                    columns:
                      - key: FY2024
                        endDate: '2024-12-31'
                        durationMonths: 0
                        derived: false
                        sources:
                          - url: >-
                              https://www.federalreserve.gov/aboutthefed/files/combinedfinstmt2025.pdf
                            kind: annual_audited
                          - url: >-
                              https://www.federalreserve.gov/aboutthefed/files/combinedfinstmt2024.pdf
                            kind: annual_audited
                      - key: FY2025
                        endDate: '2025-12-31'
                        durationMonths: 0
                        derived: false
                        sources:
                          - url: >-
                              https://www.federalreserve.gov/aboutthefed/files/combinedfinstmt2025.pdf
                            kind: annual_audited
                    rows:
                      - key: gold_certificates
                        label: Gold certificates
                        fullLabel: Gold certificates
                        depth: 0
                        header: false
                        total: false
                        values:
                          FY2024: 11037
                          FY2025: 11037
                      - key: special_drawing_rights_certificates
                        label: Special drawing rights certificates
                        fullLabel: Special drawing rights certificates
                        depth: 0
                        header: false
                        total: false
                        values:
                          FY2024: 15200
                          FY2025: 15200
                  income_summary:
                    columns:
                      - key: FY2023
                        endDate: '2023-12-31'
                        durationMonths: 12
                        derived: false
                        sources:
                          - url: >-
                              https://www.federalreserve.gov/publications/2024-ar-statistical-tables.htm
                            kind: annual_report_stats
                      - key: FY2024
                        endDate: '2024-12-31'
                        durationMonths: 12
                        derived: false
                        sources:
                          - url: >-
                              https://www.federalreserve.gov/publications/2024-ar-statistical-tables.htm
                            kind: annual_report_stats
                    rows:
                      - key: current_income
                        label: Current income
                        fullLabel: Current income
                        depth: 0
                        header: false
                        total: false
                        values:
                          FY2023: 175136.109
                          FY2024: 159323.708
                      - key: >-
                          assessments_by_the_board_of_governors_board_expenditures
                        label: >-
                          Assessments by the Board of Governors: Board
                          expenditures
                        fullLabel: >-
                          Assessments by the Board of Governors: Board
                          expenditures
                        depth: 0
                        header: false
                        total: false
                        values:
                          FY2023: 1144
                          FY2024: 1438
                noteRefs:
                  balance_sheet:
                    accrued_benefit_costs: Notes 9, 10
                    bank_premises_and_equipment_net: Note 7
                    capital_paid_in: Note 7
                    consolidated_variable_interest_entities_assets_held_net: Note 3
                    consolidated_variable_interest_entities_formed_to_administer_credit_and_liquidity_facilities_non_controlling_interest: Note 3
                    consolidated_variable_interest_entities_other_liabilities: Note 3
                    deferred_asset_remittances_to_the_treasury: Note 12
                    deposits.depository_institutions: Note 5
                    deposit_treasury_funding_of_lending_facility_credit_protection: Note 4
                    federal_reserve_notes_outstanding_net: Note 4
                    foreign_currency_denominated_investments_net: Note 2
                    loans: Note 4
                    loans.other_loans: Note 1
                    loans_to_depository_institutions: Note 1
                    prepaid_pension_benefit_costs: Note 9
                    surplus: Note 7
                    system_open_market_account.accrued_interest_receivable: Note 2
                    system_open_market_account.central_bank_liquidity_swaps: Note 2
                    system_open_market_account.federal_agency_and_government_sponsored_enterprise_mortgage_backed_securities_net: Note 2
                    system_open_market_account.government_sponsored_enterprise_debt_securities_net: Note 2
                    system_open_market_account.other_assets: Note 5
                    system_open_market_account.other_liabilities: Note 2
                    system_open_market_account.securities_purchased_under_agreements_to_resell: Note 2
                    system_open_market_account.securities_sold_under_agreements_to_repurchase: Note 2
                    system_open_market_account.treasury_securities_net: Note 2
                    treasury_general_account: Note 6
                  income_statement:
                    board_of_governors_operating_expenses_and_currency_costs: Note 8(E)
                    bureau_of_consumer_financial_protection: Note 8(E)
                    central_bank_liquidity_swaps: Note 8(B)
                    change_in_actuarial_gains_related_to_benefit_plans: Notes 9, 10, 11
                    change_in_prior_service_costs_related_to_benefit_plans: Notes 9, 10, 11
                    consolidated_variable_interest_entities_gains_net: Note 3
                    consolidated_variable_interest_entities_income_net: Note 8(C)
                    consolidated_variable_interest_entities_non_controlling_interest_income_net: Note 8(C)
                    depository_institutions_and_others: Note 8(D)
                    earnings_remittances_to_the_treasury_net: Note 12
                    equipment: Note 8(E)
                    federal_agency_and_government_sponsored_enterprise_mortgage_backed_securities_gains_net: Note 8(B)
                    federal_agency_and_government_sponsored_enterprise_mortgage_backed_securities_net: Note 8(B)
                    foreign_currency_denominated_investments_net: Note 8(B)
                    foreign_currency_translation_gains_net: Note 8(B)
                    government_sponsored_enterprise_debt_securities_net: Note 8(B)
                    income_from_investments_held_by_consolidated_variable_interest_entities_net: Note 3
                    income_from_services: Note 5
                    interest_expense.system_open_market_account.other: Note 5
                    interest_on_federal_reserve_notes: Note 13
                    investments_held_by_consolidated_variable_interest_entities: Note 3
                    investments_held_by_consolidated_variable_interest_entities_gains_net: Note 3
                    loans: Note 4
                    loans_to_depository_institutions: Note 8(A)
                    net_periodic_pension_expense: Note 9
                    occupancy: Note 8(E)
                    operating_expenses.other: Note 8(E)
                    other_components_of_net_benefit_costs: Notes 9, 10
                    other_income.system_open_market_account.other: Note 8(B)
                    other_income.system_open_market_account.other#2: Note 5
                    other_loans: Note 8(A)
                    payments_to_u_s_treasury_as_required_by_statute: Note 3
                    reimbursable_services_to_government_agencies: Note 5
                    required_by_the_federal_reserve_act_as_amended_by_the_fast_act: Note 3o
                    salaries_and_benefits: Note 8(E)
                    securities_purchased_under_agreements_to_resell: Note 8(B)
                    securities_sold_under_agreements_to_repurchase: Note 8(B)
                    system_pension_service_cost: Note 8(E)
                    treasury_securities_gains_net: Note 8(B)
                    treasury_securities_net: Note 8(B)
                quality:
                  documentsListed: 157
                  documentsStored: 157
                  documentsServed: 76
                  errata:
                    - statement: balance_sheet
                      period: '2016-06-30'
                      subject: Total liabilities @ 2016-06-30
                      detail: >-
                        June 30, 2016 total liabilities printed as 4,482,386
                        (digits transposed, same in the HTML edition). The
                        twelve liability lines sum to 4,428,386, and total
                        liabilities and capital 4,468,497 − total cap…
                      printed: 4482386
                      corrected: 4428386
                      sourceUrl: >-
                        https://www.federalreserve.gov/aboutthefed/files/quarterly-report-20160630.pdf
                  withheld:
                    - statement: income_statement
                      period: '2024-12-31'
                      subject: >-
                        Total distribution of comprehensive income @ 2024-12-31
                        12m
                      detail: no run of the items above foots it
                      printed: null
                      corrected: null
                      sourceUrl: >-
                        https://www.federalreserve.gov/publications/2024-ar-statistical-tables.htm
                    - statement: income_statement
                      period: '2023-12-31'
                      subject: >-
                        Total distribution of comprehensive income @ 2023-12-31
                        12m
                      detail: no run of the items above foots it
                      printed: null
                      corrected: null
                      sourceUrl: >-
                        https://www.federalreserve.gov/publications/2023-ar-statistical-tables.htm
        '400':
          description: >-
            A query parameter the route does not take (unknown_parameter), a
            value outside its type, enum or range (invalid_parameter), or a
            required one missing (missing_parameter); `param` names it. A
            request refused against this spec's parameter list is not metered.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Missing or invalid bearer token.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Unknown company, country, symbol or resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Rate limited. Honour Retry-After.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - apiKey: []
        - cognitoIdToken: []
components:
  schemas:
    Error:
      type: object
      required:
        - error
        - code
      properties:
        error:
          type: string
          description: Human-readable message. It may change; branch on `code`.
        code:
          type: string
          description: >-
            Stable machine code; every error carries one. unknown_parameter,
            invalid_parameter and missing_parameter come with `param`;
            unknown_parameter also with `allowed`. A route may add codes of its
            own (e.g. key_limit); treat an unlisted code by its HTTP status.
          enum:
            - unknown_parameter
            - invalid_parameter
            - missing_parameter
            - invalid_request
            - unauthenticated
            - upgrade_required
            - forbidden
            - not_found
            - conflict
            - too_large
            - unsupported_media_type
            - rate_limited
            - quota_exceeded
            - auth_unavailable
            - upstream_unavailable
            - internal_error
        param:
          type: string
          description: The query parameter at fault, when one is.
        allowed:
          type: array
          items:
            type: string
          description: 'With unknown_parameter: every query parameter the route takes.'
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: X-API-KEY
      description: >-
        Astreus API key (pk_live_...), created on the Developers page in the
        terminal. Also accepted as `Authorization: Bearer pk_live_...`.
      x-default: pk_live_YOUR_KEY
    cognitoIdToken:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Amazon Cognito ID token (token_use=id) for the Astreus user pool — the
        terminal's own session credential. API consumers should use an API key
        instead.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.