Struct Client 

pub struct Client { /* private fields */ }

The async client for interacting with the Datamaxi+ API.

This is the default surface. For a synchronous client, enable the sync feature and use [sync::Client].

Cloning a Client is cheap: the shared state lives behind an Arc, so a clone is a single refcount bump.

Implementations

impl Client

pub fn new(api_key: impl Into<String>) -> Self

Creates a new client authenticating with the given API key.

Uses the production base URL and the default timeout ([DEFAULT_TIMEOUT]). For control over the base URL, timeout, or reading the API key from the environment, use ClientBuilder. Endpoint groups are reached via accessors, e.g. Client::cex_candle.

pub async fn get<T: DeserializeOwned>( &self, endpoint: &str, parameters: Option<BTreeMap<String, String>>, ) -> Result<T>

Sends a GET request to the specified endpoint with optional parameters.

Transient failures (timeouts, connection errors, 429, and 5xx) are retried per the client’s [RetryConfig] with exponential backoff; a 429 honors its Retry-After header. Fatal statuses (400/401/403/404) are returned without retry.

With the tracing feature enabled, each call is wrapped in a span carrying method, endpoint, attempt, and the resolved status; retries additionally emit a debug event with the backoff delay. The API key is never recorded.

pub fn paginate<T>( &self, endpoint: impl Into<String>, params: BTreeMap<String, String>, ) -> Paginator<T>

where T: Paginated + DeserializeOwned,

Returns an auto-paginator over a paged endpoint (see Paginated).

params seeds the query string for every page (e.g. limit, sort, filters); a page key in params sets the starting page (defaults to 1) and is overwritten on each subsequent request as the paginator advances. Call Paginator::next_page in a loop to walk forward.

impl Client

pub fn announcements(&self) -> Announcements

Returns a handle to the Announcements endpoint group.

pub fn cex_candle(&self) -> CexCandle

Returns a handle to the CexCandle endpoint group.

pub fn cex_symbol(&self) -> CexSymbol

Returns a handle to the CexSymbol endpoint group.

pub fn forex(&self) -> Forex

Returns a handle to the Forex endpoint group.

pub fn funding_rate(&self) -> FundingRate

Returns a handle to the FundingRate endpoint group.

pub fn index_price(&self) -> IndexPrice

Returns a handle to the IndexPrice endpoint group.

pub fn liquidation(&self) -> Liquidation

Returns a handle to the Liquidation endpoint group.

pub fn listing(&self) -> Listing

Returns a handle to the Listing endpoint group.

pub fn margin_borrow(&self) -> MarginBorrow

Returns a handle to the MarginBorrow endpoint group.

pub fn naver_trend(&self) -> NaverTrend

Returns a handle to the NaverTrend endpoint group.

pub fn open_interest(&self) -> OpenInterest

Returns a handle to the OpenInterest endpoint group.

pub fn premium(&self) -> Premium

Returns a handle to the Premium endpoint group.

pub fn telegram(&self) -> Telegram

Returns a handle to the Telegram endpoint group.

pub fn ticker(&self) -> Ticker

Returns a handle to the Ticker endpoint group.

pub fn token(&self) -> Token

Returns a handle to the Token endpoint group.

pub fn trading_fees(&self) -> TradingFees

Returns a handle to the TradingFees endpoint group.

pub fn wallet_status(&self) -> WalletStatus

Returns a handle to the WalletStatus endpoint group.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Client

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

Redacts the API key so it never leaks into logs or error output.