Skip to main content

tvscreener/core/
forex.rs

1// Copyright 2026 tvscreener-rs contributors
2// SPDX-License-Identifier: Apache-2.0
3
4//! [`ForexScreener`] (`TradingView` subtype `forex`).
5//!
6//! Default forex fields, name sort, and forex symbol query misc.
7
8use super::Screener;
9use crate::field::{default_forex_fields, forex_name};
10use serde_json::json;
11
12/// Forex screener with asset-class defaults
13#[derive(Debug, Clone)]
14pub struct ForexScreener {
15    inner: Screener,
16}
17
18impl ForexScreener {
19    /// Creates a screener with default forex fields and ascending name sort.
20    pub fn new() -> Self {
21        let mut inner = Screener::new("forex");
22        inner.set_url(crate::util::get_url("forex"));
23        inner.set_all_fields_fn(default_forex_fields);
24        inner.select(default_forex_fields());
25        inner.sort_by(forex_name().field_name, true);
26        inner.add_misc("symbols", json!({ "query": { "types": ["forex"] } }));
27        Self { inner }
28    }
29}
30
31impl_typed_screener_common!(ForexScreener);