Struct CoinbaseHttpClient 

pub struct CoinbaseHttpClient { /* private fields */ }

Provides a domain-level HTTP client for the Coinbase Advanced Trade API.

Wraps CoinbaseRawHttpClient in an Arc and adds instrument caching and Nautilus type conversions. This is the primary HTTP interface for the data and execution clients.

Implementations

impl CoinbaseHttpClient

pub fn new( environment: CoinbaseEnvironment, timeout_secs: u64, proxy_url: Option<String>, retry_config: Option<RetryConfig>, ) -> Result<Self, HttpClientError>

Creates a new CoinbaseHttpClient for public endpoints only.

Errors

Returns an error if the HTTP client cannot be created.

pub fn with_credentials( credential: CoinbaseCredential, environment: CoinbaseEnvironment, timeout_secs: u64, proxy_url: Option<String>, retry_config: Option<RetryConfig>, ) -> Result<Self, HttpClientError>

Creates a new CoinbaseHttpClient with credentials for authenticated requests.

Errors

Returns an error if the HTTP client cannot be created.

pub fn from_env(environment: CoinbaseEnvironment) -> Result<Self>

Creates an authenticated client from environment variables.

Errors

Returns Error::Auth if required environment variables are not set.

pub fn from_credentials( api_key: &str, api_secret: &str, environment: CoinbaseEnvironment, timeout_secs: u64, proxy_url: Option<String>, retry_config: Option<RetryConfig>, ) -> Result<Self>

Creates a new CoinbaseHttpClient with explicit credentials.

Errors

Returns Error::Auth if credentials are invalid.

pub fn cancellation_token(&self) -> &CancellationToken

Returns the cancellation token shared by in-flight requests.

pub fn set_base_url(&self, url: String)

Overrides the base REST URL (for testing with mock servers).

Safe to call regardless of how many clones share the inner client.

pub fn environment(&self) -> CoinbaseEnvironment

Returns the configured environment.

pub fn is_authenticated(&self) -> bool

Returns true if this client has credentials for authenticated requests.

pub fn instruments(&self) -> &Arc<AtomicMap<InstrumentId, InstrumentAny>>

Returns a reference to the instrument cache.

pub fn product_aliases(&self) -> &Arc<AtomicMap<Ustr, Ustr>>

Returns a reference to the product alias map (product_id -> canonical product_id).

pub fn ts_now(&self) -> UnixNanos

Returns the current timestamp from the atomic clock.

pub async fn get_products(&self) -> Result<Value>

Gets all available products.

pub async fn get_product(&self, product_id: &str) -> Result<Value>

Gets a specific product by ID.

pub async fn get_candles( &self, product_id: &str, start: &str, end: &str, granularity: &str, ) -> Result<Value>

Gets candles for a product.

pub async fn get_market_trades( &self, product_id: &str, limit: u32, ) -> Result<Value>

Gets market trades for a product.

pub async fn get_best_bid_ask(&self, product_ids: &[&str]) -> Result<Value>

Gets best bid/ask for one or more products.

pub async fn get_product_book( &self, product_id: &str, limit: Option<u32>, ) -> Result<Value>

Gets the product order book.

pub async fn get_accounts(&self) -> Result<Value>

Gets all accounts.

pub async fn get_account(&self, account_id: &str) -> Result<Value>

Gets a specific account by UUID.

pub async fn get_portfolios(&self) -> Result<Value>

Lists all portfolios visible to the authenticated key.

pub async fn preview_order(&self, body: &Value) -> Result<Value>

Validates an order payload against the venue without submitting it.

Useful for diagnosing account is not available and similar errors because it returns the same error envelope as POST /orders.

pub async fn get_orders(&self, query: &str) -> Result<Value>

Gets historical orders.

pub async fn get_order(&self, order_id: &str) -> Result<Value>

Gets a specific order by ID.

pub async fn get_fills(&self, query: &str) -> Result<Value>

Gets fills (trade executions).

pub async fn get_transaction_summary(&self) -> Result<Value>

Gets fee transaction summary.

pub async fn request_instruments( &self, product_type: Option<CoinbaseProductType>, ) -> Result<Vec<InstrumentAny>>

Requests all instruments from Coinbase, optionally filtered by product type.

Parses each supported product into a Nautilus [InstrumentAny] and caches the results in the shared instrument map. Unsupported products (non-crypto futures, UNKNOWN product types) are skipped with a debug log.

Errors

Returns an error when the HTTP request fails or the response cannot be deserialized.

pub async fn request_instrument( &self, product_id: &str, ) -> Result<InstrumentAny>

Requests a single instrument by product ID.

Caches the result on success.

Errors

Returns an error when the HTTP request fails, deserialization fails, or the product cannot be parsed into a supported instrument.

pub async fn request_raw_product(&self, product_id: &str) -> Result<Product>

Requests the raw product payload for a product ID.

Returns the full crate::http::models::Product so callers can read derivatives-specific fields (future_product_details.index_price, funding_rate, funding_time) that are stripped when parsing to a Nautilus instrument.

Errors

Returns an error when the HTTP request fails or the response cannot be deserialized.

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

Requests the current account state.

Builds a cash-type [AccountState] from /accounts with one balance per currency. Follows Coinbase’s cursor pagination so multi-wallet accounts are reported in full. reported is set to true since the values come from the venue.

Errors

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

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

Requests a single order status report by venue or client order ID.

Resolves venue order IDs first via /orders/historical/{id}. When only a client_order_id is provided, paginates the order history filtered to that client ID.

Errors

Returns an error when the HTTP request fails, the order cannot be found, or the response cannot be parsed.

pub async fn request_order_status_reports( &self, account_id: AccountId, instrument_id: Option<InstrumentId>, open_only: bool, start: Option<DateTime<Utc>>, end: Option<DateTime<Utc>>, limit: Option<u32>, ) -> Result<Vec<OrderStatusReport>>

Requests order status reports, optionally filtered by instrument, open status, and time window.

Errors

Returns an error when the HTTP request fails or when any response cannot be deserialized.

pub async fn request_fill_reports( &self, account_id: AccountId, instrument_id: Option<InstrumentId>, venue_order_id: Option<VenueOrderId>, start: Option<DateTime<Utc>>, end: Option<DateTime<Utc>>, limit: Option<u32>, ) -> Result<Vec<FillReport>>

Requests fill reports, optionally filtered by instrument, venue order ID, and time window.

Errors

Returns an error when the HTTP request fails or the response cannot be deserialized.

pub fn cache_instrument(&self, instrument: &InstrumentAny)

Caches an instrument in the shared instrument map.

pub fn cache_instruments(&self, instruments: &[InstrumentAny])

Caches a batch of instruments in the shared instrument map.

pub fn record_product_aliases(&self, products: &[Product])

Records product_id -> alias entries for any product whose alias field is non-empty. Coinbase aliases pairs to a canonical id (e.g. BTC-USDC -> BTC-USD) that the WebSocket and user channel use on the wire even when callers operate on the alias side.

pub async fn submit_order( &self, client_order_id: ClientOrderId, instrument_id: InstrumentId, side: OrderSide, order_type: OrderType, quantity: Quantity, time_in_force: TimeInForce, price: Option<Price>, trigger_price: Option<Price>, expire_time: Option<UnixNanos>, post_only: bool, is_quote_quantity: bool, leverage: Option<Decimal>, margin_type: Option<CoinbaseMarginType>, reduce_only: bool, retail_portfolio_id: Option<String>, ) -> Result<CreateOrderResponse>

Submits a new order built from Nautilus domain types.

Maps the order side, order type, and time-in-force to Coinbase’s order_configuration shape and posts to /orders. Returns the venue’s create-order response; callers inspect success and the success/error response variants.

Errors

Returns an error when the order parameters cannot be mapped to a supported Coinbase configuration, when the HTTP request fails, or when the response cannot be parsed.

pub async fn cancel_orders( &self, venue_order_ids: &[VenueOrderId], ) -> Result<CancelOrdersResponse>

Cancels one or more orders by venue order ID via batch_cancel.

Errors

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

pub async fn request_cfm_balance_summary(&self) -> Result<CfmBalanceSummary>

Fetches the CFM (futures) balance summary.

Errors

Returns an error when the HTTP request fails or the response cannot be deserialized.

pub async fn request_cfm_margin_balances(&self) -> Result<Vec<MarginBalance>>

Fetches margin balances derived from the CFM balance summary.

Errors

Returns an error when the summary cannot be fetched or when a balance cannot be constructed.

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

Fetches a margin [AccountState] derived from the CFM balance summary.

Errors

Returns an error when the summary cannot be fetched or when balances cannot be constructed.

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

Fetches all CFM futures positions and returns Nautilus position reports.

Errors

Returns an error when the HTTP request fails or a position cannot be parsed.

pub async fn request_position_status_report( &self, account_id: AccountId, instrument_id: InstrumentId, ) -> Result<Option<PositionStatusReport>>

Fetches a single CFM futures position and returns a position status report when the venue reports a non-flat position.

Errors

Returns an error when the HTTP request fails or the position cannot be parsed.

pub async fn modify_order( &self, venue_order_id: VenueOrderId, price: Option<Price>, quantity: Option<Quantity>, trigger_price: Option<Price>, ) -> Result<EditOrderResponse>

Modifies an existing GTC order’s price, size, or stop price.

Coinbase’s /orders/edit endpoint is documented to accept edits on these fields for supported order configurations (primarily LIMIT GTC). At least one of price, quantity, or trigger_price must be supplied.

Errors

Returns an error when the HTTP request fails or the response cannot be deserialized.

Trait Implementations

impl Clone for CoinbaseHttpClient

fn clone(&self) -> CoinbaseHttpClient

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CoinbaseHttpClient

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

Formats the value using the given formatter.

impl Default for CoinbaseHttpClient

fn default() -> Self

Returns the “default value” for a type.

impl<'a, 'py> FromPyObject<'a, 'py> for CoinbaseHttpClient

where Self: Clone,

type Error = PyClassGuardError<'a, 'py>

The type returned in the event of a conversion error.

fn extract( obj: Borrowed<'a, 'py, PyAny>, ) -> Result<Self, <Self as FromPyObject<'a, 'py>>::Error>

Extracts Self from the bound smart pointer obj.

impl<'py> IntoPyObject<'py> for CoinbaseHttpClient

type Target = CoinbaseHttpClient

The Python output type

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

const NAME: &str = "CoinbaseHttpClient"

Name of the class.

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for CoinbaseHttpClient

const MODULE: Option<&str>

Module which the class will be associated with.

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 = /// Provides a domain-level HTTP client for the Coinbase Advanced Trade API. /// /// Wraps [`CoinbaseRawHttpClient`] in an `Arc` and adds instrument caching /// and Nautilus type conversions. This is the primary HTTP interface for the /// data and execution clients.

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 Layout = <<CoinbaseHttpClient as PyClassImpl>::BaseNativeType as PyClassBaseType>::Layout<CoinbaseHttpClient>

Description of how this class is laid out in memory

type BaseType = PyAny

Base class

type ThreadChecker = NoopThreadChecker

This handles following two situations:

type Inventory = Pyo3MethodsInventoryForCoinbaseHttpClient

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<PyObjectOffset>

Used to provide the dictoffset slot (equivalent to tp_dictoffset)

fn weaklist_offset() -> Option<PyObjectOffset>

Used to provide the weaklistoffset slot (equivalent to tp_weaklistoffset

impl PyStubType for CoinbaseHttpClient

fn type_output() -> TypeInfo

The type to be used in the output signature, i.e. return type of the Python function or methods.

fn type_input() -> TypeInfo

The type to be used in the input signature, i.e. the arguments of the Python function or methods.

impl PyTypeInfo for CoinbaseHttpClient

const NAME: &str = <Self as ::pyo3::PyClass>::NAME

👎Deprecated since 0.28.0:

prefer using ::type_object(py).name() to get the correct runtime value

Class name.

const MODULE: Option<&str> = <Self as ::pyo3::impl_::pyclass::PyClassImpl>::MODULE

👎Deprecated since 0.28.0:

prefer using ::type_object(py).module() to get the correct runtime value

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 CoinbaseHttpClient