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.
stringrequiredNative chain ID (e.g. 1 for Ethereum)
string[]requiredShorthand chain identifier (e.g. eth for Ethereum)
stringrequiredChain UUID (internal identifier)
BlockExplorer[]requiredstring | nullrequired"evm" | "svm" | "stark"required"mainnet" | "testnet" | "devnet"requiredstringrequiredstringrequiredbooleanrequiredToken
Returned by the /v1/tokens endpoint.
stringrequired0x0000000000000000000000000000000000000000 for native tokens
stringrequiredChain UUID (internal identifier)
stringrequiredNative chain ID (e.g. 1 for Ethereum)
string[]requiredShorthand chain identifier (e.g. eth for Ethereum)
stringrequirednumberrequiredstring | nullrequiredstringrequirednumber | nullrequiredbooleanbooleanrequiredRouteResult
A single provider's response to a route request. Contains either a quote or an error.
RouteQuoteDto5GenericRouteErrorDtoAmountTooSmallRouteErrorDtoAmountTooLargeRouteErrorDtoPausedRouteErrorDtoDisabledRouteErrorDtoSlippageExceededRouteErrorDtorequiredRouteProviderDtorequiredRouteQuote
A successful quote from a provider.
InitiatingTransactionEvmDto5InitiatingTransactionEvmGaslessDto5InitiatingTransactionSvmDto5InitiatingTransactionStarkDto5requiredTransactionStepReadyDtoTransactionStepNotReadyDtoTransactionStepAutoDtoWaitStepNotStartedDto[]requiredstringrequiredstringTokenApprovalParamsDto5TokenApprovalParamsDto5TokenApprovalParamsDto5TokenrequiredTokenrequiredRouteFeeItemDto5[]requiredInitiating Transactions
Pre-built transactions to be signed and submitted. The shape varies by VM type.
EVM
"evm""evm-gasless""svm""starknet"requiredstringrequiredChain UUID (internal identifier)
stringrequiredNative chain ID (e.g. 1 for Ethereum)
string[]requiredShorthand chain identifier (e.g. eth for Ethereum)
stringrequiredHex
stringrequiredstringrequiredEVM Gasless
"evm""evm-gasless""svm""starknet"requiredstringrequiredChain UUID (internal identifier)
stringrequiredNative chain ID (e.g. 1 for Ethereum)
string[]requiredShorthand chain identifier (e.g. eth for Ethereum)
stringrequiredSVM
"evm""evm-gasless""svm""starknet"requiredstringrequiredBase64
stringrequiredstringrequiredstring[]requiredStarknet
"evm""evm-gasless""svm""starknet"requiredstringrequiredstringrequiredstring[]requiredstringrequiredstringrequiredTokenApproval
An ERC-20 approval required before bridging. See Approvals.
stringrequiredThe contract that needs the approval
stringrequiredstringrequiredInitiatingTransactionEvmDto5requiredRouteFeeItem
A single fee line item.
RouteProviderDto | RouteFeeItemGroupSuperbridgerequiredstringrequiredstringrequiredTokenrequiredbooleanrequirednumberActivity
An activity item returned by the /v1/activity endpoint.
stringrequiredChain UUID (internal identifier)
stringrequiredNative chain ID (e.g. 1 for Ethereum)
string[]requiredShorthand chain identifier (e.g. eth for Ethereum)
stringrequiredChain UUID (internal identifier)
stringrequiredNative chain ID (e.g. 1 for Ethereum)
string[]requiredShorthand chain identifier (e.g. eth for Ethereum)
TransactionStepDoneDtoTransactionStepNotReadyDtoTransactionStepReadyDtoTransactionStepAutoDtoWaitStepDoneDtoWaitStepInProgressDtoWaitStepNotStartedDtoInfoStepDto[]requiredRouteProviderDtorequiredstringrequiredstringrequiredstringrequiredstringrequiredstringrequiredActivityFee[]requiredTokenrequiredTokenrequiredstring | nullrequirednumber | nullrequiredstring | nullrequirednumber | nullrequiredActivityFee
stringrequiredstringrequiredTokenrequiredTransactionStepDone
A completed transaction step.
"wait" | "transaction" | "info"required"not-ready""ready""done""auto""refunded"requiredstringrequiredChain UUID (internal identifier)
stringrequiredNative chain ID (e.g. 1 for Ethereum)
string[]requiredShorthand chain identifier (e.g. eth for Ethereum)
RouteActionrequiredConfirmationDtoV2requiredTokenstring | nullTransactionStepReady
A transaction step that is ready to be signed.
"wait" | "transaction" | "info"required"not-ready""ready""done""auto""refunded"requiredstringrequiredChain UUID (internal identifier)
stringrequiredNative chain ID (e.g. 1 for Ethereum)
string[]requiredShorthand chain identifier (e.g. eth for Ethereum)
RouteActionrequiredTransactionStepNotReady
A transaction step that is not yet available.
"wait" | "transaction" | "info"required"not-ready""ready""done""auto""refunded"requiredstringrequiredChain UUID (internal identifier)
stringrequiredNative chain ID (e.g. 1 for Ethereum)
string[]requiredShorthand chain identifier (e.g. eth for Ethereum)
RouteActionrequiredEvmGasEstimateDto | SvmGasEstimateDtorequiredTransactionStepAuto
A transaction step handled automatically (e.g. by a relayer).
"wait" | "transaction" | "info"required"not-ready""ready""done""auto""refunded"requiredstringrequiredChain UUID (internal identifier)
stringrequiredNative chain ID (e.g. 1 for Ethereum)
string[]requiredShorthand chain identifier (e.g. eth for Ethereum)
RouteActionrequiredWaitStepDone
A completed wait step.
"wait" | "transaction" | "info"required"not-started" | "in-progress" | "done"requirednumbernumberrequiredWaitStepInProgress
A wait step currently in progress.
"wait" | "transaction" | "info"required"not-started" | "in-progress" | "done"requirednumberrequiredstringrequirednumberrequiredWaitStepNotStarted
A wait step that has not started yet.
"wait" | "transaction" | "info"required"not-started" | "in-progress" | "done"requirednumberrequiredInfoStep
An informational step with optional link.
"wait" | "transaction" | "info"requiredstringrequiredstringConfirmation
Transaction confirmation details.
numberrequiredstringrequired"confirmed" | "reverted" | "dropped"requiredBlockExplorer
stringrequired"etherscan""blockscout""routescan""starkscan""other"requiredEvmGasEstimate
numberrequiredSvmGasEstimate
numberrequirednumberrequirednumberrequiredRouteProviderInfo
Display information for a route provider.
RouteProviderrequiredUnique identifier for the provider
stringrequiredURL to the provider icon
stringrequiredDisplay name of the provider