Skip to main content

Module models

Module models 

Source
Expand description

Data transfer objects for deserializing Ax HTTP API payloads.

Structs§

AuthenticateApiKeyRequest
Request body for POST /authenticate using API key and secret.
AuthenticateUserRequest
Request body for POST /authenticate using username and password.
AxAuthenticateResponse
Response payload returned by POST /authenticate.
AxBalance
Individual balance entry.
AxBalancesResponse
Response payload returned by GET /balances.
AxBatchCancelOrdersResponse
Response payload returned by batch cancel orders.
AxBook
Order book snapshot.
AxBookLevel
Individual price level in the order book.
AxBookResponse
Response payload returned by GET /book.
AxCancelAllOrdersResponse
Response payload returned by POST /cancel_all_orders.
AxCancelOrderResponse
Response payload returned by POST /cancel_order.
AxCandle
Individual candle/OHLCV entry.
AxCandleResponse
Response payload returned by GET /candles/current and GET /candles/last.
AxCandlesResponse
Response payload returned by GET /candles.
AxFill
Individual fill/trade entry.
AxFillsResponse
Response payload returned by GET /fills.
AxFundingRate
Individual funding rate entry.
AxFundingRatesResponse
Response payload returned by GET /funding-rates.
AxInitialMarginRequirementResponse
Response payload returned by POST /initial-margin-requirement.
AxInstrument
Individual instrument definition.
AxInstrumentsResponse
Response payload returned by GET /instruments.
AxOpenOrder
Individual open order entry.
AxOpenOrdersResponse
Response payload returned by GET /open_orders.
AxOrderDetail
Detailed order entry from historical orders query.
AxOrderStatusDetail
Detailed order status from single-order lookup.
AxOrderStatusQueryResponse
Response payload returned by GET /order-status.
AxOrdersResponse
Response payload returned by GET /orders.
AxPerSymbolRisk
Per-symbol risk metrics.
AxPlaceOrderResponse
Response payload returned by POST /place_order.
AxPosition
Individual position entry.
AxPositionsResponse
Response payload returned by GET /positions.
AxPreviewAggressiveLimitOrderResponse
Response payload returned by POST /preview-aggressive-limit-order.
AxRestTrade
Individual trade entry from the REST API.
AxRiskSnapshot
Risk snapshot data.
AxRiskSnapshotResponse
Response payload returned by GET /risk-snapshot.
AxTicker
Individual ticker entry.
AxTickersResponse
Response payload returned by GET /tickers.
AxTradesResponse
Response payload returned by GET /trades.
AxTransaction
Individual transaction entry.
AxTransactionsResponse
Response payload returned by GET /transactions.
AxWhoAmI
Response payload returned by GET /whoami.
BatchCancelOrdersRequest
Request body for batch cancel orders.
CancelAllOrdersRequest
Request body for POST /cancel_all_orders.
CancelOrderRequest
Request body for POST /cancel_order.
PlaceOrderRequest
Request body for POST /place_order.
PreviewAggressiveLimitOrderRequest
Request body for POST /preview-aggressive-limit-order.

Enums§

AxOrderRejectReason
Reason for order rejection from the exchange.