Skip to main content
POST
Cancel Trade

Yetkilendirmeler

Authorization
string
header
gerekli

An Account API key, an account access token, an account-scoped user token, or a user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.

Scopes

crypto_wallet:trade
crypto_wallet:manage

Başlıklar

Idempotency-Key
string

A unique key that makes this request safe to retry. See Idempotent requests.

Maximum string length: 255
Örnek:

"d9105228-4a08-46b1-8b91-42fed586d383"

Api-Version-Date
string

Pins the request to a dated API version.

Örnek:

"2026-11-17"

Yol Parametreleri

id
string
gerekli

Trade ID, prefixed tint_.

Yanıt

cancel sent

account_id
string | null
gerekli

The account that owns the trading wallet, prefixed biz_. null when a user owns it.

Örnek:

"biz_xxxxxxxxxxxxxx"

amount
string | null
gerekli

The USDT0 that a deposit, a spot buy, or a perpetual order short of trading balance, sends from the wallet, or the USDC that a withdraw sends back, in native units, as a decimal string. A withdraw of all shows what it sent once it finishes. null otherwise.

Örnek:

"25"

average_price
string | null
gerekli

The average fill price of the order, in USD, as a decimal string. For spot, the price the swap was quoted at. null when it is not known.

Örnek:

null

client_order_id
string | null
gerekli

The caller's own ID for the trade, unique for the account. null when none was sent.

Örnek:

null

completed_at
string | null
gerekli

When the trade ended as completed or failed, as an ISO 8601 timestamp. null before that.

Örnek:

null

created_at
string
gerekli

When the trade was created, as an ISO 8601 timestamp.

Örnek:

"2026-01-01T12:00:00.000Z"

external_order_id
string | null
gerekli

ID Whop sends to the exchange with this trade's order, so the exchange's order updates can be matched to the trade. On Hyperliquid, the order's cloid reported in orderUpdates, a 0x-prefixed 32-character hex string. Not the caller's client_order_id. null for a deposit or withdraw.

Örnek:

"0x63cabad10f072c65ad84526e0c33081b"

failure_code
enum<string> | null
gerekli

Why the trade failed, or null.

Mevcut seçenekler:
market_unavailable,
leverage_too_high,
amount_too_small,
isolated_position_open,
trading_paused,
funding_failed,
margin_unavailable,
builder_fee_unapproved,
leverage_rejected,
leverage_unconfirmed,
order_rejected,
close_rejected,
return_failed,
withdraw_failed,
null
Örnek:

"market_unavailable"

filled_size
string | null
gerekli

The size the order filled, in units of the market, as a decimal string. For a spot buy, the amount the swap was quoted to deliver. null until it fills.

Örnek:

null

funds_location
enum<string> | null
gerekli

Where the money is when the trade did not complete as asked: wallet, trading_account, or unknown while a person checks it. null otherwise.

Mevcut seçenekler:
wallet,
trading_account,
unknown,
null
Örnek:

"wallet"

id
string
gerekli

Trade ID, prefixed tint_.

Örnek:

"tint_xxxxxxxxxxxxxx"

instrument_type
enum<string> | null
gerekli

perpetual or spot for an order, perpetual for a close. null for a deposit or withdraw.

Mevcut seçenekler:
perpetual,
spot,
null
Örnek:

"perpetual"

leverage
integer | null
gerekli

The cross leverage set before an opening perpetual order. null for a spot order, close, deposit, withdraw or reduce-only order.

Örnek:

10

market
string | null
gerekli

The market, for example BTC for a perpetual or XAUT for spot. null for a deposit or withdraw.

Örnek:

"BTC"

metadata
object
gerekli

Free-form string-to-string annotations stored on the trade.

Örnek:
object
enum<string>
gerekli
Mevcut seçenekler:
trade
Örnek:

"trade"

order_type
enum<string> | null
gerekli

market, limit, take_profit or stop_loss for an order. null otherwise.

Mevcut seçenekler:
market,
limit,
take_profit,
stop_loss,
null
Örnek:

"market"

parent_id
string | null
gerekli

For a take-profit or stop-loss sent with an order, that order's trade, prefixed tint_. null otherwise.

Örnek:

null

price
object | null
gerekli

The limit price of the order in USD. A market order's price is the mid price moved by slippage_bps; a take-profit or stop-loss's is the worst price its market order may fill at once triggered. null for other types.

reduce_only
boolean | null
gerekli

Whether the order can only reduce a position. null for other types.

Örnek:

null

side
enum<string> | null
gerekli

buy or sell for an order. null otherwise.

Mevcut seçenekler:
buy,
sell,
null
Örnek:

"buy"

size
string | null
gerekli

The order size in units of the market, as a decimal string. null for other types.

Örnek:

null

status
enum<string>
gerekli

pending until the trade starts. processing while it runs, also while an order that did not fill sends the money it bridged in back to the wallet. completed when it did what was asked. failed when it did not; funds_location says where the money is. in_review when the outcome is unknown and a person checks it.

Mevcut seçenekler:
pending,
processing,
in_review,
completed,
failed
Örnek:

"pending"

status_detail
enum<string> | null
gerekli

partial_fill when the order filled only part of its size. null otherwise.

Mevcut seçenekler:
partial_fill,
null
Örnek:

"partial_fill"

step
enum<string> | null
gerekli

What a live trade is doing now: depositing while the wallet's USDT0 is being sent to the bridge, landing once sent and until it reaches the trading balance, placing while the order or close is with the venue, withdrawing while USDC heads back to the wallet, returning while money an unfilled order bridged in goes back. A spot order is quoting while the swap is priced, swapping while it runs onchain, and crediting until the new balance shows in the wallet. null once the trade is no longer pending or processing.

Mevcut seçenekler:
depositing,
landing,
placing,
withdrawing,
returning,
quoting,
swapping,
crediting,
null
Örnek:

"placing"

trigger_price
object | null
gerekli

The price in USD at which a take-profit or stop-loss sends its market order. null for other orders and types.

type
enum<string>
gerekli

order places one order: a perpetual order trades from the trading balance, a spot order swaps between USDT0 and the asset in the wallet. deposit bridges USDT0 from the wallet to the trading balance. withdraw sends USDC from the trading balance back to the wallet. close closes the whole position in one market with a market reduce-only order; when the account is then flat, a withdraw trade sends the trading balance back to the wallet.

Mevcut seçenekler:
close,
order,
deposit,
withdraw
Örnek:

"order"

updated_at
string
gerekli

When the trade last changed, as an ISO 8601 timestamp.

Örnek:

"2026-01-01T12:00:00.000Z"

user_id
string | null
gerekli

The user who owns the trading wallet, prefixed user_. null when an account owns it.

Örnek:

null