Struct AxRawHttpClient 

pub struct AxRawHttpClient { /* private fields */ }

Raw HTTP client for low-level AX Exchange API operations.

This client handles request/response operations with the AX Exchange API, returning venue-specific response types. It does not parse to Nautilus domain types.

Implementations

impl AxRawHttpClient

pub fn base_url(&self) -> &str

Returns the base URL for this client.

pub fn api_key_masked(&self) -> String

Returns a masked version of the API key for logging purposes.

pub fn cancel_all_requests(&self)

Cancel all pending HTTP requests.

Panics

Panics if the cancellation token lock is poisoned.

pub fn reset_cancellation_token(&self)

Replaces the cancelled token so new requests can proceed after reconnect.

Panics

Panics if the cancellation token lock is poisoned.

pub fn cancellation_token(&self) -> CancellationToken

Get a clone of the current cancellation token.

Panics

Panics if the cancellation token lock is poisoned.

pub fn new( base_url: Option<String>, orders_base_url: Option<String>, timeout_secs: Option<u64>, max_retries: Option<u32>, retry_delay_ms: Option<u64>, retry_delay_max_ms: Option<u64>, proxy_url: Option<String>, ) -> Result<Self, AxHttpError>

Creates a new AxRawHttpClient using the default Ax HTTP URL.

Errors

Returns an error if the retry manager cannot be created.

pub fn with_credentials( api_key: String, api_secret: String, base_url: Option<String>, orders_base_url: Option<String>, timeout_secs: Option<u64>, max_retries: Option<u32>, retry_delay_ms: Option<u64>, retry_delay_max_ms: Option<u64>, proxy_url: Option<String>, ) -> Result<Self, AxHttpError>

Creates a new AxRawHttpClient configured with credentials.

Errors

Returns an error if the HTTP client cannot be created.

pub fn set_session_token(&self, token: String)

Sets the session token for authenticated requests.

The session token is obtained through the login flow and used for bearer token authentication.

Panics

Panics if the internal lock is poisoned (indicates a panic in another thread).

pub async fn get_whoami(&self) -> Result<AxWhoAmI, AxHttpError>

Fetches the current authenticated user information.

Endpoint

GET /whoami

Errors

Returns an error if the request fails or the response cannot be parsed.

pub async fn get_instruments( &self, ) -> Result<AxInstrumentsResponse, AxHttpError>

Fetches all available instruments.

Endpoint

GET /instruments

Errors

Returns an error if the request fails or the response cannot be parsed.

pub async fn get_balances(&self) -> Result<AxBalancesResponse, AxHttpError>

Fetches all account balances for the authenticated user.

Endpoint

GET /balances

Errors

Returns an error if the request fails or the response cannot be parsed.

pub async fn get_positions(&self) -> Result<AxPositionsResponse, AxHttpError>

Fetches all open positions for the authenticated user.

Endpoint

GET /positions

Errors

Returns an error if the request fails or the response cannot be parsed.

pub async fn get_tickers(&self) -> Result<AxTickersResponse, AxHttpError>

Fetches all tickers.

Endpoint

GET /tickers

Errors

Returns an error if the request fails or the response cannot be parsed.

pub async fn get_ticker(&self, symbol: Ustr) -> Result<AxTicker, AxHttpError>

Fetches a single ticker by symbol.

Endpoint

GET /ticker?symbol=<symbol>

Errors

Returns an error if the request fails or the response cannot be parsed.

pub async fn get_instrument( &self, symbol: Ustr, ) -> Result<AxInstrument, AxHttpError>

Fetches a single instrument by symbol.

Endpoint

GET /instrument?symbol=<symbol>

Errors

Returns an error if the request fails or the response cannot be parsed.

pub async fn authenticate( &self, api_key: &str, api_secret: &str, expiration_seconds: i32, ) -> Result<AxAuthenticateResponse, AxHttpError>

Authenticates using API key and secret to obtain a session token.

Endpoint

POST /authenticate

Errors

Returns an error if the request fails or the response cannot be parsed.

pub async fn authenticate_auto( &self, expiration_seconds: i32, ) -> Result<AxAuthenticateResponse, AxHttpError>

Authenticates using stored credentials or environment variables.

Credential Resolution

Credentials are resolved in the following order:

1. Stored credentials (from with_credentials constructor)
2. Environment variables (AX_API_KEY and AX_API_SECRET)

Errors

Returns an error if:

• No credentials are available from either source
• The HTTP request fails
• The credentials are invalid

pub async fn place_order( &self, request: &PlaceOrderRequest, ) -> Result<AxPlaceOrderResponse, AxHttpError>

Places a new order.

Endpoint

POST /place_order (orders base URL)

Errors

Returns an error if the request fails or the response cannot be parsed.

pub async fn cancel_order( &self, order_id: &str, ) -> Result<AxCancelOrderResponse, AxHttpError>

Cancels an existing order.

Endpoint

POST /cancel_order (orders base URL)

Errors

Returns an error if the request fails or the response cannot be parsed.

pub async fn cancel_all_orders( &self, request: &CancelAllOrdersRequest, ) -> Result<AxCancelAllOrdersResponse, AxHttpError>

Cancels all open orders, optionally filtered by symbol or venue.

Endpoint

POST /cancel_all_orders (orders base URL)

Errors

Returns an error if the request fails or the response cannot be parsed.

pub async fn batch_cancel_orders( &self, request: &BatchCancelOrdersRequest, ) -> Result<AxBatchCancelOrdersResponse, AxHttpError>

Cancels multiple orders by their IDs in a single batch request.

Endpoint

POST /batch_cancel_orders (orders base URL)

Errors

Returns an error if the request fails or the response cannot be parsed.

pub async fn get_open_orders(&self) -> Result<AxOpenOrdersResponse, AxHttpError>

Fetches all open orders.

Endpoint

GET /open_orders (orders base URL)

Errors

Returns an error if the request fails or the response cannot be parsed.

pub async fn get_fills(&self) -> Result<AxFillsResponse, AxHttpError>

Fetches all fills/trades.

Endpoint

GET /fills

Errors

Returns an error if the request fails or the response cannot be parsed.

pub async fn get_candles( &self, symbol: Ustr, start_timestamp_ns: i64, end_timestamp_ns: i64, candle_width: AxCandleWidth, ) -> Result<AxCandlesResponse, AxHttpError>

Fetches historical candles.

Endpoint

GET /candles

Errors

Returns an error if the request fails or the response cannot be parsed.

pub async fn get_current_candle( &self, symbol: Ustr, candle_width: AxCandleWidth, ) -> Result<AxCandle, AxHttpError>

Fetches the current (incomplete) candle.

Endpoint

GET /candles/current

Errors

Returns an error if the request fails or the response cannot be parsed.

pub async fn get_last_candle( &self, symbol: Ustr, candle_width: AxCandleWidth, ) -> Result<AxCandle, AxHttpError>

Fetches the last completed candle.

Endpoint

GET /candles/last

Errors

Returns an error if the request fails or the response cannot be parsed.

pub async fn get_funding_rates( &self, symbol: Ustr, start_timestamp_ns: i64, end_timestamp_ns: i64, ) -> Result<AxFundingRatesResponse, AxHttpError>

Fetches funding rates for a symbol.

Endpoint

GET /funding-rates

Errors

Returns an error if the request fails or the response cannot be parsed.

pub async fn get_risk_snapshot( &self, ) -> Result<AxRiskSnapshotResponse, AxHttpError>

Fetches the current risk snapshot.

Endpoint

GET /risk-snapshot

Errors

Returns an error if the request fails or the response cannot be parsed.

pub async fn preview_aggressive_limit_order( &self, request: &PreviewAggressiveLimitOrderRequest, ) -> Result<AxPreviewAggressiveLimitOrderResponse, AxHttpError>

Previews an aggressive limit order to get the “take through” price.

This endpoint calculates the price needed to sweep the order book for a given quantity, which is used to simulate market orders on AX (which only supports limit orders natively).

Endpoint

POST /preview-aggressive-limit-order

Errors

Returns an error if the request fails or the response cannot be parsed.

pub async fn get_transactions( &self, transaction_types: Vec<String>, ) -> Result<AxTransactionsResponse, AxHttpError>

Fetches transactions filtered by type.

Endpoint

GET /transactions

Errors

Returns an error if the request fails or the response cannot be parsed.

pub async fn get_trades( &self, symbol: Ustr, limit: Option<i32>, ) -> Result<AxTradesResponse, AxHttpError>

Fetches recent trades for a symbol.

Endpoint

GET /trades

Errors

Returns an error if the request fails or the response cannot be parsed.

pub async fn get_book( &self, symbol: Ustr, level: Option<i32>, ) -> Result<AxBookResponse, AxHttpError>

Fetches an order book snapshot for a symbol.

Endpoint

GET /book

Errors

Returns an error if the request fails or the response cannot be parsed.

pub async fn get_order_status_by_id( &self, order_id: &str, ) -> Result<AxOrderStatusQueryResponse, AxHttpError>

Fetches the status of a single order by order ID.

Endpoint

GET /order-status (orders base URL)

Errors

Returns an error if the request fails or the response cannot be parsed.

pub async fn get_order_status_by_cid( &self, client_order_id: u64, ) -> Result<AxOrderStatusQueryResponse, AxHttpError>

Fetches the status of a single order by client order ID.

Endpoint

GET /order-status (orders base URL)

Errors

Returns an error if the request fails or the response cannot be parsed.

pub async fn get_orders( &self, params: &GetOrdersParams, ) -> Result<AxOrdersResponse, AxHttpError>

Fetches historical orders with optional filters.

Endpoint

GET /orders (orders base URL)

Errors

Returns an error if the request fails or the response cannot be parsed.

pub async fn check_initial_margin( &self, request: &PlaceOrderRequest, ) -> Result<AxInitialMarginRequirementResponse, AxHttpError>

Checks the initial margin requirement for a proposed order.

Endpoint

POST /initial-margin-requirement (orders base URL)

Errors

Returns an error if the request fails or the response cannot be parsed.

Trait Implementations

impl Debug for AxRawHttpClient

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for AxRawHttpClient

fn default() -> Self

Returns the “default value” for a type.