-
Notifications
You must be signed in to change notification settings - Fork 23
Expand file tree
/
Copy pathopen-api.json
More file actions
4739 lines (4739 loc) · 187 KB
/
open-api.json
File metadata and controls
4739 lines (4739 loc) · 187 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": {
"/v1/assets/all": {
"get": {
"operationId": "AssetsController_getAllAssets",
"summary": "Get all assets",
"description": "Returns a complete list of all supported collateral assets on the Boros platform. Each asset includes its token address, symbol, name, decimals, icon URL, and current price. Use this to display asset selectors, resolve token metadata, or look up collateral information.",
"parameters": [],
"responses": {
"200": {
"description": "Complete list of all supported collateral assets with metadata and pricing",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AssetsResponse"
}
}
}
}
},
"tags": [
"Assets"
]
}
},
"/v1/markets": {
"get": {
"operationId": "MarketsController_getMarkets",
"summary": "Get all markets",
"description": "Returns a paginated list of all available perpetual futures markets. Each market includes its configuration, current state, oracle info, and real-time pricing data such as best bid/ask APR from the order book.",
"parameters": [
{
"name": "skip",
"required": false,
"in": "query",
"description": "Maximum number of results to skip.",
"schema": {
"default": 0,
"type": "number"
}
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Maximum number of results to return. The parameter is capped at 100.",
"schema": {
"default": 100,
"type": "number"
}
}
],
"responses": {
"200": {
"description": "A paginated list of markets with their current state and configuration",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MarketsResponse"
}
}
}
},
"400": {
"description": "Invalid query parameters (e.g., skip or limit out of range)"
}
},
"tags": [
"Markets"
]
}
},
"/v1/markets/market-trades": {
"get": {
"operationId": "MarketsController_getMarketTrades",
"summary": "Get market trades",
"description": "Returns a paginated list of executed trades for a specific market, ordered by timestamp descending. Each trade includes the execution price (tick/APR), size, side, and transaction hash.",
"parameters": [
{
"name": "skip",
"required": false,
"in": "query",
"description": "Maximum number of results to skip.",
"schema": {
"default": 0,
"type": "number"
}
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Maximum number of results to return. The parameter is capped at 100.",
"schema": {
"default": 10,
"type": "number"
}
},
{
"name": "marketId",
"required": true,
"in": "query",
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": "A paginated list of executed trades for the specified market",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MarketTradesResponse"
}
}
}
},
"400": {
"description": "Invalid marketId or query parameters"
}
},
"tags": [
"Markets"
]
}
},
"/v1/markets/chart": {
"get": {
"operationId": "MarketsController_getChartData",
"summary": "Get chart data",
"description": "Returns OHLCV (Open, High, Low, Close, Volume) candlestick chart data for a specific market. Supports configurable time frames and date ranges. Useful for rendering trading charts and analyzing historical price action.",
"parameters": [
{
"name": "marketId",
"required": true,
"in": "query",
"schema": {
"type": "number"
}
},
{
"name": "timeFrame",
"required": true,
"in": "query",
"description": "TimeFrameType { FIVE_MINUTES : 5m, ONE_HOUR : 1h, ONE_DAY : 1d, ONE_WEEK : 1w }",
"schema": {
"enum": [
"5m",
"1h",
"1d",
"1w"
],
"type": "string"
}
},
{
"name": "startTimestamp",
"required": false,
"in": "query",
"schema": {
"default": 0,
"type": "number"
}
},
{
"name": "endTimestamp",
"required": false,
"in": "query",
"description": "End timestamp (Unix seconds), default to current timestamp",
"schema": {
"default": 1772602308,
"type": "number"
}
}
],
"responses": {
"200": {
"description": "Array of OHLCV candlestick data points for the specified market and time range",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChartResponse"
}
}
}
},
"400": {
"description": "Invalid marketId, timeFrame, or timestamp range"
}
},
"tags": [
"Markets"
]
}
},
"/v1/markets/{marketId}": {
"get": {
"operationId": "MarketsController_getMarketInfo",
"summary": "Get market data by marketId",
"description": "Returns detailed information for a single market identified by its numeric ID. Includes market configuration, oracle addresses, IM/MM parameters, current state, fee rates, and real-time order book pricing.",
"parameters": [
{
"name": "marketId",
"required": true,
"in": "path",
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": "Full market details including configuration, state, and pricing data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MarketResponse"
}
}
}
},
"400": {
"description": "Invalid marketId format"
},
"404": {
"description": "Market with the specified ID was not found"
}
},
"tags": [
"Markets"
]
}
},
"/v1/markets/order-books": {
"get": {
"operationId": "MarketsController_getOrderBooksByMarketId",
"summary": "Get market order books by tick",
"deprecated": true,
"description": "**Deprecated: use V2 (`/v2/markets/order-books`) which supports optional AMM liquidity inclusion.**\n\nReturns aggregated order book data for a specific market grouped by tick size. The response contains long (bid) and short (ask) sides, each with arrays of price levels showing implied APR and total size at that level.\n\nSee [Order Book mechanics](https://docs.pendle.finance/boros-dev/Mechanics/OrderBook) for tick-to-rate conversion and matching rules.",
"parameters": [
{
"name": "marketId",
"required": true,
"in": "query",
"schema": {
"type": "number"
}
},
{
"name": "tickSize",
"required": true,
"in": "query",
"schema": {
"enum": [
1e-05,
0.0001,
0.001,
0.01,
0.1
],
"type": "number"
}
}
],
"responses": {
"200": {
"description": "Order book with long and short sides aggregated by the specified tick size",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderBooksResponse"
}
}
}
},
"400": {
"description": "Invalid marketId or tickSize"
}
},
"tags": [
"Markets"
]
}
},
"/v2/markets/order-books": {
"get": {
"operationId": "MarketsController_getOrderBooksByMarketIdV2",
"summary": "Get market order books by tick (v2, recommended)",
"description": "Returns aggregated order book data with optional AMM liquidity inclusion. When AMM liquidity is included, the response merges on-chain AMM positions into the order book. Maximum 50 entries per side when AMM is included. Supersedes V1 by adding the `includeAmm` parameter.\n\nSee [Order Book mechanics](https://docs.pendle.finance/boros-dev/Mechanics/OrderBook) for tick-to-rate conversion and matching rules.",
"parameters": [
{
"name": "marketId",
"required": true,
"in": "query",
"schema": {
"type": "number"
}
},
{
"name": "tickSize",
"required": true,
"in": "query",
"schema": {
"enum": [
1e-05,
0.0001,
0.001,
0.01,
0.1
],
"type": "number"
}
},
{
"name": "includeAmm",
"required": false,
"in": "query",
"description": "Include AMM liquidity in the order book. When true, AMM positions are merged into the book. Maximum 50 entries per side when enabled.",
"schema": {
"default": false,
"example": true,
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "Order book with long and short sides, optionally including AMM liquidity",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderBooksResponse"
}
}
}
},
"400": {
"description": "Invalid marketId or tickSize"
}
},
"tags": [
"Markets"
]
}
},
"/v1/calldata/deposit": {
"get": {
"operationId": "CalldataController_getDepositCalldata",
"summary": "Get deposit from wallet to margin account calldata",
"description": "Generates the transaction calldata for depositing collateral from a wallet into a margin account. This is a sensitive action that requires the user to sign and submit the transaction directly. The returned calldata should be sent to the contract address specified in the 'to' field.",
"parameters": [
{
"name": "userAddress",
"required": true,
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "tokenId",
"required": true,
"in": "query",
"schema": {
"type": "number"
}
},
{
"name": "amount",
"required": true,
"in": "query",
"description": "BigInt string of the deposit amount",
"schema": {
"type": "string"
}
},
{
"name": "accountId",
"required": true,
"in": "query",
"schema": {
"type": "number"
}
},
{
"name": "marketId",
"required": true,
"in": "query",
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": "Deposit calldata",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetCalldataResponse"
}
}
}
},
"400": {
"description": "Invalid deposit parameters (e.g., invalid address, unsupported token, or zero amount)"
}
},
"tags": [
"Calldata"
]
}
},
"/v1/calldata/vault-pay-treasury": {
"get": {
"operationId": "CalldataController_getVaultPayTreasuryCalldata",
"summary": "Get vault pay treasury calldata",
"description": "Generates calldata for a vault to pay treasury fees. This is a sensitive action requiring the user to sign the transaction directly.",
"parameters": [
{
"name": "userAddress",
"required": true,
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "tokenId",
"required": true,
"in": "query",
"schema": {
"type": "number"
}
},
{
"name": "amount",
"required": true,
"in": "query",
"description": "BigInt string of the treasury payment amount",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Vault pay treasury calldata",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetCalldataResponse"
}
}
}
},
"400": {
"description": "Invalid parameters (e.g., invalid address or amount)"
}
},
"tags": [
"Calldata"
]
}
},
"/v1/calldata/withdraw-request": {
"get": {
"operationId": "CalldataController_getWithdrawRequestCalldata",
"summary": "Get withdraw request calldata",
"description": "Generates calldata to request a withdrawal from a margin account. Withdrawals in Boros follow a request-finalize pattern: first submit a withdrawal request, then finalize it after the cooldown period. This is a sensitive user-signed action.",
"parameters": [
{
"name": "userAddress",
"required": true,
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "tokenId",
"required": true,
"in": "query",
"schema": {
"type": "number"
}
},
{
"name": "amount",
"required": true,
"in": "query",
"description": "BigInt string of the withdrawal amount",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Withdraw request calldata",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetCalldataResponse"
}
}
}
},
"400": {
"description": "Invalid withdrawal parameters or insufficient balance"
}
},
"tags": [
"Calldata"
]
}
},
"/v1/calldata/withdraw-cancel": {
"get": {
"operationId": "CalldataController_getWithdrawCancelCalldata",
"summary": "Get cancelled withdraw from margin account to wallet calldata",
"description": "Generates calldata to cancel a pending withdrawal request. Use this if you want to abort a withdrawal that has been requested but not yet finalized. This is a sensitive user-signed action.",
"parameters": [
{
"name": "userAddress",
"required": true,
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "tokenId",
"required": true,
"in": "query",
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": "Withdraw cancel calldata",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetCalldataResponse"
}
}
}
},
"400": {
"description": "Invalid parameters or no pending withdrawal to cancel"
}
},
"tags": [
"Calldata"
]
}
},
"/v1/calldata/approve-agent": {
"get": {
"operationId": "CalldataController_getApproveAgentCalldata",
"summary": "Get approve agent calldata",
"description": "Generates calldata to approve an agent address to trade on behalf of the user's account. Once approved, the agent can execute non-sensitive actions (placing orders, transfers) without requiring the user's signature for each transaction.\n\nSee [Agent Trading guide](https://docs.pendle.finance/boros-dev/Backend/agent) for the full setup workflow.",
"parameters": [
{
"name": "userAddress",
"required": true,
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "accountId",
"required": true,
"in": "query",
"description": "Account ID (0-255)",
"schema": {
"type": "number"
}
},
{
"name": "agentAddress",
"required": true,
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "expiryTime",
"required": true,
"in": "query",
"schema": {
"example": 1709164800,
"type": "number"
}
}
],
"responses": {
"200": {
"description": "Approve agent calldata",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetCalldataResponse"
}
}
}
},
"400": {
"description": "Invalid user address, account ID, or agent address"
}
},
"tags": [
"Calldata"
]
}
},
"/v1/calldata/revoke-agent": {
"get": {
"operationId": "CalldataController_revokeApproveAgentCalldata",
"summary": "Get revoke agent calldata",
"description": "Generates calldata to revoke a previously approved agent's permissions. After revocation, the agent can no longer execute actions on behalf of the user's account.",
"parameters": [
{
"name": "userAddress",
"required": true,
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "accountId",
"required": true,
"in": "query",
"description": "Account ID (0-255)",
"schema": {
"type": "number"
}
},
{
"name": "agentAddress",
"required": true,
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Revoke agent calldata",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetCalldataResponse"
}
}
}
},
"400": {
"description": "Invalid user address, account ID, or agent address"
}
},
"tags": [
"Calldata"
]
}
},
"/v1/calldata/cash-transfer": {
"get": {
"operationId": "CalldataController_getPositionTransferCalldataV3",
"summary": "Get cash transfer contract params",
"description": "Generates agent-executable calldata for transferring cash between cross and isolated margin accounts. This is a non-sensitive action that can be executed by an approved agent. Returns an array of calldatas that may include a pay-treasury step if payTreasuryAmount is specified.",
"parameters": [
{
"name": "payTreasuryAmount",
"required": false,
"in": "query",
"description": "bigint string of amount to pay treasury",
"schema": {
"type": "string"
}
},
{
"name": "marketId",
"required": true,
"in": "query",
"schema": {
"type": "number"
}
},
{
"name": "isDeposit",
"required": true,
"in": "query",
"description": "true if you want to transfer cash from cross to isolated account, false vice versa",
"schema": {
"example": true,
"type": "boolean"
}
},
{
"name": "amount",
"required": true,
"in": "query",
"description": "BigInt string of the transfer amount",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Transfer cash between cross and isolated account",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BulkAgentExecuteParamsResponse"
}
}
}
},
"400": {
"description": "Invalid transfer parameters or insufficient balance"
}
},
"tags": [
"Calldata"
]
}
},
"/v1/calldata/place-orders": {
"post": {
"operationId": "CalldataController_getBulkPlaceOrderCalldata",
"summary": "Get place multiple limit orders contract params",
"description": "Generates agent-executable calldata for placing one or more limit orders. Supports both single orders and bulk orders (multiple orders per market with optional cancellations). This is a non-sensitive action that can be executed by an approved agent.\n\nSee [Best Practices](https://docs.pendle.finance/boros-dev/Backend/best-practices) for bulk order recommendations.",
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BulkPlaceOrderQueryDto"
}
}
}
},
"responses": {
"200": {
"description": "Place multiple orders contract params",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BulkAgentExecuteParamsResponse"
}
}
}
},
"400": {
"description": "Invalid order parameters or malformed order request body"
}
},
"tags": [
"Calldata"
]
}
},
"/v1/calldata/cancel-order": {
"get": {
"operationId": "CalldataController_getCancelOrderCalldata",
"summary": "Get cancel order contract params",
"description": "Generates agent-executable calldata for cancelling one or more orders. Supports cancelling specific orders by ID or all orders on a market. This is a non-sensitive action that can be executed by an approved agent.",
"parameters": [
{
"name": "payTreasuryAmount",
"required": false,
"in": "query",
"description": "bigint string of amount to pay treasury",
"schema": {
"type": "string"
}
},
{
"name": "marketAcc",
"required": true,
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "marketId",
"required": true,
"in": "query",
"schema": {
"type": "number"
}
},
{
"name": "cancelAll",
"required": true,
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "orderIds",
"required": false,
"in": "query",
"description": "Comma-separated order ids to cancel (ignored if cancelAll is true)",
"schema": {
"example": "1,2,3",
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Cancel order contract params",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BulkAgentExecuteParamsResponse"
}
}
}
},
"400": {
"description": "Invalid parameters, market expired, or mismatched marketAcc and marketId"
}
},
"tags": [
"Calldata"
]
}
},
"/v1/calldata/add-liquidity-single-cash-to-amm": {
"get": {
"operationId": "CalldataController_getAddLiquiditySingleCashToAmmCalldataV4",
"summary": "Get add liquidity single cash to amm contract params",
"description": "Generates agent-executable calldata for adding single-asset liquidity to an AMM pool. Specify the net cash amount to deposit and the minimum LP tokens expected (slippage protection). Returns execute params including the calldata and target account ID.",
"parameters": [
{
"name": "payTreasuryAmount",
"required": false,
"in": "query",
"description": "bigint string of amount to pay treasury",
"schema": {
"type": "string"
}
},
{
"name": "userAddress",
"required": true,
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "accountId",
"required": true,
"in": "query",
"schema": {
"type": "number"
}
},
{
"name": "marketId",
"required": true,
"in": "query",
"schema": {
"type": "number"
}
},
{
"name": "netCashIn",
"required": true,
"in": "query",
"description": "BigInt string of net cash to add as liquidity",
"schema": {
"type": "string"
}
},
{
"name": "minLpOut",
"required": true,
"in": "query",
"description": "BigInt string of minimum LP tokens to receive",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Add liquidity single cash to amm contract params",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BulkAgentExecuteParamsResponseV2"
}
}
}
},
"400": {
"description": "Invalid parameters or insufficient balance for liquidity provision"
}
},
"tags": [
"Calldata"
]
}
},
"/v1/calldata/remove-liquidity-single-cash-from-amm": {
"get": {
"operationId": "CalldataController_getRemoveLiquiditySingleCashFromAmmCalldataV4",
"summary": "Get remove liquidity single cash from amm contract params",
"description": "Generates agent-executable calldata for removing liquidity from an AMM pool and receiving cash. Specify the LP amount to remove and the minimum cash expected (slippage protection). Returns execute params including the calldata and target account ID.",
"parameters": [
{
"name": "payTreasuryAmount",
"required": false,
"in": "query",
"description": "bigint string of amount to pay treasury",
"schema": {
"type": "string"
}
},
{
"name": "marketId",
"required": true,
"in": "query",
"schema": {
"type": "number"
}
},
{
"name": "lpToRemove",
"required": true,
"in": "query",
"description": "BigInt string of LP tokens to remove",
"schema": {
"type": "string"
}
},
{
"name": "minCashOut",
"required": true,
"in": "query",
"description": "BigInt string of minimum cash to receive",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Remove liquidity single cash from amm contract params",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BulkAgentExecuteParamsResponseV2"
}
}
}
},
"400": {
"description": "Invalid parameters or insufficient LP token balance"
}
},
"tags": [
"Calldata"
]
}
},
"/v1/calldata/enter-exit-markets": {
"get": {
"operationId": "CalldataController_getEnterExitMarketsCalldata",
"summary": "Get enter exit markets contract params",
"description": "Generates agent-executable calldata for entering or exiting markets on a cross margin account. Entering a market allows the account to trade on it; exiting removes the market from the account's active list. Returns an array of calldatas for the agent to execute.",
"parameters": [
{
"name": "isCross",
"required": true,
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "marketIds",