longbridge 4.1.0

Longbridge OpenAPI SDK for Rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97

#![allow(missing_docs)]

use rust_decimal::Decimal;
use serde::{Deserialize, Serialize};

use crate::utils::counter::deserialize_counter_id_as_symbol;

/// Response for [`crate::AlertContext::list`]
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct AlertList {
    /// Alert groups per security
    pub lists: Vec<AlertSymbolGroup>,
}

/// Alert items for one security
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct AlertSymbolGroup {
    /// Security symbol
    #[serde(
        rename = "counter_id",
        deserialize_with = "deserialize_counter_id_as_symbol"
    )]
    pub symbol: String,
    /// Ticker code (without market)
    pub code: String,
    /// Market, e.g. `"HK"`
    pub market: String,
    /// Security name
    pub name: String,
    /// Latest price
    #[serde(with = "crate::serde_utils::decimal_opt_str_is_none")]
    pub price: Option<Decimal>,
    /// Day change amount
    #[serde(with = "crate::serde_utils::decimal_opt_str_is_none")]
    pub chg: Option<Decimal>,
    /// Day change percentage
    #[serde(with = "crate::serde_utils::decimal_opt_str_is_none")]
    pub p_chg: Option<Decimal>,
    /// Product type (may be empty)
    #[serde(default)]
    pub product: String,
    /// Alert items
    pub indicators: Vec<AlertItem>,
}

/// One price alert
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct AlertItem {
    /// Alert ID
    pub id: String,
    /// Condition: "1"=price_rise, "2"=price_fall, "3"=pct_rise, "4"=pct_fall
    pub indicator_id: String,
    /// Whether the alert is active
    pub enabled: bool,
    /// Frequency: 1=daily, 2=every_time, 3=once
    pub frequency: i32,
    /// Scope
    pub scope: i32,
    /// Display text, e.g. "价格涨到 600"
    pub text: String,
    /// Trigger state flags
    #[serde(default)]
    pub state: Vec<i32>,
    /// Trigger value: `{"price":"500"}` or `{"chg":"5"}`
    pub value_map: serde_json::Value,
}

/// Alert condition
#[derive(Debug, Copy, Clone, Eq, PartialEq, Serialize, Deserialize)]
pub enum AlertCondition {
    /// Price rises above threshold
    #[serde(rename = "1")]
    PriceRise = 1,
    /// Price falls below threshold
    #[serde(rename = "2")]
    PriceFall = 2,
    /// Percentage rise above threshold
    #[serde(rename = "3")]
    PercentRise = 3,
    /// Percentage fall below threshold
    #[serde(rename = "4")]
    PercentFall = 4,
}

/// Alert trigger frequency
#[derive(Debug, Copy, Clone, Eq, PartialEq, Serialize, Deserialize)]
pub enum AlertFrequency {
    /// Trigger once per day
    #[serde(rename = "1")]
    Daily = 1,
    /// Trigger every time condition is met
    #[serde(rename = "2")]
    EveryTime = 2,
    /// Trigger only once
    #[serde(rename = "3")]
    Once = 3,
}