Class Conversions

Convert between stablecoins/crypto assets (scope: convert:write).

Index

Constructors

Methods

execute list quote

Constructors

constructor

new Conversions(c: Requester): Conversions
Parameters
- c: Requester
Returns Conversions
- Defined in src/resources/conversions.ts:51

Methods

execute

execute(
params: { buy: Money; quoteId: string; sell: Money },
opts?: IdempotencyOptions,
): Promise<ConvertOrder>
Execute a conversion against a quote you already obtained from Conversions.quote.
Parameters
- params: { buy: Money; quoteId: string; sell: Money }
  Execution inputs.
  - buy: Money
    The exact buy Money from the quote (buyAmount + buyCurrency).
  - quoteId: string
    The quoteId from the quote. Required, and must not have expired.
  - sell: Money
    The exact sell Money from the quote (sellAmount + sellCurrency).
- opts: IdempotencyOptions = {}
  Optional { idempotencyKey } — retrying with the same key + body replays the original.
Returns Promise<ConvertOrder>
The resulting ConvertOrder.
Throws
On failure (e.g. 409/422 expired or mismatched quote, 401/403 auth).
Example
```
const q = await client.conversions.quote({ sellCurrency: "USDT", buyCurrency: "USDC", sellAmount: "100.00" });
const order = await client.conversions.execute(
  { quoteId: q.quoteId, sell: { amount: q.sellAmount, currency: q.sellCurrency }, buy: { amount: q.buyAmount, currency: q.buyCurrency } },
  { idempotencyKey: crypto.randomUUID() },
);
```
- Defined in src/resources/conversions.ts:81

list

list(query?: LedgerQuery): Promise<LedgerPage>
List the settled CONVERT ledger history (scope: convert:read). Keyset-paginated.
Parameters
- query: LedgerQuery = {}
  Time window + asset filter + pagination; see LedgerQuery.
Returns Promise<LedgerPage>
The raw { items, total, nextCursor } — a LedgerPage.

Throws
On failure (e.g. 401/403 auth).
- Defined in src/resources/conversions.ts:91

quote

quote(params: QuoteParams): Promise<ConvertQuote>
Get a firm, short-lived conversion quote. No funds move.
Parameters
- params: QuoteParams
  What to convert; see QuoteParams (specify exactly one of sellAmount/buyAmount).
Returns Promise<ConvertQuote>
A ConvertQuote with a quoteId, locked rate, and both exact amounts.

Throws
On failure (e.g. 401/403 missing convert:write, 422 unsupported pair).
- Defined in src/resources/conversions.ts:59