Skip to main content

Module trade

Module trade 

Source
Expand description

Authenticated trading endpoints (/api/v5/trade/*).

Structsยง

AlgoOrder
Algo-order row returned by list, history, and details endpoints.
AlgoOrderDetailsRequest
Query parameters for GET /api/v5/trade/order-algo.
AlgoOrderHistoryRequest
Query parameters for historical algo orders.
AlgoOrderListRequest
Query parameters shared by pending and historical algo orders.
AlgoOrderRequest
Request body for POST /api/v5/trade/order-algo.
AlgoOrderResult
Result row returned by algo-order mutation endpoints.
AmendAlgoOrderRequest
Request body for POST /api/v5/trade/amend-algos.
AmendOrderRequest
A request to amend an order.
AmendOrderResult
The result of amending an order.
AttachedAlgoOrderRequest
One attached take-profit/stop-loss definition for an algo order.
CancelAlgoOrderRequest
Request body for one entry in POST /api/v5/trade/cancel-algos.
CancelOrderRequest
A request to cancel an order.
CancelOrderResult
The result of cancelling an order.
ClosePositionRequest
A request to close positions.
ClosePositionResult
The result of closing a position.
EasyConvertCurrency
Easy-convert currency row.
EasyConvertFromCurrency
A convertible small balance returned by the easy-convert currency list.
EasyConvertHistory
Easy-convert history row.
EasyConvertHistoryRequest
Query parameters for easy-convert history.
EasyConvertRequest
Request body for POST /api/v5/trade/easy-convert.
EasyConvertResult
Easy-convert execution result row.
Fill
A trade fill.
FillHistory
Historical fill returned by GET /api/v5/trade/fills-history.
FillHistoryRequest
Query parameters for historical fills.
FillsRequest
Query parameters for fills.
GetOrderRequest
Request for get_order.
OneClickRepayAsset
Repayment asset information returned by one-click-repay currency-list endpoints.
OneClickRepayCurrency
One-click-repay currency row (legacy and v2).
OneClickRepayCurrencyListRequest
Query parameters for one-click-repay currency-list endpoints.
OneClickRepayDebt
Debt-side information returned by one-click-repay currency-list endpoints.
OneClickRepayHistory
One-click-repay history row (legacy and v2).
OneClickRepayHistoryRequest
Query parameters for one-click-repay history endpoints.
OneClickRepayOrderInfo
Order generated while fulfilling a v2 one-click repayment.
OneClickRepayRequest
Request body shared by one-click-repay v1 and v2 endpoints.
OneClickRepayResult
One-click-repay execution result row (legacy and v2).
Order
Details of an existing order.
OrderAttachAlgoOrder
An attached SL/TP algo order nested inside an Order (attachAlgoOrds).
OrderHistoryRequest
Query parameters for order history.
OrderLinkedAlgoOrder
A linked algo order nested inside an Order (linkedAlgoOrd).
OrderListRequest
Query parameters for pending order lists.
PlaceOrderRequest
A request to place an order.
PlaceOrderResult
The result of placing an order.
SmartIcebergTriggerRequest
One trigger definition used by a smart_iceberg request.
Trade
Accessor for the authenticated trading endpoints.