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

# List ranked holders of a token

> Holders ranked by balance descending, then holder ascending. For a classic asset this is one merged list of trustline and SAC contract holders. Zero balances only with include=zero. Deep pages are cursor-only. With as_of_ledger the holders are read at a past ledger from the balance history (credit class assets-history, weight 5); holder_count is the count at that ledger, and the `supply` key is present and null (supply_source does not apply); assets with more than 100,000 holders answer 409 and need a snapshot job. Credit class assets-holders: 5 × ceil(rows/100), at least one credit per started 64 KiB. Publishable keys are not allowed.

- Unknown or repeated query parameters return 400, so a typo or an unsupported filter never returns unfiltered data.



## OpenAPI

````yaml /api-reference/assets.json get /assets/{asset}/holders
openapi: 3.0.3
info:
  title: Lumeus Assets API
  version: '2026-09-15'
  description: >-
    Lumeus Assets API on Stellar. Sign up at https://app.lumeus.dev: Free,
    Starter, Growth and Scale plans are self-serve, Enterprise by agreement.


    - **Pricing.** Testnet is free: Testnet requests cost no credits and are
    never billed. Each organization can make 10,000 Testnet requests a day
    across Activity, Assets and RPC (unlimited on Enterprise); the count resets
    at 00:00 UTC, and a request over it answers 429 rate_limited with
    Retry-After set to the seconds until then. Mainnet requests draw from the
    plan's monthly credits. Plans, limits and credit weights: `GET
    https://api.lumeus.dev/v1/plans`.

    - **Authentication.** Send `Authorization: Bearer <key>`, the same keys as
    Activity and RPC. Testnet: `lum_test_…`; Mainnet: `lum_live_…`. A key works
    only on its own network, so pick the server that matches it (the other
    network answers 401). Publishable `lum_pub_…` keys work only on the routes
    marked "Publishable keys allowed", from an allowed browser origin.

    - **Headers.** Every response except `GET /readyz` carries X-Request-Id;
    authenticated responses carry RateLimit-Limit, RateLimit-Remaining and
    RateLimit-Reset; 429 and 503 carry Retry-After.

    - **Errors.** JSON with a machine-readable code (see
    [errors](/guides/errors)). A path with an empty, `.` or `..` segment answers
    400 invalid_request, a trailing slash answers 404 not_found, and a method
    the path does not accept answers 405 with an Allow header.

    - **CORS.** Browser calls (CORS) are allowed from https://docs.lumeus.dev
    (the Try it playground of this reference) and https://app.lumeus.dev only,
    without cookies; responses expose ETag, Link, Location, Retry-After,
    X-Request-Id, X-Lumeus-Operation-Id, X-Lumeus-Idempotency and
    RateLimit-Limit, RateLimit-Remaining and RateLimit-Reset (errors included).
    Other websites cannot read responses made with a server key: use a
    publishable key with your own allowed origins ([browser
    keys](/guides/browser-keys)).
  license:
    name: Lumeus API contract
servers:
  - url: https://assets-testnet.lumeus.dev
    description: Testnet (default)
  - url: https://assets.lumeus.dev
    description: Mainnet
security:
  - Bearer: []
tags:
  - name: Holdings
    description: >-
      Every balance an address holds: XLM, trustlines, liquidity pool shares and
      contract token balances, live or at a past ledger.
  - name: Account state
    description: Claimable balances, open DEX offers and token allowances of an address.
  - name: Tokens
    description: >-
      The token registry (identity, metadata, flags, supply) and the ranked
      holders of each token.
  - name: Snapshots
    description: >-
      Background jobs that compute holdings or holders at any past ledger,
      including before the balance history begins.
  - name: Health
    description: Liveness and readiness probes for monitoring. No authentication.
paths:
  /assets/{asset}/holders:
    get:
      tags:
        - Tokens
      summary: List ranked holders of a token
      description: >-
        Holders ranked by balance descending, then holder ascending. For a
        classic asset this is one merged list of trustline and SAC contract
        holders. Zero balances only with include=zero. Deep pages are
        cursor-only. With as_of_ledger the holders are read at a past ledger
        from the balance history (credit class assets-history, weight 5);
        holder_count is the count at that ledger, and the `supply` key is
        present and null (supply_source does not apply); assets with more than
        100,000 holders answer 409 and need a snapshot job. Credit class
        assets-holders: 5 × ceil(rows/100), at least one credit per started 64
        KiB. Publishable keys are not allowed.


        - Unknown or repeated query parameters return 400, so a typo or an
        unsupported filter never returns unfiltered data.
      operationId: listRankedHoldersOfToken
      parameters:
        - name: asset
          in: path
          required: true
          description: >-
            `native`, `CODE:ISSUER` (case-sensitive, never padded), a C… token
            contract ID or `pool:<64 hex>`. A Stellar Asset Contract ID is
            accepted as an alias and resolves to its classic `CODE:ISSUER`.
          schema:
            type: string
            example: BTC:GAGVZMODPYFTULIVSY3RGFADIC5LF4LLSN37N4MFWGNZ57TYBXL2LQQX
            x-default: BTC:GAGVZMODPYFTULIVSY3RGFADIC5LF4LLSN37N4MFWGNZ57TYBXL2LQQX
          example: BTC:GAGVZMODPYFTULIVSY3RGFADIC5LF4LLSN37N4MFWGNZ57TYBXL2LQQX
        - name: min_balance
          in: query
          required: false
          schema:
            type: string
            pattern: ^[0-9]+(\.[0-9]+)?$
            example: '1'
          description: Decimal; holders below it are left out.
        - name: include
          in: query
          required: false
          schema:
            type: string
            enum:
              - zero
          description: 'zero: also list zero balances (trustlines that hold nothing).'
        - name: as_of_ledger
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            example: 5300000
          description: >-
            Read at this past ledger from the balance history (credit class
            assets-history, weight 5). 400 when after the latest applied ledger;
            409 when the history cannot answer it exactly. Not available to
            publishable keys.
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 200
            default: 50
            example: 10
          description: Records per page, 1 to 200 (default 50).
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          description: Resume after this paging_token. Prefer following `_links.next.href`.
      responses:
        '200':
          description: A page of holders with the asset's holder count and supply.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HoldersPage'
              example:
                _embedded:
                  records:
                    - archived: false
                      asset: >-
                        BTC:GAGVZMODPYFTULIVSY3RGFADIC5LF4LLSN37N4MFWGNZ57TYBXL2LQQX
                      authorized: true
                      balance: '1362.6745030'
                      balance_raw: '13626745030'
                      decimals: 7
                      holder: CCSXXPCXICXOC2MLU3UINWYKL6M5VNLVOTHA4ZQ5S5BEDZGRWDTP52CG
                      kind: contract
                      last_modified_ledger: 5332606
                      paging_token: >-
                        WyIxMzYyNjc0NTAzMCIsIkNDU1hYUENYSUNYT0MyTUxVM1VJTldZS0w2TTVWTkxWT1RIQTRaUTVTNUJFRFpHUldEVFA1MkNHIl0
                      source: ledger_entry
                      verified: true
                    - archived: false
                      asset: >-
                        BTC:GAGVZMODPYFTULIVSY3RGFADIC5LF4LLSN37N4MFWGNZ57TYBXL2LQQX
                      authorized: true
                      balance: '459.5518062'
                      balance_raw: '4595518062'
                      decimals: 7
                      holder: CAOWRPPM74GS4HLIHK72W3LF7VWUNZEIOVGS7CZ6AUMSAFPTSHRO3VSF
                      kind: contract
                      last_modified_ledger: 4963916
                      paging_token: >-
                        WyI0NTk1NTE4MDYyIiwiQ0FPV1JQUE03NEdTNEhMSUhLNzJXM0xGN1ZXVU5aRUlPVkdTN0NaNkFVTVNBRlBUU0hSTzNWU0YiXQ
                      source: ledger_entry
                      verified: true
                _links:
                  next:
                    href: >-
                      /assets/BTC:GAGVZMODPYFTULIVSY3RGFADIC5LF4LLSN37N4MFWGNZ57TYBXL2LQQX/holders?cursor=WyIxOTgwMDAwMCIsIkdBREg1QlFaRExGWDVXWTVITDVYMkMzV1ZIMkhXVE1DNklJUDIyVlJGR1VRWk1WUVNCRllENFZLIl0&limit=10
                  self:
                    href: >-
                      /assets/BTC%3AGAGVZMODPYFTULIVSY3RGFADIC5LF4LLSN37N4MFWGNZ57TYBXL2LQQX/holders?limit=10
                asset: BTC:GAGVZMODPYFTULIVSY3RGFADIC5LF4LLSN37N4MFWGNZ57TYBXL2LQQX
                decimals: 7
                holder_count: 55
                limit: 10
                read_view:
                  network: testnet
                  generation: assets-testnet-v1-5253887
                  as_of_ledger: 5332635
                  as_of_closed_at: '2026-10-22T16:32:42Z'
                  bootstrap_ledger: 5253887
                supply: '2151.1760365'
                supply_source: exact
          headers:
            X-Request-Id:
              description: >-
                Identifier of this request: req_ followed by 24 hex characters.
                Error bodies repeat it as request_id. Quote it when contacting
                support.
              schema:
                type: string
                pattern: ^req_[0-9a-f]{24}$
            RateLimit-Limit:
              description: >-
                Requests per minute of the bucket that answered: the plan rate,
                the dashboard session floor of 120, or a publishable key's
                per-IP rate.
              schema:
                type: integer
            RateLimit-Remaining:
              description: Whole requests left in the bucket after this one.
              schema:
                type: integer
            RateLimit-Reset:
              description: Seconds until the bucket is full again.
              schema:
                type: integer
        '400':
          $ref: '#/components/responses/HTTP400_4'
        '401':
          $ref: '#/components/responses/HTTP401'
        '402':
          $ref: '#/components/responses/HTTP402'
        '403':
          $ref: '#/components/responses/HTTP403_3'
        '404':
          $ref: '#/components/responses/HTTP404_2'
        '405':
          $ref: '#/components/responses/HTTP405_7'
        '409':
          $ref: '#/components/responses/HTTP409_2'
        '429':
          $ref: '#/components/responses/HTTP429'
        '501':
          $ref: '#/components/responses/HTTP501'
        '503':
          $ref: '#/components/responses/HTTP503'
      x-codeSamples:
        - lang: bash
          label: cURL
          source: >-
            curl --fail-with-body -sS
            'https://assets-testnet.lumeus.dev/assets/BTC:GAGVZMODPYFTULIVSY3RGFADIC5LF4LLSN37N4MFWGNZ57TYBXL2LQQX/holders?limit=10'
            \
              -H "Authorization: Bearer $LUMEUS_API_KEY"
        - lang: javascript
          label: JavaScript
          source: >-
            // Node 18+ (ES module)

            const res = await
            fetch('https://assets-testnet.lumeus.dev/assets/BTC:GAGVZMODPYFTULIVSY3RGFADIC5LF4LLSN37N4MFWGNZ57TYBXL2LQQX/holders?limit=10',
            {
              method: 'GET',
              headers: {
                Authorization: `Bearer ${process.env.LUMEUS_API_KEY}`,
              },
            });

            console.log(res.status, JSON.stringify(await res.json(), null, 2));
        - lang: python
          label: Python
          source: |-
            import json
            import os

            import requests

            res = requests.get(
                "https://assets-testnet.lumeus.dev/assets/BTC:GAGVZMODPYFTULIVSY3RGFADIC5LF4LLSN37N4MFWGNZ57TYBXL2LQQX/holders?limit=10",
                headers={"Authorization": f"Bearer {os.environ['LUMEUS_API_KEY']}"},
                timeout=30,
            )
            print(res.status_code, json.dumps(res.json(), indent=2))
components:
  schemas:
    HoldersPage:
      type: object
      properties:
        read_view:
          $ref: '#/components/schemas/ReadView'
        limit:
          type: integer
          description: 'Effective page size: default 50, maximum 200.'
        _links:
          type: object
          properties:
            self:
              type: object
              properties:
                href:
                  type: string
                  description: Relative URL; resolve against this product host.
              required:
                - href
            next:
              type: object
              properties:
                href:
                  type: string
                  description: Relative URL; resolve against this product host.
              required:
                - href
              description: Present only when more records remain.
          required:
            - self
        _embedded:
          type: object
          properties:
            records:
              type: array
              items:
                $ref: '#/components/schemas/Holder'
          required:
            - records
        asset:
          type: string
          description: >-
            Canonical asset ID: native, CODE:ISSUER (case-sensitive, never
            padded), a C… contract ID for a custom token, or `pool:<64 hex>` for
            a liquidity pool share. A Stellar Asset Contract ID is accepted as
            an alias and resolves to its classic CODE:ISSUER.
        holder_count:
          type: integer
          description: >-
            Holders with a non-zero balance; with as_of_ledger, the count at
            that ledger.
          minimum: 0
        supply:
          type: string
          description: >-
            Asset supply as on the registry record (trustlines and contract
            balances including archived; no claimable balances or pool
            reserves). Null while not computed, and always null with
            as_of_ledger (the key stays present). Decimal string using the
            token's decimals (7 for XLM, classic assets and SACs). Never a
            float.
          nullable: true
        supply_source:
          type: string
          enum:
            - exact
            - derived
        decimals:
          type: integer
          description: >-
            Decimals used for balance and supply; null when a custom token's
            decimals are unknown.
          minimum: 0
          maximum: 38
          nullable: true
        requested_as:
          type: string
          description: Present when the request named the asset by another ID.
      required:
        - read_view
        - limit
        - _links
        - _embedded
        - asset
        - holder_count
        - supply
        - supply_source
        - decimals
    ReadView:
      type: object
      properties:
        network:
          type: string
          description: >-
            Network of this host, with the same vocabulary as Activity
            read_view: pubnet is Mainnet.
          enum:
            - pubnet
            - testnet
        generation:
          type: string
          description: >-
            State index generation. It changes when the index is rebuilt or
            Testnet resets; do not mix pages from two generations.
        as_of_ledger:
          type: integer
          description: >-
            The answer is exactly the post-state of this ledger. Same meaning as
            Activity read_view.snapshot_ledger. With the as_of_ledger query
            parameter it is the requested ledger.
          minimum: 1
        as_of_closed_at:
          type: string
          format: date-time
          nullable: true
          description: >-
            Close time of as_of_ledger; null for as_of_ledger reads (the balance
            history does not record close times).
        bootstrap_ledger:
          type: integer
          description: >-
            Checkpoint the state index was bootstrapped from. Balance history
            (as_of_ledger queries) begins here at the earliest.
          minimum: 1
      required:
        - network
        - generation
        - as_of_ledger
        - as_of_closed_at
        - bootstrap_ledger
    Holder:
      type: object
      properties:
        holder:
          type: string
          description: G or C StrKey.
        asset:
          type: string
          description: >-
            Canonical asset ID: native, CODE:ISSUER (case-sensitive, never
            padded), a C… contract ID for a custom token, or `pool:<64 hex>` for
            a liquidity pool share. A Stellar Asset Contract ID is accepted as
            an alias and resolves to its classic CODE:ISSUER.
        kind:
          type: string
          enum:
            - native
            - trustline
            - pool_share
            - contract
        balance:
          type: string
          description: >-
            Decimal string using the token's decimals (7 for XLM, classic assets
            and SACs). Never a float.
        balance_raw:
          type: string
          description: Exact integer string (up to i128).
          pattern: ^-?[0-9]+$
        decimals:
          type: integer
          description: >-
            Null when a custom token's decimals are unknown (balance is then in
            raw units).
          minimum: 0
          maximum: 38
          nullable: true
        source:
          type: string
          description: >-
            How the value was determined. ledger_entry: read from the protocol
            entry (account, trustline, pool share, claimable balance, SAC
            balance). token_storage: a custom SEP-41 token whose storage layout
            is recognized. simulation: balance() simulated at as_of_ledger
            (unverified).
          enum:
            - ledger_entry
            - token_storage
            - simulation
        verified:
          type: boolean
        archived:
          type: boolean
        authorized:
          type: boolean
          description: Null for XLM and pool shares.
          nullable: true
        last_modified_ledger:
          type: integer
          minimum: 1
        paging_token:
          type: string
          description: Opaque keyset cursor (balance desc, holder asc).
      required:
        - holder
        - asset
        - kind
        - balance
        - balance_raw
        - decimals
        - source
        - verified
        - archived
        - authorized
        - last_modified_ledger
        - paging_token
    Error:
      type: object
      properties:
        error:
          type: string
          description: Human-readable message. It may change; branch on code.
        code:
          type: string
          description: >-
            Machine-readable error code. Branch on code, not on the error text,
            which may change. RPC carries the same codes as the string
            error.data of a JSON-RPC error. invalid_request: 400: invalid input,
            including a malformed Idempotency-Key or an unknown or repeated
            query parameter (Webhooks also uses it for an oversized request
            body, 413). Fix the request; do not retry unchanged. unauthorized:
            401: missing, revoked, invalid or wrong-network credential.
            payment_required: 402 (Mainnet): monthly credit quota exhausted on a
            hard-capped plan. forbidden: 403: the key or account policy does not
            allow this action. not_found: 404 (Webhooks also 410): the resource
            does not exist in this organization and network.
            topic_search_disabled: 404: contract-event topic search is not
            enabled on this network. method_not_allowed: 405: the route does not
            accept this method. conflict: 409: conflicting request identity,
            idempotency key, funding or recovery state. generation_changed: 409:
            the index generation or network changed since the snapshot was
            taken; restart the walk without generation and snapshot_ledger.
            history_unavailable: 409 (Assets): as_of_ledger is not answered from
            the balance history; start a snapshot job (POST /snapshots) or retry
            later. precondition_failed: 412 (Webhooks): the subscription version
            changed; fetch the current ETag. response_too_large: 413: the result
            exceeds the response budget; lower limit or narrow the request.
            precondition_required: 428 (Webhooks): If-Match with the
            subscription ETag is required. rate_limited: 429: a rate,
            concurrency or credit-cap limit was reached, or (Activity, Assets
            and RPC on Testnet) the daily Testnet request cap (message `daily
            Testnet request cap of 10000 reached; resets at 00:00 UTC`,
            Retry-After until 00:00 UTC). Wait Retry-After seconds (a refused
            request consumes nothing). A Retry-After greater than 60 means the
            daily Testnet cap: wait until 00:00 UTC or switch to Mainnet. RPC
            carries it as the string error.data. internal_error: 500 or another
            unexpected 5xx; quote request_id when contacting support.
            not_implemented: 501: the feature is not enabled on this host. busy:
            503: reads are saturated (the queue wait expired or the database
            refused another query or ran short of memory). Retry the same
            request after Retry-After (2) seconds. query_timeout: 503: the read
            ran out of time. Do not retry unchanged right away: narrow the
            ledger range (since_ledger/until_ledger) or lower limit; Retry-After
            is 30. index_not_ready: 503: the index or snapshot is not ready yet
            or is rebuilding; retry after Retry-After seconds. topic_coverage:
            503: the effective range is outside the contract-event topic index
            coverage (the message states it); pass a range inside it or retry
            after Retry-After (60) seconds. unavailable: 503: another temporary
            failure (billing, rate limiter, queue); retry after Retry-After
            seconds.
          enum:
            - invalid_request
            - unauthorized
            - payment_required
            - forbidden
            - not_found
            - topic_search_disabled
            - method_not_allowed
            - conflict
            - generation_changed
            - history_unavailable
            - precondition_failed
            - response_too_large
            - precondition_required
            - rate_limited
            - internal_error
            - not_implemented
            - busy
            - query_timeout
            - index_not_ready
            - topic_coverage
            - unavailable
        request_id:
          type: string
          description: >-
            Identifier of this request, the same value as the X-Request-Id
            header. Quote it when contacting support.
      required:
        - error
  responses:
    HTTP400_4:
      description: Invalid input, including an unknown or repeated query parameter.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            code: invalid_request
            error: >-
              invalid asset; expected native, CODE:ISSUER, a C... contract or
              pool:<64 hex>
            request_id: req_6f1c2a9b0e4d4c7a8b3f5e21
      headers:
        X-Request-Id:
          description: >-
            Identifier of this request: req_ followed by 24 hex characters.
            Error bodies repeat it as request_id. Quote it when contacting
            support.
          schema:
            type: string
            pattern: ^req_[0-9a-f]{24}$
    HTTP401:
      description: >-
        Missing, invalid, revoked or expired key, or a key for the other network
        (code unauthorized). Keys work only on the network they were created
        for.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            code: unauthorized
            error: missing credentials
            request_id: req_6f1c2a9b0e4d4c7a8b3f5e21
      headers:
        X-Request-Id:
          description: >-
            Identifier of this request: req_ followed by 24 hex characters.
            Error bodies repeat it as request_id. Quote it when contacting
            support.
          schema:
            type: string
            pattern: ^req_[0-9a-f]{24}$
    HTTP402:
      description: >-
        Mainnet only: the plan's monthly credits are used up on a hard-capped
        plan (Free; code payment_required). Upgrade, or wait for the next
        period. Testnet requests cost no credits, so Testnet never answers 402.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            code: payment_required
            error: >-
              monthly credit quota exhausted - top up credits or upgrade your
              plan
            request_id: req_6f1c2a9b0e4d4c7a8b3f5e21
      headers:
        X-Request-Id:
          description: >-
            Identifier of this request: req_ followed by 24 hex characters.
            Error bodies repeat it as request_id. Quote it when contacting
            support.
          schema:
            type: string
            pattern: ^req_[0-9a-f]{24}$
    HTTP403_3:
      description: >-
        This key or account cannot call this route (code forbidden): for example
        a read-only key on a workspace route, or a publishable key on a route or
        from an origin it does not allow.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            code: forbidden
            error: >-
              publishable keys can only read account holdings and the asset
              registry; use a secret key on your server
            request_id: req_6f1c2a9b0e4d4c7a8b3f5e21
      headers:
        X-Request-Id:
          description: >-
            Identifier of this request: req_ followed by 24 hex characters.
            Error bodies repeat it as request_id. Quote it when contacting
            support.
          schema:
            type: string
            pattern: ^req_[0-9a-f]{24}$
    HTTP404_2:
      description: Not found in this organization and network (code not_found).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            code: not_found
            error: asset not found
            request_id: req_6f1c2a9b0e4d4c7a8b3f5e21
      headers:
        X-Request-Id:
          description: >-
            Identifier of this request: req_ followed by 24 hex characters.
            Error bodies repeat it as request_id. Quote it when contacting
            support.
          schema:
            type: string
            pattern: ^req_[0-9a-f]{24}$
    HTTP405_7:
      description: >-
        This path does not accept the HTTP method you sent (code
        method_not_allowed). The Allow header lists the methods it accepts.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            code: method_not_allowed
            error: >-
              method POST is not allowed on
              /assets/BTC:GAGVZMODPYFTULIVSY3RGFADIC5LF4LLSN37N4MFWGNZ57TYBXL2LQQX/holders;
              allowed: GET, HEAD
            request_id: req_6f1c2a9b0e4d4c7a8b3f5e21
      headers:
        X-Request-Id:
          description: >-
            Identifier of this request: req_ followed by 24 hex characters.
            Error bodies repeat it as request_id. Quote it when contacting
            support.
          schema:
            type: string
            pattern: ^req_[0-9a-f]{24}$
    HTTP409_2:
      description: >-
        as_of_ledger is not answered from the balance history: it is before the
        history begins, inside a repaired gap, or not yet written (history is
        written in 64-ledger batches, so the last few minutes are missing); for
        holders, also when the asset has more than 100,000 holders. The message
        says which; the code is history_unavailable. Start a snapshot job (`POST
        /snapshots`) or retry later.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            Before the balance history:
              summary: Before the balance history
              value:
                code: history_unavailable
                error: >-
                  balance history begins at ledger 5253887; for ledger 5000000
                  start a snapshot job (POST /snapshots)
                request_id: req_6f1c2a9b0e4d4c7a8b3f5e21
            Not written yet:
              summary: Not written yet
              value:
                code: history_unavailable
                error: >-
                  balance history is written in 64-ledger batches and currently
                  reaches ledger 5331456; retry in a few minutes or read the
                  current state without as_of_ledger
                request_id: req_6f1c2a9b0e4d4c7a8b3f5e21
            More than 100,000 holders:
              summary: More than 100,000 holders
              value:
                code: history_unavailable
                error: >-
                  this asset has more than 100000 holders; for its holders at a
                  past ledger start a snapshot job (POST /snapshots)
                request_id: req_6f1c2a9b0e4d4c7a8b3f5e21
      headers:
        X-Request-Id:
          description: >-
            Identifier of this request: req_ followed by 24 hex characters.
            Error bodies repeat it as request_id. Quote it when contacting
            support.
          schema:
            type: string
            pattern: ^req_[0-9a-f]{24}$
    HTTP429:
      description: >-
        A rate or concurrency limit was reached, or on Testnet the
        organization's daily Testnet request cap (10,000 requests a day across
        Activity, Assets and RPC); the code is rate_limited for both. Wait
        Retry-After seconds. A rate_limited answer whose Retry-After is greater
        than 60 is the daily Testnet cap: wait until 00:00 UTC or switch to
        Mainnet. A refused request costs nothing and does not count toward the
        cap.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            Daily Testnet cap:
              summary: 'Daily Testnet request cap (Retry-After: seconds until 00:00 UTC)'
              value:
                code: rate_limited
                error: >-
                  daily Testnet request cap of 10000 reached; resets at 00:00
                  UTC
                request_id: req_6f1c2a9b0e4d4c7a8b3f5e21
            Plan rate limit:
              summary: 'Plan rate limit (Retry-After: a few seconds)'
              value:
                code: rate_limited
                error: rate limit exceeded
                request_id: req_6f1c2a9b0e4d4c7a8b3f5e21
      headers:
        X-Request-Id:
          description: Identifier of this request; also in the error body as request_id.
          schema:
            type: string
        RateLimit-Limit:
          description: >-
            Requests per minute of the bucket that answered: the plan rate, the
            dashboard session floor of 120, or a publishable key's per-IP rate.
          schema:
            type: integer
        RateLimit-Remaining:
          description: Whole requests left in the bucket after this one.
          schema:
            type: integer
        RateLimit-Reset:
          description: Seconds until the bucket is full again.
          schema:
            type: integer
        Retry-After:
          description: Seconds to wait before retrying.
          schema:
            type: integer
    HTTP501:
      description: Balance history is not enabled on this host.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            code: not_implemented
            error: historical reads (as_of_ledger) are not available yet
            request_id: req_6f1c2a9b0e4d4c7a8b3f5e21
      headers:
        X-Request-Id:
          description: >-
            Identifier of this request: req_ followed by 24 hex characters.
            Error bodies repeat it as request_id. Quote it when contacting
            support.
          schema:
            type: string
            pattern: ^req_[0-9a-f]{24}$
    HTTP503:
      description: >-
        The state index is not ready (bootstrapping, or behind the network; code
        index_not_ready): wait Retry-After seconds and retry. A read that ran
        out of time answers code query_timeout with Retry-After 30: lower limit
        or narrow the filters first. With as_of_ledger, also when too many
        historical reads are running at once (code busy, Retry-After 2), a
        historical read exceeded its memory limit (busy, Retry-After 30) or its
        time limit (query_timeout, Retry-After 30), or the history is not
        initialized or rebuilding (index_not_ready).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            Index not ready:
              summary: State index not ready (Retry-After 5)
              value:
                code: index_not_ready
                error: asset state is not ready yet; retry later
                request_id: req_6f1c2a9b0e4d4c7a8b3f5e21
            Query timeout:
              summary: The read ran out of time (query_timeout, Retry-After 30)
              value:
                code: query_timeout
                error: >-
                  the read exceeded its time limit; lower limit or narrow the
                  filters, then retry (for a past ledger, start a snapshot job
                  with POST /snapshots)
                request_id: req_6f1c2a9b0e4d4c7a8b3f5e21
            Busy:
              summary: Too many historical reads (as_of_ledger, busy, Retry-After 2)
              value:
                code: busy
                error: >-
                  too many historical reads are running; retry after the
                  Retry-After delay
                request_id: req_6f1c2a9b0e4d4c7a8b3f5e21
      headers:
        X-Request-Id:
          description: Identifier of this request; also in the error body as request_id.
          schema:
            type: string
        Retry-After:
          description: Seconds to wait before retrying.
          schema:
            type: integer
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer
      description: >-
        Send `Authorization: Bearer <key>`, the same keys as Activity and RPC.
        Testnet: `lum_test_…`; Mainnet: `lum_live_…`. A key works only on its
        own network, so pick the server that matches it (the other network
        answers 401). Publishable `lum_pub_…` keys work only on the routes
        marked "Publishable keys allowed", from an allowed browser origin.

````

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