@apicity/simplefunctions 0.5.3

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 ADDED
@@ -0,0 +1,1166 @@
1
+ # @apicity/simplefunctions
2
+
3
+ [![npm](https://img.shields.io/npm/v/@apicity/simplefunctions?color=cb0000)](https://www.npmjs.com/package/@apicity/simplefunctions)
4
+ [![dependencies](https://img.shields.io/badge/dependencies-1-blue)](package.json)
5
+ [![TypeScript](https://img.shields.io/badge/TypeScript-strict-blue?logo=typescript&logoColor=white)](tsconfig.json)
6
+ [![docs](https://img.shields.io/badge/docs-docs.simplefunctions.dev-blue)](https://docs.simplefunctions.dev/api-reference/public-market-data)
7
+
8
+ SimpleFunctions public analytical and real-time data API provider for prediction-market data.
9
+
10
+ SimpleFunctions exposes two REST surfaces here: analytical Query API calls use `https://simplefunctions.dev`, while real-time market-data calls under `simplefunctions.data.v1.*` use the separate `https://data.simplefunctions.dev/v1` data API base URL. The current public WebSocket endpoint is `wss://app.simplefunctions.dev/ws`; do not model `wss://data.simplefunctions.dev/v1/ws` as active until upstream routing changes.
11
+
12
+ Runtime dependencies:
13
+
14
+ - `zod@^3.24.0` — request schemas attached to every GET endpoint as `.schema`
15
+
16
+ ## Installation
17
+
18
+ ```bash
19
+ npm install @apicity/simplefunctions
20
+ # or
21
+ pnpm add @apicity/simplefunctions
22
+ ```
23
+
24
+ ## Quick Start
25
+
26
+ ```typescript
27
+ import { createSimpleFunctions } from "@apicity/simplefunctions";
28
+
29
+ const simplefunctions = createSimpleFunctions({ apiKey: process.env.SIMPLEFUNCTIONS_API_KEY });
30
+ ```
31
+
32
+ ## API Reference
33
+
34
+ 73 endpoints across 6 groups. Each method mirrors an upstream URL path.
35
+
36
+ ### agent
37
+
38
+ <details>
39
+ <summary><code>GET</code> <b><code>simplefunctions.api.agent.feed</code></b></summary>
40
+
41
+ <code>GET https://simplefunctions.dev/api/agent/feed/{topic}{query}</code>
42
+
43
+ [Upstream docs ↗](https://docs.simplefunctions.dev/api-reference/agent)
44
+
45
+ ```typescript
46
+ const res = await simplefunctions.api.agent.feed({ /* ... */ });
47
+ ```
48
+
49
+ Source: [`packages/provider/simplefunctions/src/simplefunctions.ts`](src/simplefunctions.ts)
50
+
51
+ </details>
52
+
53
+ <details>
54
+ <summary><code>GET</code> <b><code>simplefunctions.api.agent.inspect</code></b></summary>
55
+
56
+ <code>GET https://simplefunctions.dev/api/agent/inspect/{ticker}{query}</code>
57
+
58
+ [Upstream docs ↗](https://docs.simplefunctions.dev/api-reference/agent)
59
+
60
+ ```typescript
61
+ const res = await simplefunctions.api.agent.inspect({ /* ... */ });
62
+ ```
63
+
64
+ Source: [`packages/provider/simplefunctions/src/simplefunctions.ts`](src/simplefunctions.ts)
65
+
66
+ </details>
67
+
68
+ <details>
69
+ <summary><code>GET</code> <b><code>simplefunctions.api.agent.world</code></b></summary>
70
+
71
+ <code>GET https://simplefunctions.dev/api/agent/world{query}</code>
72
+
73
+ [Upstream docs ↗](https://docs.simplefunctions.dev/api-reference/world-state)
74
+
75
+ ```typescript
76
+ const res = await simplefunctions.api.agent.world({ /* ... */ });
77
+ ```
78
+
79
+ Source: [`packages/provider/simplefunctions/src/simplefunctions.ts`](src/simplefunctions.ts)
80
+
81
+ </details>
82
+
83
+ <details>
84
+ <summary><code>GET</code> <b><code>simplefunctions.api.agent.world.delta</code></b></summary>
85
+
86
+ <code>GET https://simplefunctions.dev/api/agent/world/delta{query}</code>
87
+
88
+ [Upstream docs ↗](https://docs.simplefunctions.dev/api-reference/world-state)
89
+
90
+ ```typescript
91
+ const res = await simplefunctions.api.agent.world.delta({ /* ... */ });
92
+ ```
93
+
94
+ Source: [`packages/provider/simplefunctions/src/simplefunctions.ts`](src/simplefunctions.ts)
95
+
96
+ </details>
97
+
98
+ <details>
99
+ <summary><code>GET</code> <b><code>simplefunctions.api.agent.world.feed</code></b></summary>
100
+
101
+ <code>GET https://simplefunctions.dev/api/agent/world/feed</code>
102
+
103
+ [Upstream docs ↗](https://docs.simplefunctions.dev/api-reference/world-state)
104
+
105
+ ```typescript
106
+ const res = await simplefunctions.api.agent.world.feed({ /* ... */ });
107
+ ```
108
+
109
+ Source: [`packages/provider/simplefunctions/src/simplefunctions.ts`](src/simplefunctions.ts)
110
+
111
+ </details>
112
+
113
+ <details>
114
+ <summary><code>GET</code> <b><code>simplefunctions.api.agent.world.path</code></b></summary>
115
+
116
+ <code>GET https://simplefunctions.dev/api/agent/world/{path}{query}</code>
117
+
118
+ [Upstream docs ↗](https://docs.simplefunctions.dev/api-reference/world-state)
119
+
120
+ ```typescript
121
+ const res = await simplefunctions.api.agent.world.path({ /* ... */ });
122
+ ```
123
+
124
+ Source: [`packages/provider/simplefunctions/src/simplefunctions.ts`](src/simplefunctions.ts)
125
+
126
+ </details>
127
+
128
+ ### calibration
129
+
130
+ <details>
131
+ <summary><code>GET</code> <b><code>simplefunctions.api.calibration</code></b></summary>
132
+
133
+ <code>GET https://simplefunctions.dev/api/calibration{query}</code>
134
+
135
+ [Upstream docs ↗](https://docs.simplefunctions.dev/api-reference/index-regime)
136
+
137
+ ```typescript
138
+ const res = await simplefunctions.api.calibration({ /* ... */ });
139
+ ```
140
+
141
+ Source: [`packages/provider/simplefunctions/src/simplefunctions.ts`](src/simplefunctions.ts)
142
+
143
+ </details>
144
+
145
+ ### changes
146
+
147
+ <details>
148
+ <summary><code>GET</code> <b><code>simplefunctions.api.changes</code></b></summary>
149
+
150
+ <code>GET https://simplefunctions.dev/api/changes{query}</code>
151
+
152
+ [Upstream docs ↗](https://docs.simplefunctions.dev/reference/daily-data)
153
+
154
+ ```typescript
155
+ const res = await simplefunctions.api.changes({ /* ... */ });
156
+ ```
157
+
158
+ Source: [`packages/provider/simplefunctions/src/simplefunctions.ts`](src/simplefunctions.ts)
159
+
160
+ </details>
161
+
162
+ ### data
163
+
164
+ <details>
165
+ <summary><code>GET</code> <b><code>simplefunctions.data.v1.candles</code></b></summary>
166
+
167
+ <code>GET https://data.simplefunctions.dev/v1/candles/{ticker}{query}</code>
168
+
169
+ [Upstream docs ↗](https://docs.simplefunctions.dev/reference/realtime-data)
170
+
171
+ ```typescript
172
+ const res = await simplefunctions.data.v1.candles("KXPRESNOMD-28-GN", {
173
+ tf: "1h",
174
+ limit: 500,
175
+ });
176
+ ```
177
+
178
+ Source: [`packages/provider/simplefunctions/src/simplefunctions.ts`](src/simplefunctions.ts)
179
+
180
+ </details>
181
+
182
+ <details>
183
+ <summary><code>GET</code> <b><code>simplefunctions.data.v1.heartbeat</code></b></summary>
184
+
185
+ <code>GET https://data.simplefunctions.dev/v1/heartbeat</code>
186
+
187
+ [Upstream docs ↗](https://docs.simplefunctions.dev/reference/realtime-data)
188
+
189
+ ```typescript
190
+ const res = await simplefunctions.data.v1.heartbeat();
191
+ ```
192
+
193
+ Source: [`packages/provider/simplefunctions/src/simplefunctions.ts`](src/simplefunctions.ts)
194
+
195
+ </details>
196
+
197
+ <details>
198
+ <summary><code>GET</code> <b><code>simplefunctions.data.v1.markets</code></b></summary>
199
+
200
+ <code>GET https://data.simplefunctions.dev/v1/markets{query}</code>
201
+
202
+ [Upstream docs ↗](https://docs.simplefunctions.dev/reference/realtime-data)
203
+
204
+ ```typescript
205
+ const res = await simplefunctions.data.v1.markets({
206
+ q: "newsom",
207
+ venue: "kalshi",
208
+ });
209
+ ```
210
+
211
+ Source: [`packages/provider/simplefunctions/src/simplefunctions.ts`](src/simplefunctions.ts)
212
+
213
+ </details>
214
+
215
+ <details>
216
+ <summary><code>GET</code> <b><code>simplefunctions.data.v1.markets.featured</code></b></summary>
217
+
218
+ <code>GET https://data.simplefunctions.dev/v1/markets/featured{query}</code>
219
+
220
+ [Upstream docs ↗](https://docs.simplefunctions.dev/reference/realtime-data)
221
+
222
+ ```typescript
223
+ const res = await simplefunctions.data.v1.markets.featured({ n: 50 });
224
+ ```
225
+
226
+ Source: [`packages/provider/simplefunctions/src/simplefunctions.ts`](src/simplefunctions.ts)
227
+
228
+ </details>
229
+
230
+ <details>
231
+ <summary><code>GET</code> <b><code>simplefunctions.data.v1.markets.retrieve</code></b></summary>
232
+
233
+ <code>GET https://data.simplefunctions.dev/v1/markets/{ticker}</code>
234
+
235
+ [Upstream docs ↗](https://docs.simplefunctions.dev/reference/realtime-data)
236
+
237
+ ```typescript
238
+ const res = await simplefunctions.data.v1.markets.retrieve("KXPRESNOMD-28-GN");
239
+ ```
240
+
241
+ Source: [`packages/provider/simplefunctions/src/simplefunctions.ts`](src/simplefunctions.ts)
242
+
243
+ </details>
244
+
245
+ <details>
246
+ <summary><code>GET</code> <b><code>simplefunctions.data.v1.movers</code></b></summary>
247
+
248
+ <code>GET https://data.simplefunctions.dev/v1/movers{query}</code>
249
+
250
+ [Upstream docs ↗](https://docs.simplefunctions.dev/reference/realtime-data)
251
+
252
+ ```typescript
253
+ const res = await simplefunctions.data.v1.movers({
254
+ window: "1h",
255
+ n: 50,
256
+ minVol: 1000,
257
+ dir: "both",
258
+ });
259
+ ```
260
+
261
+ Source: [`packages/provider/simplefunctions/src/simplefunctions.ts`](src/simplefunctions.ts)
262
+
263
+ </details>
264
+
265
+ <details>
266
+ <summary><code>GET</code> <b><code>simplefunctions.data.v1.orderbook</code></b></summary>
267
+
268
+ <code>GET https://data.simplefunctions.dev/v1/orderbook/{ticker}</code>
269
+
270
+ [Upstream docs ↗](https://docs.simplefunctions.dev/reference/realtime-data)
271
+
272
+ ```typescript
273
+ const res = await simplefunctions.data.v1.orderbook("KXPRESNOMD-28-GN");
274
+ ```
275
+
276
+ Source: [`packages/provider/simplefunctions/src/simplefunctions.ts`](src/simplefunctions.ts)
277
+
278
+ </details>
279
+
280
+ <details>
281
+ <summary><code>GET</code> <b><code>simplefunctions.data.v1.search</code></b></summary>
282
+
283
+ <code>GET https://data.simplefunctions.dev/v1/search{query}</code>
284
+
285
+ [Upstream docs ↗](https://docs.simplefunctions.dev/reference/realtime-data)
286
+
287
+ ```typescript
288
+ const res = await simplefunctions.data.v1.search({
289
+ q: "rate cut",
290
+ limit: 10,
291
+ venue: "kalshi",
292
+ });
293
+ ```
294
+
295
+ Source: [`packages/provider/simplefunctions/src/simplefunctions.ts`](src/simplefunctions.ts)
296
+
297
+ </details>
298
+
299
+ <details>
300
+ <summary><code>GET</code> <b><code>simplefunctions.data.v1.snapshot</code></b></summary>
301
+
302
+ <code>GET https://data.simplefunctions.dev/v1/snapshot</code>
303
+
304
+ [Upstream docs ↗](https://docs.simplefunctions.dev/reference/realtime-data)
305
+
306
+ ```typescript
307
+ const res = await simplefunctions.data.v1.snapshot();
308
+ ```
309
+
310
+ Source: [`packages/provider/simplefunctions/src/simplefunctions.ts`](src/simplefunctions.ts)
311
+
312
+ </details>
313
+
314
+ <details>
315
+ <summary><code>GET</code> <b><code>simplefunctions.data.v1.trades</code></b></summary>
316
+
317
+ <code>GET https://data.simplefunctions.dev/v1/trades/{ticker}{query}</code>
318
+
319
+ [Upstream docs ↗](https://docs.simplefunctions.dev/reference/realtime-data)
320
+
321
+ ```typescript
322
+ const res = await simplefunctions.data.v1.trades("KXPRESNOMD-28-GN", { limit: 50 });
323
+ ```
324
+
325
+ Source: [`packages/provider/simplefunctions/src/simplefunctions.ts`](src/simplefunctions.ts)
326
+
327
+ </details>
328
+
329
+ ### edges
330
+
331
+ <details>
332
+ <summary><code>GET</code> <b><code>simplefunctions.api.edges</code></b></summary>
333
+
334
+ <code>GET https://simplefunctions.dev/api/edges{query}</code>
335
+
336
+ [Upstream docs ↗](https://docs.simplefunctions.dev/api-reference/index-regime)
337
+
338
+ ```typescript
339
+ const res = await simplefunctions.api.edges({ /* ... */ });
340
+ ```
341
+
342
+ Source: [`packages/provider/simplefunctions/src/simplefunctions.ts`](src/simplefunctions.ts)
343
+
344
+ </details>
345
+
346
+ ### public
347
+
348
+ <details>
349
+ <summary><code>GET</code> <b><code>simplefunctions.api.public.answer</code></b></summary>
350
+
351
+ <code>GET https://simplefunctions.dev/api/public/answer/{slug}</code>
352
+
353
+ [Upstream docs ↗](https://docs.simplefunctions.dev/api-reference/public-market-data)
354
+
355
+ ```typescript
356
+ const res = await simplefunctions.api.public.answer({ /* ... */ });
357
+ ```
358
+
359
+ Source: [`packages/provider/simplefunctions/src/simplefunctions.ts`](src/simplefunctions.ts)
360
+
361
+ </details>
362
+
363
+ <details>
364
+ <summary><code>GET</code> <b><code>simplefunctions.api.public.briefing</code></b></summary>
365
+
366
+ <code>GET https://simplefunctions.dev/api/public/briefing{query}</code>
367
+
368
+ [Upstream docs ↗](https://docs.simplefunctions.dev/reference/daily-data)
369
+
370
+ ```typescript
371
+ const res = await simplefunctions.api.public.briefing({ /* ... */ });
372
+ ```
373
+
374
+ Source: [`packages/provider/simplefunctions/src/simplefunctions.ts`](src/simplefunctions.ts)
375
+
376
+ </details>
377
+
378
+ <details>
379
+ <summary><code>GET</code> <b><code>simplefunctions.api.public.calendar</code></b></summary>
380
+
381
+ <code>GET https://simplefunctions.dev/api/public/calendar{query}</code>
382
+
383
+ [Upstream docs ↗](https://docs.simplefunctions.dev/api-reference/index-regime)
384
+
385
+ ```typescript
386
+ const res = await simplefunctions.api.public.calendar({ /* ... */ });
387
+ ```
388
+
389
+ Source: [`packages/provider/simplefunctions/src/simplefunctions.ts`](src/simplefunctions.ts)
390
+
391
+ </details>
392
+
393
+ <details>
394
+ <summary><code>GET</code> <b><code>simplefunctions.api.public.calibration</code></b></summary>
395
+
396
+ <code>GET https://simplefunctions.dev/api/public/calibration{query}</code>
397
+
398
+ [Upstream docs ↗](https://docs.simplefunctions.dev/api-reference/index-regime)
399
+
400
+ ```typescript
401
+ const res = await simplefunctions.api.public.calibration({ /* ... */ });
402
+ ```
403
+
404
+ Source: [`packages/provider/simplefunctions/src/simplefunctions.ts`](src/simplefunctions.ts)
405
+
406
+ </details>
407
+
408
+ <details>
409
+ <summary><code>GET</code> <b><code>simplefunctions.api.public.congress.member</code></b></summary>
410
+
411
+ <code>GET https://simplefunctions.dev/api/public/congress/member/{id}</code>
412
+
413
+ [Upstream docs ↗](https://docs.simplefunctions.dev/api-reference/public-market-data)
414
+
415
+ ```typescript
416
+ const res = await simplefunctions.api.public.congress.member({ /* ... */ });
417
+ ```
418
+
419
+ Source: [`packages/provider/simplefunctions/src/simplefunctions.ts`](src/simplefunctions.ts)
420
+
421
+ </details>
422
+
423
+ <details>
424
+ <summary><code>GET</code> <b><code>simplefunctions.api.public.congress.members</code></b></summary>
425
+
426
+ <code>GET https://simplefunctions.dev/api/public/congress/members{query}</code>
427
+
428
+ [Upstream docs ↗](https://docs.simplefunctions.dev/api-reference/public-market-data)
429
+
430
+ ```typescript
431
+ const res = await simplefunctions.api.public.congress.members({ /* ... */ });
432
+ ```
433
+
434
+ Source: [`packages/provider/simplefunctions/src/simplefunctions.ts`](src/simplefunctions.ts)
435
+
436
+ </details>
437
+
438
+ <details>
439
+ <summary><code>GET</code> <b><code>simplefunctions.api.public.contagion</code></b></summary>
440
+
441
+ <code>GET https://simplefunctions.dev/api/public/contagion{query}</code>
442
+
443
+ [Upstream docs ↗](https://docs.simplefunctions.dev/api-reference/public-market-data)
444
+
445
+ ```typescript
446
+ const res = await simplefunctions.api.public.contagion({ /* ... */ });
447
+ ```
448
+
449
+ Source: [`packages/provider/simplefunctions/src/simplefunctions.ts`](src/simplefunctions.ts)
450
+
451
+ </details>
452
+
453
+ <details>
454
+ <summary><code>GET</code> <b><code>simplefunctions.api.public.context</code></b></summary>
455
+
456
+ <code>GET https://simplefunctions.dev/api/public/context{query}</code>
457
+
458
+ [Upstream docs ↗](https://docs.simplefunctions.dev/reference/daily-data)
459
+
460
+ ```typescript
461
+ const res = await simplefunctions.api.public.context({ /* ... */ });
462
+ ```
463
+
464
+ Source: [`packages/provider/simplefunctions/src/simplefunctions.ts`](src/simplefunctions.ts)
465
+
466
+ </details>
467
+
468
+ <details>
469
+ <summary><code>GET</code> <b><code>simplefunctions.api.public.crossVenue.pairs</code></b></summary>
470
+
471
+ <code>GET https://simplefunctions.dev/api/public/cross-venue/pairs{query}</code>
472
+
473
+ [Upstream docs ↗](https://docs.simplefunctions.dev/api-reference/public-market-data)
474
+
475
+ ```typescript
476
+ const res = await simplefunctions.api.public.crossVenue.pairs({ /* ... */ });
477
+ ```
478
+
479
+ Source: [`packages/provider/simplefunctions/src/simplefunctions.ts`](src/simplefunctions.ts)
480
+
481
+ </details>
482
+
483
+ <details>
484
+ <summary><code>GET</code> <b><code>simplefunctions.api.public.crossVenue.stats</code></b></summary>
485
+
486
+ <code>GET https://simplefunctions.dev/api/public/cross-venue/stats{query}</code>
487
+
488
+ [Upstream docs ↗](https://docs.simplefunctions.dev/api-reference/public-market-data)
489
+
490
+ ```typescript
491
+ const res = await simplefunctions.api.public.crossVenue.stats({ /* ... */ });
492
+ ```
493
+
494
+ Source: [`packages/provider/simplefunctions/src/simplefunctions.ts`](src/simplefunctions.ts)
495
+
496
+ </details>
497
+
498
+ <details>
499
+ <summary><code>GET</code> <b><code>simplefunctions.api.public.databento</code></b></summary>
500
+
501
+ <code>GET https://simplefunctions.dev/api/public/databento{query}</code>
502
+
503
+ [Upstream docs ↗](https://docs.simplefunctions.dev/api-reference/public-market-data)
504
+
505
+ ```typescript
506
+ const res = await simplefunctions.api.public.databento({ /* ... */ });
507
+ ```
508
+
509
+ Source: [`packages/provider/simplefunctions/src/simplefunctions.ts`](src/simplefunctions.ts)
510
+
511
+ </details>
512
+
513
+ <details>
514
+ <summary><code>GET</code> <b><code>simplefunctions.api.public.diff</code></b></summary>
515
+
516
+ <code>GET https://simplefunctions.dev/api/public/diff{query}</code>
517
+
518
+ [Upstream docs ↗](https://docs.simplefunctions.dev/api-reference/public-market-data)
519
+
520
+ ```typescript
521
+ const res = await simplefunctions.api.public.diff({ /* ... */ });
522
+ ```
523
+
524
+ Source: [`packages/provider/simplefunctions/src/simplefunctions.ts`](src/simplefunctions.ts)
525
+
526
+ </details>
527
+
528
+ <details>
529
+ <summary><code>POST</code> <b><code>simplefunctions.api.public.discuss</code></b></summary>
530
+
531
+ <code>POST https://simplefunctions.dev/api/public/discuss</code>
532
+
533
+ [Upstream docs ↗](https://docs.simplefunctions.dev/api-reference/public-market-data)
534
+
535
+ ```typescript
536
+ const res = await simplefunctions.api.public.discuss({ /* ... */ });
537
+ ```
538
+
539
+ Source: [`packages/provider/simplefunctions/src/simplefunctions.ts`](src/simplefunctions.ts)
540
+
541
+ </details>
542
+
543
+ <details>
544
+ <summary><code>GET</code> <b><code>simplefunctions.api.public.fred</code></b></summary>
545
+
546
+ <code>GET https://simplefunctions.dev/api/public/fred{query}</code>
547
+
548
+ [Upstream docs ↗](https://docs.simplefunctions.dev/api-reference/gov-econ)
549
+
550
+ ```typescript
551
+ const res = await simplefunctions.api.public.fred({ /* ... */ });
552
+ ```
553
+
554
+ Source: [`packages/provider/simplefunctions/src/simplefunctions.ts`](src/simplefunctions.ts)
555
+
556
+ </details>
557
+
558
+ <details>
559
+ <summary><code>GET</code> <b><code>simplefunctions.api.public.glossary</code></b></summary>
560
+
561
+ <code>GET https://simplefunctions.dev/api/public/glossary{query}</code>
562
+
563
+ [Upstream docs ↗](https://docs.simplefunctions.dev/reference/daily-data)
564
+
565
+ ```typescript
566
+ const res = await simplefunctions.api.public.glossary({ /* ... */ });
567
+ ```
568
+
569
+ Source: [`packages/provider/simplefunctions/src/simplefunctions.ts`](src/simplefunctions.ts)
570
+
571
+ </details>
572
+
573
+ <details>
574
+ <summary><code>GET</code> <b><code>simplefunctions.api.public.glossary.entry</code></b></summary>
575
+
576
+ <code>GET https://simplefunctions.dev/api/public/glossary/{slug}</code>
577
+
578
+ [Upstream docs ↗](https://docs.simplefunctions.dev/reference/daily-data)
579
+
580
+ ```typescript
581
+ const res = await simplefunctions.api.public.glossary.entry({ /* ... */ });
582
+ ```
583
+
584
+ Source: [`packages/provider/simplefunctions/src/simplefunctions.ts`](src/simplefunctions.ts)
585
+
586
+ </details>
587
+
588
+ <details>
589
+ <summary><code>GET</code> <b><code>simplefunctions.api.public.guide</code></b></summary>
590
+
591
+ <code>GET https://simplefunctions.dev/api/public/guide</code>
592
+
593
+ [Upstream docs ↗](https://docs.simplefunctions.dev/api-reference/public-market-data)
594
+
595
+ ```typescript
596
+ const res = await simplefunctions.api.public.guide({ /* ... */ });
597
+ ```
598
+
599
+ Source: [`packages/provider/simplefunctions/src/simplefunctions.ts`](src/simplefunctions.ts)
600
+
601
+ </details>
602
+
603
+ <details>
604
+ <summary><code>GET</code> <b><code>simplefunctions.api.public.highlights</code></b></summary>
605
+
606
+ <code>GET https://simplefunctions.dev/api/public/highlights{query}</code>
607
+
608
+ [Upstream docs ↗](https://docs.simplefunctions.dev/api-reference/public-market-data)
609
+
610
+ ```typescript
611
+ const res = await simplefunctions.api.public.highlights({ /* ... */ });
612
+ ```
613
+
614
+ Source: [`packages/provider/simplefunctions/src/simplefunctions.ts`](src/simplefunctions.ts)
615
+
616
+ </details>
617
+
618
+ <details>
619
+ <summary><code>GET</code> <b><code>simplefunctions.api.public.ideas</code></b></summary>
620
+
621
+ <code>GET https://simplefunctions.dev/api/public/ideas{query}</code>
622
+
623
+ [Upstream docs ↗](https://docs.simplefunctions.dev/reference/daily-data)
624
+
625
+ ```typescript
626
+ const res = await simplefunctions.api.public.ideas({ /* ... */ });
627
+ ```
628
+
629
+ Source: [`packages/provider/simplefunctions/src/simplefunctions.ts`](src/simplefunctions.ts)
630
+
631
+ </details>
632
+
633
+ <details>
634
+ <summary><code>GET</code> <b><code>simplefunctions.api.public.ideas.byId</code></b></summary>
635
+
636
+ <code>GET https://simplefunctions.dev/api/public/ideas/{id}</code>
637
+
638
+ [Upstream docs ↗](https://docs.simplefunctions.dev/reference/daily-data)
639
+
640
+ ```typescript
641
+ const res = await simplefunctions.api.public.ideas.byId({ /* ... */ });
642
+ ```
643
+
644
+ Source: [`packages/provider/simplefunctions/src/simplefunctions.ts`](src/simplefunctions.ts)
645
+
646
+ </details>
647
+
648
+ <details>
649
+ <summary><code>GET</code> <b><code>simplefunctions.api.public.index</code></b></summary>
650
+
651
+ <code>GET https://simplefunctions.dev/api/public/index</code>
652
+
653
+ [Upstream docs ↗](https://docs.simplefunctions.dev/api-reference/index-regime)
654
+
655
+ ```typescript
656
+ const res = await simplefunctions.api.public.index({ /* ... */ });
657
+ ```
658
+
659
+ Source: [`packages/provider/simplefunctions/src/simplefunctions.ts`](src/simplefunctions.ts)
660
+
661
+ </details>
662
+
663
+ <details>
664
+ <summary><code>GET</code> <b><code>simplefunctions.api.public.index.history</code></b></summary>
665
+
666
+ <code>GET https://simplefunctions.dev/api/public/index/history{query}</code>
667
+
668
+ [Upstream docs ↗](https://docs.simplefunctions.dev/api-reference/index-regime)
669
+
670
+ ```typescript
671
+ const res = await simplefunctions.api.public.index.history({ /* ... */ });
672
+ ```
673
+
674
+ Source: [`packages/provider/simplefunctions/src/simplefunctions.ts`](src/simplefunctions.ts)
675
+
676
+ </details>
677
+
678
+ <details>
679
+ <summary><code>GET</code> <b><code>simplefunctions.api.public.legislation</code></b></summary>
680
+
681
+ <code>GET https://simplefunctions.dev/api/public/legislation{query}</code>
682
+
683
+ [Upstream docs ↗](https://docs.simplefunctions.dev/api-reference/gov-econ)
684
+
685
+ ```typescript
686
+ const res = await simplefunctions.api.public.legislation({ /* ... */ });
687
+ ```
688
+
689
+ Source: [`packages/provider/simplefunctions/src/simplefunctions.ts`](src/simplefunctions.ts)
690
+
691
+ </details>
692
+
693
+ <details>
694
+ <summary><code>GET</code> <b><code>simplefunctions.api.public.legislation.byBillId</code></b></summary>
695
+
696
+ <code>GET https://simplefunctions.dev/api/public/legislation/{billId}</code>
697
+
698
+ [Upstream docs ↗](https://docs.simplefunctions.dev/api-reference/gov-econ)
699
+
700
+ ```typescript
701
+ const res = await simplefunctions.api.public.legislation.byBillId({ /* ... */ });
702
+ ```
703
+
704
+ Source: [`packages/provider/simplefunctions/src/simplefunctions.ts`](src/simplefunctions.ts)
705
+
706
+ </details>
707
+
708
+ <details>
709
+ <summary><code>GET</code> <b><code>simplefunctions.api.public.liquidityByTheme</code></b></summary>
710
+
711
+ <code>GET https://simplefunctions.dev/api/public/liquidity-by-theme{query}</code>
712
+
713
+ [Upstream docs ↗](https://docs.simplefunctions.dev/api-reference/public-market-data)
714
+
715
+ ```typescript
716
+ const res = await simplefunctions.api.public.liquidityByTheme({ /* ... */ });
717
+ ```
718
+
719
+ Source: [`packages/provider/simplefunctions/src/simplefunctions.ts`](src/simplefunctions.ts)
720
+
721
+ </details>
722
+
723
+ <details>
724
+ <summary><code>GET</code> <b><code>simplefunctions.api.public.liveTickers</code></b></summary>
725
+
726
+ <code>GET https://simplefunctions.dev/api/public/live-tickers{query}</code>
727
+
728
+ [Upstream docs ↗](https://docs.simplefunctions.dev/api-reference/public-market-data)
729
+
730
+ ```typescript
731
+ const res = await simplefunctions.api.public.liveTickers({ /* ... */ });
732
+ ```
733
+
734
+ Source: [`packages/provider/simplefunctions/src/simplefunctions.ts`](src/simplefunctions.ts)
735
+
736
+ </details>
737
+
738
+ <details>
739
+ <summary><code>GET</code> <b><code>simplefunctions.api.public.market</code></b></summary>
740
+
741
+ <code>GET https://simplefunctions.dev/api/public/market/{ticker}{query}</code>
742
+
743
+ [Upstream docs ↗](https://docs.simplefunctions.dev/api-reference/market-detail)
744
+
745
+ ```typescript
746
+ const res = await simplefunctions.api.public.market({ /* ... */ });
747
+ ```
748
+
749
+ Source: [`packages/provider/simplefunctions/src/simplefunctions.ts`](src/simplefunctions.ts)
750
+
751
+ </details>
752
+
753
+ <details>
754
+ <summary><code>GET</code> <b><code>simplefunctions.api.public.market.candles</code></b></summary>
755
+
756
+ <code>GET https://simplefunctions.dev/api/public/market/{ticker}/candles{query}</code>
757
+
758
+ [Upstream docs ↗](https://docs.simplefunctions.dev/api-reference/public-market-data)
759
+
760
+ ```typescript
761
+ const res = await simplefunctions.api.public.market.candles({ /* ... */ });
762
+ ```
763
+
764
+ Source: [`packages/provider/simplefunctions/src/simplefunctions.ts`](src/simplefunctions.ts)
765
+
766
+ </details>
767
+
768
+ <details>
769
+ <summary><code>GET</code> <b><code>simplefunctions.api.public.market.history</code></b></summary>
770
+
771
+ <code>GET https://simplefunctions.dev/api/public/market/{ticker}/history</code>
772
+
773
+ [Upstream docs ↗](https://docs.simplefunctions.dev/api-reference/market-detail)
774
+
775
+ ```typescript
776
+ const res = await simplefunctions.api.public.market.history({ /* ... */ });
777
+ ```
778
+
779
+ Source: [`packages/provider/simplefunctions/src/simplefunctions.ts`](src/simplefunctions.ts)
780
+
781
+ </details>
782
+
783
+ <details>
784
+ <summary><code>GET</code> <b><code>simplefunctions.api.public.marketMicrostructureHistory</code></b></summary>
785
+
786
+ <code>GET https://simplefunctions.dev/api/public/market-microstructure-history{query}</code>
787
+
788
+ [Upstream docs ↗](https://docs.simplefunctions.dev/api-reference/public-market-data)
789
+
790
+ ```typescript
791
+ const res = await simplefunctions.api.public.marketMicrostructureHistory({ /* ... */ });
792
+ ```
793
+
794
+ Source: [`packages/provider/simplefunctions/src/simplefunctions.ts`](src/simplefunctions.ts)
795
+
796
+ </details>
797
+
798
+ <details>
799
+ <summary><code>GET</code> <b><code>simplefunctions.api.public.markets</code></b></summary>
800
+
801
+ <code>GET https://simplefunctions.dev/api/public/markets{query}</code>
802
+
803
+ [Upstream docs ↗](https://docs.simplefunctions.dev/api-reference/public-market-data)
804
+
805
+ ```typescript
806
+ const res = await simplefunctions.api.public.markets({ /* ... */ });
807
+ ```
808
+
809
+ Source: [`packages/provider/simplefunctions/src/simplefunctions.ts`](src/simplefunctions.ts)
810
+
811
+ </details>
812
+
813
+ <details>
814
+ <summary><code>GET</code> <b><code>simplefunctions.api.public.newmarkets</code></b></summary>
815
+
816
+ <code>GET https://simplefunctions.dev/api/public/newmarkets{query}</code>
817
+
818
+ [Upstream docs ↗](https://docs.simplefunctions.dev/api-reference/public-market-data)
819
+
820
+ ```typescript
821
+ const res = await simplefunctions.api.public.newmarkets({ /* ... */ });
822
+ ```
823
+
824
+ Source: [`packages/provider/simplefunctions/src/simplefunctions.ts`](src/simplefunctions.ts)
825
+
826
+ </details>
827
+
828
+ <details>
829
+ <summary><code>GET</code> <b><code>simplefunctions.api.public.odds</code></b></summary>
830
+
831
+ <code>GET https://simplefunctions.dev/api/public/odds{query}</code>
832
+
833
+ [Upstream docs ↗](https://docs.simplefunctions.dev/api-reference/public-market-data)
834
+
835
+ ```typescript
836
+ const res = await simplefunctions.api.public.odds({ /* ... */ });
837
+ ```
838
+
839
+ Source: [`packages/provider/simplefunctions/src/simplefunctions.ts`](src/simplefunctions.ts)
840
+
841
+ </details>
842
+
843
+ <details>
844
+ <summary><code>GET</code> <b><code>simplefunctions.api.public.oddsMd</code></b></summary>
845
+
846
+ <code>GET https://simplefunctions.dev/api/public/odds.md{query}</code>
847
+
848
+ [Upstream docs ↗](https://docs.simplefunctions.dev/api-reference/public-market-data)
849
+
850
+ ```typescript
851
+ const res = await simplefunctions.api.public.oddsMd({ /* ... */ });
852
+ ```
853
+
854
+ Source: [`packages/provider/simplefunctions/src/simplefunctions.ts`](src/simplefunctions.ts)
855
+
856
+ </details>
857
+
858
+ <details>
859
+ <summary><code>GET</code> <b><code>simplefunctions.api.public.opinions</code></b></summary>
860
+
861
+ <code>GET https://simplefunctions.dev/api/public/opinions{query}</code>
862
+
863
+ [Upstream docs ↗](https://docs.simplefunctions.dev/api-reference/public-market-data)
864
+
865
+ ```typescript
866
+ const res = await simplefunctions.api.public.opinions({ /* ... */ });
867
+ ```
868
+
869
+ Source: [`packages/provider/simplefunctions/src/simplefunctions.ts`](src/simplefunctions.ts)
870
+
871
+ </details>
872
+
873
+ <details>
874
+ <summary><code>GET</code> <b><code>simplefunctions.api.public.opinions.entry</code></b></summary>
875
+
876
+ <code>GET https://simplefunctions.dev/api/public/opinions/{slug}</code>
877
+
878
+ [Upstream docs ↗](https://docs.simplefunctions.dev/api-reference/public-market-data)
879
+
880
+ ```typescript
881
+ const res = await simplefunctions.api.public.opinions.entry({ /* ... */ });
882
+ ```
883
+
884
+ Source: [`packages/provider/simplefunctions/src/simplefunctions.ts`](src/simplefunctions.ts)
885
+
886
+ </details>
887
+
888
+ <details>
889
+ <summary><code>GET</code> <b><code>simplefunctions.api.public.query</code></b></summary>
890
+
891
+ <code>GET https://simplefunctions.dev/api/public/query{query}</code>
892
+
893
+ [Upstream docs ↗](https://docs.simplefunctions.dev/api-reference/query)
894
+
895
+ ```typescript
896
+ const res = await simplefunctions.api.public.query({
897
+ q: "Fed rate cut",
898
+ sources: ["kalshi", "polymarket"],
899
+ limit: 3,
900
+ });
901
+ ```
902
+
903
+ Source: [`packages/provider/simplefunctions/src/simplefunctions.ts`](src/simplefunctions.ts)
904
+
905
+ </details>
906
+
907
+ <details>
908
+ <summary><code>GET</code> <b><code>simplefunctions.api.public.queryEcon</code></b></summary>
909
+
910
+ <code>GET https://simplefunctions.dev/api/public/query-econ{query}</code>
911
+
912
+ [Upstream docs ↗](https://docs.simplefunctions.dev/api-reference/gov-econ)
913
+
914
+ ```typescript
915
+ const res = await simplefunctions.api.public.queryEcon({ /* ... */ });
916
+ ```
917
+
918
+ Source: [`packages/provider/simplefunctions/src/simplefunctions.ts`](src/simplefunctions.ts)
919
+
920
+ </details>
921
+
922
+ <details>
923
+ <summary><code>GET</code> <b><code>simplefunctions.api.public.queryGov</code></b></summary>
924
+
925
+ <code>GET https://simplefunctions.dev/api/public/query-gov{query}</code>
926
+
927
+ [Upstream docs ↗](https://docs.simplefunctions.dev/api-reference/gov-econ)
928
+
929
+ ```typescript
930
+ const res = await simplefunctions.api.public.queryGov({ /* ... */ });
931
+ ```
932
+
933
+ Source: [`packages/provider/simplefunctions/src/simplefunctions.ts`](src/simplefunctions.ts)
934
+
935
+ </details>
936
+
937
+ <details>
938
+ <summary><code>GET</code> <b><code>simplefunctions.api.public.regime.scan</code></b></summary>
939
+
940
+ <code>GET https://simplefunctions.dev/api/public/regime/scan{query}</code>
941
+
942
+ [Upstream docs ↗](https://docs.simplefunctions.dev/api-reference/index-regime)
943
+
944
+ ```typescript
945
+ const res = await simplefunctions.api.public.regime.scan({ /* ... */ });
946
+ ```
947
+
948
+ Source: [`packages/provider/simplefunctions/src/simplefunctions.ts`](src/simplefunctions.ts)
949
+
950
+ </details>
951
+
952
+ <details>
953
+ <summary><code>GET</code> <b><code>simplefunctions.api.public.scan</code></b></summary>
954
+
955
+ <code>GET https://simplefunctions.dev/api/public/scan{query}</code>
956
+
957
+ [Upstream docs ↗](https://docs.simplefunctions.dev/api-reference/public-market-data)
958
+
959
+ ```typescript
960
+ const res = await simplefunctions.api.public.scan({ /* ... */ });
961
+ ```
962
+
963
+ Source: [`packages/provider/simplefunctions/src/simplefunctions.ts`](src/simplefunctions.ts)
964
+
965
+ </details>
966
+
967
+ <details>
968
+ <summary><code>GET</code> <b><code>simplefunctions.api.public.screen</code></b></summary>
969
+
970
+ <code>GET https://simplefunctions.dev/api/public/screen{query}</code>
971
+
972
+ [Upstream docs ↗](https://docs.simplefunctions.dev/api-reference/public-market-data)
973
+
974
+ ```typescript
975
+ const res = await simplefunctions.api.public.screen({ /* ... */ });
976
+ ```
977
+
978
+ Source: [`packages/provider/simplefunctions/src/simplefunctions.ts`](src/simplefunctions.ts)
979
+
980
+ </details>
981
+
982
+ <details>
983
+ <summary><code>GET</code> <b><code>simplefunctions.api.public.screenByTickers</code></b></summary>
984
+
985
+ <code>GET https://simplefunctions.dev/api/public/screen-by-tickers{query}</code>
986
+
987
+ [Upstream docs ↗](https://docs.simplefunctions.dev/api-reference/public-market-data)
988
+
989
+ ```typescript
990
+ const res = await simplefunctions.api.public.screenByTickers({ /* ... */ });
991
+ ```
992
+
993
+ Source: [`packages/provider/simplefunctions/src/simplefunctions.ts`](src/simplefunctions.ts)
994
+
995
+ </details>
996
+
997
+ <details>
998
+ <summary><code>GET</code> <b><code>simplefunctions.api.public.search</code></b></summary>
999
+
1000
+ <code>GET https://simplefunctions.dev/api/public/search{query}</code>
1001
+
1002
+ [Upstream docs ↗](https://docs.simplefunctions.dev/api-reference/public-market-data)
1003
+
1004
+ ```typescript
1005
+ const res = await simplefunctions.api.public.search({ /* ... */ });
1006
+ ```
1007
+
1008
+ Source: [`packages/provider/simplefunctions/src/simplefunctions.ts`](src/simplefunctions.ts)
1009
+
1010
+ </details>
1011
+
1012
+ <details>
1013
+ <summary><code>GET</code> <b><code>simplefunctions.api.public.skill</code></b></summary>
1014
+
1015
+ <code>GET https://simplefunctions.dev/api/public/skill/{slug}</code>
1016
+
1017
+ [Upstream docs ↗](https://docs.simplefunctions.dev/api-reference/public-market-data)
1018
+
1019
+ ```typescript
1020
+ const res = await simplefunctions.api.public.skill({ /* ... */ });
1021
+ ```
1022
+
1023
+ Source: [`packages/provider/simplefunctions/src/simplefunctions.ts`](src/simplefunctions.ts)
1024
+
1025
+ </details>
1026
+
1027
+ <details>
1028
+ <summary><code>GET</code> <b><code>simplefunctions.api.public.skills</code></b></summary>
1029
+
1030
+ <code>GET https://simplefunctions.dev/api/public/skills{query}</code>
1031
+
1032
+ [Upstream docs ↗](https://docs.simplefunctions.dev/api-reference/public-market-data)
1033
+
1034
+ ```typescript
1035
+ const res = await simplefunctions.api.public.skills({ /* ... */ });
1036
+ ```
1037
+
1038
+ Source: [`packages/provider/simplefunctions/src/simplefunctions.ts`](src/simplefunctions.ts)
1039
+
1040
+ </details>
1041
+
1042
+ <details>
1043
+ <summary><code>GET</code> <b><code>simplefunctions.api.public.technicals</code></b></summary>
1044
+
1045
+ <code>GET https://simplefunctions.dev/api/public/technicals{query}</code>
1046
+
1047
+ [Upstream docs ↗](https://docs.simplefunctions.dev/api-reference/public-market-data)
1048
+
1049
+ ```typescript
1050
+ const res = await simplefunctions.api.public.technicals({ /* ... */ });
1051
+ ```
1052
+
1053
+ Source: [`packages/provider/simplefunctions/src/simplefunctions.ts`](src/simplefunctions.ts)
1054
+
1055
+ </details>
1056
+
1057
+ <details>
1058
+ <summary><code>GET</code> <b><code>simplefunctions.api.public.technicals.entry</code></b></summary>
1059
+
1060
+ <code>GET https://simplefunctions.dev/api/public/technicals/{slug}</code>
1061
+
1062
+ [Upstream docs ↗](https://docs.simplefunctions.dev/api-reference/public-market-data)
1063
+
1064
+ ```typescript
1065
+ const res = await simplefunctions.api.public.technicals.entry({ /* ... */ });
1066
+ ```
1067
+
1068
+ Source: [`packages/provider/simplefunctions/src/simplefunctions.ts`](src/simplefunctions.ts)
1069
+
1070
+ </details>
1071
+
1072
+ <details>
1073
+ <summary><code>GET</code> <b><code>simplefunctions.api.public.theses</code></b></summary>
1074
+
1075
+ <code>GET https://simplefunctions.dev/api/public/theses{query}</code>
1076
+
1077
+ [Upstream docs ↗](https://docs.simplefunctions.dev/reference/daily-data)
1078
+
1079
+ ```typescript
1080
+ const res = await simplefunctions.api.public.theses({ /* ... */ });
1081
+ ```
1082
+
1083
+ Source: [`packages/provider/simplefunctions/src/simplefunctions.ts`](src/simplefunctions.ts)
1084
+
1085
+ </details>
1086
+
1087
+ <details>
1088
+ <summary><code>GET</code> <b><code>simplefunctions.api.public.thesis</code></b></summary>
1089
+
1090
+ <code>GET https://simplefunctions.dev/api/public/thesis/{slug}</code>
1091
+
1092
+ [Upstream docs ↗](https://docs.simplefunctions.dev/reference/daily-data)
1093
+
1094
+ ```typescript
1095
+ const res = await simplefunctions.api.public.thesis({ /* ... */ });
1096
+ ```
1097
+
1098
+ Source: [`packages/provider/simplefunctions/src/simplefunctions.ts`](src/simplefunctions.ts)
1099
+
1100
+ </details>
1101
+
1102
+ <details>
1103
+ <summary><code>GET</code> <b><code>simplefunctions.api.public.topic</code></b></summary>
1104
+
1105
+ <code>GET https://simplefunctions.dev/api/public/topic/{slug}</code>
1106
+
1107
+ [Upstream docs ↗](https://docs.simplefunctions.dev/api-reference/public-market-data)
1108
+
1109
+ ```typescript
1110
+ const res = await simplefunctions.api.public.topic({ /* ... */ });
1111
+ ```
1112
+
1113
+ Source: [`packages/provider/simplefunctions/src/simplefunctions.ts`](src/simplefunctions.ts)
1114
+
1115
+ </details>
1116
+
1117
+ <details>
1118
+ <summary><code>GET</code> <b><code>simplefunctions.api.public.tradMarkets</code></b></summary>
1119
+
1120
+ <code>GET https://simplefunctions.dev/api/public/trad-markets{query}</code>
1121
+
1122
+ [Upstream docs ↗](https://docs.simplefunctions.dev/api-reference/public-market-data)
1123
+
1124
+ ```typescript
1125
+ const res = await simplefunctions.api.public.tradMarkets({ /* ... */ });
1126
+ ```
1127
+
1128
+ Source: [`packages/provider/simplefunctions/src/simplefunctions.ts`](src/simplefunctions.ts)
1129
+
1130
+ </details>
1131
+
1132
+ <details>
1133
+ <summary><code>GET</code> <b><code>simplefunctions.api.public.yieldCurves</code></b></summary>
1134
+
1135
+ <code>GET https://simplefunctions.dev/api/public/yield-curves</code>
1136
+
1137
+ [Upstream docs ↗](https://docs.simplefunctions.dev/api-reference/public-market-data)
1138
+
1139
+ ```typescript
1140
+ const res = await simplefunctions.api.public.yieldCurves({ /* ... */ });
1141
+ ```
1142
+
1143
+ Source: [`packages/provider/simplefunctions/src/simplefunctions.ts`](src/simplefunctions.ts)
1144
+
1145
+ </details>
1146
+
1147
+ <details>
1148
+ <summary><code>GET</code> <b><code>simplefunctions.api.public.yieldCurves.event</code></b></summary>
1149
+
1150
+ <code>GET https://simplefunctions.dev/api/public/yield-curves/{event}</code>
1151
+
1152
+ [Upstream docs ↗](https://docs.simplefunctions.dev/api-reference/public-market-data)
1153
+
1154
+ ```typescript
1155
+ const res = await simplefunctions.api.public.yieldCurves.event({ /* ... */ });
1156
+ ```
1157
+
1158
+ Source: [`packages/provider/simplefunctions/src/simplefunctions.ts`](src/simplefunctions.ts)
1159
+
1160
+ </details>
1161
+
1162
+ Part of the [apicity](https://github.com/justintanner/apicity) monorepo.
1163
+
1164
+ ## License
1165
+
1166
+ MIT — see [LICENSE](LICENSE).