/api/partner/v1/blockchain-to-token/on-ramp

This endpoint is publicly accessible and does not require authentication.

Response body

• data (array) - The list of all available on ramp blockchains and its tokens.
  • id (string) - Blockchain/network ID
  • name (string) - Name of the blockchain.
  • chainId (number) - The blockchain unique identifier.
  • logoUrl (string) - Url where the blockchain logo is stored.
  • createdAt (string) - Date where this blockchain was created.
  • updatedAt (string) - Date where this blockchain was updated.
  • tokens (object) - The list of tokens available for this blockchain.
    • id (string) - Token ID, used to create an on ramp transaction.
    • name (string) - Name of the token. (Ex: Ethereum)
    • symbol (string) - The symbol used to represent the token. (Ex: ETH)
    • isChainDefaultToken (boolean) - Used to display this token as the default blockchain token.
    • createdAt (string) - Date where this token was created.
    • updatedAt (string) - Date where this token was updated.

Example

{
  "data": [
    {
      "id": "9fc9be7c-afb7-4c3a-9adf-efc1176e0b87",
      "chainId": 10,
      "createdAt": "2024-05-10T20:21:14.075Z",
      "logoUrl": "https://capa-icons.s3.us-east-2.amazonaws.com/coins+and+network+logos/op/color.svg",
      "name": "Optimism",
      "updatedAt": "2024-05-10T20:21:14.075Z",
      "tokens": [
        {
          "id": "1ef72d77-fe4e-4487-95fb-1073aa4055da",
          "logoUrl": "https://capa-icons.s3.us-east-2.amazonaws.com/coins+and+network+logos/USDC/color.svg",
          "name": "USDC",
          "symbol": "USDC",
          "isChainDefaultToken": true,
          "createdAt": "2024-05-10T20:21:17.411Z",
          "updatedAt": "2024-05-10T20:21:17.411Z"
        }
      ]
    }
  ]
}

Use Cases

• On-Ramp Transactions: When users want to convert fiat to cryptocurrency, this module allows your application to display all available crypto tokens.
• Blockchain and token display: Use this endpoint to keep the available on-ramp blockchains and its corresponding tokens options up-to-date across different parts of your application, such as payment forms, transaction history, or user settings.