polyoxide-data 0.13.0

Rust client library for Polymarket Data API
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
use polyoxide_core::{HttpClient, QueryBuilder, Request};
use serde::{Deserialize, Serialize};

use crate::{
    error::DataApiError,
    types::{
        Activity, ActivitySortBy, ActivityType, ClosedPosition, ClosedPositionSortBy, Position,
        PositionSortBy, SortDirection, Trade, TradeFilterType, TradeSide, UserValue,
    },
};

/// User namespace for user-related operations
#[derive(Clone)]
pub struct UserApi {
    pub(crate) http_client: HttpClient,
    pub(crate) user_address: String,
}

impl UserApi {
    /// List positions for this user
    pub fn list_positions(&self) -> ListPositions {
        let mut request = Request::new(self.http_client.clone(), "/positions");
        request = request.query("user", &self.user_address);

        ListPositions { request }
    }

    /// Get total value of this user's positions
    pub fn positions_value(&self) -> GetPositionValue {
        let mut request = Request::new(self.http_client.clone(), "/value");
        request = request.query("user", &self.user_address);

        GetPositionValue { request }
    }

    /// List closed positions for this user
    pub fn closed_positions(&self) -> ListClosedPositions {
        let mut request = Request::new(self.http_client.clone(), "/closed-positions");
        request = request.query("user", &self.user_address);

        ListClosedPositions { request }
    }

    /// List trades for this user
    pub fn trades(&self) -> ListUserTrades {
        let mut request = Request::new(self.http_client.clone(), "/trades");
        request = request.query("user", &self.user_address);

        ListUserTrades { request }
    }

    /// List activity for this user
    pub fn activity(&self) -> ListActivity {
        let mut request = Request::new(self.http_client.clone(), "/activity");
        request = request.query("user", &self.user_address);

        ListActivity { request }
    }

    /// Get total markets traded by this user
    pub async fn traded(&self) -> Result<UserTraded, DataApiError> {
        Request::<UserTraded, DataApiError>::new(self.http_client.clone(), "/traded")
            .query("user", &self.user_address)
            .send()
            .await
    }
}

/// User's total markets traded count
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct UserTraded {
    /// User address
    pub user: String,
    /// Total count of distinct markets traded
    pub traded: u64,
}

/// Request builder for listing user positions
pub struct ListPositions {
    request: Request<Vec<Position>, DataApiError>,
}

impl ListPositions {
    /// Filter by specific market condition IDs (comma-separated)
    pub fn market(mut self, condition_ids: impl IntoIterator<Item = impl ToString>) -> Self {
        let ids: Vec<String> = condition_ids.into_iter().map(|s| s.to_string()).collect();
        if !ids.is_empty() {
            self.request = self.request.query("market", ids.join(","));
        }
        self
    }

    /// Filter by event IDs (comma-separated)
    pub fn event_id(mut self, event_ids: impl IntoIterator<Item = impl ToString>) -> Self {
        let ids: Vec<String> = event_ids.into_iter().map(|s| s.to_string()).collect();
        if !ids.is_empty() {
            self.request = self.request.query("eventId", ids.join(","));
        }
        self
    }

    /// Set minimum position size filter (default: 1)
    pub fn size_threshold(mut self, threshold: f64) -> Self {
        self.request = self.request.query("sizeThreshold", threshold);
        self
    }

    /// Filter for redeemable positions only
    pub fn redeemable(mut self, redeemable: bool) -> Self {
        self.request = self.request.query("redeemable", redeemable);
        self
    }

    /// Filter for mergeable positions only
    pub fn mergeable(mut self, mergeable: bool) -> Self {
        self.request = self.request.query("mergeable", mergeable);
        self
    }

    /// Set maximum number of results (0-500, default: 100)
    pub fn limit(mut self, limit: u32) -> Self {
        self.request = self.request.query("limit", limit);
        self
    }

    /// Set pagination offset (0-10000, default: 0)
    pub fn offset(mut self, offset: u32) -> Self {
        self.request = self.request.query("offset", offset);
        self
    }

    /// Set sort field
    pub fn sort_by(mut self, sort_by: PositionSortBy) -> Self {
        self.request = self.request.query("sortBy", sort_by);
        self
    }

    /// Set sort direction (default: DESC)
    pub fn sort_direction(mut self, direction: SortDirection) -> Self {
        self.request = self.request.query("sortDirection", direction);
        self
    }

    /// Filter by market title (max 100 chars)
    pub fn title(mut self, title: impl Into<String>) -> Self {
        self.request = self.request.query("title", title.into());
        self
    }

    /// Execute the request
    pub async fn send(self) -> Result<Vec<Position>, DataApiError> {
        self.request.send().await
    }
}

/// Request builder for getting total position value
pub struct GetPositionValue {
    request: Request<Vec<UserValue>, DataApiError>,
}

impl GetPositionValue {
    /// Filter by specific market condition IDs (comma-separated)
    pub fn market(mut self, condition_ids: impl IntoIterator<Item = impl ToString>) -> Self {
        let ids: Vec<String> = condition_ids.into_iter().map(|s| s.to_string()).collect();
        if !ids.is_empty() {
            self.request = self.request.query("market", ids.join(","));
        }
        self
    }

    /// Execute the request
    pub async fn send(self) -> Result<Vec<UserValue>, DataApiError> {
        self.request.send().await
    }
}

/// Request builder for listing closed positions
pub struct ListClosedPositions {
    request: Request<Vec<ClosedPosition>, DataApiError>,
}

impl ListClosedPositions {
    /// Filter by specific market condition IDs (comma-separated)
    pub fn market(mut self, condition_ids: impl IntoIterator<Item = impl ToString>) -> Self {
        let ids: Vec<String> = condition_ids.into_iter().map(|s| s.to_string()).collect();
        if !ids.is_empty() {
            self.request = self.request.query("market", ids.join(","));
        }
        self
    }

    /// Filter by event IDs (comma-separated)
    pub fn event_id(mut self, event_ids: impl IntoIterator<Item = impl ToString>) -> Self {
        let ids: Vec<String> = event_ids.into_iter().map(|s| s.to_string()).collect();
        if !ids.is_empty() {
            self.request = self.request.query("eventId", ids.join(","));
        }
        self
    }

    /// Filter by market title (max 100 chars)
    pub fn title(mut self, title: impl Into<String>) -> Self {
        self.request = self.request.query("title", title.into());
        self
    }

    /// Set maximum number of results (0-50, default: 10)
    pub fn limit(mut self, limit: u32) -> Self {
        self.request = self.request.query("limit", limit);
        self
    }

    /// Set pagination offset (0-100000, default: 0)
    pub fn offset(mut self, offset: u32) -> Self {
        self.request = self.request.query("offset", offset);
        self
    }

    /// Set sort field (default: REALIZEDPNL)
    pub fn sort_by(mut self, sort_by: ClosedPositionSortBy) -> Self {
        self.request = self.request.query("sortBy", sort_by);
        self
    }

    /// Set sort direction (default: DESC)
    pub fn sort_direction(mut self, direction: SortDirection) -> Self {
        self.request = self.request.query("sortDirection", direction);
        self
    }

    /// Execute the request
    pub async fn send(self) -> Result<Vec<ClosedPosition>, DataApiError> {
        self.request.send().await
    }
}

/// Request builder for listing user trades
pub struct ListUserTrades {
    request: Request<Vec<Trade>, DataApiError>,
}

impl ListUserTrades {
    /// Filter by market condition IDs (comma-separated)
    /// Note: Mutually exclusive with `event_id`
    pub fn market(mut self, condition_ids: impl IntoIterator<Item = impl ToString>) -> Self {
        let ids: Vec<String> = condition_ids.into_iter().map(|s| s.to_string()).collect();
        if !ids.is_empty() {
            self.request = self.request.query("market", ids.join(","));
        }
        self
    }

    /// Filter by event IDs (comma-separated)
    /// Note: Mutually exclusive with `market`
    pub fn event_id(mut self, event_ids: impl IntoIterator<Item = impl ToString>) -> Self {
        let ids: Vec<String> = event_ids.into_iter().map(|s| s.to_string()).collect();
        if !ids.is_empty() {
            self.request = self.request.query("eventId", ids.join(","));
        }
        self
    }

    /// Filter by trade side (BUY or SELL)
    pub fn side(mut self, side: TradeSide) -> Self {
        self.request = self.request.query("side", side);
        self
    }

    /// Filter for taker trades only (default: true)
    pub fn taker_only(mut self, taker_only: bool) -> Self {
        self.request = self.request.query("takerOnly", taker_only);
        self
    }

    /// Set filter type (must be paired with `filter_amount`)
    pub fn filter_type(mut self, filter_type: TradeFilterType) -> Self {
        self.request = self.request.query("filterType", filter_type);
        self
    }

    /// Set filter amount (must be paired with `filter_type`)
    pub fn filter_amount(mut self, amount: f64) -> Self {
        self.request = self.request.query("filterAmount", amount);
        self
    }

    /// Set maximum number of results (0-10000, default: 100)
    pub fn limit(mut self, limit: u32) -> Self {
        self.request = self.request.query("limit", limit);
        self
    }

    /// Set pagination offset (0-10000, default: 0)
    pub fn offset(mut self, offset: u32) -> Self {
        self.request = self.request.query("offset", offset);
        self
    }

    /// Execute the request
    pub async fn send(self) -> Result<Vec<Trade>, DataApiError> {
        self.request.send().await
    }
}

/// Request builder for listing user activity
pub struct ListActivity {
    request: Request<Vec<Activity>, DataApiError>,
}

impl ListActivity {
    /// Filter by market condition IDs (comma-separated)
    pub fn market(mut self, condition_ids: impl IntoIterator<Item = impl ToString>) -> Self {
        let ids: Vec<String> = condition_ids.into_iter().map(|s| s.to_string()).collect();
        if !ids.is_empty() {
            self.request = self.request.query("market", ids.join(","));
        }
        self
    }

    /// Filter by event IDs (comma-separated)
    pub fn event_id(mut self, event_ids: impl IntoIterator<Item = impl ToString>) -> Self {
        let ids: Vec<String> = event_ids.into_iter().map(|s| s.to_string()).collect();
        if !ids.is_empty() {
            self.request = self.request.query("eventId", ids.join(","));
        }
        self
    }

    /// Filter by activity types (comma-separated)
    pub fn activity_type(mut self, types: impl IntoIterator<Item = ActivityType>) -> Self {
        let type_strs: Vec<String> = types.into_iter().map(|t| t.to_string()).collect();
        if !type_strs.is_empty() {
            self.request = self.request.query("type", type_strs.join(","));
        }
        self
    }

    /// Filter by trade side (BUY or SELL)
    pub fn side(mut self, side: TradeSide) -> Self {
        self.request = self.request.query("side", side);
        self
    }

    /// Set start timestamp filter
    pub fn start(mut self, timestamp: i64) -> Self {
        self.request = self.request.query("start", timestamp);
        self
    }

    /// Set end timestamp filter
    pub fn end(mut self, timestamp: i64) -> Self {
        self.request = self.request.query("end", timestamp);
        self
    }

    /// Set maximum number of results (0-10000, default: 100)
    pub fn limit(mut self, limit: u32) -> Self {
        self.request = self.request.query("limit", limit);
        self
    }

    /// Set pagination offset (0-10000, default: 0)
    pub fn offset(mut self, offset: u32) -> Self {
        self.request = self.request.query("offset", offset);
        self
    }

    /// Set sort field (default: TIMESTAMP)
    pub fn sort_by(mut self, sort_by: ActivitySortBy) -> Self {
        self.request = self.request.query("sortBy", sort_by);
        self
    }

    /// Set sort direction (default: DESC)
    pub fn sort_direction(mut self, direction: SortDirection) -> Self {
        self.request = self.request.query("sortDirection", direction);
        self
    }

    /// Execute the request
    pub async fn send(self) -> Result<Vec<Activity>, DataApiError> {
        self.request.send().await
    }
}

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

    #[test]
    fn deserialize_user_traded() {
        let json = r#"{"user": "0xabcdef1234567890", "traded": 42}"#;
        let ut: UserTraded = serde_json::from_str(json).unwrap();
        assert_eq!(ut.user, "0xabcdef1234567890");
        assert_eq!(ut.traded, 42);
    }

    #[test]
    fn deserialize_user_traded_zero() {
        let json = r#"{"user": "0x0000000000000000000000000000000000000001", "traded": 0}"#;
        let ut: UserTraded = serde_json::from_str(json).unwrap();
        assert_eq!(ut.traded, 0);
    }

    #[test]
    fn user_traded_roundtrip() {
        let original = UserTraded {
            user: "0x1234".to_string(),
            traded: 100,
        };
        let json = serde_json::to_string(&original).unwrap();
        let deserialized: UserTraded = serde_json::from_str(&json).unwrap();
        assert_eq!(deserialized.user, original.user);
        assert_eq!(deserialized.traded, original.traded);
    }
}