Retrieve Swap

Retrieves a single swap and its status.

GET /swaps/{id}

JavaScript

JavaScript

import Whop from '@whop/sdk';

const client = new Whop({
  apiKey: process.env['WHOP_API_KEY'], // This is the default and can be omitted
});

const swap = await client.swaps.retrieve('id');

console.log(swap.id);

200

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

Authorizations

bearerAuthbearerAuth

Authorization · string · header · required

An Account API key, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************.

Path Parameters

id · string · required

Swap ID returned from POST /swaps.

Response

200

application/json

swap status retrieved

account_id · string · required

Account ID that owns the wallet used for the swap.

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.

error · string | null

Latest error returned for a failed swap.

Example:

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