@apicity/polymarket 0.4.2 → 0.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -28,9 +28,13 @@ import { createPolymarket } from "@apicity/polymarket";
28
28
  const polymarket = createPolymarket();
29
29
  ```
30
30
 
31
+ ## Unsupported Upstream Paths
32
+
33
+ The current Polymarket OpenAPI specs mark some paths as `x-excluded`; `@apicity/polymarket` intentionally does not expose wrappers for those unsupported surfaces. That includes Gamma administrative/private paths such as team detail, event pagination/results/comment-count, market information and abridged POST endpoints, series summaries, and private profile lookups, plus Data `/revisions` and `/other`.
34
+
31
35
  ## API Reference
32
36
 
33
- 71 endpoints across 3 groups. Each method mirrors an upstream URL path.
37
+ 108 endpoints across 3 groups. Each method mirrors an upstream URL path.
34
38
 
35
39
  ### clob
36
40
 
@@ -39,7 +43,7 @@ const polymarket = createPolymarket();
39
43
 
40
44
  <code>DELETE https://clob.polymarket.com/auth/api-key</code>
41
45
 
42
- [Upstream docs ↗](https://docs.polymarket.com/api-reference/authentication)
46
+ [Upstream docs ↗](https://docs.polymarket.com/api-reference/authentication.md)
43
47
 
44
48
  ```typescript
45
49
  const res = await polymarket.clob.auth.apiKey({ /* ... */ });
@@ -49,12 +53,27 @@ Source: [`packages/provider/polymarket/src/clob.ts`](src/clob.ts)
49
53
 
50
54
  </details>
51
55
 
56
+ <details>
57
+ <summary><code>DELETE</code> <b><code>polymarket.clob.auth.builderApiKey</code></b></summary>
58
+
59
+ <code>DELETE https://clob.polymarket.com/auth/builder-api-key</code>
60
+
61
+ [Upstream docs ↗](https://docs.polymarket.com/api-spec/clob-openapi.yaml)
62
+
63
+ ```typescript
64
+ const res = await polymarket.clob.auth.builderApiKey({ /* ... */ });
65
+ ```
66
+
67
+ Source: [`packages/provider/polymarket/src/clob.ts`](src/clob.ts)
68
+
69
+ </details>
70
+
52
71
  <details>
53
72
  <summary><code>DELETE</code> <b><code>polymarket.clob.cancelAll</code></b></summary>
54
73
 
55
74
  <code>DELETE https://clob.polymarket.com/cancel-all</code>
56
75
 
57
- [Upstream docs ↗](https://docs.polymarket.com/api-reference/trade/cancel-all-orders)
76
+ [Upstream docs ↗](https://docs.polymarket.com/api-reference/trade/cancel-all-orders.md)
58
77
 
59
78
  ```typescript
60
79
  const res = await polymarket.clob.cancelAll({ /* ... */ });
@@ -69,7 +88,7 @@ Source: [`packages/provider/polymarket/src/clob.ts`](src/clob.ts)
69
88
 
70
89
  <code>DELETE https://clob.polymarket.com/cancel-market-orders</code>
71
90
 
72
- [Upstream docs ↗](https://docs.polymarket.com/api-reference/trade/cancel-orders-for-a-market)
91
+ [Upstream docs ↗](https://docs.polymarket.com/api-reference/trade/cancel-orders-for-a-market.md)
73
92
 
74
93
  ```typescript
75
94
  const res = await polymarket.clob.cancelMarketOrders({ /* ... */ });
@@ -84,7 +103,7 @@ Source: [`packages/provider/polymarket/src/clob.ts`](src/clob.ts)
84
103
 
85
104
  <code>DELETE https://clob.polymarket.com/notifications{query}</code>
86
105
 
87
- [Upstream docs ↗](https://docs.polymarket.com/api-reference/authentication)
106
+ [Upstream docs ↗](https://docs.polymarket.com/api-reference/authentication.md)
88
107
 
89
108
  ```typescript
90
109
  const res = await polymarket.clob.notifications({ /* ... */ });
@@ -99,7 +118,7 @@ Source: [`packages/provider/polymarket/src/clob.ts`](src/clob.ts)
99
118
 
100
119
  <code>DELETE https://clob.polymarket.com/order</code>
101
120
 
102
- [Upstream docs ↗](https://docs.polymarket.com/api-reference/trade/cancel-single-order)
121
+ [Upstream docs ↗](https://docs.polymarket.com/api-reference/trade/cancel-single-order.md)
103
122
 
104
123
  ```typescript
105
124
  const res = await polymarket.clob.order({ /* ... */ });
@@ -114,7 +133,7 @@ Source: [`packages/provider/polymarket/src/clob.ts`](src/clob.ts)
114
133
 
115
134
  <code>DELETE https://clob.polymarket.com/orders</code>
116
135
 
117
- [Upstream docs ↗](https://docs.polymarket.com/api-reference/trade/cancel-multiple-orders)
136
+ [Upstream docs ↗](https://docs.polymarket.com/api-reference/trade/cancel-multiple-orders.md)
118
137
 
119
138
  ```typescript
120
139
  const res = await polymarket.clob.orders({ /* ... */ });
@@ -129,7 +148,7 @@ Source: [`packages/provider/polymarket/src/clob.ts`](src/clob.ts)
129
148
 
130
149
  <code>GET https://clob.polymarket.com/auth/api-keys</code>
131
150
 
132
- [Upstream docs ↗](https://docs.polymarket.com/api-reference/authentication)
151
+ [Upstream docs ↗](https://docs.polymarket.com/api-reference/authentication.md)
133
152
 
134
153
  ```typescript
135
154
  const res = await polymarket.clob.auth.apiKeys({ /* ... */ });
@@ -144,7 +163,7 @@ Source: [`packages/provider/polymarket/src/clob.ts`](src/clob.ts)
144
163
 
145
164
  <code>GET https://clob.polymarket.com/auth/ban-status/closed-only</code>
146
165
 
147
- [Upstream docs ↗](https://docs.polymarket.com/api-reference/authentication)
166
+ [Upstream docs ↗](https://docs.polymarket.com/api-reference/authentication.md)
148
167
 
149
168
  ```typescript
150
169
  const res = await polymarket.clob.auth.banStatus.closedOnly({ /* ... */ });
@@ -154,12 +173,27 @@ Source: [`packages/provider/polymarket/src/clob.ts`](src/clob.ts)
154
173
 
155
174
  </details>
156
175
 
176
+ <details>
177
+ <summary><code>GET</code> <b><code>polymarket.clob.auth.builderApiKey</code></b></summary>
178
+
179
+ <code>GET https://clob.polymarket.com/auth/builder-api-key</code>
180
+
181
+ [Upstream docs ↗](https://docs.polymarket.com/api-spec/clob-openapi.yaml)
182
+
183
+ ```typescript
184
+ const res = await polymarket.clob.auth.builderApiKey({ /* ... */ });
185
+ ```
186
+
187
+ Source: [`packages/provider/polymarket/src/clob.ts`](src/clob.ts)
188
+
189
+ </details>
190
+
157
191
  <details>
158
192
  <summary><code>GET</code> <b><code>polymarket.clob.auth.deriveApiKey</code></b></summary>
159
193
 
160
194
  <code>GET https://clob.polymarket.com/auth/derive-api-key</code>
161
195
 
162
- [Upstream docs ↗](https://docs.polymarket.com/api-reference/authentication)
196
+ [Upstream docs ↗](https://docs.polymarket.com/api-reference/authentication.md)
163
197
 
164
198
  ```typescript
165
199
  const res = await polymarket.clob.auth.deriveApiKey({ /* ... */ });
@@ -174,7 +208,7 @@ Source: [`packages/provider/polymarket/src/clob.ts`](src/clob.ts)
174
208
 
175
209
  <code>GET https://clob.polymarket.com/balance-allowance{query}</code>
176
210
 
177
- [Upstream docs ↗](https://docs.polymarket.com/api-reference/authentication)
211
+ [Upstream docs ↗](https://docs.polymarket.com/api-reference/authentication.md)
178
212
 
179
213
  ```typescript
180
214
  const res = await polymarket.clob.balanceAllowance({ /* ... */ });
@@ -189,7 +223,7 @@ Source: [`packages/provider/polymarket/src/clob.ts`](src/clob.ts)
189
223
 
190
224
  <code>GET https://clob.polymarket.com/balance-allowance/update{query}</code>
191
225
 
192
- [Upstream docs ↗](https://docs.polymarket.com/api-reference/authentication)
226
+ [Upstream docs ↗](https://docs.polymarket.com/api-reference/authentication.md)
193
227
 
194
228
  ```typescript
195
229
  const res = await polymarket.clob.balanceAllowance.update({ /* ... */ });
@@ -204,7 +238,7 @@ Source: [`packages/provider/polymarket/src/clob.ts`](src/clob.ts)
204
238
 
205
239
  <code>GET https://clob.polymarket.com/book{query}</code>
206
240
 
207
- [Upstream docs ↗](https://docs.polymarket.com/api-reference/clob/get-order-book)
241
+ [Upstream docs ↗](https://docs.polymarket.com/api-reference/market-data/get-order-book.md)
208
242
 
209
243
  ```typescript
210
244
  const res = await polymarket.clob.book({ /* ... */ });
@@ -214,12 +248,42 @@ Source: [`packages/provider/polymarket/src/clob.ts`](src/clob.ts)
214
248
 
215
249
  </details>
216
250
 
251
+ <details>
252
+ <summary><code>GET</code> <b><code>polymarket.clob.books</code></b></summary>
253
+
254
+ <code>GET https://clob.polymarket.com/books{query}</code>
255
+
256
+ [Upstream docs ↗](https://docs.polymarket.com/api-spec/clob-openapi.yaml)
257
+
258
+ ```typescript
259
+ const res = await polymarket.clob.books({ /* ... */ });
260
+ ```
261
+
262
+ Source: [`packages/provider/polymarket/src/clob.ts`](src/clob.ts)
263
+
264
+ </details>
265
+
266
+ <details>
267
+ <summary><code>GET</code> <b><code>polymarket.clob.builderTrades</code></b></summary>
268
+
269
+ <code>GET https://clob.polymarket.com/builder/trades{query}</code>
270
+
271
+ [Upstream docs ↗](https://docs.polymarket.com/api-reference/trade/get-builder-trades.md)
272
+
273
+ ```typescript
274
+ const res = await polymarket.clob.builderTrades({ /* ... */ });
275
+ ```
276
+
277
+ Source: [`packages/provider/polymarket/src/clob.ts`](src/clob.ts)
278
+
279
+ </details>
280
+
217
281
  <details>
218
282
  <summary><code>GET</code> <b><code>polymarket.clob.clobMarkets</code></b></summary>
219
283
 
220
284
  <code>GET https://clob.polymarket.com/clob-markets/{conditionId}</code>
221
285
 
222
- [Upstream docs ↗](https://docs.polymarket.com/api-reference/clob/get-clob-market-info)
286
+ [Upstream docs ↗](https://docs.polymarket.com/api-reference/markets/get-clob-market-info.md)
223
287
 
224
288
  ```typescript
225
289
  const res = await polymarket.clob.clobMarkets({ /* ... */ });
@@ -234,7 +298,7 @@ Source: [`packages/provider/polymarket/src/clob.ts`](src/clob.ts)
234
298
 
235
299
  <code>GET https://clob.polymarket.com/data/order/{orderID}</code>
236
300
 
237
- [Upstream docs ↗](https://docs.polymarket.com/api-reference/trade/get-single-order-by-id)
301
+ [Upstream docs ↗](https://docs.polymarket.com/api-reference/trade/get-single-order-by-id.md)
238
302
 
239
303
  ```typescript
240
304
  const res = await polymarket.clob.data.order({ /* ... */ });
@@ -249,7 +313,7 @@ Source: [`packages/provider/polymarket/src/clob.ts`](src/clob.ts)
249
313
 
250
314
  <code>GET https://clob.polymarket.com/data/orders{query}</code>
251
315
 
252
- [Upstream docs ↗](https://docs.polymarket.com/api-reference/trade/get-user-orders)
316
+ [Upstream docs ↗](https://docs.polymarket.com/api-reference/trade/get-user-orders.md)
253
317
 
254
318
  ```typescript
255
319
  const res = await polymarket.clob.data.orders({ /* ... */ });
@@ -264,7 +328,7 @@ Source: [`packages/provider/polymarket/src/clob.ts`](src/clob.ts)
264
328
 
265
329
  <code>GET https://clob.polymarket.com/data/trades{query}</code>
266
330
 
267
- [Upstream docs ↗](https://docs.polymarket.com/api-reference/trade/get-trades)
331
+ [Upstream docs ↗](https://docs.polymarket.com/api-reference/trade/get-trades.md)
268
332
 
269
333
  ```typescript
270
334
  const res = await polymarket.clob.data.trades({ /* ... */ });
@@ -279,7 +343,7 @@ Source: [`packages/provider/polymarket/src/clob.ts`](src/clob.ts)
279
343
 
280
344
  <code>GET https://clob.polymarket.com/fee-rate/{tokenId}</code>
281
345
 
282
- [Upstream docs ↗](https://docs.polymarket.com/api-reference/clob/get-fee-rate)
346
+ [Upstream docs ↗](https://docs.polymarket.com/api-reference/market-data/get-fee-rate-by-path-parameter.md)
283
347
 
284
348
  ```typescript
285
349
  const res = await polymarket.clob.feeRate({ /* ... */ });
@@ -289,12 +353,27 @@ Source: [`packages/provider/polymarket/src/clob.ts`](src/clob.ts)
289
353
 
290
354
  </details>
291
355
 
356
+ <details>
357
+ <summary><code>GET</code> <b><code>polymarket.clob.feeRateByQuery</code></b></summary>
358
+
359
+ <code>GET https://clob.polymarket.com/fee-rate{query}</code>
360
+
361
+ [Upstream docs ↗](https://docs.polymarket.com/api-reference/market-data/get-fee-rate.md)
362
+
363
+ ```typescript
364
+ const res = await polymarket.clob.feeRateByQuery({ /* ... */ });
365
+ ```
366
+
367
+ Source: [`packages/provider/polymarket/src/clob.ts`](src/clob.ts)
368
+
369
+ </details>
370
+
292
371
  <details>
293
372
  <summary><code>GET</code> <b><code>polymarket.clob.lastTradePrice</code></b></summary>
294
373
 
295
374
  <code>GET https://clob.polymarket.com/last-trade-price{query}</code>
296
375
 
297
- [Upstream docs ↗](https://docs.polymarket.com/api-reference/clob/get-last-trade-price)
376
+ [Upstream docs ↗](https://docs.polymarket.com/api-reference/market-data/get-last-trade-price.md)
298
377
 
299
378
  ```typescript
300
379
  const res = await polymarket.clob.lastTradePrice({ /* ... */ });
@@ -304,12 +383,44 @@ Source: [`packages/provider/polymarket/src/clob.ts`](src/clob.ts)
304
383
 
305
384
  </details>
306
385
 
386
+ <details>
387
+ <summary><code>GET</code> <b><code>polymarket.clob.lastTradesPrices</code></b></summary>
388
+
389
+ <code>GET https://clob.polymarket.com/last-trades-prices{query}</code>
390
+
391
+ [Upstream docs ↗](https://docs.polymarket.com/api-reference/market-data/get-last-trade-prices-query-parameters.md)
392
+
393
+ ```typescript
394
+ const res = await polymarket.clob.lastTradesPrices({ /* ... */ });
395
+ ```
396
+
397
+ Source: [`packages/provider/polymarket/src/clob.ts`](src/clob.ts)
398
+
399
+ </details>
400
+
401
+ <details>
402
+ <summary><code>GET</code> <b><code>polymarket.clob.marketLiveActivity</code></b></summary>
403
+
404
+ <code>GET https://clob.polymarket.com/markets/live-activity/{conditionId}</code>
405
+
406
+ [Upstream docs ↗](https://docs.polymarket.com/api-spec/clob-openapi.yaml)
407
+
408
+ ```typescript
409
+ const res = await polymarket.clob.marketLiveActivity({ /* ... */ });
410
+ ```
411
+
412
+ Source: [`packages/provider/polymarket/src/clob.ts`](src/clob.ts)
413
+
414
+ </details>
415
+
307
416
  <details>
308
417
  <summary><code>GET</code> <b><code>polymarket.clob.markets</code></b></summary>
309
418
 
310
419
  <code>GET https://clob.polymarket.com/markets/{paramsOrConditionIdOrSignal}</code>
311
420
 
312
- [Upstream docs ↗](https://docs.polymarket.com/api-reference/clob/get-markets)
421
+ [Upstream docs ↗](https://docs.polymarket.com/api-spec/clob-openapi.yaml)
422
+
423
+ > **Legacy compatibility:** current public market discovery is documented on the Gamma `/markets` pages. The CLOB `/markets` compatibility path is retained for existing callers and is documented by the CLOB OpenAPI spec.
313
424
 
314
425
  ```typescript
315
426
  const res = await polymarket.clob.markets({ /* ... */ });
@@ -324,7 +435,7 @@ Source: [`packages/provider/polymarket/src/clob.ts`](src/clob.ts)
324
435
 
325
436
  <code>GET https://clob.polymarket.com/markets-by-token/{tokenId}</code>
326
437
 
327
- [Upstream docs ↗](https://docs.polymarket.com/api-reference/clob/get-market-by-token)
438
+ [Upstream docs ↗](https://docs.polymarket.com/api-reference/markets/get-market-by-token.md)
328
439
 
329
440
  ```typescript
330
441
  const res = await polymarket.clob.marketsByToken({ /* ... */ });
@@ -339,7 +450,7 @@ Source: [`packages/provider/polymarket/src/clob.ts`](src/clob.ts)
339
450
 
340
451
  <code>GET https://clob.polymarket.com/midpoint{query}</code>
341
452
 
342
- [Upstream docs ↗](https://docs.polymarket.com/api-reference/clob/get-midpoint)
453
+ [Upstream docs ↗](https://docs.polymarket.com/api-reference/data/get-midpoint-price.md)
343
454
 
344
455
  ```typescript
345
456
  const res = await polymarket.clob.midpoint({ /* ... */ });
@@ -349,12 +460,57 @@ Source: [`packages/provider/polymarket/src/clob.ts`](src/clob.ts)
349
460
 
350
461
  </details>
351
462
 
463
+ <details>
464
+ <summary><code>GET</code> <b><code>polymarket.clob.midpoints</code></b></summary>
465
+
466
+ <code>GET https://clob.polymarket.com/midpoints{query}</code>
467
+
468
+ [Upstream docs ↗](https://docs.polymarket.com/api-reference/market-data/get-midpoint-prices-query-parameters.md)
469
+
470
+ ```typescript
471
+ const res = await polymarket.clob.midpoints({ /* ... */ });
472
+ ```
473
+
474
+ Source: [`packages/provider/polymarket/src/clob.ts`](src/clob.ts)
475
+
476
+ </details>
477
+
478
+ <details>
479
+ <summary><code>GET</code> <b><code>polymarket.clob.negRisk</code></b></summary>
480
+
481
+ <code>GET https://clob.polymarket.com/neg-risk/{tokenId}</code>
482
+
483
+ [Upstream docs ↗](https://docs.polymarket.com/api-spec/clob-openapi.yaml)
484
+
485
+ ```typescript
486
+ const res = await polymarket.clob.negRisk({ /* ... */ });
487
+ ```
488
+
489
+ Source: [`packages/provider/polymarket/src/clob.ts`](src/clob.ts)
490
+
491
+ </details>
492
+
493
+ <details>
494
+ <summary><code>GET</code> <b><code>polymarket.clob.negRiskByQuery</code></b></summary>
495
+
496
+ <code>GET https://clob.polymarket.com/neg-risk{query}</code>
497
+
498
+ [Upstream docs ↗](https://docs.polymarket.com/api-spec/clob-openapi.yaml)
499
+
500
+ ```typescript
501
+ const res = await polymarket.clob.negRiskByQuery({ /* ... */ });
502
+ ```
503
+
504
+ Source: [`packages/provider/polymarket/src/clob.ts`](src/clob.ts)
505
+
506
+ </details>
507
+
352
508
  <details>
353
509
  <summary><code>GET</code> <b><code>polymarket.clob.notifications</code></b></summary>
354
510
 
355
511
  <code>GET https://clob.polymarket.com/notifications{query}</code>
356
512
 
357
- [Upstream docs ↗](https://docs.polymarket.com/api-reference/authentication)
513
+ [Upstream docs ↗](https://docs.polymarket.com/api-reference/authentication.md)
358
514
 
359
515
  ```typescript
360
516
  const res = await polymarket.clob.notifications({ /* ... */ });
@@ -369,7 +525,7 @@ Source: [`packages/provider/polymarket/src/clob.ts`](src/clob.ts)
369
525
 
370
526
  <code>GET https://clob.polymarket.com/order-scoring{query}</code>
371
527
 
372
- [Upstream docs ↗](https://docs.polymarket.com/api-reference/trade/get-order-scoring-status)
528
+ [Upstream docs ↗](https://docs.polymarket.com/api-reference/trade/get-order-scoring-status.md)
373
529
 
374
530
  ```typescript
375
531
  const res = await polymarket.clob.orderScoring({ /* ... */ });
@@ -384,7 +540,7 @@ Source: [`packages/provider/polymarket/src/clob.ts`](src/clob.ts)
384
540
 
385
541
  <code>GET https://clob.polymarket.com/orders-scoring{query}</code>
386
542
 
387
- [Upstream docs ↗](https://docs.polymarket.com/api-reference/trade/get-order-scoring-status)
543
+ [Upstream docs ↗](https://docs.polymarket.com/api-reference/trade/get-order-scoring-status.md)
388
544
 
389
545
  ```typescript
390
546
  const res = await polymarket.clob.ordersScoring({ /* ... */ });
@@ -399,7 +555,7 @@ Source: [`packages/provider/polymarket/src/clob.ts`](src/clob.ts)
399
555
 
400
556
  <code>GET https://clob.polymarket.com/price{query}</code>
401
557
 
402
- [Upstream docs ↗](https://docs.polymarket.com/api-reference/clob/get-market-price)
558
+ [Upstream docs ↗](https://docs.polymarket.com/api-reference/market-data/get-market-price.md)
403
559
 
404
560
  ```typescript
405
561
  const res = await polymarket.clob.price({ /* ... */ });
@@ -409,12 +565,27 @@ Source: [`packages/provider/polymarket/src/clob.ts`](src/clob.ts)
409
565
 
410
566
  </details>
411
567
 
568
+ <details>
569
+ <summary><code>GET</code> <b><code>polymarket.clob.prices</code></b></summary>
570
+
571
+ <code>GET https://clob.polymarket.com/prices{query}</code>
572
+
573
+ [Upstream docs ↗](https://docs.polymarket.com/api-reference/market-data/get-market-prices-query-parameters.md)
574
+
575
+ ```typescript
576
+ const res = await polymarket.clob.prices({ /* ... */ });
577
+ ```
578
+
579
+ Source: [`packages/provider/polymarket/src/clob.ts`](src/clob.ts)
580
+
581
+ </details>
582
+
412
583
  <details>
413
584
  <summary><code>GET</code> <b><code>polymarket.clob.pricesHistory</code></b></summary>
414
585
 
415
586
  <code>GET https://clob.polymarket.com/prices-history{query}</code>
416
587
 
417
- [Upstream docs ↗](https://docs.polymarket.com/api-reference/clob/get-prices-history)
588
+ [Upstream docs ↗](https://docs.polymarket.com/api-reference/markets/get-prices-history.md)
418
589
 
419
590
  ```typescript
420
591
  const res = await polymarket.clob.pricesHistory({ /* ... */ });
@@ -424,12 +595,132 @@ Source: [`packages/provider/polymarket/src/clob.ts`](src/clob.ts)
424
595
 
425
596
  </details>
426
597
 
598
+ <details>
599
+ <summary><code>GET</code> <b><code>polymarket.clob.rebates.current</code></b></summary>
600
+
601
+ <code>GET https://clob.polymarket.com/rebates/current{query}</code>
602
+
603
+ [Upstream docs ↗](https://docs.polymarket.com/api-reference/rebates/get-current-rebated-fees-for-a-maker.md)
604
+
605
+ ```typescript
606
+ const res = await polymarket.clob.rebates.current({ /* ... */ });
607
+ ```
608
+
609
+ Source: [`packages/provider/polymarket/src/clob.ts`](src/clob.ts)
610
+
611
+ </details>
612
+
613
+ <details>
614
+ <summary><code>GET</code> <b><code>polymarket.clob.rewards.markets.byCondition</code></b></summary>
615
+
616
+ <code>GET https://clob.polymarket.com/rewards/markets/{conditionId}{query}</code>
617
+
618
+ [Upstream docs ↗](https://docs.polymarket.com/api-reference/rewards/get-raw-rewards-for-a-specific-market.md)
619
+
620
+ ```typescript
621
+ const res = await polymarket.clob.rewards.markets.byCondition({ /* ... */ });
622
+ ```
623
+
624
+ Source: [`packages/provider/polymarket/src/clob.ts`](src/clob.ts)
625
+
626
+ </details>
627
+
628
+ <details>
629
+ <summary><code>GET</code> <b><code>polymarket.clob.rewards.markets.current</code></b></summary>
630
+
631
+ <code>GET https://clob.polymarket.com/rewards/markets/current{query}</code>
632
+
633
+ [Upstream docs ↗](https://docs.polymarket.com/api-reference/rewards/get-current-active-rewards-configurations.md)
634
+
635
+ ```typescript
636
+ const res = await polymarket.clob.rewards.markets.current({ /* ... */ });
637
+ ```
638
+
639
+ Source: [`packages/provider/polymarket/src/clob.ts`](src/clob.ts)
640
+
641
+ </details>
642
+
643
+ <details>
644
+ <summary><code>GET</code> <b><code>polymarket.clob.rewards.markets.multi</code></b></summary>
645
+
646
+ <code>GET https://clob.polymarket.com/rewards/markets/multi{query}</code>
647
+
648
+ [Upstream docs ↗](https://docs.polymarket.com/api-reference/rewards/get-multiple-markets-with-rewards.md)
649
+
650
+ ```typescript
651
+ const res = await polymarket.clob.rewards.markets.multi({ /* ... */ });
652
+ ```
653
+
654
+ Source: [`packages/provider/polymarket/src/clob.ts`](src/clob.ts)
655
+
656
+ </details>
657
+
658
+ <details>
659
+ <summary><code>GET</code> <b><code>polymarket.clob.rewards.user</code></b></summary>
660
+
661
+ <code>GET https://clob.polymarket.com/rewards/user{query}</code>
662
+
663
+ [Upstream docs ↗](https://docs.polymarket.com/api-reference/rewards/get-earnings-for-user-by-date.md)
664
+
665
+ ```typescript
666
+ const res = await polymarket.clob.rewards.user({ /* ... */ });
667
+ ```
668
+
669
+ Source: [`packages/provider/polymarket/src/clob.ts`](src/clob.ts)
670
+
671
+ </details>
672
+
673
+ <details>
674
+ <summary><code>GET</code> <b><code>polymarket.clob.rewards.userMarkets</code></b></summary>
675
+
676
+ <code>GET https://clob.polymarket.com/rewards/user/markets{query}</code>
677
+
678
+ [Upstream docs ↗](https://docs.polymarket.com/api-reference/rewards/get-user-earnings-and-markets-configuration.md)
679
+
680
+ ```typescript
681
+ const res = await polymarket.clob.rewards.userMarkets({ /* ... */ });
682
+ ```
683
+
684
+ Source: [`packages/provider/polymarket/src/clob.ts`](src/clob.ts)
685
+
686
+ </details>
687
+
688
+ <details>
689
+ <summary><code>GET</code> <b><code>polymarket.clob.rewards.userPercentages</code></b></summary>
690
+
691
+ <code>GET https://clob.polymarket.com/rewards/user/percentages{query}</code>
692
+
693
+ [Upstream docs ↗](https://docs.polymarket.com/api-reference/rewards/get-reward-percentages-for-user.md)
694
+
695
+ ```typescript
696
+ const res = await polymarket.clob.rewards.userPercentages({ /* ... */ });
697
+ ```
698
+
699
+ Source: [`packages/provider/polymarket/src/clob.ts`](src/clob.ts)
700
+
701
+ </details>
702
+
703
+ <details>
704
+ <summary><code>GET</code> <b><code>polymarket.clob.rewards.userTotal</code></b></summary>
705
+
706
+ <code>GET https://clob.polymarket.com/rewards/user/total{query}</code>
707
+
708
+ [Upstream docs ↗](https://docs.polymarket.com/api-reference/rewards/get-total-earnings-for-user-by-date.md)
709
+
710
+ ```typescript
711
+ const res = await polymarket.clob.rewards.userTotal({ /* ... */ });
712
+ ```
713
+
714
+ Source: [`packages/provider/polymarket/src/clob.ts`](src/clob.ts)
715
+
716
+ </details>
717
+
427
718
  <details>
428
719
  <summary><code>GET</code> <b><code>polymarket.clob.samplingMarkets</code></b></summary>
429
720
 
430
721
  <code>GET https://clob.polymarket.com/sampling-markets{query}</code>
431
722
 
432
- [Upstream docs ↗](https://docs.polymarket.com/api-reference/clob/get-sampling-markets)
723
+ [Upstream docs ↗](https://docs.polymarket.com/api-reference/markets/get-sampling-markets.md)
433
724
 
434
725
  ```typescript
435
726
  const res = await polymarket.clob.samplingMarkets({ /* ... */ });
@@ -444,7 +735,7 @@ Source: [`packages/provider/polymarket/src/clob.ts`](src/clob.ts)
444
735
 
445
736
  <code>GET https://clob.polymarket.com/sampling-simplified-markets{query}</code>
446
737
 
447
- [Upstream docs ↗](https://docs.polymarket.com/api-reference/clob/get-sampling-simplified-markets)
738
+ [Upstream docs ↗](https://docs.polymarket.com/api-reference/markets/get-sampling-simplified-markets.md)
448
739
 
449
740
  ```typescript
450
741
  const res = await polymarket.clob.samplingSimplifiedMarkets({ /* ... */ });
@@ -459,7 +750,7 @@ Source: [`packages/provider/polymarket/src/clob.ts`](src/clob.ts)
459
750
 
460
751
  <code>GET https://clob.polymarket.com/simplified-markets{query}</code>
461
752
 
462
- [Upstream docs ↗](https://docs.polymarket.com/api-reference/clob/get-simplified-markets)
753
+ [Upstream docs ↗](https://docs.polymarket.com/api-reference/markets/get-simplified-markets.md)
463
754
 
464
755
  ```typescript
465
756
  const res = await polymarket.clob.simplifiedMarkets({ /* ... */ });
@@ -474,7 +765,7 @@ Source: [`packages/provider/polymarket/src/clob.ts`](src/clob.ts)
474
765
 
475
766
  <code>GET https://clob.polymarket.com/spread{query}</code>
476
767
 
477
- [Upstream docs ↗](https://docs.polymarket.com/api-reference/clob/get-spread)
768
+ [Upstream docs ↗](https://docs.polymarket.com/api-reference/market-data/get-spread.md)
478
769
 
479
770
  ```typescript
480
771
  const res = await polymarket.clob.spread({ /* ... */ });
@@ -489,7 +780,7 @@ Source: [`packages/provider/polymarket/src/clob.ts`](src/clob.ts)
489
780
 
490
781
  <code>GET https://clob.polymarket.com/tick-size/{tokenId}</code>
491
782
 
492
- [Upstream docs ↗](https://docs.polymarket.com/api-reference/clob/get-tick-size)
783
+ [Upstream docs ↗](https://docs.polymarket.com/api-reference/market-data/get-tick-size-by-path-parameter.md)
493
784
 
494
785
  ```typescript
495
786
  const res = await polymarket.clob.tickSize({ /* ... */ });
@@ -499,12 +790,27 @@ Source: [`packages/provider/polymarket/src/clob.ts`](src/clob.ts)
499
790
 
500
791
  </details>
501
792
 
793
+ <details>
794
+ <summary><code>GET</code> <b><code>polymarket.clob.tickSizeByQuery</code></b></summary>
795
+
796
+ <code>GET https://clob.polymarket.com/tick-size{query}</code>
797
+
798
+ [Upstream docs ↗](https://docs.polymarket.com/api-reference/market-data/get-tick-size.md)
799
+
800
+ ```typescript
801
+ const res = await polymarket.clob.tickSizeByQuery({ /* ... */ });
802
+ ```
803
+
804
+ Source: [`packages/provider/polymarket/src/clob.ts`](src/clob.ts)
805
+
806
+ </details>
807
+
502
808
  <details>
503
809
  <summary><code>GET</code> <b><code>polymarket.clob.time</code></b></summary>
504
810
 
505
811
  <code>GET https://clob.polymarket.com/time</code>
506
812
 
507
- [Upstream docs ↗](https://docs.polymarket.com/api-reference/clob/get-server-time)
813
+ [Upstream docs ↗](https://docs.polymarket.com/api-reference/data/get-server-time.md)
508
814
 
509
815
  ```typescript
510
816
  const res = await polymarket.clob.time({ /* ... */ });
@@ -519,7 +825,7 @@ Source: [`packages/provider/polymarket/src/clob.ts`](src/clob.ts)
519
825
 
520
826
  <code>POST https://clob.polymarket.com/auth/api-key</code>
521
827
 
522
- [Upstream docs ↗](https://docs.polymarket.com/api-reference/authentication)
828
+ [Upstream docs ↗](https://docs.polymarket.com/api-reference/authentication.md)
523
829
 
524
830
  ```typescript
525
831
  const res = await polymarket.clob.auth.apiKey({ /* ... */ });
@@ -529,12 +835,27 @@ Source: [`packages/provider/polymarket/src/clob.ts`](src/clob.ts)
529
835
 
530
836
  </details>
531
837
 
838
+ <details>
839
+ <summary><code>POST</code> <b><code>polymarket.clob.auth.builderApiKey</code></b></summary>
840
+
841
+ <code>POST https://clob.polymarket.com/auth/builder-api-key</code>
842
+
843
+ [Upstream docs ↗](https://docs.polymarket.com/api-spec/clob-openapi.yaml)
844
+
845
+ ```typescript
846
+ const res = await polymarket.clob.auth.builderApiKey({ /* ... */ });
847
+ ```
848
+
849
+ Source: [`packages/provider/polymarket/src/clob.ts`](src/clob.ts)
850
+
851
+ </details>
852
+
532
853
  <details>
533
854
  <summary><code>POST</code> <b><code>polymarket.clob.batchPricesHistory</code></b></summary>
534
855
 
535
856
  <code>POST https://clob.polymarket.com/batch-prices-history</code>
536
857
 
537
- [Upstream docs ↗](https://docs.polymarket.com/api-reference/clob/get-batch-prices-history)
858
+ [Upstream docs ↗](https://docs.polymarket.com/api-reference/markets/get-batch-prices-history.md)
538
859
 
539
860
  ```typescript
540
861
  const res = await polymarket.clob.batchPricesHistory({ /* ... */ });
@@ -549,7 +870,7 @@ Source: [`packages/provider/polymarket/src/clob.ts`](src/clob.ts)
549
870
 
550
871
  <code>POST https://clob.polymarket.com/books</code>
551
872
 
552
- [Upstream docs ↗](https://docs.polymarket.com/api-reference/clob/get-order-books)
873
+ [Upstream docs ↗](https://docs.polymarket.com/api-reference/market-data/get-order-books-request-body.md)
553
874
 
554
875
  ```typescript
555
876
  const res = await polymarket.clob.books({ /* ... */ });
@@ -564,7 +885,7 @@ Source: [`packages/provider/polymarket/src/clob.ts`](src/clob.ts)
564
885
 
565
886
  <code>POST https://clob.polymarket.com/heartbeats</code>
566
887
 
567
- [Upstream docs ↗](https://docs.polymarket.com/api-reference/trade/send-heartbeat)
888
+ [Upstream docs ↗](https://docs.polymarket.com/api-reference/trade/send-heartbeat.md)
568
889
 
569
890
  ```typescript
570
891
  const res = await polymarket.clob.heartbeats({ /* ... */ });
@@ -579,7 +900,7 @@ Source: [`packages/provider/polymarket/src/clob.ts`](src/clob.ts)
579
900
 
580
901
  <code>POST https://clob.polymarket.com/last-trades-prices</code>
581
902
 
582
- [Upstream docs ↗](https://docs.polymarket.com/api-reference/clob/get-last-trades-prices)
903
+ [Upstream docs ↗](https://docs.polymarket.com/api-reference/market-data/get-last-trade-prices-request-body.md)
583
904
 
584
905
  ```typescript
585
906
  const res = await polymarket.clob.lastTradesPrices({ /* ... */ });
@@ -589,12 +910,27 @@ Source: [`packages/provider/polymarket/src/clob.ts`](src/clob.ts)
589
910
 
590
911
  </details>
591
912
 
913
+ <details>
914
+ <summary><code>POST</code> <b><code>polymarket.clob.marketsLiveActivity</code></b></summary>
915
+
916
+ <code>POST https://clob.polymarket.com/markets/live-activity</code>
917
+
918
+ [Upstream docs ↗](https://docs.polymarket.com/api-spec/clob-openapi.yaml)
919
+
920
+ ```typescript
921
+ const res = await polymarket.clob.marketsLiveActivity({ /* ... */ });
922
+ ```
923
+
924
+ Source: [`packages/provider/polymarket/src/clob.ts`](src/clob.ts)
925
+
926
+ </details>
927
+
592
928
  <details>
593
929
  <summary><code>POST</code> <b><code>polymarket.clob.midpoints</code></b></summary>
594
930
 
595
931
  <code>POST https://clob.polymarket.com/midpoints</code>
596
932
 
597
- [Upstream docs ↗](https://docs.polymarket.com/api-reference/clob/get-midpoints)
933
+ [Upstream docs ↗](https://docs.polymarket.com/api-reference/market-data/get-midpoint-prices-request-body.md)
598
934
 
599
935
  ```typescript
600
936
  const res = await polymarket.clob.midpoints({ /* ... */ });
@@ -609,7 +945,7 @@ Source: [`packages/provider/polymarket/src/clob.ts`](src/clob.ts)
609
945
 
610
946
  <code>POST https://clob.polymarket.com/order</code>
611
947
 
612
- [Upstream docs ↗](https://docs.polymarket.com/api-reference/trade/post-a-new-order)
948
+ [Upstream docs ↗](https://docs.polymarket.com/api-reference/trade/post-a-new-order.md)
613
949
 
614
950
  ```typescript
615
951
  const res = await polymarket.clob.order({ /* ... */ });
@@ -624,7 +960,7 @@ Source: [`packages/provider/polymarket/src/clob.ts`](src/clob.ts)
624
960
 
625
961
  <code>POST https://clob.polymarket.com/orders</code>
626
962
 
627
- [Upstream docs ↗](https://docs.polymarket.com/api-reference/trade/post-multiple-orders)
963
+ [Upstream docs ↗](https://docs.polymarket.com/api-reference/trade/post-multiple-orders.md)
628
964
 
629
965
  ```typescript
630
966
  const res = await polymarket.clob.orders({ /* ... */ });
@@ -639,7 +975,7 @@ Source: [`packages/provider/polymarket/src/clob.ts`](src/clob.ts)
639
975
 
640
976
  <code>POST https://clob.polymarket.com/orders-scoring</code>
641
977
 
642
- [Upstream docs ↗](https://docs.polymarket.com/api-reference/trade/get-order-scoring-status)
978
+ [Upstream docs ↗](https://docs.polymarket.com/api-reference/trade/get-order-scoring-status.md)
643
979
 
644
980
  ```typescript
645
981
  const res = await polymarket.clob.ordersScoring({ /* ... */ });
@@ -652,7 +988,9 @@ Source: [`packages/provider/polymarket/src/clob.ts`](src/clob.ts)
652
988
  <details>
653
989
  <summary><code>POST</code> <b><code>polymarket.clob.placeOrder</code></b></summary>
654
990
 
655
- [Upstream docs ↗](https://docs.polymarket.com/api-reference/trade/post-a-new-order)
991
+ <code>POST https://clob.polymarket.com/order</code>
992
+
993
+ [Upstream docs ↗](https://docs.polymarket.com/api-reference/trade/post-a-new-order.md)
656
994
 
657
995
  ```typescript
658
996
  const res = await polymarket.clob.placeOrder({ /* ... */ });
@@ -667,7 +1005,7 @@ Source: [`packages/provider/polymarket/src/clob.ts`](src/clob.ts)
667
1005
 
668
1006
  <code>POST https://clob.polymarket.com/prices</code>
669
1007
 
670
- [Upstream docs ↗](https://docs.polymarket.com/api-reference/clob/get-market-prices)
1008
+ [Upstream docs ↗](https://docs.polymarket.com/api-reference/market-data/get-market-prices-request-body.md)
671
1009
 
672
1010
  ```typescript
673
1011
  const res = await polymarket.clob.prices({ /* ... */ });
@@ -682,7 +1020,7 @@ Source: [`packages/provider/polymarket/src/clob.ts`](src/clob.ts)
682
1020
 
683
1021
  <code>POST https://clob.polymarket.com/spreads</code>
684
1022
 
685
- [Upstream docs ↗](https://docs.polymarket.com/api-reference/clob/get-spreads)
1023
+ [Upstream docs ↗](https://docs.polymarket.com/api-reference/market-data/get-spreads.md)
686
1024
 
687
1025
  ```typescript
688
1026
  const res = await polymarket.clob.spreads({ /* ... */ });
@@ -697,7 +1035,7 @@ Source: [`packages/provider/polymarket/src/clob.ts`](src/clob.ts)
697
1035
 
698
1036
  <code>POST https://clob.polymarket.com/v1/heartbeats</code>
699
1037
 
700
- [Upstream docs ↗](https://docs.polymarket.com/api-reference/trade/send-heartbeat)
1038
+ [Upstream docs ↗](https://docs.polymarket.com/api-reference/trade/send-heartbeat.md)
701
1039
 
702
1040
  ```typescript
703
1041
  const res = await polymarket.clob.v1.heartbeats({ /* ... */ });
@@ -712,7 +1050,7 @@ Source: [`packages/provider/polymarket/src/clob.ts`](src/clob.ts)
712
1050
 
713
1051
  <code>PUT https://clob.polymarket.com/balance-allowance{query}</code>
714
1052
 
715
- [Upstream docs ↗](https://docs.polymarket.com/api-reference/authentication)
1053
+ [Upstream docs ↗](https://docs.polymarket.com/api-reference/authentication.md)
716
1054
 
717
1055
  ```typescript
718
1056
  const res = await polymarket.clob.balanceAllowance({ /* ... */ });
@@ -724,12 +1062,27 @@ Source: [`packages/provider/polymarket/src/clob.ts`](src/clob.ts)
724
1062
 
725
1063
  ### data
726
1064
 
1065
+ <details>
1066
+ <summary><code>GET</code> <b><code>polymarket.data.accounting.snapshot</code></b></summary>
1067
+
1068
+ <code>GET https://data-api.polymarket.com/v1/accounting/snapshot{query}</code>
1069
+
1070
+ [Upstream docs ↗](https://docs.polymarket.com/api-reference/misc/download-an-accounting-snapshot-zip-of-csvs.md)
1071
+
1072
+ ```typescript
1073
+ const res = await polymarket.data.accounting.snapshot({ /* ... */ });
1074
+ ```
1075
+
1076
+ Source: [`packages/provider/polymarket/src/data.ts`](src/data.ts)
1077
+
1078
+ </details>
1079
+
727
1080
  <details>
728
1081
  <summary><code>GET</code> <b><code>polymarket.data.activity</code></b></summary>
729
1082
 
730
1083
  <code>GET https://data-api.polymarket.com/activity{query}</code>
731
1084
 
732
- [Upstream docs ↗](https://docs.polymarket.com/api-reference/data/get-activity)
1085
+ [Upstream docs ↗](https://docs.polymarket.com/api-reference/core/get-user-activity.md)
733
1086
 
734
1087
  ```typescript
735
1088
  const res = await polymarket.data.activity({ /* ... */ });
@@ -739,12 +1092,87 @@ Source: [`packages/provider/polymarket/src/data.ts`](src/data.ts)
739
1092
 
740
1093
  </details>
741
1094
 
1095
+ <details>
1096
+ <summary><code>GET</code> <b><code>polymarket.data.activity.combos</code></b></summary>
1097
+
1098
+ <code>GET https://data-api.polymarket.com/v1/activity/combos{query}</code>
1099
+
1100
+ [Upstream docs ↗](https://docs.polymarket.com/api-reference/core/get-user-combo-activity.md)
1101
+
1102
+ ```typescript
1103
+ const res = await polymarket.data.activity.combos({ /* ... */ });
1104
+ ```
1105
+
1106
+ Source: [`packages/provider/polymarket/src/data.ts`](src/data.ts)
1107
+
1108
+ </details>
1109
+
1110
+ <details>
1111
+ <summary><code>GET</code> <b><code>polymarket.data.builders.leaderboard</code></b></summary>
1112
+
1113
+ <code>GET https://data-api.polymarket.com/v1/builders/leaderboard{query}</code>
1114
+
1115
+ [Upstream docs ↗](https://docs.polymarket.com/api-reference/builders/get-aggregated-builder-leaderboard.md)
1116
+
1117
+ ```typescript
1118
+ const res = await polymarket.data.builders.leaderboard({ /* ... */ });
1119
+ ```
1120
+
1121
+ Source: [`packages/provider/polymarket/src/data.ts`](src/data.ts)
1122
+
1123
+ </details>
1124
+
1125
+ <details>
1126
+ <summary><code>GET</code> <b><code>polymarket.data.builders.volume</code></b></summary>
1127
+
1128
+ <code>GET https://data-api.polymarket.com/v1/builders/volume{query}</code>
1129
+
1130
+ [Upstream docs ↗](https://docs.polymarket.com/api-reference/builders/get-daily-builder-volume-time-series.md)
1131
+
1132
+ ```typescript
1133
+ const res = await polymarket.data.builders.volume({ /* ... */ });
1134
+ ```
1135
+
1136
+ Source: [`packages/provider/polymarket/src/data.ts`](src/data.ts)
1137
+
1138
+ </details>
1139
+
1140
+ <details>
1141
+ <summary><code>GET</code> <b><code>polymarket.data.closedPositions</code></b></summary>
1142
+
1143
+ <code>GET https://data-api.polymarket.com/closed-positions{query}</code>
1144
+
1145
+ [Upstream docs ↗](https://docs.polymarket.com/api-reference/core/get-closed-positions-for-a-user.md)
1146
+
1147
+ ```typescript
1148
+ const res = await polymarket.data.closedPositions({ /* ... */ });
1149
+ ```
1150
+
1151
+ Source: [`packages/provider/polymarket/src/data.ts`](src/data.ts)
1152
+
1153
+ </details>
1154
+
1155
+ <details>
1156
+ <summary><code>GET</code> <b><code>polymarket.data.health</code></b></summary>
1157
+
1158
+ <code>GET https://data-api.polymarket.com/</code>
1159
+
1160
+ [Upstream docs ↗](https://docs.polymarket.com/api-spec/data-openapi.yaml)
1161
+
1162
+ ```typescript
1163
+ const res = await polymarket.data.health({ /* ... */ });
1164
+ ```
1165
+
1166
+ Source: [`packages/provider/polymarket/src/data.ts`](src/data.ts)
1167
+
1168
+ </details>
1169
+
742
1170
  <details>
743
1171
  <summary><code>GET</code> <b><code>polymarket.data.holders</code></b></summary>
744
1172
 
745
1173
  <code>GET https://data-api.polymarket.com/holders{query}</code>
746
1174
 
747
- [Upstream docs ↗](https://docs.polymarket.com/api-reference/data/get-holders)
1175
+ [Upstream docs ↗](https://docs.polymarket.com/api-reference/core/get-top-holders-for-markets.md)
748
1176
 
749
1177
  ```typescript
750
1178
  const res = await polymarket.data.holders({ /* ... */ });
@@ -754,12 +1182,27 @@ Source: [`packages/provider/polymarket/src/data.ts`](src/data.ts)
754
1182
 
755
1183
  </details>
756
1184
 
1185
+ <details>
1186
+ <summary><code>GET</code> <b><code>polymarket.data.leaderboard</code></b></summary>
1187
+
1188
+ <code>GET https://data-api.polymarket.com/v1/leaderboard{query}</code>
1189
+
1190
+ [Upstream docs ↗](https://docs.polymarket.com/api-reference/core/get-trader-leaderboard-rankings.md)
1191
+
1192
+ ```typescript
1193
+ const res = await polymarket.data.leaderboard({ /* ... */ });
1194
+ ```
1195
+
1196
+ Source: [`packages/provider/polymarket/src/data.ts`](src/data.ts)
1197
+
1198
+ </details>
1199
+
757
1200
  <details>
758
1201
  <summary><code>GET</code> <b><code>polymarket.data.liveVolume</code></b></summary>
759
1202
 
760
1203
  <code>GET https://data-api.polymarket.com/live-volume{query}</code>
761
1204
 
762
- [Upstream docs ↗](https://docs.polymarket.com/api-reference/data/get-live-volume)
1205
+ [Upstream docs ↗](https://docs.polymarket.com/api-reference/misc/get-live-volume-for-an-event.md)
763
1206
 
764
1207
  ```typescript
765
1208
  const res = await polymarket.data.liveVolume({ /* ... */ });
@@ -769,12 +1212,27 @@ Source: [`packages/provider/polymarket/src/data.ts`](src/data.ts)
769
1212
 
770
1213
  </details>
771
1214
 
1215
+ <details>
1216
+ <summary><code>GET</code> <b><code>polymarket.data.marketPositions</code></b></summary>
1217
+
1218
+ <code>GET https://data-api.polymarket.com/v1/market-positions{query}</code>
1219
+
1220
+ [Upstream docs ↗](https://docs.polymarket.com/api-reference/core/get-positions-for-a-market.md)
1221
+
1222
+ ```typescript
1223
+ const res = await polymarket.data.marketPositions({ /* ... */ });
1224
+ ```
1225
+
1226
+ Source: [`packages/provider/polymarket/src/data.ts`](src/data.ts)
1227
+
1228
+ </details>
1229
+
772
1230
  <details>
773
1231
  <summary><code>GET</code> <b><code>polymarket.data.oi</code></b></summary>
774
1232
 
775
1233
  <code>GET https://data-api.polymarket.com/oi{query}</code>
776
1234
 
777
- [Upstream docs ↗](https://docs.polymarket.com/api-reference/data/get-open-interest)
1235
+ [Upstream docs ↗](https://docs.polymarket.com/api-reference/misc/get-open-interest.md)
778
1236
 
779
1237
  ```typescript
780
1238
  const res = await polymarket.data.oi({ /* ... */ });
@@ -789,7 +1247,7 @@ Source: [`packages/provider/polymarket/src/data.ts`](src/data.ts)
789
1247
 
790
1248
  <code>GET https://data-api.polymarket.com/positions{query}</code>
791
1249
 
792
- [Upstream docs ↗](https://docs.polymarket.com/api-reference/data/get-positions)
1250
+ [Upstream docs ↗](https://docs.polymarket.com/api-reference/core/get-current-positions-for-a-user.md)
793
1251
 
794
1252
  ```typescript
795
1253
  const res = await polymarket.data.positions({ /* ... */ });
@@ -799,12 +1257,42 @@ Source: [`packages/provider/polymarket/src/data.ts`](src/data.ts)
799
1257
 
800
1258
  </details>
801
1259
 
1260
+ <details>
1261
+ <summary><code>GET</code> <b><code>polymarket.data.positions.combos</code></b></summary>
1262
+
1263
+ <code>GET https://data-api.polymarket.com/v1/positions/combos{query}</code>
1264
+
1265
+ [Upstream docs ↗](https://docs.polymarket.com/api-reference/core/get-user-combo-positions.md)
1266
+
1267
+ ```typescript
1268
+ const res = await polymarket.data.positions.combos({ /* ... */ });
1269
+ ```
1270
+
1271
+ Source: [`packages/provider/polymarket/src/data.ts`](src/data.ts)
1272
+
1273
+ </details>
1274
+
1275
+ <details>
1276
+ <summary><code>GET</code> <b><code>polymarket.data.traded</code></b></summary>
1277
+
1278
+ <code>GET https://data-api.polymarket.com/traded{query}</code>
1279
+
1280
+ [Upstream docs ↗](https://docs.polymarket.com/api-reference/misc/get-total-markets-a-user-has-traded.md)
1281
+
1282
+ ```typescript
1283
+ const res = await polymarket.data.traded({ /* ... */ });
1284
+ ```
1285
+
1286
+ Source: [`packages/provider/polymarket/src/data.ts`](src/data.ts)
1287
+
1288
+ </details>
1289
+
802
1290
  <details>
803
1291
  <summary><code>GET</code> <b><code>polymarket.data.trades</code></b></summary>
804
1292
 
805
1293
  <code>GET https://data-api.polymarket.com/trades{query}</code>
806
1294
 
807
- [Upstream docs ↗](https://docs.polymarket.com/api-reference/data/get-trades)
1295
+ [Upstream docs ↗](https://docs.polymarket.com/api-reference/core/get-trades-for-a-user-or-markets.md)
808
1296
 
809
1297
  ```typescript
810
1298
  const res = await polymarket.data.trades({ /* ... */ });
@@ -819,7 +1307,7 @@ Source: [`packages/provider/polymarket/src/data.ts`](src/data.ts)
819
1307
 
820
1308
  <code>GET https://data-api.polymarket.com/value{query}</code>
821
1309
 
822
- [Upstream docs ↗](https://docs.polymarket.com/api-reference/data/get-positions-value)
1310
+ [Upstream docs ↗](https://docs.polymarket.com/api-reference/core/get-total-value-of-a-users-positions.md)
823
1311
 
824
1312
  ```typescript
825
1313
  const res = await polymarket.data.value({ /* ... */ });
@@ -836,7 +1324,7 @@ Source: [`packages/provider/polymarket/src/data.ts`](src/data.ts)
836
1324
 
837
1325
  <code>GET https://gamma-api.polymarket.com/comments/{paramsOrIdOrSignal}</code>
838
1326
 
839
- [Upstream docs ↗](https://docs.polymarket.com/api-reference/gamma/get-comments)
1327
+ [Upstream docs ↗](https://docs.polymarket.com/api-reference/comments/list-comments.md)
840
1328
 
841
1329
  ```typescript
842
1330
  const res = await polymarket.gamma.comments({ /* ... */ });
@@ -851,7 +1339,7 @@ Source: [`packages/provider/polymarket/src/gamma.ts`](src/gamma.ts)
851
1339
 
852
1340
  <code>GET https://gamma-api.polymarket.com/comments/user_address/{address}{query}</code>
853
1341
 
854
- [Upstream docs ↗](https://docs.polymarket.com/api-reference/gamma/get-comments-by-user)
1342
+ [Upstream docs ↗](https://docs.polymarket.com/api-reference/comments/get-comments-by-user-address.md)
855
1343
 
856
1344
  ```typescript
857
1345
  const res = await polymarket.gamma.comments.byUser({ /* ... */ });
@@ -866,7 +1354,9 @@ Source: [`packages/provider/polymarket/src/gamma.ts`](src/gamma.ts)
866
1354
 
867
1355
  <code>GET https://gamma-api.polymarket.com/events/{paramsOrIdOrSignal}</code>
868
1356
 
869
- [Upstream docs ↗](https://docs.polymarket.com/api-reference/gamma/get-events)
1357
+ [Upstream docs ↗](https://docs.polymarket.com/api-reference/events/list-events.md)
1358
+
1359
+ > **Deprecated upstream:** the replay fixture for the list form `GET /events?...` returned `Deprecation: true`, `Sunset: Fri, 01 May 2026 00:00:00 GMT`, and `Warning: 299 - "use /events/keyset"`. This compatibility method remains for existing bare-array `/events` callers; prefer `polymarket.gamma.events.keyset()` for new paginated event lists.
870
1360
 
871
1361
  ```typescript
872
1362
  const res = await polymarket.gamma.events({ /* ... */ });
@@ -881,7 +1371,7 @@ Source: [`packages/provider/polymarket/src/gamma.ts`](src/gamma.ts)
881
1371
 
882
1372
  <code>GET https://gamma-api.polymarket.com/events/keyset{query}</code>
883
1373
 
884
- [Upstream docs ↗](https://docs.polymarket.com/api-reference/gamma/get-events-keyset)
1374
+ [Upstream docs ↗](https://docs.polymarket.com/api-reference/events/list-events-keyset-pagination.md)
885
1375
 
886
1376
  ```typescript
887
1377
  const res = await polymarket.gamma.events.keyset({ /* ... */ });
@@ -896,7 +1386,7 @@ Source: [`packages/provider/polymarket/src/gamma.ts`](src/gamma.ts)
896
1386
 
897
1387
  <code>GET https://gamma-api.polymarket.com/events/slug/{slug}</code>
898
1388
 
899
- [Upstream docs ↗](https://docs.polymarket.com/api-reference/gamma/get-event-by-slug)
1389
+ [Upstream docs ↗](https://docs.polymarket.com/api-reference/events/get-event-by-slug.md)
900
1390
 
901
1391
  ```typescript
902
1392
  const res = await polymarket.gamma.events.slug({ /* ... */ });
@@ -911,7 +1401,7 @@ Source: [`packages/provider/polymarket/src/gamma.ts`](src/gamma.ts)
911
1401
 
912
1402
  <code>GET https://gamma-api.polymarket.com/events/{id}/tags</code>
913
1403
 
914
- [Upstream docs ↗](https://docs.polymarket.com/api-reference/gamma/get-event-tags)
1404
+ [Upstream docs ↗](https://docs.polymarket.com/api-reference/events/get-event-tags.md)
915
1405
 
916
1406
  ```typescript
917
1407
  const res = await polymarket.gamma.events.tags({ /* ... */ });
@@ -926,7 +1416,7 @@ Source: [`packages/provider/polymarket/src/gamma.ts`](src/gamma.ts)
926
1416
 
927
1417
  <code>GET https://gamma-api.polymarket.com/markets/{paramsOrIdOrSignal}</code>
928
1418
 
929
- [Upstream docs ↗](https://docs.polymarket.com/api-reference/gamma/get-markets)
1419
+ [Upstream docs ↗](https://docs.polymarket.com/api-reference/markets/list-markets.md)
930
1420
 
931
1421
  ```typescript
932
1422
  const res = await polymarket.gamma.markets({ /* ... */ });
@@ -941,7 +1431,7 @@ Source: [`packages/provider/polymarket/src/gamma.ts`](src/gamma.ts)
941
1431
 
942
1432
  <code>GET https://gamma-api.polymarket.com/markets/keyset{query}</code>
943
1433
 
944
- [Upstream docs ↗](https://docs.polymarket.com/api-reference/gamma/get-markets-keyset)
1434
+ [Upstream docs ↗](https://docs.polymarket.com/api-reference/markets/list-markets-keyset-pagination.md)
945
1435
 
946
1436
  ```typescript
947
1437
  const res = await polymarket.gamma.markets.keyset({ /* ... */ });
@@ -956,7 +1446,7 @@ Source: [`packages/provider/polymarket/src/gamma.ts`](src/gamma.ts)
956
1446
 
957
1447
  <code>GET https://gamma-api.polymarket.com/markets/slug/{slug}</code>
958
1448
 
959
- [Upstream docs ↗](https://docs.polymarket.com/api-reference/gamma/get-market-by-slug)
1449
+ [Upstream docs ↗](https://docs.polymarket.com/api-reference/markets/get-market-by-slug.md)
960
1450
 
961
1451
  ```typescript
962
1452
  const res = await polymarket.gamma.markets.slug({ /* ... */ });
@@ -971,7 +1461,7 @@ Source: [`packages/provider/polymarket/src/gamma.ts`](src/gamma.ts)
971
1461
 
972
1462
  <code>GET https://gamma-api.polymarket.com/markets/{id}/tags</code>
973
1463
 
974
- [Upstream docs ↗](https://docs.polymarket.com/api-reference/gamma/get-market-tags)
1464
+ [Upstream docs ↗](https://docs.polymarket.com/api-reference/markets/get-market-tags-by-id.md)
975
1465
 
976
1466
  ```typescript
977
1467
  const res = await polymarket.gamma.markets.tags({ /* ... */ });
@@ -981,12 +1471,27 @@ Source: [`packages/provider/polymarket/src/gamma.ts`](src/gamma.ts)
981
1471
 
982
1472
  </details>
983
1473
 
1474
+ <details>
1475
+ <summary><code>GET</code> <b><code>polymarket.gamma.publicProfile</code></b></summary>
1476
+
1477
+ <code>GET https://gamma-api.polymarket.com/public-profile{query}</code>
1478
+
1479
+ [Upstream docs ↗](https://docs.polymarket.com/api-reference/profiles/get-public-profile-by-wallet-address.md)
1480
+
1481
+ ```typescript
1482
+ const res = await polymarket.gamma.publicProfile({ /* ... */ });
1483
+ ```
1484
+
1485
+ Source: [`packages/provider/polymarket/src/gamma.ts`](src/gamma.ts)
1486
+
1487
+ </details>
1488
+
984
1489
  <details>
985
1490
  <summary><code>GET</code> <b><code>polymarket.gamma.search</code></b></summary>
986
1491
 
987
1492
  <code>GET https://gamma-api.polymarket.com/public-search{query}</code>
988
1493
 
989
- [Upstream docs ↗](https://docs.polymarket.com/api-reference/gamma/search)
1494
+ [Upstream docs ↗](https://docs.polymarket.com/api-reference/search/search-markets-events-and-profiles.md)
990
1495
 
991
1496
  ```typescript
992
1497
  const res = await polymarket.gamma.search({ /* ... */ });
@@ -1001,7 +1506,7 @@ Source: [`packages/provider/polymarket/src/gamma.ts`](src/gamma.ts)
1001
1506
 
1002
1507
  <code>GET https://gamma-api.polymarket.com/series/{paramsOrIdOrSignal}</code>
1003
1508
 
1004
- [Upstream docs ↗](https://docs.polymarket.com/api-reference/gamma/get-series)
1509
+ [Upstream docs ↗](https://docs.polymarket.com/api-reference/series/list-series.md)
1005
1510
 
1006
1511
  ```typescript
1007
1512
  const res = await polymarket.gamma.series({ /* ... */ });
@@ -1016,7 +1521,7 @@ Source: [`packages/provider/polymarket/src/gamma.ts`](src/gamma.ts)
1016
1521
 
1017
1522
  <code>GET https://gamma-api.polymarket.com/sports</code>
1018
1523
 
1019
- [Upstream docs ↗](https://docs.polymarket.com/api-reference/gamma/get-sports)
1524
+ [Upstream docs ↗](https://docs.polymarket.com/api-reference/sports/get-sports-metadata-information.md)
1020
1525
 
1021
1526
  ```typescript
1022
1527
  const res = await polymarket.gamma.sports({ /* ... */ });
@@ -1031,7 +1536,7 @@ Source: [`packages/provider/polymarket/src/gamma.ts`](src/gamma.ts)
1031
1536
 
1032
1537
  <code>GET https://gamma-api.polymarket.com/sports/market-types</code>
1033
1538
 
1034
- [Upstream docs ↗](https://docs.polymarket.com/api-reference/gamma/get-sports-market-types)
1539
+ [Upstream docs ↗](https://docs.polymarket.com/api-reference/sports/get-valid-sports-market-types.md)
1035
1540
 
1036
1541
  ```typescript
1037
1542
  const res = await polymarket.gamma.sports.marketTypes({ /* ... */ });
@@ -1041,12 +1546,27 @@ Source: [`packages/provider/polymarket/src/gamma.ts`](src/gamma.ts)
1041
1546
 
1042
1547
  </details>
1043
1548
 
1549
+ <details>
1550
+ <summary><code>GET</code> <b><code>polymarket.gamma.status</code></b></summary>
1551
+
1552
+ <code>GET https://gamma-api.polymarket.com/status</code>
1553
+
1554
+ [Upstream docs ↗](https://docs.polymarket.com/api-spec/gamma-openapi.yaml)
1555
+
1556
+ ```typescript
1557
+ const res = await polymarket.gamma.status({ /* ... */ });
1558
+ ```
1559
+
1560
+ Source: [`packages/provider/polymarket/src/gamma.ts`](src/gamma.ts)
1561
+
1562
+ </details>
1563
+
1044
1564
  <details>
1045
1565
  <summary><code>GET</code> <b><code>polymarket.gamma.tags</code></b></summary>
1046
1566
 
1047
1567
  <code>GET https://gamma-api.polymarket.com/tags/{paramsOrIdOrSignal}</code>
1048
1568
 
1049
- [Upstream docs ↗](https://docs.polymarket.com/api-reference/gamma/get-tags)
1569
+ [Upstream docs ↗](https://docs.polymarket.com/api-reference/tags/list-tags.md)
1050
1570
 
1051
1571
  ```typescript
1052
1572
  const res = await polymarket.gamma.tags({ /* ... */ });
@@ -1059,9 +1579,9 @@ Source: [`packages/provider/polymarket/src/gamma.ts`](src/gamma.ts)
1059
1579
  <details>
1060
1580
  <summary><code>GET</code> <b><code>polymarket.gamma.tags.relatedTags</code></b></summary>
1061
1581
 
1062
- <code>GET https://gamma-api.polymarket.com/tags/{id}/related-tags</code>
1582
+ <code>GET https://gamma-api.polymarket.com/tags/{id}/related-tags{query}</code>
1063
1583
 
1064
- [Upstream docs ↗](https://docs.polymarket.com/api-reference/gamma/get-related-tags-by-id)
1584
+ [Upstream docs ↗](https://docs.polymarket.com/api-reference/tags/get-related-tags-relationships-by-tag-id.md)
1065
1585
 
1066
1586
  ```typescript
1067
1587
  const res = await polymarket.gamma.tags.relatedTags({ /* ... */ });
@@ -1074,9 +1594,9 @@ Source: [`packages/provider/polymarket/src/gamma.ts`](src/gamma.ts)
1074
1594
  <details>
1075
1595
  <summary><code>GET</code> <b><code>polymarket.gamma.tags.relatedTags.slug</code></b></summary>
1076
1596
 
1077
- <code>GET https://gamma-api.polymarket.com/tags/slug/{slug}/related-tags</code>
1597
+ <code>GET https://gamma-api.polymarket.com/tags/slug/{slug}/related-tags{query}</code>
1078
1598
 
1079
- [Upstream docs ↗](https://docs.polymarket.com/api-reference/gamma/get-related-tags-by-slug)
1599
+ [Upstream docs ↗](https://docs.polymarket.com/api-reference/tags/get-related-tags-relationships-by-tag-slug.md)
1080
1600
 
1081
1601
  ```typescript
1082
1602
  const res = await polymarket.gamma.tags.relatedTags.slug({ /* ... */ });
@@ -1086,12 +1606,42 @@ Source: [`packages/provider/polymarket/src/gamma.ts`](src/gamma.ts)
1086
1606
 
1087
1607
  </details>
1088
1608
 
1609
+ <details>
1610
+ <summary><code>GET</code> <b><code>polymarket.gamma.tags.relatedTags.tags</code></b></summary>
1611
+
1612
+ <code>GET https://gamma-api.polymarket.com/tags/{id}/related-tags/tags{query}</code>
1613
+
1614
+ [Upstream docs ↗](https://docs.polymarket.com/api-reference/tags/get-tags-related-to-a-tag-id.md)
1615
+
1616
+ ```typescript
1617
+ const res = await polymarket.gamma.tags.relatedTags.tags({ /* ... */ });
1618
+ ```
1619
+
1620
+ Source: [`packages/provider/polymarket/src/gamma.ts`](src/gamma.ts)
1621
+
1622
+ </details>
1623
+
1624
+ <details>
1625
+ <summary><code>GET</code> <b><code>polymarket.gamma.tags.relatedTags.tags.slug</code></b></summary>
1626
+
1627
+ <code>GET https://gamma-api.polymarket.com/tags/slug/{slug}/related-tags/tags{query}</code>
1628
+
1629
+ [Upstream docs ↗](https://docs.polymarket.com/api-reference/tags/get-tags-related-to-a-tag-slug.md)
1630
+
1631
+ ```typescript
1632
+ const res = await polymarket.gamma.tags.relatedTags.tags.slug({ /* ... */ });
1633
+ ```
1634
+
1635
+ Source: [`packages/provider/polymarket/src/gamma.ts`](src/gamma.ts)
1636
+
1637
+ </details>
1638
+
1089
1639
  <details>
1090
1640
  <summary><code>GET</code> <b><code>polymarket.gamma.tags.slug</code></b></summary>
1091
1641
 
1092
1642
  <code>GET https://gamma-api.polymarket.com/tags/slug/{slug}</code>
1093
1643
 
1094
- [Upstream docs ↗](https://docs.polymarket.com/api-reference/gamma/get-tag-by-slug)
1644
+ [Upstream docs ↗](https://docs.polymarket.com/api-reference/tags/get-tag-by-slug.md)
1095
1645
 
1096
1646
  ```typescript
1097
1647
  const res = await polymarket.gamma.tags.slug({ /* ... */ });
@@ -1101,6 +1651,21 @@ Source: [`packages/provider/polymarket/src/gamma.ts`](src/gamma.ts)
1101
1651
 
1102
1652
  </details>
1103
1653
 
1654
+ <details>
1655
+ <summary><code>GET</code> <b><code>polymarket.gamma.teams</code></b></summary>
1656
+
1657
+ <code>GET https://gamma-api.polymarket.com/teams{query}</code>
1658
+
1659
+ [Upstream docs ↗](https://docs.polymarket.com/api-reference/sports/list-teams.md)
1660
+
1661
+ ```typescript
1662
+ const res = await polymarket.gamma.teams({ /* ... */ });
1663
+ ```
1664
+
1665
+ Source: [`packages/provider/polymarket/src/gamma.ts`](src/gamma.ts)
1666
+
1667
+ </details>
1668
+
1104
1669
  Part of the [apicity](https://github.com/justintanner/apicity) monorepo.
1105
1670
 
1106
1671
  ## License