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

# List chains

> The chain list to render in a picker. Reflects what is actually routable right now, so a chain missing here cannot be quoted.

A sandbox key sees only testnets.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/chains
openapi: 3.1.0
info:
  title: Hypermid API
  description: >-
    Price and execute cross-chain swaps, read reference data and payer balances,
    and quote the fiat on-ramp. Quotes return an executable `transactionRequest`
    your frontend submits directly, so Hypermid never custodies the funds.


    Payments — `checkout`, `deposit`, and `withdrawal` sessions — and
    payment-link management are available through these merchant REST endpoints
    and the [`@hypermid/sdk`](https://docs.hypermid.io/sdk/payments) package.
    Payer-facing routes are intentionally omitted.
  version: 0.2.0
  contact: {}
servers:
  - url: https://server.hypermid.io
    description: Production — live keys (sk_live_…)
  - url: https://server.hypermid.io
    description: Sandbox — test keys (sk_test_…), testnets only
security: []
tags:
  - name: payments
    description: >-
      Create and read payment sessions, manage webhooks, and configure payout
      addresses with a secret partner key.
  - name: payment links
    description: >-
      Create, read, version, and revoke reusable checkout payment links with a
      secret partner key.
  - name: quote
    description: >-
      Route pricing for the orchestration product. Returns an executable
      `transactionRequest` your frontend submits directly, so Hypermid never
      custodies the funds.
  - name: status
    description: >-
      Resolve the state of a submitted swap or transfer. Two endpoints with
      different audiences — see each one's description before choosing.
  - name: catalog
    description: >-
      Reference data an integration needs to render a picker: supported chains
      and tokens, prices, routable connections, and fee configuration. A sandbox
      key sees only testnets here.
  - name: balances
    description: Read a payer wallet's token balances across supported chains.
  - name: onramp
    description: >-
      The fiat rail — card and bank payment for crypto, quoted and settled
      through our onramp partner. Requires per-partner onramp credentials on
      your account.
  - name: webhooks
    description: >-
      Events Hypermid sends TO you when a session completes. These are requests
      we make to your server, not endpoints you call.
paths:
  /v1/chains:
    get:
      tags:
        - catalog
      summary: List chains
      description: >-
        The chain list to render in a picker. Reflects what is actually routable
        right now, so a chain missing here cannot be quoted.


        A sandbox key sees only testnets.
      operationId: CatalogController_getChains
      parameters:
        - name: network
          required: false
          in: query
          description: Filter to mainnet or testnet chains. Omit for both.
          schema:
            example: mainnet
            enum:
              - mainnet
              - testnet
            type: string
        - name: settlement
          required: false
          in: query
          description: >-
            `true` returns only chains that can SETTLE a payment. The unfiltered
            list includes chains that are valid as a payment SOURCE but cannot
            be a destination — build a destination picker with this on, or a
            payer can choose a chain the payment can never complete on.
          schema:
            example: 'true'
            enum:
              - 'true'
              - 'false'
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChainsResponseDto'
components:
  schemas:
    ChainsResponseDto:
      type: object
      properties:
        chains:
          description: Supported chains that currently have at least one routable token.
          type: array
          items:
            $ref: '#/components/schemas/ChainCatalogEntryDto'
      required:
        - chains
    ChainCatalogEntryDto:
      type: object
      properties:
        chainId:
          type: number
          example: 8453
          description: EVM chain id, or our canonical id for a non-EVM chain.
        key:
          type: string
          example: base
          description: Short stable slug for the chain, safe to use in URLs.
        name:
          type: string
          example: Base
          description: Human-readable chain name, for display.
        ecosystem:
          type: string
          example: evm
          description: Which family the chain belongs to (EVM, Solana, NEAR, and so on).
        testnet:
          type: boolean
          example: false
          description: True for a testnet. A sandbox key sees only these.
        native:
          type: object
          example:
            symbol: ETH
            name: Ether
            decimals: 18
          description: The chain's native gas asset.
        providers:
          type: object
          description: Providers that reach this chain + each provider's own ids.
          additionalProperties: true
          example:
            lifi:
              chainId: 8453
            nearIntents:
              blockchain: base
        settlement:
          type: boolean
          example: true
          description: True iff Hypermid settles (deploys contracts) on this chain.
      required:
        - chainId
        - key
        - name
        - ecosystem
        - testnet
        - native
        - providers
        - settlement

````