Skip to main content
GET
TypeScript

Authorizations

Authorization
string
header
required

An Account API key, an App API key, an account access token, an account-scoped user token, or a user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.

Headers

Api-Version-Date
string

Pins the request to a dated API version.

Example:

"2026-10-09-2"

Path Parameters

id
string
required

Swap ID returned from POST /swaps.

Response

swap status retrieved

account_id
string
required

Account that owns the swap: a business ID prefixed biz_, or the user ID for a personal account.

Example:

"biz_xxxxxxxxxxxxxx"

id
string
required

Swap ID.

Example:

"vault-swap-cwal_xxxxxxxxxxxxxx"

object
enum<string>
required
Available options:
swap
Example:

"swap"

status
enum<string>
required

Current swap status. complete and failed are terminal.

Available options:
queued,
working,
complete,
failed
Example:

"failed"

tx_hashes
string[]
required

On-chain transaction hashes produced by the swap.

user_id
string | null
required

User whose personal account owns the swap, prefixed user_. Null for a business account.

Example:

null

error
string | null

Latest error returned for a failed swap.

Example:

"Swap reverted: quoted price moved beyond the slippage tolerance"