Rango Docs
API SwaggerWidget PlaygroundAppWebsite
  • 👋Welcome to Rango
  • 🏠Introduction
  • 💁How It Works
  • ✅Integrations
  • ⚖️Rango vs. Competitors
  • 🔐Security
  • 🛣️Roadmap
  • 🦎Tokenomics
  • 💰Airdrop
  • ❓FAQ
  • 🐞Bug Bounty
  • API Integration
    • 🔡Terminology
    • 🚄API Key & Rate Limits
    • 🤝Choosing the Right API
    • 🦄Basic API - Single Step
      • 🛝API Flow
      • ⚙️API Reference
        • Get Blockchains & Tokens
        • Get Quote
        • Create Transaction (Swap)
        • Check Transaction Status
        • Check Approve Transaction Status
        • Get Address Assets & Balances
        • Get Token Balance
        • Report Transaction Failure
        • Get Direct Tokens
        • Get Custom Token
        • Message Passing
      • 🎓Tutorial
        • 🍰SDK Example
      • 💰Monetization
      • 🎹Sample Transactions
      • ✅Integration Checklist
    • 🦎Main API - Multi Step
      • 🛝API Flow
      • ⚙️API Reference
        • Get Blockchains & Tokens
        • Get Best Route
        • Get All Possible Routes
        • Confirm Route
        • Create Transaction
        • Check Transaction Status
        • Check Approve Transaction Status
        • Report Transaction Failure
        • Get Custom Token
        • Get Address Token Balance
      • 🎓Tutorial
        • 🍰SDK Example
      • 💰Monetization
      • 🎹Sample Transactions
  • ℹ️API Troubleshooting
  • Technical Docs
    • 🍔Swap Aggregation
    • 💰Monetization
    • ⛽Fee Structure
    • ⛽Network Fees and Gas Estimates
    • ⌛Stuck Transactions
  • Widget Integration
    • 🧩Overview
    • 🎇Quick Start
    • ⚙️Customization
    • 💰Monetization
    • 🛣️React Router
    • 🎵Events
    • 💳External Wallets
  • Smart Contracts
    • 👩‍💼Architecture
    • 🔎Audit Reports
    • 🏗️Deployment Addresses
    • 📩Message Passing
  • Ask for Integration
    • 🙋‍♂️DEXs & DEX Aggregators
    • 📱Rango Mobile SDK
  • Useful Links
    • Twitter
    • Discord Server
    • TG Announcements
    • TG Group
  • Terms of Use
  • Privacy policy
Powered by GitBook
On this page
  • Custom Token API
  • Custom Token Request
  • Custom Token Response

Was this helpful?

  1. API Integration
  2. Basic API - Single Step
  3. API Reference

Get Custom Token

Get metadata of a custom token

PreviousGet Direct TokensNextMessage Passing

Last updated 9 months ago

Was this helpful?

Custom Token API

Provides token details for a user-specified token that is not included in Rango's official list. Currently supports blockchains based on Solana and EVM.

const tokenResponse = await rango.token({
    "blockchain": "SOLANA", 
    "address": "3yoMkf3X6bDxjks6YaWwNk4SAbuaysLg1a4BjQKToQAA"
})
const response = await axios.get('https://api.rango.exchange/basic/meta/custom-token', {
  params: {
    'blockchain': 'SOLANA',
    'address': '3yoMkf3X6bDxjks6YaWwNk4SAbuaysLg1a4BjQKToQAA',
    'apiKey': 'c6381a79-2817-4602-83bf-6a641a409e32'
  }
});
curl --request GET \
     --url 'https://api.rango.exchange/basic/meta/custom-token?blockchain=SOLANA&address=3yoMkf3X6bDxjks6YaWwNk4SAbuaysLg1a4BjQKToQAA&apiKey=c6381a79-2817-4602-83bf-6a641a409e32'

Custom Token Request

  • blockchain* String

    • Description: The blockchain which the token belongs to.

    • Example: SOLANA

  • address* String

    • Description: Smart contract address of the token.

    • Example: 3yoMkf3X6bDxjks6YaWwNk4SAbuaysLg1a4BjQKToQAA

export type CustomTokenRequest = {
  blockchain: string
  address: string
}

Custom Token Response

  • token

    • Description: The token's metadata

  • error

    • Description: Error message if there was any problem

  • errorCode

    • Description: Error code if there was any problem

  • traceId

    • Description: Trace id help Rango support to resolve the issue

export type CustomTokenResponse = {
  token: Token
  error: string | null
  errorCode: number | null
  traceId: number | null
}

export type Token = {
  blockchain: string
  chainId: string | null
  address: string | null
  symbol: string
  name: string | null
  decimals: number
  image: string
  blockchainImage: string
  usdPrice: number | null
  isPopular: boolean
  supportedSwappers: string[]
}
{
  "token": {
    "blockchain": "SOLANA",
    "symbol": "Brett",
    "name": "Brett",
    "isPopular": false,
    "chainId": "mainnet-beta",
    "address": "3yoMkf3X6bDxjks6YaWwNk4SAbuaysLg1a4BjQKToQAA",
    "decimals": 9,
    "image": "https://bafkreifi5rkzrqyze3cqoqt5xm6ullqpyh5g52ut46pmwva6cju2yyy3ay.ipfs.nftstorage.link",
    "blockchainImage": "https://raw.githubusercontent.com/rango-exchange/assets/main/blockchains/SOLANA/icon.svg",
    "usdPrice": 0.09683140474717515,
    "supportedSwappers": []
  },
  "error": null,
  "errorCode": null,
  "traceId": null
}

🦄
⚙️
Custom tokenrango-exchange
Custom Token Swagger
Logo