Expand description
Data transfer objects for deserializing Ax HTTP API payloads.
Structs§
- Authenticate
ApiKey Request - Request body for
POST /authenticateusing API key and secret. - Authenticate
User Request - Request body for
POST /authenticateusing username and password. - AxAuthenticate
Response - Response payload returned by
POST /authenticate. - AxBalance
- Individual balance entry.
- AxBalances
Response - Response payload returned by
GET /balances. - AxBatch
Cancel Orders Response - Response payload returned by batch cancel orders.
- AxBook
- Order book snapshot.
- AxBook
Level - Individual price level in the order book.
- AxBook
Response - Response payload returned by
GET /book. - AxCancel
AllOrders Response - Response payload returned by
POST /cancel_all_orders. - AxCancel
Order Response - Response payload returned by
POST /cancel_order. - AxCandle
- Individual candle/OHLCV entry.
- AxCandle
Response - Response payload returned by
GET /candles/currentandGET /candles/last. - AxCandles
Response - Response payload returned by
GET /candles. - AxFill
- Individual fill/trade entry.
- AxFills
Response - Response payload returned by
GET /fills. - AxFunding
Rate - Individual funding rate entry.
- AxFunding
Rates Response - Response payload returned by
GET /funding-rates. - AxInitial
Margin Requirement Response - Response payload returned by
POST /initial-margin-requirement. - AxInstrument
- Individual instrument definition.
- AxInstruments
Response - Response payload returned by
GET /instruments. - AxOpen
Order - Individual open order entry.
- AxOpen
Orders Response - Response payload returned by
GET /open_orders. - AxOrder
Detail - Detailed order entry from historical orders query.
- AxOrder
Status Detail - Detailed order status from single-order lookup.
- AxOrder
Status Query Response - Response payload returned by
GET /order-status. - AxOrders
Response - Response payload returned by
GET /orders. - AxPer
Symbol Risk - Per-symbol risk metrics.
- AxPlace
Order Response - Response payload returned by
POST /place_order. - AxPosition
- Individual position entry.
- AxPositions
Response - Response payload returned by
GET /positions. - AxPreview
Aggressive Limit Order Response - Response payload returned by
POST /preview-aggressive-limit-order. - AxRest
Trade - Individual trade entry from the REST API.
- AxRisk
Snapshot - Risk snapshot data.
- AxRisk
Snapshot Response - Response payload returned by
GET /risk-snapshot. - AxTicker
- Individual ticker entry.
- AxTickers
Response - Response payload returned by
GET /tickers. - AxTrades
Response - Response payload returned by
GET /trades. - AxTransaction
- Individual transaction entry.
- AxTransactions
Response - Response payload returned by
GET /transactions. - AxWho
AmI - Response payload returned by
GET /whoami. - Batch
Cancel Orders Request - Request body for batch cancel orders.
- Cancel
AllOrders Request - Request body for
POST /cancel_all_orders. - Cancel
Order Request - Request body for
POST /cancel_order. - Place
Order Request - Request body for
POST /place_order. - Preview
Aggressive Limit Order Request - Request body for
POST /preview-aggressive-limit-order.
Enums§
- AxOrder
Reject Reason - Reason for order rejection from the exchange.