polyio 0.13.0

A create for interacting with the Polygon API at polygon.io.
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
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126

// Copyright (C) 2020-2022 Daniel Mueller <deso@posteo.net>
// SPDX-License-Identifier: GPL-3.0-or-later

use serde::Deserialize;

use crate::Str;


/// An exchange as returned by the `/v1/meta/exchanges` endpoint.
///
/// Please note that not all fields available in a request are
/// represented here.
#[derive(Clone, Debug, Deserialize, PartialEq)]
pub struct Exchange {
  /// Exchange ID.
  #[serde(rename = "id")]
  pub id: usize,
  /// The type of exchange.
  #[serde(rename = "type")]
  pub type_: String,
  /// The type of market data the exchange provides.
  #[serde(rename = "market")]
  pub market: String,
  /// The exchange's name.
  #[serde(rename = "name")]
  pub name: String,
  /// The exchange's code.
  ///
  /// This field is seemingly only set for exchanges of type `Equities`.
  pub code: Option<String>,
}


Endpoint! {
  /// The representation of a GET request to the `/v1/meta/exchanges` endpoint.
  pub Get(()),
  Ok => Vec<Exchange>, [
    /// The exchanges information was retrieved successfully.
    /* 200 */ OK,
  ],
  Err => GetError, []

  fn path(_input: &Self::Input) -> Str {
    "/v1/meta/exchanges".into()
  }
}


#[cfg(test)]
mod tests {
  use super::*;

  use serde_json::from_str as from_json;

  #[cfg(not(target_arch = "wasm32"))]
  use test_log::test;

  #[cfg(not(target_arch = "wasm32"))]
  use crate::Client;


  #[test]
  fn parse_reference_exchanges() {
    let response = r#"[
  {
    "id": 1,
    "type": "exchange",
    "market": "equities",
    "mic": "XASE",
    "name": "NYSE American (AMEX)",
    "tape": "A"
  },
  {
    "id": 2,
    "type": "exchange",
    "market": "equities",
    "mic": "XBOS",
    "name": "NASDAQ OMX BX",
    "tape": "B"
  },
  {
    "id": 15,
    "type": "exchange",
    "market": "equities",
    "mic": "IEXG",
    "name": "IEX",
    "tape": "V"
  },
  {
    "id": 16,
    "type": "TRF",
    "market": "equities",
    "mic": "XCBO",
    "name": "Chicago Board Options Exchange",
    "tape": "W"
  }
]"#;

    let exchgs = from_json::<Vec<Exchange>>(response).unwrap();
    assert_eq!(exchgs.len(), 4);
    assert_eq!(exchgs[0].id, 1);
    assert_eq!(exchgs[0].type_, "exchange");
    assert_eq!(exchgs[0].market, "equities");
    assert_eq!(exchgs[0].name, "NYSE American (AMEX)");
    assert_eq!(exchgs[1].id, 2);
    assert_eq!(exchgs[2].id, 15);
    assert_eq!(exchgs[3].id, 16);
  }

  #[cfg(not(target_arch = "wasm32"))]
  #[test(tokio::test)]
  async fn request_exchanges() {
    let client = Client::from_env().unwrap();
    let exchgs = client.issue::<Get>(()).await.unwrap();

    assert!(!exchgs.is_empty());

    // We are in trouble if NYE cannot be found.
    let nye = exchgs
      .iter()
      .find(|exchg| exchg.code.as_deref() == Some("NYE"))
      .unwrap();
    assert_eq!(nye.type_, "exchange");
    assert_eq!(nye.market, "equities");
  }
}