-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathapi-1.yaml
More file actions
6009 lines (4508 loc) · 171 KB
/
api-1.yaml
File metadata and controls
6009 lines (4508 loc) · 171 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.0
paths:
/auth/signing-message:
get:
description: Returns a signing message with a randomly generated nonce for
authentication purposes.
operationId: AuthController_getSigningMessage
parameters: []
responses:
"200":
description: A signing message containing a nonce has been successfully generated
content:
application/json:
schema:
type: string
example: >-
Welcome to Limitless.exchange! Please sign this message to
verify your identity.
Nonce: 0xa1b2c3d4e5f67890...
summary: Get signing message
tags:
- Authentication
/auth/verify-auth:
get:
description: Verifies if the user is authenticated by checking the session cookie
operationId: AuthController_verifyAuth
parameters: []
responses:
"200":
description: User is authenticated
content:
application/json:
schema:
type: string
description: Ethereum address of the authenticated user
example: "0x1234567890123456789012345678901234567890"
"401":
description: User is not authenticated
content:
application/json:
schema:
type: object
properties:
message:
type: string
example: The token cookie is required
security:
- limitless_session: []
summary: Verify authentication
tags:
- Authentication
/auth/login:
post:
description: Authenticates a user with a signed message and creates a session
operationId: AuthController_login
parameters:
- name: x-account
in: header
description: The Ethereum address of the user
required: true
schema:
type: string
- name: x-signing-message
in: header
description: The signing message generated by the server
required: true
schema:
type: string
- name: x-signature
in: header
description: The signature generated by signing the message with the user's wallet
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/CreateUserDto"
responses:
"200":
description: User has been successfully logged in and a session cookie has been
set
content:
application/json:
schema:
type: object
properties:
account:
type: string
example: "0x1234567890123456789012345678901234567890"
displayName:
type: string
example: 0x1234...7890
smartWallet:
type: string
nullable: true
example: "0x0987654321098765432109876543210987654321"
client:
type: string
example: eoa
"400":
description: Bad request (missing or invalid parameters)
content:
application/json:
schema:
type: object
properties:
message:
type: string
example: Smart wallet is required
"500":
description: Internal server error
content:
application/json:
schema:
type: object
properties:
message:
type: string
example: Error creating JWT token
summary: User login
tags:
- Authentication
/auth/logout:
post:
description: Logs out the user by clearing the session cookie
operationId: AuthController_logout
parameters: []
responses:
"200":
description: User has been successfully logged out
content:
application/json:
schema:
type: object
properties:
message:
type: string
example: Logged out successfully
security:
- limitless_session: []
summary: User logout
tags:
- Authentication
/markets/active/{categoryId}:
get:
description: Retrieves markets and groups that are active and not yet resolved,
with optional category filtering
operationId: MarketController_getActiveMarkets[0]
parameters:
- name: page
required: false
in: query
description: Page number for pagination
schema:
example: 1
type: number
- name: limit
required: false
in: query
description: Number of items per page
schema:
example: 10
type: number
- name: sortBy
required: false
in: query
description: Sort by query parameter
schema:
example: newest
type: string
- name: tradeType
required: false
in: query
description: Filter by trade type (amm, clob, or group)
schema:
enum:
- amm
- clob
- group
type: string
- name: automationType
required: false
in: query
description: Filter by automation type (manual, lumy, or sports)
schema:
enum:
- manual
- lumy
- sports
type: string
- name: categoryId
required: false
in: path
description: Filter markets by category ID
schema:
type: number
responses:
"200":
description: Active markets and groups with volume and liquidity data
content:
application/json:
schema:
$ref: "#/components/schemas/BrowseActiveMarketsResponseDto"
"500":
description: Server error when retrieving markets data
summary: Browse Active Markets
tags:
- Markets
/markets/active:
get:
description: Retrieves markets and groups that are active and not yet resolved,
with optional category filtering
operationId: MarketController_getActiveMarkets[1]
parameters:
- name: page
required: false
in: query
description: Page number for pagination
schema:
example: 1
type: number
- name: limit
required: false
in: query
description: Number of items per page
schema:
example: 10
type: number
- name: sortBy
required: false
in: query
description: Sort by query parameter
schema:
example: newest
type: string
- name: tradeType
required: false
in: query
description: Filter by trade type (amm, clob, or group)
schema:
enum:
- amm
- clob
- group
type: string
- name: automationType
required: false
in: query
description: Filter by automation type (manual, lumy, or sports)
schema:
enum:
- manual
- lumy
- sports
type: string
- name: categoryId
required: false
in: path
description: Filter markets by category ID
schema:
type: number
responses:
"200":
description: Active markets and groups with volume and liquidity data
content:
application/json:
schema:
$ref: "#/components/schemas/BrowseActiveMarketsResponseDto"
"500":
description: Server error when retrieving markets data
summary: Browse Active Markets
tags:
- Markets
/markets/categories/count:
get:
description: Returns the number of active markets for each category and the
total market count
operationId: MarketController_getActiveMarketCountPerCategory
parameters: []
responses:
"200":
description: Object containing category counts and total count
content:
application/json:
schema:
$ref: "#/components/schemas/CategoryCountResponseDto"
"500":
description: Server error when retrieving category count data
summary: Get active market count per category
tags:
- Markets
/markets/active/slugs:
get:
description: Retrieves slugs, strike prices, tickers, and deadlines for all
active markets and groups. Group markets are nested under their parent
group.
operationId: MarketController_getActiveSlugs
parameters: []
responses:
"200":
description: List of active market and group slugs with metadata
content:
application/json:
schema:
type: array
items:
oneOf:
- type: object
properties:
slug:
type: string
description: Market slug identifier
example: btc-price-prediction-2024
strikePrice:
type: string
nullable: true
description: Strike price extracted from market title
example: "50000"
ticker:
type: string
nullable: true
description: Asset ticker symbol
example: BTC
deadline:
type: string
nullable: true
format: date-time
description: Market expiration deadline
example: 2024-12-31T23:59:59Z
required:
- slug
description: Individual market entry
- type: object
properties:
slug:
type: string
description: Group slug identifier
example: crypto-predictions-2024
strikePrice:
type: "null"
description: Groups do not have strike prices
ticker:
type: string
description: Group asset ticker symbol
example: USDC
deadline:
type: string
nullable: true
format: date-time
description: Group expiration deadline
example: 2024-12-31T23:59:59Z
markets:
type: array
items:
type: object
properties:
slug:
type: string
description: Market slug within the group
example: btc-50k-prediction
required:
- slug
description: Array of markets within this group
required:
- slug
- deadline
- markets
description: Group entry with nested markets
"500":
description: Server error when retrieving market slugs
summary: Get active market slugs with metadata
tags:
- Markets
/markets/{addressOrSlug}:
get:
description: Retrieves market or group data using either an Ethereum address or
a slug identifier
operationId: MarketController_find
parameters:
- name: addressOrSlug
required: true
in: path
description: Market/group address (0x...) or slug identifier (my-market-name)
schema:
example: crypto-predictions-2025
responses:
"200":
description: Market or group details with pricing and volume data
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ClobMarketResponseDto"
description: CLOB market with position IDs and trading data
- $ref: "#/components/schemas/NegRiskGroupResponseDto"
description: NegRisk group with nested markets array
- $ref: "#/components/schemas/AmmMarketResponseDto"
description: AMM market with liquidity and volume data
"404":
description: Market or group not found
"500":
description: Server error when retrieving market/group data
summary: Get Market Details
tags:
- Markets
/markets/{slug}/get-feed-events:
get:
description: Retrieves the latest feed events related to a specific market with
pagination support
operationId: MarketController_getFeedEvent
parameters:
- name: page
required: false
in: query
description: Page number for pagination
schema:
example: 1
type: number
- name: limit
required: false
in: query
description: Number of events per page
schema:
example: 10
type: number
- name: slug
required: false
in: path
description: Slug of the market
schema:
example: my-market-slug-123
responses:
"200":
description: List of feed events for the market
content:
application/json:
schema:
$ref: "#/components/schemas/FeedEventsResponseDto"
"500":
description: Server error when retrieving feed events
security:
- bearer: []
summary: Get feed events for a market
tags:
- Markets
/markets/{slug}/historical-price:
get:
description: Retrieve historical price data for a specific market with
configurable time intervals
operationId: MarketOrderbookController_getHistoricalPrice
parameters:
- name: to
required: false
in: query
description: End date for historical data
schema:
example: 2024-01-31T23:59:59Z
- name: from
required: false
in: query
description: Start date for historical data
schema:
example: 2024-01-01T00:00:00Z
- name: interval
required: false
in: query
description: Time interval for data points
schema:
enum:
- 1h
- 6h
- 1d
- 1w
- 1m
- all
type: string
- name: slug
required: true
in: path
description: Market slug identifier
schema:
example: presidential-election-2024
responses:
"200":
description: Historical price data
content:
application/json:
schema:
type: array
items:
type: object
properties:
title:
type: string
example: YES Token
prices:
type: array
items:
type: object
properties:
price:
type: number
example: 0.75
timestamp:
type: string
example: 2024-01-15T10:30:00Z
summary: Get Historical Prices
tags:
- Trading
/markets/{slug}/orderbook:
get:
description: Retrieve the current orderbook for a market showing all open buy
and sell orders
operationId: MarketOrderbookController_getOrderbook
parameters:
- name: slug
required: true
in: path
description: Market slug identifier
schema:
example: presidential-election-2024
responses:
"200":
description: Current orderbook with bids and asks
content:
application/json:
schema:
type: object
properties:
adjustedMidpoint:
type: number
example: 0.75
asks:
type: array
items:
type: object
properties:
price:
type: number
example: 0.76
size:
type: number
example: 100
bids:
type: array
items:
type: object
properties:
price:
type: number
example: 0.74
size:
type: number
example: 150
lastTradePrice:
type: number
example: 0.75
maxSpread:
type: number
example: 0.05
minSize:
type: number
example: 1
tokenId:
type: string
example: "196332044857908579498285167379934237586289302353716299439995448593246\
45414627"
"400":
description: Market does not support orderbook (AMM market)
"404":
description: Market not found
summary: Get Orderbook
tags:
- Trading
/markets/{slug}/locked-balance:
get:
description: Get the amount of funds locked in open orders for the authenticated user
operationId: MarketOrderbookController_getLockedBalance
parameters:
- name: slug
required: true
in: path
description: Market slug identifier
schema:
example: presidential-election-2024
responses:
"200":
description: User's locked balance details
content:
application/json:
schema:
type: object
properties:
lockedBalance:
type: string
example: "250.50"
lockedBalanceFormatted:
type: string
example: 250.50 USDC
currency:
type: string
example: USDC
orderCount:
type: number
example: 3
security:
- limitless_session: []
summary: Get Locked Balance
tags:
- Trading
/markets/{slug}/user-orders:
get:
description: Get all orders placed by the authenticated user for a specific market
operationId: MarketOrderbookController_getUserOrders
parameters:
- name: statuses
required: false
in: query
description: Order status(es) to filter by. Defaults to [LIVE] if not provided
schema:
type: array
items:
type: string
enum:
- LIVE
- MATCHED
- name: limit
required: false
in: query
description: Maximum number of orders to return
schema:
minimum: 1
example: 100
type: number
- name: slug
required: true
in: path
description: Market slug identifier
schema:
example: presidential-election-2024
responses:
"200":
description: List of user orders for the market
content:
application/json:
schema:
type: object
properties:
orders:
type: array
items:
type: object
properties:
id:
type: string
example: "12345"
side:
type: string
example: BUY
price:
type: string
example: "0.75"
quantity:
type: string
example: "100"
status:
type: string
example: LIVE
security:
- limitless_session: []
summary: User Orders
tags:
- Trading
/markets/{slug}/events:
get:
description: Get recent events for a specific market including trades, orders,
and liquidity changes
operationId: MarketOrderbookController_getMarketEvents
parameters:
- name: page
required: false
in: query
description: Page number for pagination
schema:
example: 1
type: number
- name: limit
required: false
in: query
description: Number of events per page
schema:
example: 20
type: number
- name: slug
required: true
in: path
description: Market slug identifier
schema:
example: presidential-election-2024
responses:
"200":
description: List of market events
content:
application/json:
schema:
type: object
properties:
events:
type: array
items:
type: object
properties:
id:
type: string
example: event-123
type:
type: string
example: ORDER_PLACED
timestamp:
type: string
example: 2024-01-15T10:30:00Z
data:
type: object
additionalProperties: true
summary: Market Events
tags:
- Trading
/markets/search:
get:
operationId: MarketSearchController_search
parameters:
- name: query
required: true
in: query
description: Search query text
schema:
example: Sports betting markets with high odds
type: string
- name: limit
required: false
in: query
description: Maximum number of results to return
schema:
default: 10
example: 10
type: number
- name: page
required: false
in: query
description: Number of page
schema:
default: 1
example: 0
type: number
- name: similarityThreshold
required: false
in: query
description: Minimum similarity score (0-1)
schema:
default: 0.5
example: 0.5
type: number
responses:
"200":
description: Returns markets matching the search query
"400":
description: Invalid request parameters
"500":
description: Internal server error
summary: Search for markets based on semantic similarity
tags:
- Markets
/portfolio/trades:
get:
description: Retrieve all trades executed by the authenticated user
operationId: PortfolioController_getTrades
parameters: []
responses:
"200":
description: List of user trades with details
content:
application/json:
schema:
type: object
additionalProperties: true
"401":
description: Unauthorized
security:
- bearer: []
- limitless_session: []
summary: Get Trades
tags:
- Portfolio
/portfolio/positions:
get:
description: Retrieve all active positions with P&L calculations and market values
operationId: PortfolioController_getPositions
parameters: []
responses:
"200":
description: Complete portfolio positions with summary
content:
application/json:
schema:
$ref: "#/components/schemas/PortfolioPositionsDto"
"401":
description: Unauthorized
security:
- bearer: []
- limitless_session: []
summary: Get Positions
tags:
- Portfolio
/portfolio/pnl-chart:
get:
description: "Hybrid PnL: realised series + current total snapshot"
operationId: PortfolioController_getPnlChart
parameters:
- name: timeframe
required: false
in: query
description: Timeframe window for percent change and chart series
schema:
example: 7d
type: string
responses:
"200":
description: PnL chart data
content:
application/json:
schema:
$ref: "#/components/schemas/PortfolioPnlChartDto"
"401":
description: Unauthorized
security:
- bearer: []
- limitless_session: []
summary: Get portfolio PnL chart
tags:
- Portfolio
/portfolio/history:
get:
description: Paginated history including AMM, CLOB trades, splits/merges,
NegRisk conversions
operationId: PortfolioController_getHistory
parameters:
- name: page
required: true
in: query
description: Page number
schema:
example: 1
type: number
- name: limit
required: true
in: query
description: Number of items per page
schema:
example: 10
type: number
- name: from
required: false
in: query
description: Start date for filtering (ISO 8601 format)
schema:
format: date-time
example: 2024-01-01T00:00:00.000Z
type: string
- name: to
required: false
in: query
description: End date for filtering (ISO 8601 format)
schema:
format: date-time
example: 2024-12-31T23:59:59.999Z
type: string
responses:
"200":
description: Paginated history of all user actions
content:
application/json:
schema:
$ref: "#/components/schemas/HistoryResponseDto"
"400":
description: Invalid pagination parameters
"401":
description: Unauthorized
security:
- bearer: []
- limitless_session: []
summary: Get History
tags:
- Portfolio
/portfolio/points:
get:
operationId: PortfolioController_getPointsBreakdown
parameters: []
responses:
"200":
description: Points breakdown
"401":
description: Unauthorized
security:
- bearer: []
- limitless_session: []
summary: Get points breakdown
tags:
- Portfolio
/portfolio/{account}/traded-volume:
get:
description: Get total traded volume and statistics for a specific user
operationId: PublicPortfolioController_tradedVolume
parameters:
- name: account
required: true
in: path
description: User Ethereum address
schema:
example: "0x742d35Cc6634C0532925a3b844Bc454e4438f44e"
type: string
responses:
"200":
description: User trading volume statistics
content:
application/json:
schema:
type: object
additionalProperties: true
summary: User Total Volume
tags:
- Public Portfolio
/portfolio/{account}/positions:
get:
description: Retrieve all positions for a specific user address
operationId: PublicPortfolioController_getPositions
parameters:
- name: account
required: true
in: path
description: User Ethereum address
schema:
example: "0x742d35Cc6634C0532925a3b844Bc454e4438f44e"
type: string
responses:
"200":
description: Complete list of user positions
content:
application/json:
schema:
$ref: "#/components/schemas/PortfolioPositionsDto"
summary: Get All User Positions
tags:
- Public Portfolio
/portfolio/{account}/pnl-chart:
get:
description: "Hybrid PnL: realised series + current total snapshot"
operationId: PublicPortfolioController_getPnlChart
parameters:
- name: account
required: true
in: path
description: User Ethereum address
schema:
example: "0x742d35Cc6634C0532925a3b844Bc454e4438f44e"
type: string
- name: timeframe
required: false
in: query
description: Timeframe window for percent change and chart series
schema:
example: 7d
type: string
responses:
"200":
description: PnL chart data
content:
application/json:
schema:
$ref: "#/components/schemas/PortfolioPnlChartDto"
summary: Get portfolio PnL chart (public)
tags:
- Public Portfolio
/portfolio/trading/allowance:
get:
description: Check USDC allowance for CLOB or NegRisk trading contracts
operationId: TradingPortfolioController_getAllowance
parameters:
- name: type
required: true
in: query
description: "Trading type: CLOB or NegRisk"
schema:
enum:
- clob
- negrisk