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

# Corporate bond screener

> Corporate bond disclosure screener: individually disclosed bonds, notes, sukuk and labelled capital instruments. No borrowing groups, market prices, yields or ratings; partial pilot coverage.



## OpenAPI

````yaml https://astreus.ai/openapi.json get /api/v1/debt/instruments
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/debt/instruments:
    get:
      tags:
        - Company Data
      summary: Corporate bond screener
      description: >-
        Corporate bond disclosure screener: individually disclosed bonds, notes,
        sukuk and labelled capital instruments. No borrowing groups, market
        prices, yields or ratings; partial pilot coverage.
      operationId: get-corporate-bond-screener
      parameters:
        - name: as_of
          in: query
          description: Public information through this UTC date, YYYY-MM-DD.
          schema:
            type: string
        - name: q
          in: query
          description: Instrument or issuer contains; max 100 characters.
          schema:
            type: string
        - name: currency
          in: query
          description: Native ISO currency in upper case, e.g. USD.
          schema:
            type: string
        - name: kind
          in: query
          description: >-
            Instrument kind: note includes subordinated, Tier 2 and AT1 notes;
            sukuk includes AT1 sukuk; loan is term loans and loans; capital is
            equity-classified capital instruments.
          schema:
            type: string
            enum:
              - bond
              - note
              - sukuk
              - loan
              - capital
              - group
        - name: include_prior
          in: query
          description: >-
            Include prior-only disclosures; these do not establish current
            outstanding status.
          schema:
            type: boolean
            default: true
        - name: include_matured
          in: query
          description: >-
            Include matured instruments and those the issuer shows as repaid or
            redeemed or the exchange delisted; default excludes them without
            deleting their evidence.
          schema:
            type: boolean
            default: false
        - name: sort
          in: query
          description: >-
            Amounts sort by their USD value at the cutoff (daily reference
            rates); an amount whose currency has no rate sorts last.
          schema:
            type: string
            enum:
              - maturity
              - coupon
              - amount
              - issuer
            default: maturity
        - name: direction
          in: query
          description: Sort direction.
          schema:
            type: string
            enum:
              - asc
              - desc
            default: asc
        - name: limit
          in: query
          description: >-
            Instruments per page, 1–100 (above 100 is a 400). Each instrument
            brings its cited sources, ~6 KB.
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 25
        - name: cursor
          in: query
          description: >-
            `page_info.nextCursor` from the previous page (`next_cursor` is its
            deprecated alias); `page_info.hasMore` is false on the last page.
            Revision-bound: restart from the first page if the data or filters
            change.
          schema:
            type: string
        - name: company
          in: query
          description: Repeat for up to 50 exact CIKs or platform keys.
          schema:
            type: array
            items:
              type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  debt:
                    type: object
                    properties:
                      company:
                        type: 'null'
                      coverage:
                        type: string
                      coverage_note:
                        type: string
                      scope:
                        type: 'null'
                      observation_date:
                        type: 'null'
                      instruments:
                        type: array
                        items:
                          type: object
                          properties:
                            kind:
                              type: string
                            events:
                              type: array
                              items: {}
                            fields:
                              type: object
                              properties:
                                isin:
                                  type: object
                                  properties:
                                    unit:
                                      type: 'null'
                                    basis:
                                      type: 'null'
                                    value:
                                      type: string
                                    precision:
                                      type: 'null'
                                    source_id:
                                      type: string
                                    null_reason:
                                      type: 'null'
                                coupon:
                                  type: object
                                  properties:
                                    unit:
                                      type: string
                                    basis:
                                      type: string
                                    value:
                                      type: string
                                    precision:
                                      type: 'null'
                                    source_id:
                                      type: string
                                    null_reason:
                                      type: 'null'
                                maturity:
                                  type: object
                                  properties:
                                    unit:
                                      type: 'null'
                                    basis:
                                      type: 'null'
                                    value:
                                      type: string
                                      format: date
                                    precision:
                                      type: string
                                    source_id:
                                      type: string
                                    null_reason:
                                      type: 'null'
                                rate_type:
                                  type: object
                                  properties:
                                    unit:
                                      type: 'null'
                                    basis:
                                      type: 'null'
                                    value:
                                      type: string
                                    precision:
                                      type: 'null'
                                    source_id:
                                      type: string
                                    null_reason:
                                      type: 'null'
                                issue_date:
                                  type: object
                                  properties:
                                    unit:
                                      type: 'null'
                                    basis:
                                      type: 'null'
                                    value:
                                      type: string
                                      format: date
                                    precision:
                                      type: string
                                    source_id:
                                      type: string
                                    null_reason:
                                      type: 'null'
                                listing_date:
                                  type: object
                                  properties:
                                    unit:
                                      type: 'null'
                                    basis:
                                      type: string
                                    value:
                                      type: string
                                      format: date
                                    precision:
                                      type: string
                                    source_id:
                                      type: string
                                    null_reason:
                                      type: 'null'
                                listed_amount:
                                  type: object
                                  properties:
                                    unit:
                                      type: string
                                    basis:
                                      type: string
                                    value:
                                      type: string
                                    precision:
                                      type: 'null'
                                    source_id:
                                      type: string
                                    null_reason:
                                      type: 'null'
                                listed_currency:
                                  type: object
                                  properties:
                                    unit:
                                      type: 'null'
                                    basis:
                                      type: string
                                    value:
                                      type: string
                                    precision:
                                      type: 'null'
                                    source_id:
                                      type: string
                                    null_reason:
                                      type: 'null'
                                original_issue_amount:
                                  type: object
                                  properties:
                                    unit:
                                      type: string
                                    basis:
                                      type: string
                                    value:
                                      type: string
                                    precision:
                                      type: 'null'
                                    source_id:
                                      type: string
                                    null_reason:
                                      type: 'null'
                                common_code:
                                  type: object
                                  properties:
                                    unit:
                                      type: 'null'
                                    basis:
                                      type: 'null'
                                    value:
                                      type: string
                                    precision:
                                      type: 'null'
                                    source_id:
                                      type: string
                                    null_reason:
                                      type: 'null'
                            issuer:
                              type: object
                              properties:
                                name:
                                  type: string
                                role:
                                  type: string
                                source_id:
                                  type: string
                                review_state:
                                  type: string
                            status:
                              type: string
                            object_id:
                              type: string
                            description:
                              type: string
                            disclosures:
                              type: array
                              items:
                                type: object
                                properties:
                                  document_ref:
                                    type: string
                                  snapshot_kind:
                                    type: string
                                  observation_date:
                                    type: string
                                    format: date
                            field_roles:
                              type: object
                              properties:
                                isin:
                                  type: string
                                coupon:
                                  type: string
                                maturity:
                                  type: string
                                rate_type:
                                  type: string
                                issue_date:
                                  type: string
                                listing_date:
                                  type: string
                                listed_amount:
                                  type: string
                                listed_currency:
                                  type: string
                                original_issue_amount:
                                  type: string
                                common_code:
                                  type: string
                            issuer_role:
                              type: 'null'
                            object_kind:
                              type: string
                            disclosed_at:
                              type: string
                              format: date-time
                            document_ref:
                              type: string
                            classification:
                              type: string
                            identity_state:
                              type: string
                            term_conflicts:
                              type: array
                              items: {}
                            terms_documents:
                              type: array
                              items:
                                type: string
                            observation_date:
                              type: string
                              format: date
                            observation_kind:
                              type: string
                            prior_disclosure:
                              type: boolean
                            source_description:
                              type: string
                            denomination_currency:
                              type: string
                            description_source_id:
                              type: string
                            company:
                              type: object
                              properties:
                                cik:
                                  type: string
                                ticker:
                                  type: string
                                name:
                                  type: string
                            stale:
                              type: boolean
                            amount_key:
                              type: string
                      facilities:
                        type: array
                        items: {}
                      totals:
                        type: object
                      filed_ladder:
                        type: array
                        items: {}
                      sources:
                        type: array
                        items:
                          type: object
                          properties:
                            source_id:
                              type: string
                            document_ref:
                              type: string
                            source_url:
                              type: string
                            source_published_at:
                              type: string
                              format: date-time
                            locator:
                              type: object
                              properties:
                                series:
                                  type: string
                                section:
                                  type: string
                                text_end:
                                  type: integer
                                text_hash:
                                  type: string
                                text_start:
                                  type: integer
                                issue_date:
                                  type: string
                                  format: date
                                issue_label:
                                  type: string
                                capture_method:
                                  type: string
                            raw_excerpt:
                              type: string
                            context_excerpt:
                              type: string
                      issuers:
                        type: array
                        items:
                          type: object
                          properties:
                            cik:
                              type: string
                            name:
                              type: string
                            individual_instruments:
                              type: integer
                            coverage:
                              type: string
                      currencies:
                        type: array
                        items:
                          type: string
                      as_of:
                        type: 'null'
                      page_info:
                        type: object
                        properties:
                          total:
                            type: integer
                          limit:
                            type: integer
                          hasMore:
                            type: boolean
                          nextCursor:
                            type: string
                          next_cursor:
                            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:
                debt:
                  company: null
                  coverage: partial
                  coverage_note: >-
                    Reviewed issuer disclosures. Includes sukuk and separately
                    labelled equity-classified capital instruments. Original
                    issue amounts are not current balances. Prices, yields and
                    ratings are not covered.
                  scope: null
                  observation_date: null
                  instruments:
                    - kind: sukuk
                      events: []
                      fields:
                        isin:
                          unit: null
                          basis: null
                          value: XS2392596180
                          precision: null
                          source_id: 2bb7c84d-6932-5c82-994c-3603ff9faa16
                          null_reason: null
                        coupon:
                          unit: percent
                          basis: listed_profit_rate
                          value: '2.082'
                          precision: null
                          source_id: e145dae1-12fa-5406-b35d-1c325fa1bc2f
                          null_reason: null
                        maturity:
                          unit: null
                          basis: null
                          value: '2026-11-02'
                          precision: day
                          source_id: 7a58bd19-9e57-580b-834f-0b48575ba93b
                          null_reason: null
                        rate_type:
                          unit: null
                          basis: null
                          value: fixed
                          precision: null
                          source_id: e145dae1-12fa-5406-b35d-1c325fa1bc2f
                          null_reason: null
                        issue_date:
                          unit: null
                          basis: null
                          value: '2021-11-02'
                          precision: day
                          source_id: ba7c33ec-95b4-52bb-9b69-47c06c8bbd4b
                          null_reason: null
                        listing_date:
                          unit: null
                          basis: exchange_listing_date
                          value: '2021-11-02'
                          precision: day
                          source_id: 8f875721-154a-5f90-8a87-d94c2fb8f251
                          null_reason: null
                        listed_amount:
                          unit: USD
                          basis: exchange_listed_issue_size
                          value: '500000000'
                          precision: null
                          source_id: f89972d3-4f04-5092-84d7-97dc9e8281cc
                          null_reason: null
                        listed_currency:
                          unit: null
                          basis: exchange_currency_field
                          value: USD
                          precision: null
                          source_id: c48049db-97d1-5112-af8f-cc8d6033415d
                          null_reason: null
                        original_issue_amount:
                          unit: USD
                          basis: amount_at_issuance
                          value: '500000000'
                          precision: null
                          source_id: ba7c33ec-95b4-52bb-9b69-47c06c8bbd4b
                          null_reason: null
                      issuer:
                        name: EI Sukuk Company Limited
                        role: issuer
                        source_id: 493ee8df-d718-5027-b6ab-7f1ada3e14de
                        review_state: reviewed
                      status: outstanding_unconfirmed
                      object_id: f63448bf-2d38-5f8b-bff8-0668ed6575c3
                      description: 2.082% Sukuk due 2 Nov 2026 (USD)
                      disclosures:
                        - document_ref: NDX-2cb89d7e-359a-4bb3-b4b0-0d247b311ee6
                          snapshot_kind: supplement
                          observation_date: '2026-09-21'
                        - document_ref: ENBD-2026-09-19-ISSUANCES
                          snapshot_kind: supplement
                          observation_date: '2026-09-19'
                      field_roles:
                        isin: term
                        coupon: term
                        maturity: term
                        rate_type: term
                        issue_date: term
                        listing_date: observation
                        listed_amount: observation
                        listed_currency: observation
                        original_issue_amount: term
                      issuer_role: null
                      object_kind: individual
                      disclosed_at: '2026-09-21T17:56:00.555Z'
                      document_ref: NDX-2cb89d7e-359a-4bb3-b4b0-0d247b311ee6
                      classification: liability
                      identity_state: reviewed
                      term_conflicts: []
                      terms_documents:
                        - ENBD-2026-09-19-ISSUANCES
                        - NDX-2cb89d7e-359a-4bb3-b4b0-0d247b311ee6
                      observation_date: '2026-09-21'
                      observation_kind: supplement
                      prior_disclosure: false
                      source_description: EI Sukuk Company Ltd. Nov 2026
                      denomination_currency: USD
                      description_source_id: 2bb7c84d-6932-5c82-994c-3603ff9faa16
                      company:
                        cik: XDFM000003
                        name: Emirates NBD Bank PJSC
                        ticker: EMIRATESNBD
                      stale: false
                      amount_key: listed_amount
                    - kind: note
                      events: []
                      fields:
                        isin:
                          unit: null
                          basis: null
                          value: XS1135337498
                          precision: null
                          source_id: 8fcbfcc2-2dfc-5c43-a2d1-cb21c9072ca7
                          null_reason: null
                        coupon:
                          unit: percent
                          basis: stated_coupon
                          value: '1.625'
                          precision: null
                          source_id: a35ad215-e64c-5deb-988f-59b083ddc26f
                          null_reason: null
                        maturity:
                          unit: null
                          basis: null
                          value: '2026-11-10'
                          precision: day
                          source_id: 3e338a42-1959-5e5f-a18c-de3cb482bb72
                          null_reason: null
                        rate_type:
                          unit: null
                          basis: null
                          value: fixed
                          precision: null
                          source_id: a35ad215-e64c-5deb-988f-59b083ddc26f
                          null_reason: null
                        common_code:
                          unit: null
                          basis: null
                          value: '113533749'
                          precision: null
                          source_id: 8fcbfcc2-2dfc-5c43-a2d1-cb21c9072ca7
                          null_reason: null
                        original_issue_amount:
                          unit: EUR
                          basis: initial_series_principal_in_establishing_document
                          value: '1400000000'
                          precision: null
                          source_id: 007650c6-317b-5d57-804e-e3ef70865058
                          null_reason: null
                      issuer:
                        name: Apple Inc.
                        role: issuer
                        source_id: 7fb47609-49ca-5729-8d61-8ee0ef592367
                        review_state: reviewed
                      status: outstanding_unconfirmed
                      object_id: 7c3ce40f-0ae4-55c1-a260-99b5bf61857b
                      description: 1.625% Notes due 2026 (EUR)
                      disclosures:
                        - document_ref: SEC-TERM-000119312514406296-d816414dex41
                          snapshot_kind: supplement
                          observation_date: '2014-11-10'
                      field_roles:
                        isin: term
                        coupon: term
                        maturity: term
                        rate_type: term
                        common_code: term
                        original_issue_amount: term
                      issuer_role: null
                      object_kind: individual
                      disclosed_at: '2014-11-10T22:05:54.000Z'
                      document_ref: SEC-TERM-000119312514406296-d816414dex41
                      classification: liability
                      identity_state: reviewed
                      term_conflicts: []
                      terms_documents:
                        - SEC-TERM-000119312514406296-d816414dex41
                      observation_date: '2014-11-10'
                      observation_kind: supplement
                      prior_disclosure: false
                      denomination_currency: EUR
                      description_source_id: 007650c6-317b-5d57-804e-e3ef70865058
                      company:
                        cik: '0000320193'
                        name: Apple Inc.
                        ticker: AAPL
                      stale: true
                      amount_key: original_issue_amount
                  facilities: []
                  totals: {}
                  filed_ladder: []
                  sources:
                    - source_id: 007650c6-317b-5d57-804e-e3ef70865058
                      document_ref: SEC-TERM-000119312514406296-d816414dex41
                      source_url: >-
                        https://www.sec.gov/Archives/edgar/data/320193/000119312514406296/d816414dex41.htm
                      source_published_at: '2014-11-10T22:05:54.000Z'
                      locator:
                        series: 1.625% Notes due 2026
                        section: Terms
                        text_end: 6033
                        text_hash: >-
                          7ed21188dc01a4b6e679edaba051f6684df22561b6d703cf66d085e32b3b9dfe
                        text_start: 5979
                      raw_excerpt: Aggregate Principal Amount at Maturity. €1,400,000,000
                      context_excerpt: ''
                    - source_id: ba7c33ec-95b4-52bb-9b69-47c06c8bbd4b
                      document_ref: ENBD-2026-09-19-ISSUANCES
                      source_url: >-
                        https://www.emiratesnbd.com/en/investor-relations/debt-and-ratings
                      source_published_at: '2026-09-19T00:54:36.119Z'
                      locator:
                        section: public_issuance_table
                        text_hash: >-
                          a8e1b992cabd447eb807324f43c2b4a7e1797f4ec22309a6a6be8f4b4069eaa1
                        issue_date: '2021-11-02'
                        issue_label: USD 500mn Sukuk
                        capture_method: web_text_extract
                      raw_excerpt: >-
                        L1946: USD 500mn Sukuk  | 5 years  | 2-Nov-21  |
                        2-Nov-26  | 2.082%  | USD  | 500  | 500  |
                      context_excerpt: >-
                        Historical issuance terms. Current outstanding amount
                        and redemption status are not established by this
                        catalog.
                  issuers:
                    - cik: XADS000009
                      name: Abu Dhabi Commercial Bank
                      individual_instruments: 3
                      coverage: partial
                    - cik: XADS000024
                      name: Aldar Properties PJSC
                      individual_instruments: 10
                      coverage: partial
                  currencies:
                    - AED
                    - AUD
                  as_of: null
                  page_info:
                    total: 560
                    limit: 2
                    hasMore: true
                    nextCursor: >-
                      eyJyZXZpc2lvbiI6ImRiOTkxNDJiMjg2MzE3NjZlMzg5NjU0ZmFmODQwYjZjIiwiZmlsdGVycyI6ImE5NWNmNDU5ZWVhOGFmZmI2YWUwMjY3OWYzNjM1NjI3Iiwia2V5IjpbMCwiMjAyNi0xMS0xMCIsIjdjM2NlNDBmLTBhZTQtNTVjMS1hMjYwLTk5YjViZjYxODU3…
                    next_cursor: >-
                      eyJyZXZpc2lvbiI6ImRiOTkxNDJiMjg2MzE3NjZlMzg5NjU0ZmFmODQwYjZjIiwiZmlsdGVycyI6ImE5NWNmNDU5ZWVhOGFmZmI2YWUwMjY3OWYzNjM1NjI3Iiwia2V5IjpbMCwiMjAyNi0xMS0xMCIsIjdjM2NlNDBmLTBhZTQtNTVjMS1hMjYwLTk5YjViZjYxODU3…
        '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.