Skip to main content
POST

Authorizations

x-auth-token
string
header
required

The API token for login provided by UQPAY.

Headers

x-idempotency-key
string<uuid>
required

A unique identifier used to maintain operation idempotency. Use the same key and request body when retrying an operation, and a new key for a new operation.

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Body

application/json
asset_id
string<uuid>
required

Asset identifier returned by List assets.

Example:

"7453f146-b267-11f1-b4f4-0abd773ba497"

side
enum<string>
required
Available options:
BUY
Example:

"BUY"

funding_currency
enum<string>
required

Currency used to fund the trade.

Available options:
USDC
Example:

"USDC"

cash_amount
string
required

Positive funding amount before fees. Do not include quantity.

Pattern: ^[0-9]{1,18}(\.[0-9]{1,6})?$
Example:

"1"

Response

Success

quote_id
string<uuid>
required

Quote identifier to submit when creating an order.

Example:

"0576b03b-56dd-48b1-ba24-058ce90d0f53"

asset_id
string<uuid>
required

Asset identifier used across asset, quote, order, and position requests.

Example:

"7453f146-b267-11f1-b4f4-0abd773ba497"

symbol
string
required

Asset symbol.

Example:

"AAPLx"

side
enum<string>
required

Direction of the proposed trade.

Available options:
BUY,
SELL
Example:

"BUY"

network
string
required

Network selected for the quote. The quote request does not choose a network.

Example:

"Ethereum"

funding_currency
enum<string>
required

Funding currency.

Available options:
USDC
Example:

"USDC"

quantity
string | null
required

Quoted asset quantity; null when the quantity is determined during execution.

Pattern: ^-?[0-9]+(\.[0-9]+)?$
Example:

"0.00297066689243735"

price
string | null
required

Quoted price per unit in funding_currency; null when the execution price is not fixed by the quote.

Pattern: ^-?[0-9]+(\.[0-9]+)?$
Example:

"336.624750000000055741"

cash_amount
string | null
required

Trade amount before fees in funding_currency; null when it is determined during execution.

Pattern: ^-?[0-9]+(\.[0-9]+)?$
Example:

"1"

fees
object[] | null
required

Quoted fees. Null means fees are not yet available; it does not mean that no fee will be charged.

total_amount
string | null
required

Buy outlay including fees, or sell proceeds after fees, in funding_currency. Null when the total cannot yet be determined.

Pattern: ^-?[0-9]+(\.[0-9]+)?$
Example:

"1.0005"

created_at
string<date-time>
required

Time the quote was created.

Example:

"2026-09-21T01:33:07.797Z"

expires_at
string<date-time> | null
required

Deadline for accepting the quote. Request a new quote after expiry.

Example:

"2026-09-21T01:34:04.542Z"