Struct DeriveHttpClient 

pub struct DeriveHttpClient { /* private fields */ }

HTTP client for the Derive REST API.

The client carries an atomic id counter so every request frame has a unique correlator; the REST transport ships only params on the wire but the id is preserved for logs and reused by the upcoming WebSocket client. Each call routes through a RetryManager that re-signs auth headers on every attempt, so retries never replay a stale X-LYRATIMESTAMP.

Implementations

impl DeriveHttpClient

pub fn new( base_url: impl Into<String>, timeout_secs: Option<u64>, proxy_url: Option<String>, retry_config: Option<RetryConfig>, ) -> Result<Self>

Creates a public-only client.

retry_config defaults to [http_retry_config(3, 100, 5_000)] when None.

Errors

Returns DeriveHttpError::Transport when the underlying HTTP client (proxy URL, TLS init) cannot be constructed.

pub fn with_credentials( base_url: impl Into<String>, credentials: DeriveCredentials, timeout_secs: Option<u64>, proxy_url: Option<String>, retry_config: Option<RetryConfig>, ) -> Result<Self>

Creates a client with credentials installed for send_private calls.

Errors

Returns DeriveHttpError::Transport when the underlying HTTP client cannot be constructed.

pub fn base_url(&self) -> &str

Returns the configured base URL (no trailing slash).

pub fn has_credentials(&self) -> bool

Returns true when credentials are installed.

pub async fn send_public<P, R>(&self, method: &str, params: &P) -> Result<R>

where P: Serialize + ?Sized, R: DeserializeOwned,

Sends an unauthenticated request and decodes the JSON-RPC envelope.

Public endpoints are idempotent reads; this path retries transient failures via the configured RetryManager.

Errors

Propagates transport, HTTP, and JSON-RPC errors. See DeriveHttpError.

pub async fn send_private<P, R>(&self, method: &str, params: &P) -> Result<R>

where P: Serialize + ?Sized, R: DeserializeOwned,

Sends an authenticated idempotent request (private reads).

Used for private/get_* endpoints whose responses are pure reads of venue state. Transient failures retry via the configured RetryManager.

Errors

Returns DeriveHttpError::MissingCredentials when the client was built without credentials. Other variants propagate from the transport or the venue.

pub async fn send_private_once<P, R>( &self, method: &str, params: &P, ) -> Result<R>

where P: Serialize + ?Sized, R: DeserializeOwned,

Sends an authenticated request exactly once (no retry).

Used for state-changing endpoints (private/order, private/cancel, private/cancel_all, private/cancel_by_label, private/replace) where a transport-level failure leaves the venue’s view of the signed action ambiguous: the request may have been accepted before the network broke. Automatic replay would either double-submit (when the venue accepted) or trigger a duplicate-nonce rejection (which the caller would surface as OrderRejected even though the original is live). Callers are expected to resolve ambiguous outcomes via reconciliation rather than retry here.

Matching-engine writes must carry their instrument so the venue’s per-instrument allowance is paced too; use the typed wrappers (Self::submit_order, Self::cancel_order, Self::replace_order) which pass it through Self::send_private_write.

Errors

Returns DeriveHttpError::MissingCredentials when the client was built without credentials. Other variants propagate from the transport or the venue.

pub async fn get_instruments( &self, currency: &str, instrument_type: DeriveInstrumentType, expired: bool, ) -> Result<Vec<DeriveInstrument>>

Fetches the venue’s listed instruments.

currency is the perpetual/option underlying (e.g. "ETH"). When expired is true the venue includes expired option strikes.

Errors

Propagates DeriveHttpError for transport, HTTP, and JSON-RPC failures.

pub async fn get_instrument( &self, instrument_name: &str, ) -> Result<DeriveInstrument>

Fetches a single instrument definition by name.

Mirrors public/get_instrument, which the venue documents as the per-asset variant of public/get_instruments. The returned record matches one row of the bulk endpoint.

Errors

Propagates DeriveHttpError for transport, HTTP, and JSON-RPC failures.

pub async fn get_trade_history( &self, instrument_name: &str, from_timestamp: Option<i64>, to_timestamp: Option<i64>, page: u32, page_size: u32, ) -> Result<DerivePublicTradesResult>

Fetches a page of public trade history for the instrument.

from_timestamp / to_timestamp are UNIX milliseconds and bound the returned window. page is 1-indexed; page_size is capped by the venue at 1000.

Errors

Propagates DeriveHttpError for transport, HTTP, and JSON-RPC failures.

pub async fn get_funding_rate_history( &self, instrument_name: &str, start_timestamp: Option<i64>, end_timestamp: Option<i64>, period: Option<u32>, ) -> Result<DerivePublicFundingRateHistoryResult>

Fetches the public funding rate history for the instrument.

start_timestamp / end_timestamp are UNIX milliseconds. period, if provided, selects the sample interval in seconds.

Errors

Propagates DeriveHttpError for transport, HTTP, and JSON-RPC failures.

pub async fn get_candles( &self, instrument_name: &str, start_timestamp: i64, end_timestamp: i64, period: u32, ) -> Result<Vec<DerivePublicCandle>>

Fetches OHLCV candles via public/get_tradingview_chart_data.

start_timestamp / end_timestamp are UNIX seconds and bound the returned window. period is the bucket size in seconds; the venue accepts 60, 300, 900, 1800, 3600, 14400, 28800, 86400, and 604800. The venue ships result as a flat array; the client decodes it directly into Vec<DerivePublicCandle>.

Errors

Propagates DeriveHttpError for transport, HTTP, and JSON-RPC failures.

pub async fn get_tickers( &self, instrument_type: DeriveInstrumentType, currency: Option<&str>, expiry_date: Option<&str>, ) -> Result<DeriveTickersResult>

Fetches current ticker snapshots.

currency is the underlying ("ETH", "BTC", etc.). Options require both currency and expiry_date; perps and ERC-20 spot pairs reject expiry_date.

Errors

Propagates DeriveHttpError for transport, HTTP, and JSON-RPC failures.

pub async fn get_ticker( &self, instrument_name: &str, ) -> Result<DeriveTickerSnapshot>

Fetches the current ticker snapshot for one instrument.

This is a single-instrument convenience wrapper over public/get_tickers, which replaced Derive’s deprecated public/get_ticker RPC.

Errors

Propagates DeriveHttpError for transport, HTTP, JSON-RPC failures, or when the response omits the requested instrument.

pub async fn submit_order( &self, params: &DeriveOrderParams, ) -> Result<DeriveOrder>

Submits a signed order to the venue.

params must be the fully-built signed private/order body.

Errors

Returns DeriveHttpError::MissingCredentials when no credentials were installed; otherwise propagates transport and venue errors.

pub async fn cancel_order( &self, params: &DeriveCancelParams, ) -> Result<DeriveEmptyResult>

Cancels a single order by venue order id.

Errors

Returns DeriveHttpError::MissingCredentials when no credentials were installed; otherwise propagates transport and venue errors.

pub async fn cancel_all( &self, params: &DeriveCancelAllParams, ) -> Result<DeriveEmptyResult>

Cancels every open order on the subaccount, optionally scoped to an instrument.

Errors

Returns DeriveHttpError::MissingCredentials when no credentials were installed; otherwise propagates transport and venue errors.

pub async fn cancel_by_label( &self, params: &DeriveCancelByLabelParams, ) -> Result<DeriveCancelByLabelResult>

Cancels every open order for the given user label on the subaccount.

Errors

Returns DeriveHttpError::MissingCredentials when no credentials were installed; otherwise propagates transport and venue errors.

pub async fn replace_order( &self, params: &DeriveReplaceParams, ) -> Result<DeriveReplaceOutcome>

Submits a signed private/replace request that cancels one order before creating its replacement.

params must be the fully-built typed request body.

Errors

Returns DeriveHttpError::MissingCredentials when no credentials were installed; otherwise propagates transport and venue errors.

pub async fn get_subaccount( &self, params: &DeriveGetSubaccountParams, ) -> Result<DeriveSubaccount>

Returns the subaccount snapshot including margin, balances, and open orders.

Errors

Returns DeriveHttpError::MissingCredentials when no credentials were installed; otherwise propagates transport and venue errors.

pub async fn get_open_orders( &self, params: &DeriveGetOpenOrdersParams, ) -> Result<DeriveOpenOrdersResult>

Returns currently open orders for the subaccount.

Errors

Returns DeriveHttpError::MissingCredentials when no credentials were installed; otherwise propagates transport and venue errors.

pub async fn get_trigger_orders( &self, params: &DeriveGetTriggerOrdersParams, ) -> Result<DeriveOpenOrdersResult>

Returns currently untriggered trigger orders for the subaccount.

Errors

Returns DeriveHttpError::MissingCredentials when no credentials were installed; otherwise propagates transport and venue errors.

pub async fn get_order( &self, params: &DeriveGetOrderParams, ) -> Result<DeriveOrder>

Returns a single order by venue order id.

Errors

Returns DeriveHttpError::MissingCredentials when no credentials were installed; otherwise propagates transport and venue errors.

pub async fn get_order_history( &self, params: &DeriveGetOrderHistoryParams, ) -> Result<DeriveOrdersResult>

Returns one page of order history for the subaccount, optionally scoped to an instrument and time window.

from_timestamp / to_timestamp are UNIX milliseconds. page is 1-indexed and page_size is capped by the venue at 1000.

Errors

Returns DeriveHttpError::MissingCredentials when no credentials were installed; otherwise propagates transport and venue errors.

pub async fn get_private_trade_history( &self, params: &DeriveGetTradeHistoryParams, ) -> Result<DeriveTradesResult>

Returns one page of subaccount trade history.

Errors

Returns DeriveHttpError::MissingCredentials when no credentials were installed; otherwise propagates transport and venue errors.

pub async fn get_positions( &self, params: &DeriveGetPositionsParams, ) -> Result<DerivePositionsResult>

Returns the positions held by the subaccount.

Errors

Returns DeriveHttpError::MissingCredentials when no credentials were installed; otherwise propagates transport and venue errors.

Trait Implementations

impl Clone for DeriveHttpClient

fn clone(&self) -> DeriveHttpClient

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DeriveHttpClient

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

Formats the value using the given formatter.