Struct datamaxi::cex::Candle

pub struct Candle {
    pub client: Client,
}

Provides methods for retrieving CEX candle data and related information.

Fields

client: Client

Implementations

impl Candle

pub fn get<E, S>( &self, exchange: E, symbol: S, options: CandleOptions, ) -> Result<CandleResponse>

where E: Into<String>, S: Into<String>,

Retrieves candle data for a specified exchange and symbol. Additional parameters can be provided to filter and sort the results. The response will contain an array of candle data objects, each representing a single candle with open, high, low, close, and volume values.

pub fn exchanges<M>(&self, market: M) -> Result<Vec<String>>

where M: Into<String>,

Retrieves a list of supported exchanges for candle data. The market parameter can be used to filter the results by market.

pub fn symbols<E>( &self, exchange: E, options: SymbolsOptions, ) -> Result<Vec<SymbolsResponse>>

where E: Into<String>,

Retrieves a list of supported symbols for candle data. The exchange parameter is required, and the market parameter can be used to filter the results by market.

pub fn intervals(&self) -> Result<Vec<String>>

Retrieves a list of supported candle intervals.

Trait Implementations

impl Clone for Candle

fn clone(&self) -> Candle

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Datamaxi for Candle

Implements the Datamaxi trait for Candle, providing methods to create new instances of Candle with or without a custom base URL.

fn new(api_key: String) -> Candle

Creates a new Candle instance with the default base URL.

Parameters

• api_key: A String representing the API key used for authentication in API requests.

Returns

A new Candle instance configured with the default base URL and the provided api_key.

Example

use crate::datamaxi::api::Datamaxi;
let candle = datamaxi::cex::Candle::new("my_api_key".to_string());

fn new_with_base_url(api_key: String, base_url: String) -> Candle

Creates a new Candle instance with a custom base URL.

Parameters

• api_key: A String representing the API key used for authentication in API requests.
• base_url: A String representing the custom base URL for API requests.

Returns

A new Candle instance configured with the specified base_url and api_key.

Example

use crate::datamaxi::api::Datamaxi;
let candle = datamaxi::cex::Candle::new_with_base_url("my_api_key".to_string(), "https://custom-api.example.com".to_string());