cbr-client

Неофициальная Rust-библиотека для работы с API сервиса статистических данных Банка России: https://www.cbr.ru/statistics/data-service/APIdocumentation/.

Установка

[dependencies]
cbr-client = "0.1.1"

Пример (async)

use cbr_client::{CategoryId, CbrClient, DataNewQuery, IndicatorId, Year, YearSpan};

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = CbrClient::new()?;

    let years = YearSpan::new(Year::new(2021), Year::new(2021))?;
    let data = client
        .data_new(
            DataNewQuery::new(CategoryId::new(5)?, years)
                .with_i_ids([IndicatorId::new(7)?, IndicatorId::new(8)?]),
        )
        .await?;

    println!("rows: {}", data.row_data.len());
    Ok(())
}

Пример (blocking)

Для блокирующего клиента включите feature blocking:

[dependencies]
cbr-client = { version = "0.1.1", features = ["blocking"] }

use cbr_client::{
    BlockingCbrClient, DataQuery, DatasetId, MeasureId, PublicationId, Year, YearSpan,
};

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = BlockingCbrClient::new()?;
    let years = YearSpan::new(Year::new(2021), Year::new(2021))?;

    let data = client.data(
        DataQuery::new(years, DatasetId::new(38)?, PublicationId::new(18)?)
            .with_measure_id(MeasureId::new(2)?),
    )?;

    println!("raw rows: {}", data.raw_data.len());
    Ok(())
}

Пример: временной ряд USD/RUB

Готовый пример находится в examples/usd_rub_time_series.rs.

В модуле cbr_client::presets::fx доступны:

константные пресеты (SeriesPreset)
параметризованный runtime-резолвер:
- resolve_fx_series(client, FxPeriodicity, FxMetric)
- resolve_fx_series_blocking(...) (с feature blocking)

Настройка клиента

use std::time::Duration;
use cbr_client::CbrClient;

let client = CbrClient::builder()
    .base_url("https://www.cbr.ru/dataservice")
    .timeout(Duration::from_secs(15))
    .user_agent("my-app/1.0")
    .build()?;

Advanced API (кастомные типы)

Если нужно десериализовать ответ сразу в собственную структуру, используйте generic-методы:

async: request_json<T>(path) и request_json_with_query<T, Q>(path, &query)
blocking (feature blocking): request_json<T>(path) и request_json_with_query<T, Q>(path, &query)

path задаётся относительно base_url, ведущий / необязателен.

use serde::{Deserialize, Serialize};
use cbr_client::CbrClient;

#[derive(Debug, Deserialize)]
struct MyPayload {
    value: i32,
}

#[derive(Debug, Serialize)]
struct MyQuery {
    page: u32,
}

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = CbrClient::new()?;
    let _payload: MyPayload = client
        .request_json_with_query("/some-endpoint", &MyQuery { page: 1 })
        .await?;
    Ok(())
}

Работа через proxy

use cbr_client::CbrClient;

let client = CbrClient::builder()
    .proxy("http://127.0.0.1:8080")
    // Использование системных proxy-переменных окружения:
    //.use_system_proxy(true)
    .build()?;

cbr-client 0.1.1