POST
Prepare an account-owned Squid route

Authorizations

Authorization
string
header
required

The authorization field takes the session bearer returned by sign-in, or an API key where the route allows keys. Paste the token itself into the authorization field. When invitation-only access is enabled, private operations require the account's sign-in email to be invited. Sign-in can complete without an invitation, but private HTTP, MCP and FIX operations refuse with access_not_allowlisted (HTTP 403): "Private access is limited to invited accounts. Contact support to request access." Public market data remains available. Invitation changes apply to the next private operation, including existing FIX sessions. Do not retry until support confirms access.

Path Parameters

accountId
string
required
Minimum string length: 1

Body

application/json
fromChain
string
required

Source EVM chain ID. A source without configured transaction verification is unavailable.

Pattern: ^[1-9]\d{0,15}$
fromToken
string
required

Source token contract address, validated against the provider route.

Pattern: ^0x[0-9a-fA-F]{40}$
fromAmount
string
required

Positive uint256 amount in source-token base units.

Pattern: ^[1-9]\d{0,77}$
fromAddress
string
required

The source wallet that signs the transaction and receives source-chain refunds.

Pattern: ^0x[0-9a-fA-F]{40}$
refundAddress
string
required

Must match fromAddress, ignoring case; a separate refund recipient is unsupported.

Pattern: ^0x[0-9a-fA-F]{40}$

Response

Success

state
string
required
Allowed value: "ready"
accountId
string
required
Minimum string length: 1
routeId
string
required
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
quoteId
string
required
Required string length: 1 - 256
expiresAtEpochMs
integer
required
fromChainId
string
required
Pattern: ^[1-9]\d{0,15}$
toChainId
string
required
Allowed value: "1"
fromToken
string
required
Pattern: ^0x[0-9a-fA-F]{40}$
fromAmount
string
required
Pattern: ^[1-9]\d{0,77}$
fromAddress
string
required
Pattern: ^0x[0-9a-fA-F]{40}$
transactionRequest
object
required