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. - 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. - AxInstrument
- Individual instrument definition.
- AxInstruments
Response - Response payload returned by
GET /instruments. - AxOpen
Order - Individual open order entry.
- 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. - 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. - AxTransaction
- Individual transaction entry.
- AxTransactions
Response - Response payload returned by
GET /transactions. - AxWho
AmI - Response payload returned by
GET /whoami. - Cancel
Order Request - Request body for
POST /cancel_order. - Place
Order Request - Request body for
POST /place_order.
Type Aliases§
- AxOpen
Orders Response - Response payload returned by
GET /open_orders.