Sign in
Swaps

Retrieve Swap

Retrieves a single swap and its status.

get/swaps/{id}

Path parameters

idstring required

Swap ID returned from POST /swaps.

Response

swap status retrieved

account_idstring required

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

errorstring nullable

Latest error returned for a failed swap.

idstring required

Swap ID.

object'swap' required
status'queued' | 'working' | 'complete' | 'failed' required

Current swap status. complete and failed are terminal.

tx_hashesstring[] required

On-chain transaction hashes produced by the swap.

user_idstring nullable required

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

Example response

{
  "account_id": "biz_xxxxxxxxxxxxxx",
  "error": "Swap reverted: quoted price moved beyond the slippage tolerance",
  "id": "vault-swap-cwal_xxxxxxxxxxxxxx",
  "object": "swap",
  "status": "failed",
  "tx_hashes": [
    "0xabc"
  ]
}

Changes