Struct CandlesRequest 

pub struct CandlesRequest {
    pub ticker: String,
    pub class_code: String,
    pub start_date: DateTime<Utc>,
    pub end_date: DateTime<Utc>,
    pub time_frame: String,
}

Parameters of BcsHttpClient::get_candles.

Sent as a query string. The broker allows at most 1440 bars per request.

Examples

use brokapi_bcs_protocol::http::models::CandlesRequest;
use chrono::{TimeZone, Utc};

let req = CandlesRequest {
    ticker: "SBER".into(),
    class_code: "TQBR".into(),
    start_date: Utc.with_ymd_and_hms(2026, 10, 19, 7, 0, 0).unwrap(),
    end_date: Utc.with_ymd_and_hms(2026, 10, 19, 8, 0, 0).unwrap(),
    time_frame: "M5".into(),
};
assert_eq!(
    serde_urlencoded::to_string(&req)?,
    "ticker=SBER&classCode=TQBR&startDate=2026-10-19T07%3A00%3A00.000Z&endDate=2026-10-19T08%3A00%3A00.000Z&timeFrame=M5"
);

Fields

ticker: String

Ticker.

class_code: String

Class code (board).

start_date: DateTime<Utc>

Start of the period (UTC).

end_date: DateTime<Utc>

End of the period (UTC).

time_frame: String

Time frame of a bar: M1, M5, M15, M30, H1, H4, D, W or MN. A string, so what you send is what the broker gets.

Trait Implementations

impl Clone for CandlesRequest

fn clone(&self) -> CandlesRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CandlesRequest

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

Formats the value using the given formatter.

impl Serialize for CandlesRequest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.