Struct CoinbaseIntxHttpClient

pub struct CoinbaseIntxHttpClient { /* private fields */ }

Provides a higher-level HTTP client for the Coinbase International REST API.

This client wraps the underlying CoinbaseIntxHttpInnerClient to handle conversions into the Nautilus domain model.

Implementations

impl CoinbaseIntxHttpClient

pub fn new(base_url: Option<String>, timeout_secs: Option<u64>) -> Self

Creates a new CoinbaseIntxHttpClient using the default Coinbase HTTP URL, optionally overridden with a custom base url.

This version of the client has no credentials, so it can only call publicly accessible endpoints.

pub fn from_env() -> Result<Self>

Creates a new authenticated CoinbaseIntxHttpClient using environment variables and the default Coinbase International HTTP base url.

pub fn with_credentials( api_key: Option<String>, api_secret: Option<String>, api_passphrase: Option<String>, base_url: Option<String>, timeout_secs: Option<u64>, ) -> Result<Self>

Creates a new CoinbaseIntxHttpClient configured with credentials for authenticated requests, optionally using a custom base url.

pub fn base_url(&self) -> &str

Returns the base url being used by the client.

pub fn api_key(&self) -> Option<&str>

Returns the public API key being used by the client.

pub const 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 the cached instrument symbols.

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

Adds the given instruments into the clients instrument cache.

Any existing instruments will be replaced.

pub fn add_instrument(&mut self, instrument: InstrumentAny)

Adds the given instrument into the clients instrument cache.

Any existing instrument will be replaced.

pub async fn list_portfolios(&self) -> Result<Vec<CoinbaseIntxPortfolio>>

Requests a list of portfolio details from Coinbase International.

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

Requests the account state for the given account ID from Coinbase International.

pub async fn request_instruments(&self) -> Result<Vec<InstrumentAny>>

Requests all instruments from Coinbase International.

pub async fn request_instrument(&self, symbol: &Symbol) -> Result<InstrumentAny>

Requests the instrument for the given symbol from Coinbase International.

pub async fn request_order_status_report( &self, account_id: AccountId, venue_order_id: VenueOrderId, ) -> Result<OrderStatusReport>

Requests an order status reports for the given venue order ID from Coinbase International.

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

Requests order status reports for all open orders from Coinbase International.

pub async fn request_fill_reports( &self, account_id: AccountId, client_order_id: Option<ClientOrderId>, start: Option<DateTime<Utc>>, ) -> Result<Vec<FillReport>>

Requests all fill reports from Coinbase International.

pub async fn request_position_status_report( &self, account_id: AccountId, symbol: Symbol, ) -> Result<PositionStatusReport>

Requests a position status report from Coinbase International.

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

Requests all position status reports from Coinbase International.

pub async fn submit_order( &self, account_id: AccountId, client_order_id: ClientOrderId, symbol: Symbol, order_side: OrderSide, order_type: OrderType, quantity: Quantity, time_in_force: TimeInForce, expire_time: Option<DateTime<Utc>>, price: Option<Price>, trigger_price: Option<Price>, post_only: Option<bool>, reduce_only: Option<bool>, ) -> Result<OrderStatusReport>

Submits a new order to Coinbase International.

pub async fn cancel_order( &self, account_id: AccountId, client_order_id: ClientOrderId, ) -> Result<OrderStatusReport>

Cancels a currently open order on Coinbase International.

pub async fn cancel_orders( &self, account_id: AccountId, symbol: Symbol, order_side: Option<OrderSide>, ) -> Result<Vec<OrderStatusReport>>

Cancels all orders for the given account ID and filter params on Coinbase International.

pub async fn modify_order( &self, account_id: AccountId, client_order_id: ClientOrderId, new_client_order_id: ClientOrderId, price: Option<Price>, trigger_price: Option<Price>, quantity: Option<Quantity>, ) -> Result<OrderStatusReport>

Modifies a currently open order on Coinbase International.

impl CoinbaseIntxHttpClient

pub fn py_base_url(&self) -> &str

pub fn py_api_key(&self) -> Option<&str>

pub const fn py_is_initialized(&self) -> bool

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

pub fn py_add_instrument( &mut self, py: Python<'_>, instrument: PyObject, ) -> PyResult<()>

pub fn py_list_portfolios<'py>( &mut self, py: Python<'py>, ) -> PyResult<Bound<'py, PyAny>>

Trait Implementations

impl Clone for CoinbaseIntxHttpClient

fn clone(&self) -> CoinbaseIntxHttpClient

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for CoinbaseIntxHttpClient

fn default() -> Self

Returns the “default value” for a type.

impl IntoPy<Py<PyAny>> for CoinbaseIntxHttpClient

fn into_py(self, py: Python<'_>) -> PyObject

👎Deprecated since 0.23.0: IntoPy is going to be replaced by IntoPyObject. See the migration guide (https://pyo3.rs/v0.23.0/migration) for more information.

Performs the conversion.

impl<'py> IntoPyObject<'py> for CoinbaseIntxHttpClient

type Target = CoinbaseIntxHttpClient

The Python output type

type Output = Bound<'py, <CoinbaseIntxHttpClient 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 CoinbaseIntxHttpClient

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for CoinbaseIntxHttpClient

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)]

type BaseType = PyAny

Base class

type ThreadChecker = SendablePyClass<CoinbaseIntxHttpClient>

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 doc(py: Python<'_>) -> PyResult<&'static CStr>

Rendered class doc

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

fn dict_offset() -> Option<isize>

fn weaklist_offset() -> Option<isize>

impl PyClassNewTextSignature<CoinbaseIntxHttpClient> for PyClassImplCollector<CoinbaseIntxHttpClient>

fn new_text_signature(self) -> Option<&'static str>

impl<'a, 'py> PyFunctionArgument<'a, 'py, false> for &'a CoinbaseIntxHttpClient

type Holder = Option<PyRef<'py, CoinbaseIntxHttpClient>>

fn extract( obj: &'a Bound<'py, PyAny>, holder: &'a mut Self::Holder, ) -> PyResult<Self>

impl<'a, 'py> PyFunctionArgument<'a, 'py, false> for &'a mut CoinbaseIntxHttpClient

type Holder = Option<PyRefMut<'py, CoinbaseIntxHttpClient>>

fn extract( obj: &'a Bound<'py, PyAny>, holder: &'a mut Self::Holder, ) -> PyResult<Self>

impl PyMethods<CoinbaseIntxHttpClient> for PyClassImplCollector<CoinbaseIntxHttpClient>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for CoinbaseIntxHttpClient

const NAME: &'static str = "CoinbaseIntxHttpClient"

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 type_object_bound(py: Python<'_>) -> Bound<'_, PyType>

👎Deprecated since 0.23.0: renamed to PyTypeInfo::type_object

Deprecated name for [PyTypeInfo::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_type_of_bound(object: &Bound<'_, PyAny>) -> bool

👎Deprecated since 0.23.0: renamed to PyTypeInfo::is_type_of

Deprecated name for [PyTypeInfo::is_type_of].

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

Checks if object is an instance of this type.

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

👎Deprecated since 0.23.0: renamed to PyTypeInfo::is_exact_type_of

Deprecated name for [PyTypeInfo::is_exact_type_of].

impl DerefToPyAny for CoinbaseIntxHttpClient