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
  • Affiliate (Referral)
  • Affiliate Ref (Referrer Code)
  • Asset (Token)
  • Blockchain
  • Blockchain Name
  • Blockchain Type (Transaction Type)
  • Swapper
  • Swapper Type
  • Swap Aggregation

Was this helpful?

  1. API Integration

Terminology

Terms and Naming Conventions in Rango Exchange

PreviousBug BountyNextAPI Key & Rate Limits

Last updated 7 months ago

Was this helpful?

In this document, we will briefly review the concepts related to Rango's API or SDK to make on-boarding across different sections of the documentation easier for you.

Affiliate (Referral)

We use the terms affiliate or referral to describe our program available to both individual users and dApps. By joining the program, individuals can refer new users to our platform and earn an affiliate fee for the swap transactions initiated by their referrals. Additionally, dApps can charge users an extra fee per transaction, which will be deducted from the user's input amount. For more detailed information about our affiliate program, please refer to this document.

Affiliate Ref (Referrer Code)

The Affiliate Reference (affiliateRef) or Referrer Code (referrerCode) is an unique key that you could generate on our Affiliate Page in Rango Exchange dApp. If you use this, we will send the affiliate fees to the wallet that created this link.

Asset (Token)

Rango uses the terms asset or token to identify tokens across different blockchains. Currently, Rango supports over 10,000 tokens and also enables the trading of custom tokens on all EVM-based and Solana blockchains.

In Rango, each token is identified by three properties: Blockchain, Symbol, and Address. While the combination of Blockchain and Address is sufficient to identify a unique token in EVM-based blockchains, Rango also supports various other blockchains, such as Cosmos-based ones. To maintain a consistent API across all endpoints, the Symbol property is also included.

Asset Format

When dealing with asset formats, it's crucial to distinguish between native and non-native coins. Below is the format you should use for each type:

1. Native Coins:

  • Format: Blockchain.Symbol or simply use Blockchain

  • Examples:

    • BSC.BNB (or BSC), SOLANA.SOL (or SOLANA), OSMOSIS.OSMO (or OSMOSIS)

This denotes the blockchain on which the native coin operates, followed by the symbol of the coin itself.

2. Non-Native Coins:

  • Format: Blockchain--TokenAddress

  • Other Acceptable Format: Blockchain.Symbol--TokenAddress (This 2nd format is only required for Cosmos tokens and will be deprecated soon.)

  • Examples:

    • BSC--0x55d398326f99059ff775485246999027b3197955

    • BSC.USDT--0x55d398326f99059ff775485246999027b3197955

This format consists of the blockchain and the token's address on the blockchain, which are separated by a double dash (--).

Native Token Address

For native tokens, we do not use addresses like 0xeeeeeeeeeeeeeeeeee... or 0x000000000000000... Instead, we simply use a null address.

Blockchain

Rango facilitates swaps and bridges across various blockchains, including UTXO blockchains, EVM blockchains, Solana, Cosmos-based blockchains, Starknet, Tron, and more. In Rango, the terms "blockchain" or "chain" are typically used to refer to these networks. You could see list of all supported blockchains in Integrations article. You could also dynamically get list of all supported blockchains based on this document.

Blockchain Name

In Rango, each blockchain has a unique identifier name which is used in all related API calls or sdk methods. These are some samples:

Blockchain
Name (ID)

Ethereum

ETH

Arbitrum

ARBITRUM

Avalanche

AVAX_CCHAIN

Scroll

SCROLL

Cosmos

COSMOS

Bitcoin

BTC

You could see list of all blockchain names in Integrations document or get it dynamically using meta or blockchains endpoint.

Blockchain Type (Transaction Type)

Rango distinguishes between various blockchains based on their technical structures and underlying transaction models. Each blockchain and transaction is assigned a property called type. Here are the currently supported blockchain types:

Type
Sample Blockchains

EVM

Ethereum, Polygon, Scroll, ...

TRANSFER

Bitcoin, Litecoin, Doge, ...

COSMOS

Cosmos, Osmosis, Akash, ...

SOLANA

Solana

STARKNET

Starknet

TRON

Tron

TON

Ton

Swapper

Rango supports various protocols for swapping and bridging tokens, including DEXes (e.g., Uniswap, Pancake Swap), Bridges (e.g., Across, Stargate), DEX Aggregators (e.g., 1inch, Paraswap, OpenOcean), and centralized solutions (e.g., XO Swap, SWFT). In our API and related documents, we use the Swapper to refer to all these protocols.

Centralized (off-chain) swappers are disabled by default in the Rango API due to the risk of blocking user tokens because of KYC requirements for risky addresses and the need for additional information like user IP. However, if you wish to enable them, you can do so by passing a flag (enableCentralizedSwappers) to the relevant API calls.

Swapper Type

Each swappers in Rango is at least one of the following types: (usually one of them)

Type
Sample Swappers
Description

DEX

Jupiter, JunoSwap, 1Inch, ...

On-chain DEXes or DEX aggregators

BRIDGE

Synapse Bridge, Satellite, ...

Bridges via chains

AGGREGATOR

CBridge Aggregator, Stargate Aggregator, ThorChain Aggregator, ...

OFF_CHAIN

SWFT, XO Swap

Centralized solutions

Swap Aggregation

Introducing Rango as a DEX and bridge aggregator means it not only routes through various protocols but also aggregates multiple transactions into a single one. For more information about swap aggregation, please refer to this document.

implemented by Rango

🔡
Swap Aggregators
Sample for affiliateRef Code in Rango Exchange App