Skip to main content

Token

networkstring
addressstring

In the network's own address form.

symbolstring
namestring
decimalsinteger
tokenIdstringnullable

How a Bitcoin request names the token.

iconstringnullable
isNativeboolean
hiddenboolean
sortOrderintegernullable

Lower first, across networks. Tokens on the home network are ordered apart from the rest.

priceCoinSlugstringnullable
statusstring

Possible values: [Active, Inactive]

wrapRoute objectnullable

BTC → this token. A token on an intermediary network carries only status.

statusstring

Inactive closes this direction, whatever intermediaryChains say.

Possible values: [Active, Inactive]

appIdinteger
acrossSupportedboolean
intermediaryChains object

Keyed by intermediary network name.

property name* WrapRouteIntermediaryChain
statusstring

Possible values: [Active, Inactive]

intermediaryTokenOnIntermediaryChainstring
intermediaryTokenOnIntermediaryChainDecimalsinteger
pathFromTeleBTCToIntermediarystring[]

The swap on the intermediary network, TeleBTC first.

pathFromIntermediaryToOutputTokenstring[]

The swap on the token's network; empty when the token arrives 1:1.

isUniversalboolean

true when the token is reached by a swap on its own network.

pathFromTeleBTCToIntermediaryFeeTiersinteger[]

The pool fee of each hop of pathFromTeleBTCToIntermediary, in millionths.

unwrapRoute objectnullable

This token → BTC. A token on an intermediary network carries only status.

statusstring

Inactive closes this direction, whatever intermediaryChains say.

Possible values: [Active, Inactive]

directDepositboolean

true when the unwrap is a deposit into the network's Across SpokePool.

intermediaryChains object

Keyed by intermediary network name.

property name* UnwrapRouteIntermediaryChain
statusstring

Possible values: [Active, Inactive]

intermediaryTokenOnIntermediaryChainstring
intermediaryTokenOnIntermediaryChainDecimalsinteger
Token
{
"network": "string",
"address": "string",
"symbol": "string",
"name": "string",
"decimals": 0,
"tokenId": "string",
"icon": "string",
"isNative": true,
"hidden": true,
"sortOrder": 0,
"priceCoinSlug": "string",
"status": "Active",
"wrapRoute": {
"status": "Active",
"appId": 0,
"acrossSupported": true,
"intermediaryChains": {}
},
"unwrapRoute": {
"status": "Active",
"directDeposit": true,
"intermediaryChains": {}
}
}