polymarket-hft 0.0.7

A high-frequency trading system for Polymarket with built-in API clients (Data API, CLOB, CLOB WebSocket, Gamma, RTDS) and CLI
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
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
//! CoinGecko API client.

use reqwest::Method;
use reqwest_middleware::ClientWithMiddleware;

use super::model::*;
use crate::client::http::{self, HttpClientConfig};

const BASE_URL: &str = "https://api.coingecko.com/api/v3";

/// Helper macro to add optional query parameters to a request.
macro_rules! add_optional_query {
    ($req:expr, $($key:literal => $value:expr),* $(,)?) => {{
        let mut req = $req;
        $(
            if let Some(ref v) = $value {
                req = req.query(&[($key, v)]);
            }
        )*
        req
    }};
}

/// Helper macro to add optional boolean query parameters.
macro_rules! add_optional_bool_query {
    ($req:expr, $($key:literal => $value:expr),* $(,)?) => {{
        let mut req = $req;
        $(
            if let Some(v) = $value {
                req = req.query(&[($key, if v { "true" } else { "false" })]);
            }
        )*
        req
    }};
}

/// CoinGecko API client.
#[derive(Clone)]
pub struct Client {
    inner: ClientWithMiddleware,
    api_key: String,
    base_url: String,
}

impl Client {
    /// Creates a new CoinGecko API client.
    pub fn new(api_key: impl Into<String>) -> Self {
        Self {
            inner: http::build_default_client().expect("Failed to build default HTTP client"),
            api_key: api_key.into(),
            base_url: BASE_URL.to_string(),
        }
    }

    /// Creates a new CoinGecko API client with custom configuration.
    pub fn with_config(api_key: impl Into<String>, config: HttpClientConfig) -> Self {
        Self {
            inner: config
                .build()
                .expect("Failed to build HTTP client with config"),
            api_key: api_key.into(),
            base_url: BASE_URL.to_string(),
        }
    }

    /// Sets the base URL (internal use or testing).
    #[allow(dead_code)]
    pub(crate) fn with_base_url(mut self, base_url: String) -> Self {
        self.base_url = base_url;
        self
    }

    /// Helper to create a request builder with the API key header.
    fn request(&self, method: Method, path: &str) -> reqwest_middleware::RequestBuilder {
        let url = format!("{}{}", self.base_url, path);
        self.inner
            .request(method, &url)
            .header("x-cg-demo-api-key", &self.api_key)
            .header("Accept", "application/json")
    }

    /// Get simple price for one or more coins.
    ///
    /// Returns simple price data for the specified coin IDs in the target currencies.
    pub async fn get_simple_price(
        &self,
        request: SimplePriceRequest,
    ) -> Result<SimplePriceResponse, CgError> {
        let req = self.request(Method::GET, "/simple/price");

        let req = req
            .query(&[("ids", &request.ids)])
            .query(&[("vs_currencies", &request.vs_currencies)]);

        let req = add_optional_bool_query!(req,
            "include_market_cap" => request.include_market_cap,
            "include_24hr_vol" => request.include_24hr_vol,
            "include_24hr_change" => request.include_24hr_change,
            "include_last_updated_at" => request.include_last_updated_at,
        );

        let response = req.send().await?;
        let data = response.json::<SimplePriceResponse>().await?;
        Ok(data)
    }

    /// Get list of all supported coins.
    ///
    /// Returns a list of all supported coins with id, name, and symbol.
    pub async fn get_coins_list(
        &self,
        request: CoinsListRequest,
    ) -> Result<CoinsListResponse, CgError> {
        let req = self.request(Method::GET, "/coins/list");

        let req = add_optional_bool_query!(req,
            "include_platform" => request.include_platform,
        );

        let response = req.send().await?;
        let data = response.json::<CoinsListResponse>().await?;
        Ok(data)
    }

    /// Get coin market data.
    ///
    /// Returns market data including price, market cap, volume for coins.
    pub async fn get_coins_markets(
        &self,
        request: CoinsMarketsRequest,
    ) -> Result<CoinsMarketsResponse, CgError> {
        let req = self.request(Method::GET, "/coins/markets");

        let req = req.query(&[("vs_currency", &request.vs_currency)]);

        let per_page_str = request.per_page.map(|v| v.to_string());
        let page_str = request.page.map(|v| v.to_string());

        let req = add_optional_query!(req,
            "ids" => request.ids,
            "category" => request.category,
            "order" => request.order,
            "per_page" => per_page_str,
            "page" => page_str,
            "price_change_percentage" => request.price_change_percentage,
            "locale" => request.locale,
            "precision" => request.precision,
        );

        let req = add_optional_bool_query!(req,
            "sparkline" => request.sparkline,
        );

        let response = req.send().await?;
        let data = response.json::<CoinsMarketsResponse>().await?;
        Ok(data)
    }

    /// Get trending search coins, NFTs, and categories.
    ///
    /// Returns the top trending coins, NFTs, and categories based on user searches.
    pub async fn get_trending(&self) -> Result<TrendingResponse, CgError> {
        let req = self.request(Method::GET, "/search/trending");
        let response = req.send().await?;
        let data = response.json::<TrendingResponse>().await?;
        Ok(data)
    }

    /// Get global cryptocurrency data.
    ///
    /// Returns global crypto statistics including total market cap, volume, and dominance.
    pub async fn get_global(&self) -> Result<GlobalResponse, CgError> {
        let req = self.request(Method::GET, "/global");
        let response = req.send().await?;
        let data = response.json::<GlobalResponse>().await?;
        Ok(data)
    }

    /// Get list of supported vs currencies.
    ///
    /// Returns all supported vs currencies for price queries.
    pub async fn get_supported_vs_currencies(
        &self,
    ) -> Result<SupportedVsCurrenciesResponse, CgError> {
        let req = self.request(Method::GET, "/simple/supported_vs_currencies");
        let response = req.send().await?;
        let data = response.json::<SupportedVsCurrenciesResponse>().await?;
        Ok(data)
    }

    /// Get list of exchanges.
    ///
    /// Returns all exchanges with trading volume data.
    pub async fn get_exchanges(
        &self,
        request: ExchangesRequest,
    ) -> Result<ExchangesResponse, CgError> {
        let req = self.request(Method::GET, "/exchanges");

        let per_page_str = request.per_page.map(|v| v.to_string());
        let page_str = request.page.map(|v| v.to_string());

        let req = add_optional_query!(req,
            "per_page" => per_page_str,
            "page" => page_str,
        );

        let response = req.send().await?;
        let data = response.json::<ExchangesResponse>().await?;
        Ok(data)
    }

    /// Get coin detail by ID.
    ///
    /// Returns comprehensive data for a specific coin.
    pub async fn get_coin(
        &self,
        request: CoinDetailRequest,
    ) -> Result<CoinDetailResponse, CgError> {
        let path = format!("/coins/{}", request.id);
        let req = self.request(Method::GET, &path);

        let req = add_optional_bool_query!(req,
            "localization" => request.localization,
            "tickers" => request.tickers,
            "market_data" => request.market_data,
            "community_data" => request.community_data,
            "developer_data" => request.developer_data,
            "sparkline" => request.sparkline,
        );

        let response = req.send().await?;
        let data = response.json::<CoinDetailResponse>().await?;
        Ok(data)
    }

    /// Get historical market chart data for a coin.
    ///
    /// Returns price, market cap, and volume over time.
    pub async fn get_coin_market_chart(
        &self,
        request: MarketChartRequest,
    ) -> Result<MarketChartResponse, CgError> {
        let path = format!("/coins/{}/market_chart", request.id);
        let req = self.request(Method::GET, &path);

        let req = req
            .query(&[("vs_currency", &request.vs_currency)])
            .query(&[("days", &request.days)]);

        let req = add_optional_query!(req,
            "interval" => request.interval,
        );

        let response = req.send().await?;
        let data = response.json::<MarketChartResponse>().await?;
        Ok(data)
    }

    /// Get historical data for a coin at a specific date.
    ///
    /// Returns market data snapshot for the specified date.
    pub async fn get_coin_history(
        &self,
        request: CoinHistoryRequest,
    ) -> Result<CoinHistoryResponse, CgError> {
        let path = format!("/coins/{}/history", request.id);
        let req = self.request(Method::GET, &path);

        let req = req.query(&[("date", &request.date)]);

        let req = add_optional_bool_query!(req,
            "localization" => request.localization,
        );

        let response = req.send().await?;
        let data = response.json::<CoinHistoryResponse>().await?;
        Ok(data)
    }

    /// Get OHLC candlestick data for a coin.
    ///
    /// Returns Open, High, Low, Close data for charting.
    pub async fn get_coin_ohlc(&self, request: OhlcRequest) -> Result<OhlcResponse, CgError> {
        let path = format!("/coins/{}/ohlc", request.id);
        let req = self.request(Method::GET, &path);

        let req = req
            .query(&[("vs_currency", &request.vs_currency)])
            .query(&[("days", &request.days)]);

        let response = req.send().await?;
        let data = response.json::<OhlcResponse>().await?;
        Ok(data)
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use wiremock::matchers::{method, path};
    use wiremock::{Mock, MockServer, ResponseTemplate};

    #[tokio::test]
    async fn test_get_simple_price() {
        let mock_server = MockServer::start().await;
        let client = Client::new("test-key").with_base_url(mock_server.uri());

        let response_body = r#"{
            "bitcoin": {
                "usd": 50000.0,
                "usd_market_cap": 950000000000.0,
                "usd_24h_vol": 20000000000.0,
                "usd_24h_change": 1.5
            }
        }"#;

        Mock::given(method("GET"))
            .and(path("/simple/price"))
            .respond_with(ResponseTemplate::new(200).set_body_string(response_body))
            .mount(&mock_server)
            .await;

        let request = SimplePriceRequest {
            ids: "bitcoin".to_string(),
            vs_currencies: "usd".to_string(),
            include_market_cap: Some(true),
            include_24hr_vol: Some(true),
            include_24hr_change: Some(true),
            ..Default::default()
        };

        let result = client.get_simple_price(request).await;
        assert!(result.is_ok());
        let response = result.unwrap();
        assert!(response.contains_key("bitcoin"));
        let bitcoin = response.get("bitcoin").unwrap();
        assert_eq!(bitcoin.get("usd").unwrap(), &Some(50000.0));
    }

    #[tokio::test]
    async fn test_get_coins_list() {
        let mock_server = MockServer::start().await;
        let client = Client::new("test-key").with_base_url(mock_server.uri());

        let response_body = r#"[
            {"id": "bitcoin", "symbol": "btc", "name": "Bitcoin"},
            {"id": "ethereum", "symbol": "eth", "name": "Ethereum"}
        ]"#;

        Mock::given(method("GET"))
            .and(path("/coins/list"))
            .respond_with(ResponseTemplate::new(200).set_body_string(response_body))
            .mount(&mock_server)
            .await;

        let request = CoinsListRequest::default();
        let result = client.get_coins_list(request).await;
        assert!(result.is_ok());
        let response = result.unwrap();
        assert_eq!(response.len(), 2);
        assert_eq!(response[0].id, "bitcoin");
        assert_eq!(response[1].id, "ethereum");
    }

    #[tokio::test]
    async fn test_get_coins_markets() {
        let mock_server = MockServer::start().await;
        let client = Client::new("test-key").with_base_url(mock_server.uri());

        let response_body = r#"[
            {
                "id": "bitcoin",
                "symbol": "btc",
                "name": "Bitcoin",
                "image": "https://example.com/btc.png",
                "current_price": 50000.0,
                "market_cap": 950000000000,
                "market_cap_rank": 1,
                "fully_diluted_valuation": 1050000000000,
                "total_volume": 20000000000,
                "high_24h": 51000.0,
                "low_24h": 49000.0,
                "price_change_24h": 1000.0,
                "price_change_percentage_24h": 2.0,
                "market_cap_change_24h": 10000000000,
                "market_cap_change_percentage_24h": 1.5,
                "circulating_supply": 19000000,
                "total_supply": 21000000,
                "max_supply": 21000000,
                "ath": 69000.0,
                "ath_change_percentage": -27.5,
                "ath_date": "2021-11-10T00:00:00.000Z",
                "atl": 67.81,
                "atl_change_percentage": 73700.0,
                "atl_date": "2013-07-06T00:00:00.000Z",
                "roi": null,
                "last_updated": "2024-01-01T00:00:00.000Z"
            }
        ]"#;

        Mock::given(method("GET"))
            .and(path("/coins/markets"))
            .respond_with(ResponseTemplate::new(200).set_body_string(response_body))
            .mount(&mock_server)
            .await;

        let request = CoinsMarketsRequest {
            vs_currency: "usd".to_string(),
            ids: Some("bitcoin".to_string()),
            per_page: Some(1),
            ..Default::default()
        };

        let result = client.get_coins_markets(request).await;
        assert!(result.is_ok());
        let response = result.unwrap();
        assert_eq!(response.len(), 1);
        assert_eq!(response[0].id, "bitcoin");
        assert_eq!(response[0].current_price, Some(50000.0));
    }

    #[tokio::test]
    async fn test_get_trending() {
        let mock_server = MockServer::start().await;
        let client = Client::new("test-key").with_base_url(mock_server.uri());

        let response_body = r#"{
            "coins": [
                {
                    "item": {
                        "id": "bitcoin",
                        "coin_id": 1,
                        "name": "Bitcoin",
                        "symbol": "BTC",
                        "market_cap_rank": 1,
                        "thumb": "https://example.com/btc-thumb.png",
                        "small": "https://example.com/btc-small.png",
                        "large": "https://example.com/btc-large.png",
                        "slug": "bitcoin",
                        "price_btc": 1.0,
                        "score": 0
                    }
                }
            ],
            "nfts": [],
            "categories": []
        }"#;

        Mock::given(method("GET"))
            .and(path("/search/trending"))
            .respond_with(ResponseTemplate::new(200).set_body_string(response_body))
            .mount(&mock_server)
            .await;

        let result = client.get_trending().await;
        assert!(result.is_ok());
        let response = result.unwrap();
        assert_eq!(response.coins.len(), 1);
        assert_eq!(response.coins[0].item.id, "bitcoin");
    }

    #[tokio::test]
    async fn test_get_global() {
        let mock_server = MockServer::start().await;
        let client = Client::new("test-key").with_base_url(mock_server.uri());

        let response_body = r#"{
            "data": {
                "active_cryptocurrencies": 10000,
                "upcoming_icos": 0,
                "ongoing_icos": 50,
                "ended_icos": 3000,
                "markets": 800,
                "total_market_cap": {
                    "usd": 2000000000000.0
                },
                "total_volume": {
                    "usd": 80000000000.0
                },
                "market_cap_percentage": {
                    "btc": 50.5,
                    "eth": 18.5
                },
                "market_cap_change_percentage_24h_usd": 1.5,
                "updated_at": 1704067200
            }
        }"#;

        Mock::given(method("GET"))
            .and(path("/global"))
            .respond_with(ResponseTemplate::new(200).set_body_string(response_body))
            .mount(&mock_server)
            .await;

        let result = client.get_global().await;
        assert!(result.is_ok());
        let response = result.unwrap();
        assert_eq!(response.data.active_cryptocurrencies, Some(10000));
        assert_eq!(response.data.market_cap_percentage.get("btc"), Some(&50.5));
    }
}