Struct Coinbase 

pub struct Coinbase { /* private fields */ }

A Coinbase Advanced Trade client over injected transports.

Implementations

impl Coinbase

pub fn sync_time(&mut self) -> Result<i64, Error>

Learn the offset between this machine’s clock and the venue’s, from GET /api/v3/brokerage/time.

Explicit rather than automatic: it costs a request, and a client should not make one the caller did not ask for. Call it once after connecting, and again if the process runs long enough for drift to matter.

Returns the new offset in milliseconds (server - local).

Errors

Returns an Error if the request fails or the response cannot be parsed.

pub fn with_http( http: Box<dyn HttpTransport>, options: &ExchangeOptions, ) -> Coinbase

Build a Coinbase client. Signed calls require credentials whose key name is the API key id and whose private key (with_private_key) is the EC PKCS#8 PEM.

pub fn with_credentials( http: Box<dyn HttpTransport>, options: &ExchangeOptions, credentials: Credentials, ) -> Coinbase

Build an authenticated Coinbase client.

pub fn with_clock(self, now_ms: Box<dyn Fn() -> i64 + Send + Sync>) -> Coinbase

Override the timestamp source (deterministic signing in tests).

pub fn with_ws(self, ws: Box<dyn WsTransport>) -> Coinbase

Attach a WebSocket transport.

pub fn wire_symbol(symbol: &Symbol) -> String

The Coinbase wire symbol for a canonical Symbol (BTC/USD -> BTC-USD).

pub fn ticker(&self, symbol: &Symbol) -> Result<Ticker, Error>

A ticker for symbol.

Errors

Returns an Error if the request fails or the symbol is unknown.

pub fn klines( &self, symbol: &Symbol, interval: &str, limit: u32, ) -> Result<Vec<Candle>, Error>

Up to limit candles for symbol at interval (unified). Coinbase returns newest-first; the result is chronological.

Errors

Returns an Error if the request fails or a row cannot be parsed.

pub fn order_book( &self, symbol: &Symbol, depth: u32, ) -> Result<OrderBookSnapshot, Error>

A depth snapshot of symbol up to depth levels per side.

Errors

Returns an Error if the request fails or the response cannot be parsed.

pub fn subscribe_trades(&mut self, symbol: &Symbol) -> Result<(), Error>

Subscribe to the public trade stream for symbol.

Errors

Returns Error::NotConnected if no WebSocket transport is configured, or Error::InvalidCredentials if credentials are missing.

pub fn subscribe_book(&mut self, symbol: &Symbol) -> Result<(), Error>

Subscribe to the order-book stream for symbol.

Errors

See subscribe_trades.

pub fn subscribe_ticker(&mut self, symbol: &Symbol) -> Result<(), Error>

Subscribe to the ticker stream for symbol.

Errors

See subscribe_trades.

pub fn poll_events(&mut self) -> Vec<Event>

Drain all stream events available since the last call. Non-blocking.

pub fn place_order(&self, request: &OrderRequest) -> Result<Order, Error>

pub fn cancel_order( &self, _symbol: &Symbol, order_id: &str, ) -> Result<(), Error>

Cancel an open order by venue id.

Errors

Returns an Error if credentials are missing or the venue rejects it.

pub fn query_order( &self, symbol: &Symbol, order_id: &str, ) -> Result<Order, Error>

Query a single order by venue id.

Errors

Returns an Error if credentials are missing or the order is unknown.

pub fn open_orders(&self, symbol: Option<&Symbol>) -> Result<Vec<Order>, Error>

Open orders, optionally filtered to one symbol.

Errors

Returns an Error if credentials are missing or the request fails.

pub fn balances(&self) -> Result<Vec<Balance>, Error>

Account balances.

Errors

Returns an Error if credentials are missing or the request fails.

Trait Implementations

impl Debug for Coinbase

Hand-written: the client holds Box<dyn HttpTransport>, Box<dyn WsTransport> and a Box<dyn Fn() -> i64> clock, none of which a derive can reach. The transports are shown by whether a connection is open rather than by value, and the credentials only by whether they are set – printing them would put secret material into every log line that formats a client.

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

Formats the value using the given formatter.

impl Exchange for Coinbase

fn name(&self) -> &'static str

The venue’s lowercase identifier (e.g. "binance").

impl Execution for Coinbase

fn place_order(&mut self, request: &OrderRequest) -> Result<Order, Error>

Place an order and return it as accepted by the venue.

fn cancel_order(&mut self, symbol: &Symbol, order_id: &str) -> Result<(), Error>

Cancel an open order by venue id.

fn query_order( &mut self, symbol: &Symbol, order_id: &str, ) -> Result<Order, Error>

Query a single order by venue id.

fn open_orders(&mut self, symbol: Option<&Symbol>) -> Result<Vec<Order>, Error>

All open orders, optionally filtered to one symbol.

fn balances(&mut self) -> Result<Vec<Balance>, Error>

Current account balances.

impl MarketData for Coinbase

fn ticker(&mut self, symbol: &Symbol) -> Result<Ticker, Error>

A point-in-time ticker for symbol.

fn klines( &mut self, symbol: &Symbol, interval: &str, limit: u32, ) -> Result<Vec<Candle>, Error>

Up to limit historical candles for symbol at the given interval (e.g. "1m", "1h"). Returns wickra_core::Candles so the result feeds the indicator core directly.

fn order_book( &mut self, symbol: &Symbol, depth: u32, ) -> Result<OrderBookSnapshot, Error>

A depth snapshot of symbol up to depth levels per side.

fn subscribe_trades(&mut self, symbol: &Symbol) -> Result<(), Error>

Subscribe to the public trade stream for symbol.

fn subscribe_book(&mut self, symbol: &Symbol) -> Result<(), Error>

Subscribe to the order-book stream for symbol.

fn subscribe_ticker(&mut self, symbol: &Symbol) -> Result<(), Error>

Subscribe to the ticker stream for symbol.

fn poll_events(&mut self) -> Vec<Event>

Drain all events buffered since the last call. Non-blocking: returns an empty vector when nothing is pending.