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.
AxAuthenticateResponse: Response payload returned by POST /authenticate.
AxBalance: Individual balance entry.
AxBalancesResponse: Response payload returned by GET /balances.
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.
AxEstimatedFundingRate: Live funding estimate carried by a ticker.
AxFill: Individual fill/trade entry.
AxFillsResponse: Response payload returned by GET /fills.
AxFundingException: Funding schedule override for a date in the schedule’s timezone.
AxFundingRate: Individual funding rate entry.
AxFundingRatesResponse: Response payload returned by GET /funding-rates.
AxFundingSchedule: Machine-readable funding schedule.
AxFundingSlot: One funding slot of a trading day, as returned by GET /funding-slots.
AxFundingSlotsResponse: Response payload returned by GET /funding-slots.
AxFundingTime: Recurring funding time with ISO weekday numbers in [1, 7].
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.
AxReplaceOrderResponse: Response payload returned by POST /replace-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.
AxTickerResponse: Response payload returned by GET /ticker.
AxTickersResponse: Response payload returned by GET /tickers.
AxTimeOfDay: Time of day in the containing schedule’s timezone.
AxTradesResponse: Response payload returned by GET /trades.
AxTradingSchedule: Machine-readable trading schedule.
AxTradingSegment: Trading session segment with ISO weekday numbers in [1, 7].
AxTransaction: Individual transaction entry.
AxTransactionsResponse: Response payload returned by GET /transactions.
AxWhoAmI: Response payload returned by GET /whoami.
AxWhoAmIAccount: An account entry within a AxWhoAmI response.
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.
ReplaceOrderRequest: Request body for POST /replace-order.

Enums§

AxEstimatedFundingStatus: Availability of a live funding estimate.
AxOrderRejectReason: Reason for order rejection from the exchange.
AxRepriceBehavior: Post-only repricing behavior from the latest place or replace request.

Module models

Module models Copy item path

Structs§

Enums§

Module models