pub struct BinanceSpotHttpClient { /* private fields */ }Expand description
High-level HTTP client for Binance Spot API.
Wraps BinanceRawSpotHttpClient and provides domain-level methods:
- Simple types (ping, server_time): Pass through from raw client.
- Complex types (instruments, orders): Transform to Nautilus domain types.
Implementations§
Source§impl BinanceSpotHttpClient
impl BinanceSpotHttpClient
Sourcepub fn new(
environment: BinanceEnvironment,
api_key: Option<String>,
api_secret: Option<String>,
base_url_override: Option<String>,
recv_window: Option<u64>,
timeout_secs: Option<u64>,
proxy_url: Option<String>,
) -> BinanceSpotHttpResult<Self>
pub fn new( environment: BinanceEnvironment, api_key: Option<String>, api_secret: Option<String>, base_url_override: Option<String>, recv_window: Option<u64>, timeout_secs: Option<u64>, proxy_url: Option<String>, ) -> BinanceSpotHttpResult<Self>
Creates a new Binance Spot HTTP client.
§Errors
Returns an error if the underlying HTTP client cannot be created.
Sourcepub fn inner(&self) -> &BinanceRawSpotHttpClient
pub fn inner(&self) -> &BinanceRawSpotHttpClient
Returns a reference to the inner raw client.
Sourcepub const fn schema_version() -> u16
pub const fn schema_version() -> u16
Returns the SBE schema version.
Sourcepub fn cache_instruments(&self, instruments: Vec<InstrumentAny>)
pub fn cache_instruments(&self, instruments: Vec<InstrumentAny>)
Caches multiple instruments.
Sourcepub fn cache_instrument(&self, instrument: InstrumentAny)
pub fn cache_instrument(&self, instrument: InstrumentAny)
Caches a single instrument.
Sourcepub fn get_instrument(&self, symbol: &Ustr) -> Option<InstrumentAny>
pub fn get_instrument(&self, symbol: &Ustr) -> Option<InstrumentAny>
Gets an instrument from the cache by symbol.
Sourcepub async fn ping(&self) -> BinanceSpotHttpResult<()>
pub async fn ping(&self) -> BinanceSpotHttpResult<()>
Sourcepub async fn server_time(&self) -> BinanceSpotHttpResult<i64>
pub async fn server_time(&self) -> BinanceSpotHttpResult<i64>
Returns the server time in microseconds since epoch.
Note: SBE provides microsecond precision vs JSON’s milliseconds.
§Errors
Returns an error if the request fails or SBE decoding fails.
Sourcepub async fn exchange_info(
&self,
) -> BinanceSpotHttpResult<BinanceExchangeInfoSbe>
pub async fn exchange_info( &self, ) -> BinanceSpotHttpResult<BinanceExchangeInfoSbe>
Returns exchange information including trading symbols.
§Errors
Returns an error if the request fails or SBE decoding fails.
Sourcepub async fn request_instruments(
&self,
) -> BinanceSpotHttpResult<Vec<InstrumentAny>>
pub async fn request_instruments( &self, ) -> BinanceSpotHttpResult<Vec<InstrumentAny>>
Requests Nautilus instruments for all trading symbols.
Fetches exchange info via SBE and parses each symbol into a CurrencyPair. Non-trading symbols are skipped with a debug log.
§Errors
Returns an error if the request fails or SBE decoding fails.
Sourcepub async fn request_trades(
&self,
instrument_id: InstrumentId,
limit: Option<u32>,
) -> Result<Vec<TradeTick>>
pub async fn request_trades( &self, instrument_id: InstrumentId, limit: Option<u32>, ) -> Result<Vec<TradeTick>>
Requests recent trades for an instrument.
§Errors
Returns an error if the request fails, the instrument is not cached, or trade parsing fails.
Sourcepub async fn request_bars(
&self,
bar_type: BarType,
start: Option<DateTime<Utc>>,
end: Option<DateTime<Utc>>,
limit: Option<u32>,
) -> Result<Vec<Bar>>
pub async fn request_bars( &self, bar_type: BarType, start: Option<DateTime<Utc>>, end: Option<DateTime<Utc>>, limit: Option<u32>, ) -> Result<Vec<Bar>>
Requests bar (kline/candlestick) data.
§Errors
Returns an error if the bar type is not supported, instrument is not cached, or the request fails.
Sourcepub async fn request_account_state(
&self,
params: &AccountInfoParams,
) -> BinanceSpotHttpResult<BinanceAccountInfo>
pub async fn request_account_state( &self, params: &AccountInfoParams, ) -> BinanceSpotHttpResult<BinanceAccountInfo>
Requests account state including balances.
§Errors
Returns an error if the request fails or SBE decoding fails.
Sourcepub async fn request_order_status(
&self,
account_id: AccountId,
instrument_id: InstrumentId,
venue_order_id: Option<VenueOrderId>,
client_order_id: Option<ClientOrderId>,
) -> Result<OrderStatusReport>
pub async fn request_order_status( &self, account_id: AccountId, instrument_id: InstrumentId, venue_order_id: Option<VenueOrderId>, client_order_id: Option<ClientOrderId>, ) -> Result<OrderStatusReport>
Requests the status of a specific order.
Either venue_order_id or client_order_id must be provided.
§Errors
Returns an error if neither identifier is provided, the request fails, instrument is not cached, or parsing fails.
Sourcepub async fn request_order_status_reports(
&self,
account_id: AccountId,
instrument_id: Option<InstrumentId>,
start: Option<DateTime<Utc>>,
end: Option<DateTime<Utc>>,
open_only: bool,
limit: Option<u32>,
) -> Result<Vec<OrderStatusReport>>
pub async fn request_order_status_reports( &self, account_id: AccountId, instrument_id: Option<InstrumentId>, start: Option<DateTime<Utc>>, end: Option<DateTime<Utc>>, open_only: bool, limit: Option<u32>, ) -> Result<Vec<OrderStatusReport>>
Requests order status reports.
When open_only is true, returns only open orders (instrument_id optional).
When open_only is false, returns order history (instrument_id required).
§Errors
Returns an error if the request fails, any order’s instrument is not cached, or parsing fails.
Sourcepub async fn request_fill_reports(
&self,
account_id: AccountId,
instrument_id: InstrumentId,
venue_order_id: Option<VenueOrderId>,
start: Option<DateTime<Utc>>,
end: Option<DateTime<Utc>>,
limit: Option<u32>,
) -> Result<Vec<FillReport>>
pub async fn request_fill_reports( &self, account_id: AccountId, instrument_id: InstrumentId, venue_order_id: Option<VenueOrderId>, start: Option<DateTime<Utc>>, end: Option<DateTime<Utc>>, limit: Option<u32>, ) -> Result<Vec<FillReport>>
Requests fill reports (trade history) for an instrument.
§Errors
Returns an error if the request fails, any trade’s instrument is not cached, or parsing fails.
Sourcepub async fn submit_order(
&self,
account_id: AccountId,
instrument_id: InstrumentId,
client_order_id: ClientOrderId,
order_side: OrderSide,
order_type: OrderType,
quantity: Quantity,
time_in_force: TimeInForce,
price: Option<Price>,
trigger_price: Option<Price>,
post_only: bool,
) -> Result<OrderStatusReport>
pub async fn submit_order( &self, account_id: AccountId, instrument_id: InstrumentId, client_order_id: ClientOrderId, order_side: OrderSide, order_type: OrderType, quantity: Quantity, time_in_force: TimeInForce, price: Option<Price>, trigger_price: Option<Price>, post_only: bool, ) -> Result<OrderStatusReport>
Submits a new order to the venue.
Converts Nautilus domain types to Binance-specific parameters
and returns an OrderStatusReport.
§Errors
Returns an error if:
- The instrument is not cached.
- The order type or time-in-force is unsupported.
- Stop orders are submitted without a trigger price.
- The request fails or SBE decoding fails.
Sourcepub async fn modify_order(
&self,
account_id: AccountId,
instrument_id: InstrumentId,
venue_order_id: VenueOrderId,
client_order_id: ClientOrderId,
order_side: OrderSide,
order_type: OrderType,
quantity: Quantity,
time_in_force: TimeInForce,
price: Option<Price>,
) -> Result<OrderStatusReport>
pub async fn modify_order( &self, account_id: AccountId, instrument_id: InstrumentId, venue_order_id: VenueOrderId, client_order_id: ClientOrderId, order_side: OrderSide, order_type: OrderType, quantity: Quantity, time_in_force: TimeInForce, price: Option<Price>, ) -> Result<OrderStatusReport>
Modifies an existing order (cancel and replace atomically).
§Errors
Returns an error if:
- The instrument is not cached.
- The order type or time-in-force is unsupported.
- The request fails or SBE decoding fails.
Sourcepub async fn cancel_order(
&self,
instrument_id: InstrumentId,
venue_order_id: Option<VenueOrderId>,
client_order_id: Option<ClientOrderId>,
) -> Result<VenueOrderId>
pub async fn cancel_order( &self, instrument_id: InstrumentId, venue_order_id: Option<VenueOrderId>, client_order_id: Option<ClientOrderId>, ) -> Result<VenueOrderId>
Cancels an existing order on the venue.
Either venue_order_id or client_order_id must be provided.
§Errors
Returns an error if the request fails or SBE decoding fails.
Sourcepub async fn cancel_all_orders(
&self,
instrument_id: InstrumentId,
) -> Result<Vec<(VenueOrderId, ClientOrderId)>>
pub async fn cancel_all_orders( &self, instrument_id: InstrumentId, ) -> Result<Vec<(VenueOrderId, ClientOrderId)>>
Cancels all open orders for a symbol.
Returns the venue order IDs of all canceled orders.
§Errors
Returns an error if the request fails or SBE decoding fails.
Source§impl BinanceSpotHttpClient
impl BinanceSpotHttpClient
pub fn py_schema_id(&self) -> u16
pub fn py_schema_version(&self) -> u16
Trait Implementations§
Source§impl Clone for BinanceSpotHttpClient
impl Clone for BinanceSpotHttpClient
Source§impl Debug for BinanceSpotHttpClient
impl Debug for BinanceSpotHttpClient
Source§impl<'py> IntoPyObject<'py> for BinanceSpotHttpClient
impl<'py> IntoPyObject<'py> for BinanceSpotHttpClient
Source§type Target = BinanceSpotHttpClient
type Target = BinanceSpotHttpClient
Source§type Output = Bound<'py, <BinanceSpotHttpClient as IntoPyObject<'py>>::Target>
type Output = Bound<'py, <BinanceSpotHttpClient as IntoPyObject<'py>>::Target>
Source§fn into_pyobject(
self,
py: Python<'py>,
) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>
fn into_pyobject( self, py: Python<'py>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>
Source§impl PyClass for BinanceSpotHttpClient
impl PyClass for BinanceSpotHttpClient
Source§impl PyClassImpl for BinanceSpotHttpClient
impl PyClassImpl for BinanceSpotHttpClient
Source§const IS_BASETYPE: bool = false
const IS_BASETYPE: bool = false
Source§const IS_SUBCLASS: bool = false
const IS_SUBCLASS: bool = false
Source§const IS_MAPPING: bool = false
const IS_MAPPING: bool = false
Source§const IS_SEQUENCE: bool = false
const IS_SEQUENCE: bool = false
Source§const IS_IMMUTABLE_TYPE: bool = false
const IS_IMMUTABLE_TYPE: bool = false
Source§const RAW_DOC: &'static CStr = /// High-level HTTP client for Binance Spot API.
///
/// Wraps [`BinanceRawSpotHttpClient`] and provides domain-level methods:
/// - Simple types (ping, server_time): Pass through from raw client.
/// - Complex types (instruments, orders): Transform to Nautilus domain types.
const RAW_DOC: &'static CStr = /// High-level HTTP client for Binance Spot API. /// /// Wraps [`BinanceRawSpotHttpClient`] and provides domain-level methods: /// - Simple types (ping, server_time): Pass through from raw client. /// - Complex types (instruments, orders): Transform to Nautilus domain types.
Source§const DOC: &'static CStr
const DOC: &'static CStr
text_signature if a constructor is defined. Read moreSource§type ThreadChecker = SendablePyClass<BinanceSpotHttpClient>
type ThreadChecker = SendablePyClass<BinanceSpotHttpClient>
Source§type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild
type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild
Source§type BaseNativeType = PyAny
type BaseNativeType = PyAny
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>
Source§impl PyClassNewTextSignature for BinanceSpotHttpClient
impl PyClassNewTextSignature for BinanceSpotHttpClient
const TEXT_SIGNATURE: &'static str = "(environment=..., api_key=None, api_secret=None, base_url=None, recv_window=None, timeout_secs=None, proxy_url=None)"
Source§impl PyMethods<BinanceSpotHttpClient> for PyClassImplCollector<BinanceSpotHttpClient>
impl PyMethods<BinanceSpotHttpClient> for PyClassImplCollector<BinanceSpotHttpClient>
fn py_methods(self) -> &'static PyClassItems
Source§impl PyTypeInfo for BinanceSpotHttpClient
impl PyTypeInfo for BinanceSpotHttpClient
Source§fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject
fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject
§fn type_object(py: Python<'_>) -> Bound<'_, PyType>
fn type_object(py: Python<'_>) -> Bound<'_, PyType>
§fn is_type_of(object: &Bound<'_, PyAny>) -> bool
fn is_type_of(object: &Bound<'_, PyAny>) -> bool
object is an instance of this type or a subclass of this type.§fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool
fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool
object is an instance of this type.impl DerefToPyAny for BinanceSpotHttpClient
impl ExtractPyClassWithClone for BinanceSpotHttpClient
Auto Trait Implementations§
impl Freeze for BinanceSpotHttpClient
impl !RefUnwindSafe for BinanceSpotHttpClient
impl Send for BinanceSpotHttpClient
impl Sync for BinanceSpotHttpClient
impl Unpin for BinanceSpotHttpClient
impl !UnwindSafe for BinanceSpotHttpClient
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more§impl<'py, T> IntoPyObjectExt<'py> for Twhere
T: IntoPyObject<'py>,
impl<'py, T> IntoPyObjectExt<'py> for Twhere
T: IntoPyObject<'py>,
§fn into_bound_py_any(self, py: Python<'py>) -> Result<Bound<'py, PyAny>, PyErr>
fn into_bound_py_any(self, py: Python<'py>) -> Result<Bound<'py, PyAny>, PyErr>
self into an owned Python object, dropping type information.§fn into_py_any(self, py: Python<'py>) -> Result<Py<PyAny>, PyErr>
fn into_py_any(self, py: Python<'py>) -> Result<Py<PyAny>, PyErr>
self into an owned Python object, dropping type information and unbinding it
from the 'py lifetime.§fn into_pyobject_or_pyerr(self, py: Python<'py>) -> Result<Self::Output, PyErr>
fn into_pyobject_or_pyerr(self, py: Python<'py>) -> Result<Self::Output, PyErr>
self into a Python object. Read more§impl<'py, T> IntoPyObjectNautilusExt<'py> for Twhere
T: IntoPyObjectExt<'py>,
impl<'py, T> IntoPyObjectNautilusExt<'py> for Twhere
T: IntoPyObjectExt<'py>,
§fn into_py_any_unwrap(self, py: Python<'py>) -> Py<PyAny>
fn into_py_any_unwrap(self, py: Python<'py>) -> Py<PyAny>
§impl<T> PolicyExt for Twhere
T: ?Sized,
impl<T> PolicyExt for Twhere
T: ?Sized,
§impl<T> PyErrArguments for T
impl<T> PyErrArguments for T
§impl<T> PyTypeCheck for Twhere
T: PyTypeInfo,
impl<T> PyTypeCheck for Twhere
T: PyTypeInfo,
§const NAME: &'static str = T::NAME
const NAME: &'static str = T::NAME
§fn type_check(object: &Bound<'_, PyAny>) -> bool
fn type_check(object: &Bound<'_, PyAny>) -> bool
§fn classinfo_object(py: Python<'_>) -> Bound<'_, PyAny>
fn classinfo_object(py: Python<'_>) -> Bound<'_, PyAny>
isinstance and issubclass function. Read more