Skip to main content
GET
/
api
/
partner
/
v1
/
blockchain-to-token
/
off-ramp
cURL
curl --request GET \
  --url https://staging-api.capa.fi/api/partner/v1/blockchain-to-token/off-ramp
{
  "status": "ok",
  "data": [
    {
      "tokens": [
        {
          "id": "1054c912-ddd7-4d71-aedd-de1ecf5b6e35",
          "symbol": "eth",
          "name": "ethereum",
          "logoUrl": "https://s3.amazon/eth-logo.png",
          "createdAt": "2024-04-05 13:45:27.063",
          "updatedAt": "2024-04-05 13:45:27.063",
          "isChainDefaultToken": true,
          "vmType": "EVM"
        }
      ],
      "id": "1054c912-ddd7-4d71-aedd-de1ecf5b6e35",
      "name": "Optimism",
      "chainId": 10,
      "logoUrl": "https://s3.amazon/optimism-logo.png",
      "vmType": "EVM",
      "createdAt": "2024-04-05 13:45:27.063",
      "updatedAt": "2024-04-05 13:45:27.063"
    }
  ]
}
Retrieves a comprehensive list of all supported blockchains and their corresponding tokens configured in the system for on ramp transactions. This endpoint is publicly accessible and does not require authentication.

​
Response body

  • data (array) - The list of all available off 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 off 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

JSON
{
  "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

  • Off-Ramp Transactions: In cases where users are converting cryptocurrency back to fiat, this module ensures that all relevant tokens are available for selection.
  • Blockchain and token display: Use this endpoint to keep the available off-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.

Response

200 - application/json

Retrieves all blockchains with their tokens that are available for off-ramp

​
status
string
Example:

"ok"

​
data
object[]