Struct OhlcvRequestBuilder

Source

pub struct OhlcvRequestBuilder { /* private fields */ }

Expand description

Builder for OhlcvRequest with validation.

The builder provides a fluent API for constructing OHLCV requests. The symbol field is required, while all other fields have sensible defaults or are optional.

§Default Values

timeframe: “1h” (1 hour)
since: None
limit: None
until: None

§Examples

use ccxt_core::types::ohlcv_request::OhlcvRequestBuilder;

// Minimal request (only symbol required)
let request = OhlcvRequestBuilder::new()
    .symbol("ETH/USDT")
    .build()
    .expect("Valid request");

// Full request with all options
let request = OhlcvRequestBuilder::new()
    .symbol("BTC/USDT")
    .timeframe("15m")
    .since(1609459200000)
    .limit(500)
    .until(1609545600000)
    .build()
    .expect("Valid request");

Implementations§

Source §

impl OhlcvRequestBuilder

Source

pub fn new() -> OhlcvRequestBuilder

Creates a new OhlcvRequestBuilder with default values.

Source

pub fn symbol(self, symbol: impl Into<String>) -> OhlcvRequestBuilder

Sets the trading symbol (required).

§Arguments

symbol - Trading pair symbol (e.g., “BTC/USDT”)

§Examples

use ccxt_core::types::ohlcv_request::OhlcvRequestBuilder;

let builder = OhlcvRequestBuilder::new()
    .symbol("BTC/USDT");

Source

pub fn timeframe(self, timeframe: impl Into<String>) -> OhlcvRequestBuilder

Sets the candlestick timeframe/interval (optional, defaults to “1h”).

Common timeframes:

“1m”, “3m”, “5m”, “15m”, “30m” (minutes)
“1h”, “2h”, “4h”, “6h”, “8h”, “12h” (hours)
“1d”, “3d” (days)
“1w” (week)
“1M” (month)

§Arguments

timeframe - Candlestick interval string

§Examples

use ccxt_core::types::ohlcv_request::OhlcvRequestBuilder;

let builder = OhlcvRequestBuilder::new()
    .symbol("BTC/USDT")
    .timeframe("4h");

Source

pub fn since(self, since: i64) -> OhlcvRequestBuilder

Sets the start timestamp in milliseconds (optional).

Only candles with timestamp >= since will be returned.

§Arguments

since - Unix timestamp in milliseconds

§Examples

use ccxt_core::types::ohlcv_request::OhlcvRequestBuilder;

let builder = OhlcvRequestBuilder::new()
    .symbol("BTC/USDT")
    .since(1609459200000); // 2021-01-01 00:00:00 UTC

Source

pub fn limit(self, limit: u32) -> OhlcvRequestBuilder

Sets the maximum number of candles to return (optional).

Most exchanges have a maximum limit (typically 500-1500).

§Arguments

limit - Maximum number of candles

§Examples

use ccxt_core::types::ohlcv_request::OhlcvRequestBuilder;

let builder = OhlcvRequestBuilder::new()
    .symbol("BTC/USDT")
    .limit(100);

Source

pub fn until(self, until: i64) -> OhlcvRequestBuilder

Sets the end timestamp in milliseconds (optional).

Only candles with timestamp <= until will be returned.

§Arguments

until - Unix timestamp in milliseconds

§Examples

use ccxt_core::types::ohlcv_request::OhlcvRequestBuilder;

let builder = OhlcvRequestBuilder::new()
    .symbol("BTC/USDT")
    .until(1609545600000); // 2021-01-02 00:00:00 UTC

Source

pub fn build(self) -> Result<OhlcvRequest, Error>

Builds the OhlcvRequest with validation.

§Returns

Ok(OhlcvRequest) if the symbol is provided
Err(Error) if the symbol is missing

§Default Values

timeframe defaults to “1h” if not specified

§Examples

use ccxt_core::types::ohlcv_request::OhlcvRequestBuilder;

// Valid request
let request = OhlcvRequestBuilder::new()
    .symbol("BTC/USDT")
    .build()
    .expect("Valid request");

// Invalid request (missing symbol)
let result = OhlcvRequestBuilder::new()
    .timeframe("1h")
    .build();
assert!(result.is_err());