# List tickers

Endpoint: GET /v1/tickers
Security: httpAuth

## Query parameters:

  - `limit` (integer)
    The number of entities to return.

  - `startingAfter` (string)
    Entity id used to the determine beginning of query results.

  - `sortBy` (string)
    Property name used to sort the query results.
    Enum: "id", "ledgerId", "kind", "name", "symbol"

  - `sortOrder` (string)
    Sort order applied to the query results.
    Enum: "ASC", "DESC"

  - `ledgerId` (array)
    Return entities matching given ledger id.
    Example: ["exemplaryLedgerId1","exemplaryLedgerId2"]

  - `kind` (string)
    Return entities matching given kind.
    Enum: "Native", "Contract", "Token"

  - `name` (array)
    Return entities with names that contains or equals to provided name.
    Example: ["exemplaryTickerName1","exemplaryTickerName2"]

  - `symbol` (array)
    Return entities with names that contains or equals to provided symbol.
    Example: ["exemplaryTickerSymbol1","exemplaryTickerSymbol2"]

  - `validationStatus` (string)
    Return entities matching the requested validation status
    Enum: "Validated", "NonValidated"

  - `lock` (array)
    Return tickers matching given lock status.
    Enum: "Unlocked", "Locked", "Archived"

  - `issuer` (array)
    Return tickers issued by one of the given issuing addresses. Only set for assets whose ledger identifies them by an issuer, in which case it must be combined with assetCode to identify a single asset. Combine with ledgerId to keep the result unambiguous across ledgers.
    Example: ["rN7n7otQDd6FczFgLdSqtcsAUxDkw6fzRH"]

  - `assetCode` (array)
    Return tickers whose asset code in the ledger matches one of the given codes. Only set for assets whose ledger identifies them by an issuer and a code, in which case it must be combined with issuer to identify a single asset. Combine with ledgerId to keep the result unambiguous across ledgers.
    Example: ["USD","4558414D504C452D544F4B454E00000000000000"]

  - `assetReference` (array)
    Return tickers whose asset reference in the ledger matches one of the given references. Set for assets that a ledger identifies without an issuer, such as an issuance id, a contract address or a mint. Assets that need two values join them with a dash: - for ERC721 and ERC1155, - for a Hedera NFT. Combine with ledgerId to keep the result unambiguous across ledgers.
    Example: ["0000012C1EA5B6D9C0E5A2F4B8D7C36A1F0E9B8D7C6A5F4E","0x6b175474e89094c44da98b954eedeac495271d0f","0xb47e3cd837ddf8e4c57f05d70ab865de6e193bbb-7804"]

## Response 200 fields (application/json):

  - `items` (array, required)

  - `items.data` (object, required)

  - `items.data.id` (string, required)

  - `items.data.ledgerId` (string, required)

  - `items.data.kind` (string, required)
    Enum: same as `kind` (3 values)

  - `items.data.name` (string, required)

  - `items.data.decimals` (integer)

  - `items.data.symbol` (string)

  - `items.data.ledgerDetails` (any, required) — one of (discriminator: type):
    - Algorand:
      - `properties` (any, required)
        - `type` (string, required)
          Enum: "Native"
      - `type` (string, required)
        Enum: "Algorand"
    - Bitcoin:
      - `properties` (any, required)
        - `type` (string, required)
          Enum: same as `type` (1 values)
      - `type` (string, required)
        Enum: "Bitcoin"
    - Cardano:
      - `properties` (any, required)
        - `type` (string, required)
          Enum: same as `type` (1 values)
      - `type` (string, required)
        Enum: "Cardano"
    - Ethereum:
      - `properties` (any, required) — one of (discriminator: type):
        - ERC1155:
          - `address` (string, required)
          - `tokenId` (string, required)
          - `type` (string, required)
            Enum: "ERC1155"
        - ERC20:
          - `address` (string, required)
          - `type` (string, required)
            Enum: "ERC20"
        - ERC721:
          - `address` (string, required)
          - `tokenId` (string, required)
            This field is a large integer and represented as a string because it may contain value that cannot be expressed with JSON number without a loss of precision.
          - `type` (string, required)
            Enum: "ERC721"
        - Native:
          - `type` (string, required)
            Enum: same as `type` (1 values)
      - `type` (string, required)
        Enum: "Ethereum"
    - Hedera:
      - `properties` (any, required) — one of (discriminator: type):
        - FungibleToken:
          - `id` (string, required)
            String consisting Hedera Token Id
          - `type` (string, required)
            Enum: "FungibleToken"
        - Native:
          - `type` (string, required)
            Enum: same as `type` (1 values)
        - NonFungibleToken:
          - `id` (string, required)
            String consisting Hedera Token Id
          - `serialNumber` (integer, required)
          - `type` (string, required)
            Enum: "NonFungibleToken"
      - `type` (string, required)
        Enum: "Hedera"
    - Solana:
      - `properties` (any, required) — one of (discriminator: type):
        - Native:
          - `type` (string, required)
            Enum: same as `type` (1 values)
        - Token:
          - `mint` (string, required)
          - `tokenType` (string, required)
            Enum: "SPL", "SPL2022"
          - `type` (string, required)
            Enum: "Token"
      - `type` (string, required)
        Enum: "Solana"
    - Stellar:
      - `properties` (any, required) — one of (discriminator: type):
        - Native:
          - `type` (string, required)
            Enum: same as `type` (1 values)
        - Token:
          - `code` (string, required)
          - `issuer` (string, required)
          - `type` (string, required)
            Enum: same as `type` in "Token" (1 values)
      - `type` (string, required)
        Enum: "Stellar"
    - Substrate:
      - `properties` (any, required)
        - `type` (string, required)
          Enum: same as `type` (1 values)
      - `type` (string, required)
        Enum: "Substrate"
    - Tezos:
      - `properties` (any, required)
        - `type` (string, required)
          Enum: same as `type` (1 values)
      - `type` (string, required)
        Enum: "Tezos"
    - Tron:
      - `properties` (any, required) — one of (discriminator: type):
        - Native:
          - `type` (string, required)
            Enum: same as `type` (1 values)
        - TRC20:
          - `contractAddress` (string, required)
          - `type` (string, required)
            Enum: "TRC20"
      - `type` (string, required)
        Enum: "Tron"
    - XRPL:
      - `properties` (any, required) — one of (discriminator: type):
        - FungibleToken:
          - `currencyCode` (string, required)
          - `issuer` (string, required)
          - `type` (string, required)
            Enum: same as `type` in "FungibleToken" (1 values)
        - MultiPurposeToken:
          - `issuanceId` (string, required)
            XRPL MPToken Issuance ID (192-bit integer hex encoded)
          - `type` (string, required)
            Enum: "MultiPurposeToken"
        - Native:
          - `type` (string, required)
            Enum: same as `type` (1 values)
      - `type` (string, required)
        Enum: "XRPL"

  - `items.data.lock` (string, required)
    Enum: same as `lock` (3 values)

  - `items.data.metadata` (object)

  - `items.data.metadata.description` (string)

  - `items.data.metadata.revision` (integer, required)

  - `items.data.metadata.createdAt` (string, required)

  - `items.data.metadata.createdBy` (object)

  - `items.data.metadata.createdBy.id` (string, required)

  - `items.data.metadata.createdBy.domainId` (string, required)

  - `items.data.metadata.lastModifiedAt` (string, required)

  - `items.data.metadata.lastModifiedBy` (object)

  - `items.data.metadata.customProperties` (object, required)

  - `items.signature` (string)

  - `items.id` (string, required)
    Deletion target: Mar. 31st 2027

  - `items.ledgerId` (string, required)
    Deletion target: Mar. 31st 2027

  - `items.kind` (string, required)
    Enum: same as `kind` (3 values)

  - `items.name` (string, required)
    Deletion target: Mar. 31st 2027

  - `items.decimals` (integer)
    Deletion target: Mar. 31st 2027

  - `items.symbol` (string)
    Deletion target: Mar. 31st 2027

  - `items.ledgerDetails` (any, required) — one of (discriminator: type):
    - Algorand:
      - `properties` (any, required)
        - `type` (string, required)
          Enum: same as `type` (1 values)
      - `type` (string, required)
        Enum: same as `type` in "Algorand" (1 values)
    - Bitcoin:
      - `properties` (any, required)
        - `type` (string, required)
          Enum: same as `type` (1 values)
      - `type` (string, required)
        Enum: same as `type` in "Bitcoin" (1 values)
    - Cardano:
      - `properties` (any, required)
        - `type` (string, required)
          Enum: same as `type` (1 values)
      - `type` (string, required)
        Enum: same as `type` in "Cardano" (1 values)
    - Ethereum:
      - `properties` (any, required) — one of (discriminator: type):
        - ERC1155:
          - `address` (string, required)
          - `tokenId` (string, required)
          - `type` (string, required)
            Enum: same as `type` in "ERC1155" (1 values)
        - ERC20:
          - `address` (string, required)
          - `type` (string, required)
            Enum: same as `type` in "ERC20" (1 values)
        - ERC721:
          - `address` (string, required)
          - `tokenId` (string, required)
            This field is a large integer and represented as a string because it may contain value that cannot be expressed with JSON number without a loss of precision.
          - `type` (string, required)
            Enum: same as `type` in "ERC721" (1 values)
        - Native:
          - `type` (string, required)
            Enum: same as `type` (1 values)
      - `type` (string, required)
        Enum: same as `type` in "Ethereum" (1 values)
    - Hedera:
      - `properties` (any, required) — one of (discriminator: type):
        - FungibleToken:
          - `id` (string, required)
            String consisting Hedera Token Id
          - `type` (string, required)
            Enum: same as `type` in "FungibleToken" (1 values)
        - Native:
          - `type` (string, required)
            Enum: same as `type` (1 values)
        - NonFungibleToken:
          - `id` (string, required)
            String consisting Hedera Token Id
          - `serialNumber` (integer, required)
          - `type` (string, required)
            Enum: same as `type` in "NonFungibleToken" (1 values)
      - `type` (string, required)
        Enum: same as `type` in "Hedera" (1 values)
    - Solana:
      - `properties` (any, required) — one of (discriminator: type):
        - Native:
          - `type` (string, required)
            Enum: same as `type` (1 values)
        - Token:
          - `mint` (string, required)
          - `tokenType` (string, required)
            Enum: same as `tokenType` in "Token" (2 values)
          - `type` (string, required)
            Enum: same as `type` in "Token" (1 values)
      - `type` (string, required)
        Enum: same as `type` in "Solana" (1 values)
    - Stellar:
      - `properties` (any, required) — one of (discriminator: type):
        - Native:
          - `type` (string, required)
            Enum: same as `type` (1 values)
        - Token:
          - `code` (string, required)
          - `issuer` (string, required)
          - `type` (string, required)
            Enum: same as `type` in "Token" (1 values)
      - `type` (string, required)
        Enum: same as `type` in "Stellar" (1 values)
    - Substrate:
      - `properties` (any, required)
        - `type` (string, required)
          Enum: same as `type` (1 values)
      - `type` (string, required)
        Enum: same as `type` in "Substrate" (1 values)
    - Tezos:
      - `properties` (any, required)
        - `type` (string, required)
          Enum: same as `type` (1 values)
      - `type` (string, required)
        Enum: same as `type` in "Tezos" (1 values)
    - Tron:
      - `properties` (any, required) — one of (discriminator: type):
        - Native:
          - `type` (string, required)
            Enum: same as `type` (1 values)
        - TRC20:
          - `contractAddress` (string, required)
          - `type` (string, required)
            Enum: same as `type` in "TRC20" (1 values)
      - `type` (string, required)
        Enum: same as `type` in "Tron" (1 values)
    - XRPL:
      - `properties` (any, required) — one of (discriminator: type):
        - FungibleToken:
          - `currencyCode` (string, required)
          - `issuer` (string, required)
          - `type` (string, required)
            Enum: same as `type` in "FungibleToken" (1 values)
        - MultiPurposeToken:
          - `issuanceId` (string, required)
            XRPL MPToken Issuance ID (192-bit integer hex encoded)
          - `type` (string, required)
            Enum: same as `type` in "MultiPurposeToken" (1 values)
        - Native:
          - `type` (string, required)
            Enum: same as `type` (1 values)
      - `type` (string, required)
        Enum: same as `type` in "XRPL" (1 values)

  - `count` (integer, required)

  - `currentStartingAfter` (string)

  - `nextStartingAfter` (string)

## Response 401 fields (application/json):

  - `reason` (string, required)

  - `message` (string)