Skip to main content

TokenListController_getToTokenList

GET 
/v2/token-lists/to-token-list

TokenListController_getToTokenList

Request​

Query Parameters

    fromChainId stringrequired

    Id of source chain, e.g Optimism = 10

    Example: 10
    toChainId stringrequired

    Id of destination chain, e.g xDAI = 100

    Example: 100
    disableSwapping boolean

    Flag to specify if tokens that need dex swap should be ignored. This option will be ignored if singleTxOnly is marked true.

    includeDexes string[]

    Possible values: [oneinch, zerox, rainbow]

    Specify Dexes that should be included for token support.

    excludeDexes string[]

    Possible values: [oneinch, zerox, rainbow]

    Specify Dexes that should be excluded for token support. This option will be ignored if includeDexes is specified.

    includeBridges string[]

    Possible values: [hop, anyswap, anyswap-router-v4, anyswap-router-v6, polygon-bridge, arbitrum-bridge, hyphen, across, optimism-bridge, celer, refuel-bridge, stargate, connext, cctp, synapse, base-bridge, zora-bridge, zksync-native, symbiosis, gnosis-native-bridge, mantle-native-bridge]

    Specify Bridges that should be included for token support.

    excludeBridges string[]

    Possible values: [hop, anyswap, anyswap-router-v4, anyswap-router-v6, polygon-bridge, arbitrum-bridge, hyphen, across, optimism-bridge, celer, refuel-bridge, stargate, connext, cctp, synapse, base-bridge, zora-bridge, zksync-native, symbiosis, gnosis-native-bridge, mantle-native-bridge]

    Specify Bridges that should be excluded for token support. This option will be ignored if includeBridges is specified.

    singleTxOnly boolean

    To be Marked true if you want the token list that needs only a single transaction from the user to bridge.

    isShortList boolean

    To be Marked true if you want the shorter and more efficient token list.

Header Parameters

    API-KEY string

Responses​

All Supported token by a given route

Schema

    success booleanrequired

    Status of API.

    results

    object[]

    required

  • Array [

    • name string

    Name of token.

    address stringrequired

    Address of token.

    icon string

    URL for icon of token.

    decimals number

    Decimal used for token.

    symbol stringrequired

    Symbol of token.

    chainId stringrequired

    Possible values: [MAINNET_CHAIN_ID, OPTIMISM_CHAIN_ID, BSC_CHAIN_ID, XDAI_CHAIN_ID, POLYGON_CHAIN_ID, FANTOM_CHAIN_ID, ZKSYNC_ERA_CHAIN_ID, POLYGON_ZKEVM_CHAIN_ID, MANTLE_CHAIN_ID, BASE_CHAIN_ID, ARBITRUM_CHAIN_ID, AVAX_CHAIN_ID, LINEA_CHAIN_ID, ZORA_CHAIN_ID, AURORA_CHAIN_ID]

    Chain id of the token

    logoURI string

    URL for icon of token.

    chainAgnosticId string

    Unique Id over all chains

  • ]

Loading...