Reference

Types

All types returned by the Superbridge API

All types returned by the Superbridge API, generated from the OpenAPI spec.

Chain

Returned by the /v1/chains endpoint.

idstring

Native chain ID (e.g. 1 for Ethereum)

keysstring[]

Shorthand chain identifier (e.g. eth for Ethereum)

uidstring

Chain UUID (internal identifier)

blockExplorersBlockExplorer[]

logoUristring | null

vm"evm" | "svm" | "stark"

type"mainnet" | "testnet" | "devnet"

namestring

rpcUrlstring

testnetboolean

Token

Returned by the /v1/tokens endpoint.

addressstring

0x0000000000000000000000000000000000000000 for native tokens

chainUidstring

Chain UUID (internal identifier)

chainIdstring

Native chain ID (e.g. 1 for Ethereum)

chainKeysstring[]

Shorthand chain identifier (e.g. eth for Ethereum)

namestring

decimalsnumber

logoUristring | null

symbolstring

usdnumber | null

isSpl2022boolean

verifiedboolean

RouteResult

A single provider's response to a route request. Contains either a quote or an error.

resultQuoteDto5GenericQuoteErrorDtoAmountTooLargeQuoteErrorDtoAmountTooSmallQuoteErrorDtoPausedQuoteErrorDtoDisabledQuoteErrorDtoPriceImpactTooHighQuoteErrorDtoEscapeHatchNotSupportedQuoteErrorDtoERC777MintToSmartContractQuoteErrorDto

providerRouteProviderDto

RouteQuote

A successful quote from a provider.

Initiating Transactions

Pre-built transactions to be signed and submitted. The shape varies by VM type.

EVM

type"evm"

chainUidstring

Chain UUID (internal identifier)

chainIdstring

Native chain ID (e.g. 1 for Ethereum)

chainKeysstring[]

Shorthand chain identifier (e.g. eth for Ethereum)

datastring

Hex

tostring

valuestring

EVM Gasless

type"evm-gasless"

chainUidstring

Chain UUID (internal identifier)

chainIdstring

Native chain ID (e.g. 1 for Ethereum)

chainKeysstring[]

Shorthand chain identifier (e.g. eth for Ethereum)

typedDatastring

SVM

type"svm"

datastring

Base64

chainUidstring

chainIdstring

chainKeysstring[]

Starknet

type"starknet"

chainUidstring

chainIdstring

chainKeysstring[]

callsStarkCallDto[]

TokenApproval

An ERC-20 approval required before bridging. See Approvals.

contractAddressstring

The contract that needs the approval

tokenAddressstring

amountstring

txInitiatingTransactionEvmDto5

RouteFeeItem

A single fee line item.

namestring

amountstring

tokenToken

exclusiveboolean

bpsnumber

Activity

An activity item returned by the /v1/activity endpoint.

fromChainUidstring

Chain UUID (internal identifier)

fromChainIdstring

Native chain ID (e.g. 1 for Ethereum)

fromChainKeysstring[]

Shorthand chain identifier (e.g. eth for Ethereum)

toChainUidstring

Chain UUID (internal identifier)

toChainIdstring

Native chain ID (e.g. 1 for Ethereum)

toChainKeysstring[]

Shorthand chain identifier (e.g. eth for Ethereum)

stepsTransactionStepDoneDtoTransactionStepNotReadyDtoTransactionStepReadyDtoTransactionStepAutoDtoWaitStepDoneDtoWaitStepInProgressDtoWaitStepNotStartedDtoInfoStepDto[]

providerRouteProviderDto

idstring

fromstring

tostring

amountstring

receiveAmountstring

feesActivityFee[]

fromTokenToken

toTokenToken

refuelAmountstring | null

refuelPriceUsdnumber | null

referrerstring | null

nextCheckTimestampnumber | null

escapeHatchboolean

providerExplorerDetailsProviderExplorerDetails | null

ActivityFee

namestring

amountstring

tokenToken

TransactionStepDone

A completed transaction step.

type"transaction"

chainUidstring

Chain UUID (internal identifier)

chainIdstring

Native chain ID (e.g. 1 for Ethereum)

chainKeysstring[]

Shorthand chain identifier (e.g. eth for Ethereum)

actionRouteAction

transactionType"done"

confirmationConfirmationDtoV2

gasTokenToken

gasCoststring | null

TransactionStepReady

A transaction step that is ready to be signed.

type"transaction"

chainUidstring

Chain UUID (internal identifier)

chainIdstring

Native chain ID (e.g. 1 for Ethereum)

chainKeysstring[]

Shorthand chain identifier (e.g. eth for Ethereum)

actionRouteAction

transactionType"ready"

TransactionStepNotReady

A transaction step that is not yet available.

type"transaction"

chainUidstring

Chain UUID (internal identifier)

chainIdstring

Native chain ID (e.g. 1 for Ethereum)

chainKeysstring[]

Shorthand chain identifier (e.g. eth for Ethereum)

actionRouteAction

transactionType"not-ready"

estimatedGasEvmGasEstimateDto | SvmGasEstimateDto

TransactionStepAuto

A transaction step handled automatically (e.g. by a relayer).

type"transaction"

chainUidstring

Chain UUID (internal identifier)

chainIdstring

Native chain ID (e.g. 1 for Ethereum)

chainKeysstring[]

Shorthand chain identifier (e.g. eth for Ethereum)

actionRouteAction

transactionType"auto"

WaitStepDone

A completed wait step.

type"wait"

waitType"done"

actualDurationnumber

expectedDurationnumber

WaitStepInProgress

A wait step currently in progress.

type"wait"

waitType"in-progress"

startedAtnumber

labelstring

expectedDurationnumber

WaitStepNotStarted

A wait step that has not started yet.

type"wait"

waitType"not-started"

expectedDurationnumber

InfoStep

An informational step with optional link.

type"info"

textstring

linkstring

Confirmation

Transaction confirmation details.

timestampnumber

transactionHashstring

status"confirmed" | "reverted" | "dropped"

BlockExplorer

urlstring

family"etherscan""blockscout""routescan""starkscan""other"

EvmGasEstimate

gasLimitnumber

SvmGasEstimate

computeUnitLimitnumber

pricenumber

signaturesnumber

RouteProviderInfo

Display information for a route provider.

idRouteProvider

Unique identifier for the provider

iconstring

URL to the provider icon

namestring

Display name of the provider