pub struct BinanceFuturesHttpClient { /* private fields */ }Expand description
Binance Futures HTTP client for USD-M and COIN-M perpetuals.
This client wraps the generic HTTP client and provides convenience methods
for futures-specific endpoints. Use BinanceProductType::UsdM for USD-margined
or BinanceProductType::CoinM for coin-margined futures.
Implementations§
Source§impl BinanceFuturesHttpClient
impl BinanceFuturesHttpClient
Sourcepub fn new(
product_type: BinanceProductType,
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>,
) -> BinanceHttpResult<Self>
pub fn new( product_type: BinanceProductType, 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>, ) -> BinanceHttpResult<Self>
Creates a new BinanceFuturesHttpClient instance.
§Errors
Returns an error if:
product_typeis not a futures type (UsdM or CoinM).- Credential creation fails.
Sourcepub const fn product_type(&self) -> BinanceProductType
pub const fn product_type(&self) -> BinanceProductType
Returns the product type (UsdM or CoinM).
Sourcepub const fn inner(&self) -> &BinanceHttpClient
pub const fn inner(&self) -> &BinanceHttpClient
Returns a reference to the underlying generic HTTP client.
Sourcepub async fn exchange_info(&self) -> BinanceHttpResult<()>
pub async fn exchange_info(&self) -> BinanceHttpResult<()>
Fetches exchange information and populates the instrument cache.
§Errors
Returns an error if the HTTP request fails.
Sourcepub async fn instruments(&self) -> BinanceHttpResult<Vec<InstrumentAny>>
pub async fn instruments(&self) -> BinanceHttpResult<Vec<InstrumentAny>>
Fetches exchange information and returns parsed Nautilus instruments.
Only returns perpetual contracts. Non-perpetual contracts (quarterly futures) are filtered out.
§Errors
Returns an error if the HTTP request fails or parsing fails.
Sourcepub async fn ticker_24h(
&self,
params: &BinanceTicker24hrParams,
) -> BinanceHttpResult<Vec<BinanceFuturesTicker24hr>>
pub async fn ticker_24h( &self, params: &BinanceTicker24hrParams, ) -> BinanceHttpResult<Vec<BinanceFuturesTicker24hr>>
Sourcepub async fn book_ticker(
&self,
params: &BinanceBookTickerParams,
) -> BinanceHttpResult<Vec<BinanceBookTicker>>
pub async fn book_ticker( &self, params: &BinanceBookTickerParams, ) -> BinanceHttpResult<Vec<BinanceBookTicker>>
Sourcepub async fn depth(
&self,
params: &BinanceDepthParams,
) -> BinanceHttpResult<BinanceOrderBook>
pub async fn depth( &self, params: &BinanceDepthParams, ) -> BinanceHttpResult<BinanceOrderBook>
Sourcepub async fn mark_price(
&self,
params: &MarkPriceParams,
) -> BinanceHttpResult<Vec<BinanceFuturesMarkPrice>>
pub async fn mark_price( &self, params: &MarkPriceParams, ) -> BinanceHttpResult<Vec<BinanceFuturesMarkPrice>>
Fetches mark price and funding rate.
If symbol is None, returns mark price for all symbols.
§Errors
Returns an error if the HTTP request fails.
Sourcepub async fn funding_rate(
&self,
params: &FundingRateParams,
) -> BinanceHttpResult<Vec<BinanceFundingRate>>
pub async fn funding_rate( &self, params: &FundingRateParams, ) -> BinanceHttpResult<Vec<BinanceFundingRate>>
Sourcepub async fn open_interest(
&self,
params: &OpenInterestParams,
) -> BinanceHttpResult<BinanceOpenInterest>
pub async fn open_interest( &self, params: &OpenInterestParams, ) -> BinanceHttpResult<BinanceOpenInterest>
Sourcepub async fn create_listen_key(&self) -> BinanceHttpResult<ListenKeyResponse>
pub async fn create_listen_key(&self) -> BinanceHttpResult<ListenKeyResponse>
Creates a listen key for user data stream.
§Errors
Returns an error if the HTTP request fails or credentials are missing.
Sourcepub async fn keepalive_listen_key(
&self,
listen_key: &str,
) -> BinanceHttpResult<()>
pub async fn keepalive_listen_key( &self, listen_key: &str, ) -> BinanceHttpResult<()>
Sourcepub async fn close_listen_key(&self, listen_key: &str) -> BinanceHttpResult<()>
pub async fn close_listen_key(&self, listen_key: &str) -> BinanceHttpResult<()>
Trait Implementations§
Source§impl Clone for BinanceFuturesHttpClient
impl Clone for BinanceFuturesHttpClient
Source§fn clone(&self) -> BinanceFuturesHttpClient
fn clone(&self) -> BinanceFuturesHttpClient
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for BinanceFuturesHttpClient
impl Debug for BinanceFuturesHttpClient
Source§impl<'py> IntoPyObject<'py> for BinanceFuturesHttpClient
impl<'py> IntoPyObject<'py> for BinanceFuturesHttpClient
Source§type Target = BinanceFuturesHttpClient
type Target = BinanceFuturesHttpClient
Source§type Output = Bound<'py, <BinanceFuturesHttpClient as IntoPyObject<'py>>::Target>
type Output = Bound<'py, <BinanceFuturesHttpClient 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 BinanceFuturesHttpClient
impl PyClass for BinanceFuturesHttpClient
Source§impl PyClassImpl for BinanceFuturesHttpClient
impl PyClassImpl for BinanceFuturesHttpClient
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 = /// Binance Futures HTTP client for USD-M and COIN-M perpetuals.
///
/// This client wraps the generic HTTP client and provides convenience methods
/// for futures-specific endpoints. Use [`BinanceProductType::UsdM`] for USD-margined
/// or [`BinanceProductType::CoinM`] for coin-margined futures.
const RAW_DOC: &'static CStr = /// Binance Futures HTTP client for USD-M and COIN-M perpetuals. /// /// This client wraps the generic HTTP client and provides convenience methods /// for futures-specific endpoints. Use [`BinanceProductType::UsdM`] for USD-margined /// or [`BinanceProductType::CoinM`] for coin-margined futures.
Source§const DOC: &'static CStr
const DOC: &'static CStr
text_signature if a constructor is defined. Read moreSource§type ThreadChecker = SendablePyClass<BinanceFuturesHttpClient>
type ThreadChecker = SendablePyClass<BinanceFuturesHttpClient>
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 PyTypeInfo for BinanceFuturesHttpClient
impl PyTypeInfo for BinanceFuturesHttpClient
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 BinanceFuturesHttpClient
impl ExtractPyClassWithClone for BinanceFuturesHttpClient
Auto Trait Implementations§
impl Freeze for BinanceFuturesHttpClient
impl !RefUnwindSafe for BinanceFuturesHttpClient
impl Send for BinanceFuturesHttpClient
impl Sync for BinanceFuturesHttpClient
impl Unpin for BinanceFuturesHttpClient
impl !UnwindSafe for BinanceFuturesHttpClient
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