---
title: "List ledgers"
method: GET
path: "/v1/ledgers"
tags: ["Ledgers"]
---

# List ledgers

`GET /v1/ledgers`

## Query parameters

- `limit` integer
- `startingAfter` string
- `sortBy` 'id' | 'alias' | 'metadata.createdAt' | 'metadata.lastModifiedAt'
- `sortOrder` 'ASC' | 'DESC'

## Response `200`

- CoreTrustedLedgersCollection
  - `items` CoreTrustedLedger[], required
    - `data` CoreLedger, required
      - `id` string, required
      - `alias` string, required
      - `parameters` union, required
        - CoreLedgerParametersAlgorand
          - `genesisId` string, required
          - `genesisHash` string, required
          - `nativeTickerSymbol` string, required
          - `nativeTickerName` string, required
          - `nativeTickerDecimals` integer, required
          - `type` 'Algorand', required
        - CoreLedgerParametersBitcoin
          - `supportsSegWit` boolean, required
          - `vaultLedgerIdentifier` 'btc' | 'ltc' | 'bch' | 'doge' | 'dash', required
          - `network` 'mainnet' | 'testnet' | 'regtest', required
          - `tickerSymbol` string, required
          - `tickerName` string, required
          - `dustLimit` string, required — This field is a large integer that can be positive or zero. It is represented as a string because it may contain value that cannot be expressed with JSON number without a loss of precision.
          - `type` 'Bitcoin', required
        - CoreLedgerParametersCardano
          - `nativeTickerSymbol` string, required
          - `nativeTickerName` string, required
          - `testnetMagic` integer
          - `type` 'Cardano', required
        - CoreLedgerParametersEthereum
          - `chainId` integer, required
          - `vaultLedgerIdentifier` 'eth' | 'etc', required
          - `nativeTickerSymbol` string, required
          - `nativeTickerName` string, required
          - `supportsEIP1559` boolean, required
          - `type` 'Ethereum', required
        - CoreLedgerParametersHedera
          - `nativeTickerSymbol` string, required
          - `nativeTickerName` string, required
          - `type` 'Hedera', required
        - CoreLedgerParametersSolana
          - `nativeTickerSymbol` string, required
          - `nativeTickerName` string, required
          - `lamportsPerSignature` string, required — This field is a large integer that can be positive or zero. It is represented as a string because it may contain value that cannot be expressed with JSON number without a loss of precision.
          - `type` 'Solana', required
        - CoreLedgerParametersStellar
          - `nativeTickerSymbol` string, required
          - `nativeTickerName` string, required
          - `networkPassphrase` string, required
          - `type` 'Stellar', required
        - CoreLedgerParametersSubstrate
          - `genesisHash` string, ^0x[a-f0-9]{64}$, required
          - `addressPrefix` integer, required
          - `nativeTickerSymbol` string, required
          - `nativeTickerName` string, required
          - `nativeTickerDecimals` integer, required
          - `supportedRuntimeVersions` CoreSubstrateRuntimeInfo[], required
            - `transactionVersion` integer, required
            - `feeParameters` CoreSubstrateFeeParameters, required
              - …
            - `pallets` CoreSubstratePalletInfo[], required
              - …
            - `chainType` 'RelayChain' | 'AssetHub'
          - `type` 'Substrate', required
        - CoreLedgerParametersTezos
          - `nativeTickerSymbol` string, required
          - `nativeTickerName` string, required
          - `chainId` string, required
          - `type` 'Tezos', required
        - CoreLedgerParametersTron
          - `nativeTickerSymbol` string, required
          - `nativeTickerName` string, required
          - `type` 'Tron', required
        - CoreLedgerParametersXRPL
          - `nativeTickerSymbol` string, required
          - `nativeTickerName` string, required
          - `networkId` integer, required
          - `type` 'XRPL', required
      - `metadata` CoreEntityMetadata, required
        - `description` string
        - `revision` integer, required
        - `createdAt` string, date-time, required
        - `createdBy` CoreUserReference
          - `id` string, uuid, required
          - `domainId` string, uuid, required
        - `lastModifiedAt` string, date-time, required
        - `lastModifiedBy` CoreUserReference
          - `id` string, uuid, required
          - `domainId` string, uuid, required
        - `customProperties` CoreStringsMap, required
    - `signature` string, base64, required
    - `signingKey` string, base64, required
  - `count` integer, required
  - `currentStartingAfter` string
  - `nextStartingAfter` string

## Other responses

- `400` — Invalid value for: query parameter limit, Invalid value for: query parameter startingAfter, Invalid value for: query parameter sortBy, Invalid value for: query parameter sortOrder, Invalid value for: query parameters
- `401` — One of: Invalid JWT (InvalidJwtError); User not authorized (PermissionDeniedError)
- `404` — Entity or Domain not found (EntityNotFoundError)

---

[API](https://skmtc.net/ripple/apis/ripple-custody-api.md) · [All operations](https://skmtc.net/ripple/apis/ripple-custody-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ripple/ripple-custody-api/revisions/410038300d74/schema)