List All Crypto

This method allows you to retrieve a list of all cryptocurrencies supported by the API.

Method Signature

async listCryptos(params?: ListCryptosParams): Promise<RampableCrypto[]>

Parameters

ListCryptosParams (optional):

• useSmartContract: boolean - Filter results based on tokens that use Rampable smart contract proxy
• blockchainType: 'EVM' | 'STELLAR' - Filter results based on blockchain type
• rampableAccessToken: string (optional) - The Rampable access token

Returns

Promise<RampableCrypto[]> - An array of cryptocurrency objects with the following properties:

• _id: string - Internal identifier
• symbol: string - Cryptocurrency symbol (e.g., "usdt")
• id: string - Unique identifier (e.g., "usdt-ethereum")
• name: string - Full name of the cryptocurrency (e.g., "Tether")
• label: string - Display label (e.g., "USDT - Ethereum")
• address: string - Contract address
• chainId: number - Blockchain network identifier
• is_native: boolean - Whether the token is native to the blockchain
• logo: string - URL to the cryptocurrency's logo
• currencies: string[] - Supported fiat currencies
• decimal: number - Number of decimal places
• priceId: string - Identifier used for price tracking

Example Usage

// List all cryptocurrencies
const allCryptos = await sdk.rampableReference.listCryptos();
 
// List only EVM-based cryptocurrencies
const evmCryptos = await sdk.rampableReference.listCryptos({
  blockchainType: 'EVM',
});
 
// List cryptocurrencies using smart contract proxy
const smartContractCryptos = await sdk.rampableReference.listCryptos({
  useSmartContract: true,
});

Response Example

[
  {
    "_id": "64dae87a6acf6644dd1a212d",
    "symbol": "usdt",
    "id": "usdt-ethereum",
    "name": "Tether",
    "label": "USDT - Ethereum",
    "address": "0xdAC17F958D2ee523a2206206994597C13D831ec7",
    "chainId": 1,
    "is_native": false,
    "logo": "https://raw.githubusercontent.com/Xellar-Protocol/xellar-assets/master/assets/tether/logo.png",
    "currencies": [
      "IDR",
      "INR",
      "THB",
      "USD",
      "EUR",
      "SGD"
    ],
    "decimal": 6,
    "priceId": "tether"
  }
  // ... more cryptocurrencies
]

Additional Information

For more information, see the Rampable References API Documentation (opens in a new tab).