Struct AxHttpClient 

pub struct AxHttpClient { /* private fields */ }

High-level HTTP client for the Ax REST API.

This client wraps the underlying AxRawHttpClient to provide a convenient interface for Python bindings and instrument caching.

Implementations

impl AxHttpClient

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 AxHttpClient 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 AxHttpClient configured with credentials.

Errors

Returns an error if the HTTP client cannot be created.

pub fn base_url(&self) -> &str

Returns the base URL for this client.

pub fn cancel_all_requests(&self)

Cancel all pending HTTP requests.

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.

pub fn is_initialized(&self) -> bool

Checks if the client is initialized.

The client is considered initialized if any instruments have been cached from the venue.

pub fn get_cached_symbols(&self) -> Vec<String>

Returns a snapshot of all instrument symbols currently held in the internal cache.

pub fn cache_instruments(&self, instruments: Vec<InstrumentAny>)

Caches multiple instruments.

Any existing instruments with the same symbols will be replaced.

pub fn cache_instrument(&self, instrument: InstrumentAny)

Caches a single instrument.

Any existing instrument with the same symbol will be replaced.

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

Authenticates with Ax using API credentials.

On success, the session token is automatically stored for subsequent authenticated requests.

Errors

Returns an error if the HTTP request fails or credentials are invalid.

pub async fn authenticate_with_totp( &self, api_key: &str, api_secret: &str, expiration_seconds: i32, totp_code: Option<&str>, ) -> Result<String, AxHttpError>

Authenticates with Ax using API credentials and TOTP.

On success, the session token is automatically stored for subsequent authenticated requests.

Errors

Returns an error if the HTTP request fails or credentials are invalid.

pub fn get_instrument(&self, symbol: &Ustr) -> Option<InstrumentAny>

Gets an instrument from the cache by symbol.

pub async fn request_instruments( &self, maker_fee: Option<Decimal>, taker_fee: Option<Decimal>, ) -> Result<Vec<InstrumentAny>>

Requests all instruments from Ax.

Errors

Returns an error if the HTTP request fails or instrument parsing fails.

pub async fn request_instrument( &self, symbol: &str, maker_fee: Option<Decimal>, taker_fee: Option<Decimal>, ) -> Result<InstrumentAny>

Requests a single instrument from Ax by symbol.

Errors

Returns an error if the HTTP request fails or instrument parsing fails.

pub async fn request_account_state( &self, account_id: AccountId, ) -> Result<AccountState>

Requests account state from Ax and parses to a Nautilus [AccountState].

Errors

Returns an error if the HTTP request fails or parsing fails.

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

Requests funding rates from Ax.

Errors

Returns an error if the HTTP request fails.

pub async fn request_bars( &self, symbol: &str, start_timestamp_ns: i64, end_timestamp_ns: i64, width: AxCandleWidth, ) -> Result<Vec<Bar>>

Requests historical bars from Ax and parses them to Nautilus Bar types.

Requires the instrument to be cached (call request_instruments first).

Errors

Returns an error if:

• The instrument is not found in the cache.
• The HTTP request fails.
• Bar parsing fails.

pub async fn request_order_status_reports( &self, account_id: AccountId, ) -> Result<Vec<OrderStatusReport>>

Requests open orders from Ax and parses them to Nautilus [OrderStatusReport].

Requires instruments to be cached for parsing order details.

Errors

Returns an error if:

• The HTTP request fails.
• An order’s instrument is not found in the cache.
• Order parsing fails.

pub async fn request_fill_reports( &self, account_id: AccountId, ) -> Result<Vec<FillReport>>

Requests fills from Ax and parses them to Nautilus [FillReport].

Requires instruments to be cached for parsing fill details.

Errors

Returns an error if:

• The HTTP request fails.
• A fill’s instrument is not found in the cache.
• Fill parsing fails.

pub async fn request_position_reports( &self, account_id: AccountId, ) -> Result<Vec<PositionStatusReport>>

Requests positions from Ax and parses them to Nautilus [PositionStatusReport].

Requires instruments to be cached for parsing position details.

Errors

Returns an error if:

• The HTTP request fails.
• A position’s instrument is not found in the cache.
• Position parsing fails.

impl AxHttpClient

pub fn py_base_url(&self) -> &str

pub fn py_cancel_all_requests(&self)

Trait Implementations

impl Clone for AxHttpClient

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for AxHttpClient

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

Formats the value using the given formatter.

impl Default for AxHttpClient

fn default() -> Self

Returns the “default value” for a type.

impl<'py> IntoPyObject<'py> for AxHttpClient

type Target = AxHttpClient

The Python output type

type Output = Bound<'py, <AxHttpClient as IntoPyObject<'py>>::Target>

The smart pointer type to use.

type Error = PyErr

The type returned in the event of a conversion error.

fn into_pyobject( self, py: Python<'py>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>

Performs the conversion.

impl PyClass for AxHttpClient

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for AxHttpClient

const IS_BASETYPE: bool = false

#[pyclass(subclass)]

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]

const IS_MAPPING: bool = false

#[pyclass(mapping)]

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]

const IS_IMMUTABLE_TYPE: bool = false

#[pyclass(immutable_type)]

const RAW_DOC: &'static CStr = /// High-level HTTP client for the Ax REST API. /// /// This client wraps the underlying [`AxRawHttpClient`] to provide a convenient /// interface for Python bindings and instrument caching.

Docstring for the class provided on the struct or enum.

const DOC: &'static CStr

Fully rendered class doc, including the text_signature if a constructor is defined.

type BaseType = PyAny

Base class

type ThreadChecker = SendablePyClass<AxHttpClient>

This handles following two situations:

type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild

Immutable or mutable

type Dict = PyClassDummySlot

Specify this class has #[pyclass(dict)] or not.

type WeakRef = PyClassDummySlot

Specify this class has #[pyclass(weakref)] or not.

type BaseNativeType = PyAny

The closest native ancestor. This is PyAny by default, and when you declare #[pyclass(extends=PyDict)], it’s PyDict.

fn items_iter() -> PyClassItemsIter

fn lazy_type_object() -> &'static LazyTypeObject<Self>

fn dict_offset() -> Option<isize>

fn weaklist_offset() -> Option<isize>

impl PyClassNewTextSignature for AxHttpClient

const TEXT_SIGNATURE: &'static str = "(base_url=None, orders_base_url=None, timeout_secs=None, max_retries=None, retry_delay_ms=None, retry_delay_max_ms=None, proxy_url=None)"

impl PyMethods<AxHttpClient> for PyClassImplCollector<AxHttpClient>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for AxHttpClient

const NAME: &'static str = "AxHttpClient"

Class name.

const MODULE: Option<&'static str>

Module name, if any.

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.

fn type_object(py: Python<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.

fn is_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type or a subclass of this type.

fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.

impl DerefToPyAny for AxHttpClient

impl ExtractPyClassWithClone for AxHttpClient