Struct KuCoin 

pub struct KuCoin { /* private fields */ }

A KuCoin client over injected transports.

Implementations

impl KuCoin

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

Learn the offset between this machine’s clock and the venue’s, from GET /api/v1/timestamp.

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, ) -> KuCoin

Build a public KuCoin client.

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

Build an authenticated KuCoin client (credentials must carry a passphrase).

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

Override the timestamp source (deterministic signing in tests).

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

Attach a WebSocket transport.

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

The KuCoin wire symbol for a canonical Symbol (BTC/USDT -> BTC-USDT).

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

A ticker for symbol (from the 24-hour stats endpoint).

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). KuCoin 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 (top 20 levels per side).

Errors

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

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

Subscribe to a pushed derivatives channel.

KuCoin publishes both on /contract/instrument, under two subjects: funding.rate and mark.index.price. The funding subject carries no price, so a funding print reports a mark of zero rather than one taken from the other subject at another moment.

Liquidations is refused: KuCoin publishes no public stream of forced orders.

Errors

Returns an Error on a spot client, for Liquidations, or if the subscription fails.

pub fn open_interest(&self, symbol: &Symbol) -> Result<OpenInterest, Error>

The current open interest (GET /api/v1/contracts/<contract>).

Polled, not pushed. KuCoin reports it in contracts and publishes the contract’s multiplier in the same reply, so the base-currency figure is exact arithmetic on one reading rather than two.

Errors

Returns an Error on a spot client, if the request fails, or if the reply carries neither figure.

pub fn long_short_ratio( &self, _symbol: &Symbol, ) -> Result<LongShortRatio, Error>

KuCoin publishes no public long/short positioning figure.

Errors

Always returns an Error: there is nothing to read.

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.

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 subscribe_user_data(&mut self) -> Result<(), Error>

Open the private user-data stream. Negotiates a bullet-private token over REST (POST /api/v1/bullet-private, signed), connects the returned instance endpoint (<endpoint>?token=<token>&connectId=<id>), then subscribes to the account’s own order and balance channels – on spot /spotMarket/tradeOrders and /account/balance, on futures /contractMarket/tradeOrders and /contractAccount/wallet. A futures client negotiates its token against the futures host, which serves the same /api/v1/bullet-private path. Afterwards poll_events also surfaces the account’s own Event::OrderUpdate and Event::BalanceUpdate.

The bullet token expires; keepalive_user_data sends KuCoin’s ping to keep it alive, and a dropped stream is re-subscribed automatically on the next poll_events, which re-negotiates a fresh token.

Errors

Returns Error::InvalidCredentials without credentials or a passphrase, Error::NotConnected without a WebSocket transport, or another Error if the token negotiation or subscription fails.

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

Send KuCoin’s application-level heartbeat ({"id":..,"type":"ping"}) on the private stream so the bullet token is not dropped for inactivity. A no-op before subscribe_user_data.

Errors

Returns an Error if the ping cannot be sent.

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>

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

Trade-account balances.

Errors

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

impl KuCoin

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

Open futures positions (/api/v1/positions on the futures host); flat positions are omitted. Quantities are in contracts, KuCoin’s native futures unit.

Errors

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

pub fn set_leverage( &mut self, _symbol: &Symbol, leverage: u32, ) -> Result<(), Error>

Record the leverage applied to subsequent futures orders. KuCoin has no standalone set-leverage endpoint — leverage is a per-order field — so this stores it locally rather than issuing a request.

Errors

Never errors; the signature matches the Derivatives trait.

pub fn set_margin_mode( &self, symbol: &Symbol, mode: MarginMode, ) -> Result<(), Error>

Set the margin mode for symbol (/api/v1/position/changeMarginMode).

Errors

Returns an Error if the change is rejected or the request fails.

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

Flatten the open position in symbol with a reduce-only market order (size in contracts).

Errors

Returns Error::NotFound if there is no open position, or another Error if the request fails.

pub fn place_batch( &self, requests: &[OrderRequest], ) -> Result<Vec<Result<Order, Error>>, Error>

Place several spot orders on one symbol in one request (/api/v1/orders/multi). KuCoin returns the results in request order, so each element maps to its request’s own Result.

Errors

Returns an Error if the batch request itself fails, or if called on a futures client (multi is a spot endpoint).

pub fn cancel_batch( &self, symbol: &Symbol, order_ids: &[String], ) -> Result<(), Error>

Cancel several orders by id. KuCoin has no batch-cancel-by-id endpoint, so the ids are cancelled sequentially.

Errors

Returns an Error if any cancel fails.

pub fn place_oco(&self, request: &OcoRequest) -> Result<Vec<Order>, Error>

Place a one-cancels-other bracket (/api/v3/oco/order). KuCoin models an OCO as one order-list, so the returned vector holds one order carrying the list id.

Errors

Returns an Error if the OCO is invalid or rejected.

Trait Implementations

impl AdvancedOrders for KuCoin

fn amend_order( &mut self, _symbol: &Symbol, _order_id: &str, _new_price: Option<Decimal>, _new_quantity: Option<Decimal>, ) -> Result<Order, Error>

KuCoin has no in-place amend (orders are cancelled and re-placed), so this returns an Error::Exchange.

fn place_batch( &mut self, requests: &[OrderRequest], ) -> Result<Vec<Result<Order, Error>>, Error>

Place several orders in one request. The outer Result covers a transport/auth failure; each inner Result is that order’s own outcome, so a partially-accepted batch still returns the successes.

fn cancel_batch( &mut self, symbol: &Symbol, order_ids: &[String], ) -> Result<(), Error>

Cancel several orders on one symbol in a single request.

fn place_oco(&mut self, request: &OcoRequest) -> Result<Vec<Order>, Error>

Place a one-cancels-other bracket, returning the resulting order legs.

impl Debug for KuCoin

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 Derivatives for KuCoin

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

Open positions, optionally filtered to one symbol; flat positions are omitted.

fn set_leverage(&mut self, symbol: &Symbol, leverage: u32) -> Result<(), Error>

Set the account leverage for symbol.

fn set_margin_mode( &mut self, symbol: &Symbol, mode: MarginMode, ) -> Result<(), Error>

Set the margin mode (cross / isolated) for symbol.

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

Flatten the open position in symbol with a reduce-only market order.

impl DerivativesStream for KuCoin

fn subscribe_derivatives( &mut self, symbol: &Symbol, channel: DerivativesChannel, ) -> Result<(), Error>

Subscribe to a pushed derivatives channel. Frames arrive through poll_events as Event::Derivatives.

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

Read the current open interest. Polled, not pushed.

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

Read the current long/short positioning ratio. Polled, not pushed.

impl Exchange for KuCoin

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

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

impl Execution for KuCoin

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 KuCoin

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.

impl WsExecution for KuCoin

fn place_order_ws(&mut self, _request: &OrderRequest) -> Result<Order, Error>

KuCoin exposes no WebSocket order-entry API — its WebSocket surface is subscription-only (market data plus the private tradeOrders/balance push channels). Orders are placed over REST, so this returns a documented Error::Exchange.

fn cancel_order_ws( &mut self, _symbol: &Symbol, _order_id: &str, ) -> Result<(), Error>

Cancel an order over the WebSocket API by venue id.

impl WsUserData for KuCoin

fn subscribe_user_data(&mut self) -> Result<(), Error>

Open the private user-data stream. After it returns, poll_events on the same client also drains the user’s order and balance events alongside the public market-data stream.

fn keepalive_user_data(&mut self) -> Result<(), Error>

Keep the private user-data stream alive: refresh the venue’s session so it is not dropped for inactivity. The consumer calls this periodically (e.g. on a timer). Venues that need a REST keepalive refresh their listen key; venues that need an application-level heartbeat send a ping frame. The default is a no-op for venues that need neither.