Swaps

Retrieve Swap

Changed on

Retrieves a swap and its status. Poll it after creating a crypto swap, which finishes in the background.

get/swaps/{id}

Request

  • Base URL: https://api.whop.com/api/v1
  • URL: https://api.whop.com/api/v1/swaps/{id}
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

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

  • 507636677fe9Revision changes
    • info

      the security scope crypto_wallet:swap was added to the endpoint's security scheme bearerAuth

    • info

      the security scope crypto_wallet:manage was removed from the endpoint's security scheme bearerAuth

  • c3b5561c6176Revision changes
    • info

      the security scope crypto_wallet:swap was added to the endpoint's security scheme bearerAuth

    • info

      the security scope crypto_wallet:manage was removed from the endpoint's security scheme bearerAuth