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"

namestring

rpcUrlstring

Token

Returned by the /v1/tokens and /v1/token endpoints.

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.

resultQuoteDtoGenericQuoteErrorDtoAmountTooLargeQuoteErrorDtoAmountTooSmallQuoteErrorDtoPausedQuoteErrorDtoDisabledQuoteErrorDtoPriceImpactTooHighQuoteErrorDtoEscapeHatchNotSupportedQuoteErrorDtoERC777MintToSmartContractQuoteErrorDto

metaRouteMetaDto

RouteQuote

A successful quote from a provider.

type"bridge" | "crosschainswap" | "swap"

initiatingTransactionInitiatingTransactionEvmDtoInitiatingTransactionEvmGaslessDtoInitiatingTransactionSvmDtoInitiatingTransactionStarkDto

stepsTransactionStepReadyDtoTransactionStepDoneDtoTransactionStepInvalidatedDtoTransactionStepNotReadyDtoTransactionStepAutoDtoWaitStepDoneDtoWaitStepInvalidatedDtoWaitStepInProgressDtoWaitStepNotStartedDtoUpgradeEventDto[]

feesFeeGroup[]

metadatastring

nativeboolean

revokeTokenApprovalTokenApprovalParamsDto

tokenApprovalTokenApprovalParamsDto

gasTokenApprovalTokenApprovalParamsDto

tokenTokenDto

receiveTokenTokenDto

receivestring

minReceivestring

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

fromstring

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

txInitiatingTransactionEvmDto

FeeItem

A single fee line item.

amountstring

tokenTokenDto

usdnumber

namestring

exclusiveboolean

bpsnumber

FeeGroup

A group of fee line items belonging to a provider.

itemsFeeItem[]

providerProviderDto

Activity

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

type"bridge" | "crosschainswap" | "swap"

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)

stepsTransactionStepDoneDtoTransactionStepInvalidatedDtoTransactionStepNotReadyDtoTransactionStepReadyDtoTransactionStepAutoDtoWaitStepDoneDtoWaitStepInvalidatedDtoWaitStepInProgressDtoWaitStepNotStartedDtoUpgradeEventDto[]

feesFeeGroup[]

metaRouteMetaDto

idstring

fromstring

tostring

amountstring

receiveAmountstring

fromTokenTokenDto

toTokenTokenDto

referrerstring | null

nextCheckTimestampnumber | null

escapeHatchboolean

providerExplorerDetailsProviderExplorerDetails | null

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

transactionStatus"done"

confirmationConfirmationDtoV2

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

transactionStatus"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

transactionStatus"not-ready"

estimatedGasEvmNotReadyStepGasEstimateDto | SvmNotReadyStepGasEstimateDto | StarkNotReadyStepGasEstimateDto

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

transactionStatus"auto"

WaitStepDone

A completed wait step.

type"wait"

waitTypeWaitStepType

waitStatus"done"

actualDurationnumber

expectedDurationnumber

WaitStepInProgress

A wait step currently in progress.

type"wait"

waitTypeWaitStepType

waitStatus"in-progress"

startedAtnumber

expectedDurationnumber

WaitStepNotStarted

A wait step that has not started yet.

type"wait"

waitTypeWaitStepType

waitStatus"not-started"

expectedDurationnumber

WaitStepInvalidated

A wait step invalidated by a protocol upgrade event.

type"wait"

waitTypeWaitStepType

waitStatus"invalidated"

actualDurationnumber

invalidatedByUpgradeEventDto

expectedDurationnumber

UpgradeEvent

A protocol upgrade event that can invalidate earlier wait or transaction steps.

type"upgrade-event"

upgradeType"op-upgrade-fault-proofs" | "arb-upgrade-bold"

upgradeSubType"op-upgrade-fault-proofs""op-respected-game-type-change""op-upgrade-13""op-retirement-timestamp-change""arb-bold-upgrade"

chainUidstring

Chain UUID (internal identifier)

chainIdstring

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

chainKeysstring[]

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

timestampnumber

blockNumbernumber

Confirmation

Transaction confirmation details.

timestampnumber

transactionHashstring

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

BlockExplorer

urlstring

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

EvmNotReadyStepGasEstimate

vm"evm"

gasLimitnumber

SvmNotReadyStepGasEstimate

vm"svm"

computeUnitLimitnumber

pricenumber

signaturesnumber

StarkNotReadyStepGasEstimate

vm"stark"

l1GasAmountnumber

l1DataGasAmountnumber

l2GasAmountnumber

l1GasPricestring

l1DataGasPricestring

l2GasPricestring

Provider

Display information for a route provider.

idstring

namestring

iconstring