zklighter-perps 1.0.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.
Files changed (103) hide show
  1. package/.circleci/config.yml +86 -0
  2. package/.openapi-generator/FILES +95 -0
  3. package/.openapi-generator/VERSION +1 -0
  4. package/.openapi-generator-ignore +23 -0
  5. package/apis/AccountApi.ts +454 -0
  6. package/apis/BlockApi.ts +178 -0
  7. package/apis/CandlestickApi.ts +231 -0
  8. package/apis/InfoApi.ts +197 -0
  9. package/apis/OrderApi.ts +607 -0
  10. package/apis/RelayerApi.ts +95 -0
  11. package/apis/RootApi.ts +56 -0
  12. package/apis/TransactionApi.ts +608 -0
  13. package/apis/WsApi.ts +82 -0
  14. package/apis/index.ts +11 -0
  15. package/config.yaml +5 -0
  16. package/index.ts +5 -0
  17. package/models/AccountMarketStats.ts +100 -0
  18. package/models/AccountPnL.ts +91 -0
  19. package/models/AccountPosition.ts +140 -0
  20. package/models/AccountStats.ts +92 -0
  21. package/models/Block.ts +163 -0
  22. package/models/Blocks.ts +91 -0
  23. package/models/Candlestick.ts +108 -0
  24. package/models/Candlesticks.ts +91 -0
  25. package/models/ContractAddress.ts +68 -0
  26. package/models/CurrentHeight.ts +76 -0
  27. package/models/Cursor.ts +60 -0
  28. package/models/DetailedAccount.ts +169 -0
  29. package/models/DetailedAccounts.ts +91 -0
  30. package/models/EnrichedTx.ts +204 -0
  31. package/models/ExchangeStats.ts +107 -0
  32. package/models/Funding.ts +84 -0
  33. package/models/Fundings.ts +91 -0
  34. package/models/L1ProviderInfo.ts +84 -0
  35. package/models/Layer1BasicInfo.ts +143 -0
  36. package/models/Layer2BasicInfo.ts +92 -0
  37. package/models/MainAccount.ts +92 -0
  38. package/models/MainAccounts.ts +91 -0
  39. package/models/MarketInfo.ts +140 -0
  40. package/models/MarketSig.ts +100 -0
  41. package/models/NextNonce.ts +76 -0
  42. package/models/Order.ts +209 -0
  43. package/models/OrderBook.ts +143 -0
  44. package/models/OrderBookDepth.ts +99 -0
  45. package/models/OrderBookDetail.ts +287 -0
  46. package/models/OrderBookDetails.ts +83 -0
  47. package/models/OrderBookOrders.ts +107 -0
  48. package/models/OrderBookStats.ts +100 -0
  49. package/models/OrderBooks.ts +83 -0
  50. package/models/Orders.ts +91 -0
  51. package/models/Permission.ts +76 -0
  52. package/models/PnLEntry.ts +68 -0
  53. package/models/PriceLevel.ts +68 -0
  54. package/models/ReqDoFaucet.ts +60 -0
  55. package/models/ReqGetAccount.ts +79 -0
  56. package/models/ReqGetAccountActiveOrders.ts +76 -0
  57. package/models/ReqGetAccountByL1Address.ts +60 -0
  58. package/models/ReqGetAccountInactiveOrders.ts +111 -0
  59. package/models/ReqGetAccountOrders.ts +84 -0
  60. package/models/ReqGetAccountPendingTxs.ts +87 -0
  61. package/models/ReqGetAccountPnL.ts +124 -0
  62. package/models/ReqGetAccountTxs.ts +103 -0
  63. package/models/ReqGetBlock.ts +79 -0
  64. package/models/ReqGetBlockTxs.ts +79 -0
  65. package/models/ReqGetByAccount.ts +79 -0
  66. package/models/ReqGetCandlesticks.ts +107 -0
  67. package/models/ReqGetFundings.ts +102 -0
  68. package/models/ReqGetL1Tx.ts +60 -0
  69. package/models/ReqGetMarketSig.ts +76 -0
  70. package/models/ReqGetNextNonce.ts +68 -0
  71. package/models/ReqGetOrderBookDetails.ts +79 -0
  72. package/models/ReqGetOrderBookOrders.ts +68 -0
  73. package/models/ReqGetOrderBooks.ts +79 -0
  74. package/models/ReqGetPermission.ts +87 -0
  75. package/models/ReqGetRangeWithCursor.ts +68 -0
  76. package/models/ReqGetRangeWithIndex.ts +68 -0
  77. package/models/ReqGetRangeWithIndexSortable.ts +87 -0
  78. package/models/ReqGetRecentTrades.ts +68 -0
  79. package/models/ReqGetRollbacks.ts +76 -0
  80. package/models/ReqGetSubAccount.ts +87 -0
  81. package/models/ReqGetTrades.ts +104 -0
  82. package/models/ReqGetTx.ts +79 -0
  83. package/models/ReqSearch.ts +60 -0
  84. package/models/ResultCode.ts +68 -0
  85. package/models/Rollback.ts +84 -0
  86. package/models/Rollbacks.ts +91 -0
  87. package/models/Search.ts +76 -0
  88. package/models/SignBody.ts +76 -0
  89. package/models/SimpleOrder.ts +100 -0
  90. package/models/Status.ts +68 -0
  91. package/models/SubAccount.ts +116 -0
  92. package/models/SubAccounts.ts +107 -0
  93. package/models/Trade.ts +148 -0
  94. package/models/Trades.ts +83 -0
  95. package/models/Tx.ts +164 -0
  96. package/models/TxHash.ts +76 -0
  97. package/models/Txs.ts +83 -0
  98. package/models/ValidatorInfo.ts +68 -0
  99. package/models/index.ts +84 -0
  100. package/openapi-generator-cli.jar +0 -0
  101. package/openapi.json +3934 -0
  102. package/package.json +23 -0
  103. package/runtime.ts +426 -0
package/openapi.json ADDED
@@ -0,0 +1,3934 @@
1
+ {
2
+ "swagger": "2.0",
3
+ "info": {
4
+ "title": "",
5
+ "version": ""
6
+ },
7
+ "host": "zk-perps-api.elliot.ai",
8
+ "schemes": [
9
+ "https"
10
+ ],
11
+ "consumes": [
12
+ "application/json"
13
+ ],
14
+ "produces": [
15
+ "application/json"
16
+ ],
17
+ "paths": {
18
+ "/": {
19
+ "get": {
20
+ "summary": "Get status of zklighter",
21
+ "operationId": "GetStatus",
22
+ "responses": {
23
+ "200": {
24
+ "description": "A successful response.",
25
+ "schema": {
26
+ "$ref": "#/definitions/Status"
27
+ }
28
+ }
29
+ },
30
+ "tags": [
31
+ "root"
32
+ ]
33
+ }
34
+ },
35
+ "/api/v1/account": {
36
+ "get": {
37
+ "summary": "Get account by main account's l1_address or index and sub account's index. Returns detailed account info",
38
+ "operationId": "GetAccount",
39
+ "responses": {
40
+ "200": {
41
+ "description": "A successful response.",
42
+ "schema": {
43
+ "$ref": "#/definitions/DetailedAccounts"
44
+ }
45
+ }
46
+ },
47
+ "parameters": [
48
+ {
49
+ "name": "by",
50
+ "in": "query",
51
+ "required": true,
52
+ "type": "string",
53
+ "enum": [
54
+ "index",
55
+ "l1_address"
56
+ ]
57
+ },
58
+ {
59
+ "name": "value",
60
+ "in": "query",
61
+ "required": true,
62
+ "type": "string"
63
+ },
64
+ {
65
+ "name": "sub_account_index",
66
+ "description": " NilSubAccountIndex",
67
+ "in": "query",
68
+ "required": true,
69
+ "type": "integer",
70
+ "format": "uint8",
71
+ "default": "255"
72
+ }
73
+ ],
74
+ "tags": [
75
+ "account"
76
+ ],
77
+ "consumes": [
78
+ "multipart/form-data"
79
+ ]
80
+ }
81
+ },
82
+ "/api/v1/accountActiveOrders": {
83
+ "get": {
84
+ "summary": "Get account active orders",
85
+ "operationId": "GetAccountActiveOrders",
86
+ "responses": {
87
+ "200": {
88
+ "description": "A successful response.",
89
+ "schema": {
90
+ "$ref": "#/definitions/Orders"
91
+ }
92
+ }
93
+ },
94
+ "parameters": [
95
+ {
96
+ "name": "account_index",
97
+ "in": "query",
98
+ "required": true,
99
+ "type": "integer",
100
+ "format": "int32"
101
+ },
102
+ {
103
+ "name": "sub_account_index",
104
+ "description": " NilSubAccountIndex",
105
+ "in": "query",
106
+ "required": true,
107
+ "type": "integer",
108
+ "format": "uint8",
109
+ "default": "255"
110
+ },
111
+ {
112
+ "name": "market_id",
113
+ "in": "query",
114
+ "required": true,
115
+ "type": "integer",
116
+ "format": "uin16"
117
+ }
118
+ ],
119
+ "tags": [
120
+ "order"
121
+ ],
122
+ "consumes": [
123
+ "multipart/form-data"
124
+ ]
125
+ }
126
+ },
127
+ "/api/v1/accountInactiveOrders": {
128
+ "get": {
129
+ "summary": "Get account active orders",
130
+ "operationId": "GetAccountInactiveOrders",
131
+ "responses": {
132
+ "200": {
133
+ "description": "A successful response.",
134
+ "schema": {
135
+ "$ref": "#/definitions/Orders"
136
+ }
137
+ }
138
+ },
139
+ "parameters": [
140
+ {
141
+ "name": "account_index",
142
+ "in": "query",
143
+ "required": true,
144
+ "type": "integer",
145
+ "format": "int32"
146
+ },
147
+ {
148
+ "name": "sub_account_index",
149
+ "description": " NilSubAccountIndex",
150
+ "in": "query",
151
+ "required": true,
152
+ "type": "integer",
153
+ "format": "uint8",
154
+ "default": "255"
155
+ },
156
+ {
157
+ "name": "filter",
158
+ "in": "query",
159
+ "required": true,
160
+ "type": "string",
161
+ "enum": [
162
+ "market_id",
163
+ "all"
164
+ ]
165
+ },
166
+ {
167
+ "name": "market_id",
168
+ "in": "query",
169
+ "required": false,
170
+ "type": "integer",
171
+ "format": "uin16"
172
+ },
173
+ {
174
+ "name": "cursor",
175
+ "in": "query",
176
+ "required": false,
177
+ "type": "string"
178
+ },
179
+ {
180
+ "name": "limit",
181
+ "in": "query",
182
+ "required": true,
183
+ "type": "integer",
184
+ "format": "int64",
185
+ "minimum": 1,
186
+ "maximum": 100
187
+ }
188
+ ],
189
+ "tags": [
190
+ "order"
191
+ ],
192
+ "consumes": [
193
+ "multipart/form-data"
194
+ ]
195
+ }
196
+ },
197
+ "/api/v1/accountOrders": {
198
+ "get": {
199
+ "summary": "Get account orders",
200
+ "operationId": "GetAccountOrders",
201
+ "responses": {
202
+ "200": {
203
+ "description": "A successful response.",
204
+ "schema": {
205
+ "$ref": "#/definitions/Orders"
206
+ }
207
+ }
208
+ },
209
+ "parameters": [
210
+ {
211
+ "name": "account_index",
212
+ "in": "query",
213
+ "required": true,
214
+ "type": "integer",
215
+ "format": "int32"
216
+ },
217
+ {
218
+ "name": "market_id",
219
+ "in": "query",
220
+ "required": true,
221
+ "type": "integer",
222
+ "format": "uin16"
223
+ },
224
+ {
225
+ "name": "cursor",
226
+ "in": "query",
227
+ "required": false,
228
+ "type": "string"
229
+ },
230
+ {
231
+ "name": "limit",
232
+ "in": "query",
233
+ "required": true,
234
+ "type": "integer",
235
+ "format": "int64",
236
+ "minimum": 1,
237
+ "maximum": 100
238
+ }
239
+ ],
240
+ "tags": [
241
+ "order"
242
+ ],
243
+ "consumes": [
244
+ "multipart/form-data"
245
+ ]
246
+ }
247
+ },
248
+ "/api/v1/accountPendingTxs": {
249
+ "get": {
250
+ "summary": "Get pending transactions of a specific account",
251
+ "operationId": "GetAccountPendingTxs",
252
+ "responses": {
253
+ "200": {
254
+ "description": "A successful response.",
255
+ "schema": {
256
+ "$ref": "#/definitions/Txs"
257
+ }
258
+ }
259
+ },
260
+ "parameters": [
261
+ {
262
+ "name": "by",
263
+ "in": "query",
264
+ "required": true,
265
+ "type": "string",
266
+ "enum": [
267
+ "account_index",
268
+ "l1_address"
269
+ ]
270
+ },
271
+ {
272
+ "name": "value",
273
+ "in": "query",
274
+ "required": true,
275
+ "type": "string"
276
+ },
277
+ {
278
+ "name": "types",
279
+ "in": "query",
280
+ "required": false,
281
+ "type": "integer",
282
+ "format": "uint8"
283
+ }
284
+ ],
285
+ "tags": [
286
+ "transaction"
287
+ ],
288
+ "consumes": [
289
+ "multipart/form-data"
290
+ ]
291
+ }
292
+ },
293
+ "/api/v1/accountTxs": {
294
+ "get": {
295
+ "summary": "Get transactions of a specific account",
296
+ "operationId": "GetAccountTxs",
297
+ "responses": {
298
+ "200": {
299
+ "description": "A successful response.",
300
+ "schema": {
301
+ "$ref": "#/definitions/Txs"
302
+ }
303
+ }
304
+ },
305
+ "parameters": [
306
+ {
307
+ "name": "index",
308
+ "in": "query",
309
+ "required": false,
310
+ "type": "integer",
311
+ "format": "int64"
312
+ },
313
+ {
314
+ "name": "limit",
315
+ "in": "query",
316
+ "required": true,
317
+ "type": "integer",
318
+ "format": "int64",
319
+ "minimum": 1,
320
+ "maximum": 100
321
+ },
322
+ {
323
+ "name": "by",
324
+ "in": "query",
325
+ "required": true,
326
+ "type": "string",
327
+ "enum": [
328
+ "account_index",
329
+ "l1_address"
330
+ ]
331
+ },
332
+ {
333
+ "name": "value",
334
+ "in": "query",
335
+ "required": true,
336
+ "type": "string"
337
+ },
338
+ {
339
+ "name": "types",
340
+ "in": "query",
341
+ "required": false,
342
+ "type": "integer",
343
+ "format": "uint8"
344
+ }
345
+ ],
346
+ "tags": [
347
+ "transaction"
348
+ ],
349
+ "consumes": [
350
+ "multipart/form-data"
351
+ ]
352
+ }
353
+ },
354
+ "/api/v1/accounts": {
355
+ "get": {
356
+ "summary": "Get accounts returns main accounts by account index",
357
+ "operationId": "GetAccounts",
358
+ "responses": {
359
+ "200": {
360
+ "description": "A successful response.",
361
+ "schema": {
362
+ "$ref": "#/definitions/MainAccounts"
363
+ }
364
+ }
365
+ },
366
+ "parameters": [
367
+ {
368
+ "name": "index",
369
+ "in": "query",
370
+ "required": false,
371
+ "type": "integer",
372
+ "format": "int64"
373
+ },
374
+ {
375
+ "name": "limit",
376
+ "in": "query",
377
+ "required": true,
378
+ "type": "integer",
379
+ "format": "int64",
380
+ "minimum": 1,
381
+ "maximum": 100
382
+ },
383
+ {
384
+ "name": "sort",
385
+ "in": "query",
386
+ "required": false,
387
+ "type": "string",
388
+ "enum": [
389
+ "asc",
390
+ "desc"
391
+ ],
392
+ "default": "asc"
393
+ }
394
+ ],
395
+ "tags": [
396
+ "account"
397
+ ],
398
+ "consumes": [
399
+ "multipart/form-data"
400
+ ]
401
+ }
402
+ },
403
+ "/api/v1/accountsByL1Address": {
404
+ "get": {
405
+ "summary": "Get accounts by l1_address returns main account and its sub accounts",
406
+ "operationId": "GetAccountsByL1Address",
407
+ "responses": {
408
+ "200": {
409
+ "description": "A successful response.",
410
+ "schema": {
411
+ "$ref": "#/definitions/SubAccounts"
412
+ }
413
+ }
414
+ },
415
+ "parameters": [
416
+ {
417
+ "name": "l1_address",
418
+ "in": "query",
419
+ "required": true,
420
+ "type": "string"
421
+ }
422
+ ],
423
+ "tags": [
424
+ "account"
425
+ ],
426
+ "consumes": [
427
+ "multipart/form-data"
428
+ ]
429
+ }
430
+ },
431
+ "/api/v1/block": {
432
+ "get": {
433
+ "summary": "Get block by its height or commitment",
434
+ "operationId": "GetBlock",
435
+ "responses": {
436
+ "200": {
437
+ "description": "A successful response.",
438
+ "schema": {
439
+ "$ref": "#/definitions/Blocks"
440
+ }
441
+ }
442
+ },
443
+ "parameters": [
444
+ {
445
+ "name": "by",
446
+ "in": "query",
447
+ "required": true,
448
+ "type": "string",
449
+ "enum": [
450
+ "commitment",
451
+ "height"
452
+ ]
453
+ },
454
+ {
455
+ "name": "value",
456
+ "in": "query",
457
+ "required": true,
458
+ "type": "string"
459
+ }
460
+ ],
461
+ "tags": [
462
+ "block"
463
+ ],
464
+ "consumes": [
465
+ "multipart/form-data"
466
+ ]
467
+ }
468
+ },
469
+ "/api/v1/blockTxs": {
470
+ "get": {
471
+ "summary": "Get transactions in a block",
472
+ "operationId": "GetBlockTxs",
473
+ "responses": {
474
+ "200": {
475
+ "description": "A successful response.",
476
+ "schema": {
477
+ "$ref": "#/definitions/Txs"
478
+ }
479
+ }
480
+ },
481
+ "parameters": [
482
+ {
483
+ "name": "by",
484
+ "in": "query",
485
+ "required": true,
486
+ "type": "string",
487
+ "enum": [
488
+ "block_height",
489
+ "block_commitment"
490
+ ]
491
+ },
492
+ {
493
+ "name": "value",
494
+ "in": "query",
495
+ "required": true,
496
+ "type": "string"
497
+ }
498
+ ],
499
+ "tags": [
500
+ "transaction"
501
+ ],
502
+ "consumes": [
503
+ "multipart/form-data"
504
+ ]
505
+ }
506
+ },
507
+ "/api/v1/blocks": {
508
+ "get": {
509
+ "summary": "Get blocks",
510
+ "operationId": "GetBlocks",
511
+ "responses": {
512
+ "200": {
513
+ "description": "A successful response.",
514
+ "schema": {
515
+ "$ref": "#/definitions/Blocks"
516
+ }
517
+ }
518
+ },
519
+ "parameters": [
520
+ {
521
+ "name": "index",
522
+ "in": "query",
523
+ "required": false,
524
+ "type": "integer",
525
+ "format": "int64"
526
+ },
527
+ {
528
+ "name": "limit",
529
+ "in": "query",
530
+ "required": true,
531
+ "type": "integer",
532
+ "format": "int64",
533
+ "minimum": 1,
534
+ "maximum": 100
535
+ },
536
+ {
537
+ "name": "sort",
538
+ "in": "query",
539
+ "required": false,
540
+ "type": "string",
541
+ "enum": [
542
+ "asc",
543
+ "desc"
544
+ ],
545
+ "default": "asc"
546
+ }
547
+ ],
548
+ "tags": [
549
+ "block"
550
+ ],
551
+ "consumes": [
552
+ "multipart/form-data"
553
+ ]
554
+ }
555
+ },
556
+ "/api/v1/candlesticks": {
557
+ "get": {
558
+ "summary": "Get candlesticks",
559
+ "operationId": "GetCandlesticks",
560
+ "responses": {
561
+ "200": {
562
+ "description": "A successful response.",
563
+ "schema": {
564
+ "$ref": "#/definitions/Candlesticks"
565
+ }
566
+ }
567
+ },
568
+ "parameters": [
569
+ {
570
+ "name": "market_id",
571
+ "in": "query",
572
+ "required": true,
573
+ "type": "integer",
574
+ "format": "uin16"
575
+ },
576
+ {
577
+ "name": "resolution",
578
+ "in": "query",
579
+ "required": true,
580
+ "type": "string",
581
+ "enum": [
582
+ "1m",
583
+ "5m",
584
+ "15m",
585
+ "1h",
586
+ "4h",
587
+ "1d"
588
+ ]
589
+ },
590
+ {
591
+ "name": "start_timestamp",
592
+ "in": "query",
593
+ "required": true,
594
+ "type": "integer",
595
+ "format": "int64"
596
+ },
597
+ {
598
+ "name": "end_timestamp",
599
+ "in": "query",
600
+ "required": true,
601
+ "type": "integer",
602
+ "format": "int64"
603
+ },
604
+ {
605
+ "name": "count_back",
606
+ "in": "query",
607
+ "required": true,
608
+ "type": "integer",
609
+ "format": "int64"
610
+ }
611
+ ],
612
+ "tags": [
613
+ "candlestick"
614
+ ],
615
+ "consumes": [
616
+ "multipart/form-data"
617
+ ]
618
+ }
619
+ },
620
+ "/api/v1/currentHeight": {
621
+ "get": {
622
+ "operationId": "GetCurrentHeight",
623
+ "responses": {
624
+ "200": {
625
+ "description": "A successful response.",
626
+ "schema": {
627
+ "$ref": "#/definitions/CurrentHeight"
628
+ }
629
+ }
630
+ },
631
+ "tags": [
632
+ "block"
633
+ ]
634
+ }
635
+ },
636
+ "/api/v1/exchangeStats": {
637
+ "get": {
638
+ "summary": "Get exchange stats",
639
+ "operationId": "GetExchangeStats",
640
+ "responses": {
641
+ "200": {
642
+ "description": "A successful response.",
643
+ "schema": {
644
+ "$ref": "#/definitions/ExchangeStats"
645
+ }
646
+ }
647
+ },
648
+ "tags": [
649
+ "order"
650
+ ]
651
+ }
652
+ },
653
+ "/api/v1/faucet": {
654
+ "get": {
655
+ "summary": "Request funds from faucet",
656
+ "operationId": "DoFaucet",
657
+ "responses": {
658
+ "200": {
659
+ "description": "A successful response.",
660
+ "schema": {
661
+ "$ref": "#/definitions/ResultCode"
662
+ }
663
+ }
664
+ },
665
+ "parameters": [
666
+ {
667
+ "name": "l1_address",
668
+ "in": "query",
669
+ "required": true,
670
+ "type": "string"
671
+ }
672
+ ],
673
+ "tags": [
674
+ "account"
675
+ ],
676
+ "consumes": [
677
+ "multipart/form-data"
678
+ ]
679
+ }
680
+ },
681
+ "/api/v1/fundings": {
682
+ "get": {
683
+ "summary": "Get fundings",
684
+ "operationId": "GetFundings",
685
+ "responses": {
686
+ "200": {
687
+ "description": "A successful response.",
688
+ "schema": {
689
+ "$ref": "#/definitions/Fundings"
690
+ }
691
+ }
692
+ },
693
+ "parameters": [
694
+ {
695
+ "name": "market_id",
696
+ "in": "query",
697
+ "required": true,
698
+ "type": "integer",
699
+ "format": "uin16"
700
+ },
701
+ {
702
+ "name": "resolution",
703
+ "in": "query",
704
+ "required": true,
705
+ "type": "string",
706
+ "enum": [
707
+ "1h"
708
+ ]
709
+ },
710
+ {
711
+ "name": "start_timestamp",
712
+ "in": "query",
713
+ "required": true,
714
+ "type": "integer",
715
+ "format": "int64"
716
+ },
717
+ {
718
+ "name": "end_timestamp",
719
+ "in": "query",
720
+ "required": true,
721
+ "type": "integer",
722
+ "format": "int64"
723
+ },
724
+ {
725
+ "name": "count_back",
726
+ "in": "query",
727
+ "required": true,
728
+ "type": "integer",
729
+ "format": "int64"
730
+ }
731
+ ],
732
+ "tags": [
733
+ "candlestick"
734
+ ],
735
+ "consumes": [
736
+ "multipart/form-data"
737
+ ]
738
+ }
739
+ },
740
+ "/api/v1/l2Signature": {
741
+ "post": {
742
+ "summary": "Get transaction signature body",
743
+ "operationId": "GetL2SignatureBody",
744
+ "responses": {
745
+ "200": {
746
+ "description": "A successful response.",
747
+ "schema": {
748
+ "$ref": "#/definitions/SignBody"
749
+ }
750
+ }
751
+ },
752
+ "parameters": [
753
+ {
754
+ "name": "body",
755
+ "in": "body",
756
+ "required": true,
757
+ "schema": {
758
+ "$ref": "#/definitions/ReqSendTx"
759
+ }
760
+ }
761
+ ],
762
+ "tags": [
763
+ "transaction"
764
+ ],
765
+ "consumes": [
766
+ "multipart/form-data"
767
+ ]
768
+ }
769
+ },
770
+ "/api/v1/layer1BasicInfo": {
771
+ "get": {
772
+ "summary": "Get zklighter l1 general info, including contract address and rpc info",
773
+ "operationId": "GetLayer1BasicInfo",
774
+ "responses": {
775
+ "200": {
776
+ "description": "A successful response.",
777
+ "schema": {
778
+ "$ref": "#/definitions/Layer1BasicInfo"
779
+ }
780
+ }
781
+ },
782
+ "tags": [
783
+ "info"
784
+ ]
785
+ }
786
+ },
787
+ "/api/v1/layer2BasicInfo": {
788
+ "get": {
789
+ "summary": "Get zklighter general info, including contract address, and count of transactions and active users",
790
+ "operationId": "GetLayer2BasicInfo",
791
+ "responses": {
792
+ "200": {
793
+ "description": "A successful response.",
794
+ "schema": {
795
+ "$ref": "#/definitions/Layer2BasicInfo"
796
+ }
797
+ }
798
+ },
799
+ "tags": [
800
+ "info"
801
+ ]
802
+ }
803
+ },
804
+ "/api/v1/nextNonce": {
805
+ "get": {
806
+ "summary": "Get next nonce for a specific account",
807
+ "operationId": "GetNextNonce",
808
+ "responses": {
809
+ "200": {
810
+ "description": "A successful response.",
811
+ "schema": {
812
+ "$ref": "#/definitions/NextNonce"
813
+ }
814
+ }
815
+ },
816
+ "parameters": [
817
+ {
818
+ "name": "account_index",
819
+ "in": "query",
820
+ "required": true,
821
+ "type": "integer",
822
+ "format": "int32"
823
+ },
824
+ {
825
+ "name": "sub_account_index",
826
+ "in": "query",
827
+ "required": true,
828
+ "type": "integer",
829
+ "format": "uint8"
830
+ }
831
+ ],
832
+ "tags": [
833
+ "transaction"
834
+ ],
835
+ "consumes": [
836
+ "multipart/form-data"
837
+ ]
838
+ }
839
+ },
840
+ "/api/v1/orderBookDetails": {
841
+ "get": {
842
+ "summary": "Get order books metadata",
843
+ "operationId": "GetOrderBookDetails",
844
+ "responses": {
845
+ "200": {
846
+ "description": "A successful response.",
847
+ "schema": {
848
+ "$ref": "#/definitions/OrderBookDetails"
849
+ }
850
+ }
851
+ },
852
+ "parameters": [
853
+ {
854
+ "name": "filter",
855
+ "in": "query",
856
+ "required": true,
857
+ "type": "string",
858
+ "enum": [
859
+ "market_id",
860
+ "all"
861
+ ]
862
+ },
863
+ {
864
+ "name": "market_id",
865
+ "in": "query",
866
+ "required": false,
867
+ "type": "integer",
868
+ "format": "uin16"
869
+ }
870
+ ],
871
+ "tags": [
872
+ "order"
873
+ ],
874
+ "consumes": [
875
+ "multipart/form-data"
876
+ ]
877
+ }
878
+ },
879
+ "/api/v1/orderBookOrders": {
880
+ "get": {
881
+ "summary": "Get order book orders",
882
+ "operationId": "GetOrderBookOrders",
883
+ "responses": {
884
+ "200": {
885
+ "description": "A successful response.",
886
+ "schema": {
887
+ "$ref": "#/definitions/OrderBookOrders"
888
+ }
889
+ }
890
+ },
891
+ "parameters": [
892
+ {
893
+ "name": "market_id",
894
+ "in": "query",
895
+ "required": true,
896
+ "type": "integer",
897
+ "format": "uin16"
898
+ },
899
+ {
900
+ "name": "limit",
901
+ "in": "query",
902
+ "required": true,
903
+ "type": "integer",
904
+ "format": "int64",
905
+ "minimum": 1,
906
+ "maximum": 100
907
+ }
908
+ ],
909
+ "tags": [
910
+ "order"
911
+ ],
912
+ "consumes": [
913
+ "multipart/form-data"
914
+ ]
915
+ }
916
+ },
917
+ "/api/v1/orderBooks": {
918
+ "get": {
919
+ "summary": "Get order books metadata",
920
+ "operationId": "GetOrderBooks",
921
+ "responses": {
922
+ "200": {
923
+ "description": "A successful response.",
924
+ "schema": {
925
+ "$ref": "#/definitions/OrderBooks"
926
+ }
927
+ }
928
+ },
929
+ "parameters": [
930
+ {
931
+ "name": "filter",
932
+ "in": "query",
933
+ "required": true,
934
+ "type": "string",
935
+ "enum": [
936
+ "market_id",
937
+ "all"
938
+ ]
939
+ },
940
+ {
941
+ "name": "market_id",
942
+ "in": "query",
943
+ "required": false,
944
+ "type": "integer",
945
+ "format": "uin16"
946
+ }
947
+ ],
948
+ "tags": [
949
+ "order"
950
+ ],
951
+ "consumes": [
952
+ "multipart/form-data"
953
+ ]
954
+ }
955
+ },
956
+ "/api/v1/pendingTxs": {
957
+ "get": {
958
+ "summary": "Get pending transactions",
959
+ "operationId": "GetPendingTxs",
960
+ "responses": {
961
+ "200": {
962
+ "description": "A successful response.",
963
+ "schema": {
964
+ "$ref": "#/definitions/Txs"
965
+ }
966
+ }
967
+ },
968
+ "parameters": [
969
+ {
970
+ "name": "index",
971
+ "in": "query",
972
+ "required": false,
973
+ "type": "integer",
974
+ "format": "int64"
975
+ },
976
+ {
977
+ "name": "limit",
978
+ "in": "query",
979
+ "required": true,
980
+ "type": "integer",
981
+ "format": "int64",
982
+ "minimum": 1,
983
+ "maximum": 100
984
+ }
985
+ ],
986
+ "tags": [
987
+ "transaction"
988
+ ],
989
+ "consumes": [
990
+ "multipart/form-data"
991
+ ]
992
+ }
993
+ },
994
+ "/api/v1/permission": {
995
+ "get": {
996
+ "summary": "Get permission by account's l1_address, index and tx_type",
997
+ "operationId": "GetPermission",
998
+ "responses": {
999
+ "200": {
1000
+ "description": "A successful response.",
1001
+ "schema": {
1002
+ "$ref": "#/definitions/Permission"
1003
+ }
1004
+ }
1005
+ },
1006
+ "parameters": [
1007
+ {
1008
+ "name": "by",
1009
+ "in": "query",
1010
+ "required": true,
1011
+ "type": "string",
1012
+ "enum": [
1013
+ "index",
1014
+ "l1_address"
1015
+ ]
1016
+ },
1017
+ {
1018
+ "name": "value",
1019
+ "in": "query",
1020
+ "required": true,
1021
+ "type": "string"
1022
+ },
1023
+ {
1024
+ "name": "tx_type",
1025
+ "in": "query",
1026
+ "required": true,
1027
+ "type": "integer",
1028
+ "format": "uint8"
1029
+ }
1030
+ ],
1031
+ "tags": [
1032
+ "account"
1033
+ ],
1034
+ "consumes": [
1035
+ "multipart/form-data"
1036
+ ]
1037
+ }
1038
+ },
1039
+ "/api/v1/pnl": {
1040
+ "get": {
1041
+ "summary": "Get account PnL chart",
1042
+ "operationId": "GetAccountPnl",
1043
+ "responses": {
1044
+ "200": {
1045
+ "description": "A successful response.",
1046
+ "schema": {
1047
+ "$ref": "#/definitions/AccountPnL"
1048
+ }
1049
+ }
1050
+ },
1051
+ "parameters": [
1052
+ {
1053
+ "name": "by",
1054
+ "in": "query",
1055
+ "required": true,
1056
+ "type": "string",
1057
+ "enum": [
1058
+ "index",
1059
+ "l1_address"
1060
+ ]
1061
+ },
1062
+ {
1063
+ "name": "value",
1064
+ "in": "query",
1065
+ "required": true,
1066
+ "type": "string"
1067
+ },
1068
+ {
1069
+ "name": "resolution",
1070
+ "in": "query",
1071
+ "required": true,
1072
+ "type": "string",
1073
+ "enum": [
1074
+ "1m",
1075
+ "5m",
1076
+ "15m",
1077
+ "1h",
1078
+ "4h",
1079
+ "1d"
1080
+ ]
1081
+ },
1082
+ {
1083
+ "name": "start_timestamp",
1084
+ "in": "query",
1085
+ "required": true,
1086
+ "type": "integer",
1087
+ "format": "int64"
1088
+ },
1089
+ {
1090
+ "name": "end_timestamp",
1091
+ "in": "query",
1092
+ "required": true,
1093
+ "type": "integer",
1094
+ "format": "int64"
1095
+ },
1096
+ {
1097
+ "name": "count_back",
1098
+ "in": "query",
1099
+ "required": true,
1100
+ "type": "integer",
1101
+ "format": "int64"
1102
+ }
1103
+ ],
1104
+ "tags": [
1105
+ "account"
1106
+ ],
1107
+ "consumes": [
1108
+ "multipart/form-data"
1109
+ ]
1110
+ }
1111
+ },
1112
+ "/api/v1/quote": {
1113
+ "get": {
1114
+ "summary": "Get Market Signature",
1115
+ "operationId": "GetMarketSig",
1116
+ "responses": {
1117
+ "200": {
1118
+ "description": "A successful response.",
1119
+ "schema": {
1120
+ "$ref": "#/definitions/MarketSig"
1121
+ }
1122
+ }
1123
+ },
1124
+ "parameters": [
1125
+ {
1126
+ "name": "market_id",
1127
+ "in": "query",
1128
+ "required": true,
1129
+ "type": "integer",
1130
+ "format": "uin16"
1131
+ },
1132
+ {
1133
+ "name": "is_ask",
1134
+ "in": "query",
1135
+ "required": true,
1136
+ "type": "boolean",
1137
+ "format": "boolean"
1138
+ },
1139
+ {
1140
+ "name": "base_amount",
1141
+ "in": "query",
1142
+ "required": true,
1143
+ "type": "integer",
1144
+ "format": "int64"
1145
+ }
1146
+ ],
1147
+ "tags": [
1148
+ "relayer"
1149
+ ],
1150
+ "consumes": [
1151
+ "multipart/form-data"
1152
+ ]
1153
+ }
1154
+ },
1155
+ "/api/v1/recentTrades": {
1156
+ "get": {
1157
+ "summary": "Get recent trades",
1158
+ "operationId": "GetRecentTrades",
1159
+ "responses": {
1160
+ "200": {
1161
+ "description": "A successful response.",
1162
+ "schema": {
1163
+ "$ref": "#/definitions/Trades"
1164
+ }
1165
+ }
1166
+ },
1167
+ "parameters": [
1168
+ {
1169
+ "name": "market_id",
1170
+ "in": "query",
1171
+ "required": true,
1172
+ "type": "integer",
1173
+ "format": "uin16"
1174
+ },
1175
+ {
1176
+ "name": "limit",
1177
+ "in": "query",
1178
+ "required": true,
1179
+ "type": "integer",
1180
+ "format": "int64",
1181
+ "minimum": 1,
1182
+ "maximum": 100
1183
+ }
1184
+ ],
1185
+ "tags": [
1186
+ "order"
1187
+ ],
1188
+ "consumes": [
1189
+ "multipart/form-data"
1190
+ ]
1191
+ }
1192
+ },
1193
+ "/api/v1/rollbacks": {
1194
+ "get": {
1195
+ "summary": "Get rollbacks",
1196
+ "operationId": "GetRollbacks",
1197
+ "responses": {
1198
+ "200": {
1199
+ "description": "A successful response.",
1200
+ "schema": {
1201
+ "$ref": "#/definitions/Rollbacks"
1202
+ }
1203
+ }
1204
+ },
1205
+ "parameters": [
1206
+ {
1207
+ "name": "from_block_height",
1208
+ "in": "query",
1209
+ "required": true,
1210
+ "type": "integer",
1211
+ "format": "int64"
1212
+ },
1213
+ {
1214
+ "name": "offset",
1215
+ "in": "query",
1216
+ "required": true,
1217
+ "type": "integer",
1218
+ "format": "int32",
1219
+ "minimum": 0,
1220
+ "maximum": 100000
1221
+ },
1222
+ {
1223
+ "name": "limit",
1224
+ "in": "query",
1225
+ "required": true,
1226
+ "type": "integer",
1227
+ "format": "int64",
1228
+ "minimum": 1,
1229
+ "maximum": 100
1230
+ }
1231
+ ],
1232
+ "tags": [
1233
+ "info"
1234
+ ],
1235
+ "consumes": [
1236
+ "multipart/form-data"
1237
+ ]
1238
+ }
1239
+ },
1240
+ "/api/v1/search": {
1241
+ "get": {
1242
+ "summary": "Search with a specific keyword",
1243
+ "operationId": "Search",
1244
+ "responses": {
1245
+ "200": {
1246
+ "description": "A successful response.",
1247
+ "schema": {
1248
+ "$ref": "#/definitions/Search"
1249
+ }
1250
+ }
1251
+ },
1252
+ "parameters": [
1253
+ {
1254
+ "name": "keyword",
1255
+ "in": "query",
1256
+ "required": true,
1257
+ "type": "string"
1258
+ }
1259
+ ],
1260
+ "tags": [
1261
+ "info"
1262
+ ],
1263
+ "consumes": [
1264
+ "multipart/form-data"
1265
+ ]
1266
+ }
1267
+ },
1268
+ "/api/v1/sendTx": {
1269
+ "post": {
1270
+ "summary": "Send raw transaction",
1271
+ "operationId": "SendTx",
1272
+ "responses": {
1273
+ "200": {
1274
+ "description": "A successful response.",
1275
+ "schema": {
1276
+ "$ref": "#/definitions/TxHash"
1277
+ }
1278
+ }
1279
+ },
1280
+ "parameters": [
1281
+ {
1282
+ "name": "body",
1283
+ "in": "body",
1284
+ "required": true,
1285
+ "schema": {
1286
+ "$ref": "#/definitions/ReqSendTx"
1287
+ }
1288
+ }
1289
+ ],
1290
+ "tags": [
1291
+ "transaction"
1292
+ ],
1293
+ "consumes": [
1294
+ "multipart/form-data"
1295
+ ]
1296
+ }
1297
+ },
1298
+ "/api/v1/trades": {
1299
+ "get": {
1300
+ "summary": "Get trades",
1301
+ "operationId": "GetTrades",
1302
+ "responses": {
1303
+ "200": {
1304
+ "description": "A successful response.",
1305
+ "schema": {
1306
+ "$ref": "#/definitions/Trades"
1307
+ }
1308
+ }
1309
+ },
1310
+ "parameters": [
1311
+ {
1312
+ "name": "market_id",
1313
+ "in": "query",
1314
+ "required": true,
1315
+ "type": "integer",
1316
+ "format": "uin16"
1317
+ },
1318
+ {
1319
+ "name": "order_index",
1320
+ "in": "query",
1321
+ "required": false,
1322
+ "type": "integer",
1323
+ "format": "int64"
1324
+ },
1325
+ {
1326
+ "name": "by",
1327
+ "in": "query",
1328
+ "required": true,
1329
+ "type": "string",
1330
+ "enum": [
1331
+ "block_height",
1332
+ "timestamp",
1333
+ "trade_id"
1334
+ ]
1335
+ },
1336
+ {
1337
+ "name": "from",
1338
+ "in": "query",
1339
+ "required": true,
1340
+ "type": "integer",
1341
+ "format": "int64"
1342
+ },
1343
+ {
1344
+ "name": "limit",
1345
+ "in": "query",
1346
+ "required": true,
1347
+ "type": "integer",
1348
+ "format": "int64",
1349
+ "minimum": 1,
1350
+ "maximum": 100
1351
+ }
1352
+ ],
1353
+ "tags": [
1354
+ "order"
1355
+ ],
1356
+ "consumes": [
1357
+ "multipart/form-data"
1358
+ ]
1359
+ }
1360
+ },
1361
+ "/api/v1/tx": {
1362
+ "get": {
1363
+ "summary": "Get transaction by hash or sequence index",
1364
+ "operationId": "GetTx",
1365
+ "responses": {
1366
+ "200": {
1367
+ "description": "A successful response.",
1368
+ "schema": {
1369
+ "$ref": "#/definitions/EnrichedTx"
1370
+ }
1371
+ }
1372
+ },
1373
+ "parameters": [
1374
+ {
1375
+ "name": "by",
1376
+ "in": "query",
1377
+ "required": true,
1378
+ "type": "string",
1379
+ "enum": [
1380
+ "hash",
1381
+ "sequence_index"
1382
+ ]
1383
+ },
1384
+ {
1385
+ "name": "value",
1386
+ "in": "query",
1387
+ "required": true,
1388
+ "type": "string"
1389
+ }
1390
+ ],
1391
+ "tags": [
1392
+ "transaction"
1393
+ ],
1394
+ "consumes": [
1395
+ "multipart/form-data"
1396
+ ]
1397
+ }
1398
+ },
1399
+ "/api/v1/txFromL1TxHash": {
1400
+ "get": {
1401
+ "summary": "Get L1 transaction by L1 transaction hash",
1402
+ "operationId": "getTxFromL1TxHash",
1403
+ "responses": {
1404
+ "200": {
1405
+ "description": "A successful response.",
1406
+ "schema": {
1407
+ "$ref": "#/definitions/EnrichedTx"
1408
+ }
1409
+ }
1410
+ },
1411
+ "parameters": [
1412
+ {
1413
+ "name": "hash",
1414
+ "in": "query",
1415
+ "required": true,
1416
+ "type": "string"
1417
+ }
1418
+ ],
1419
+ "tags": [
1420
+ "transaction"
1421
+ ],
1422
+ "consumes": [
1423
+ "multipart/form-data"
1424
+ ]
1425
+ }
1426
+ },
1427
+ "/api/v1/txs": {
1428
+ "get": {
1429
+ "summary": "Get transactions which are already packed into blocks",
1430
+ "operationId": "GetTxs",
1431
+ "responses": {
1432
+ "200": {
1433
+ "description": "A successful response.",
1434
+ "schema": {
1435
+ "$ref": "#/definitions/Txs"
1436
+ }
1437
+ }
1438
+ },
1439
+ "parameters": [
1440
+ {
1441
+ "name": "index",
1442
+ "in": "query",
1443
+ "required": false,
1444
+ "type": "integer",
1445
+ "format": "int64"
1446
+ },
1447
+ {
1448
+ "name": "limit",
1449
+ "in": "query",
1450
+ "required": true,
1451
+ "type": "integer",
1452
+ "format": "int64",
1453
+ "minimum": 1,
1454
+ "maximum": 100
1455
+ }
1456
+ ],
1457
+ "tags": [
1458
+ "transaction"
1459
+ ],
1460
+ "consumes": [
1461
+ "multipart/form-data"
1462
+ ]
1463
+ }
1464
+ },
1465
+ "/api/v1/ws_status": {
1466
+ "get": {
1467
+ "summary": "WebSocket Status",
1468
+ "operationId": "GetWebSocketStatus",
1469
+ "responses": {
1470
+ "200": {
1471
+ "description": "A successful response.",
1472
+ "schema": {
1473
+ "$ref": "#/definitions/ResultCode"
1474
+ }
1475
+ }
1476
+ },
1477
+ "tags": [
1478
+ "ws"
1479
+ ]
1480
+ }
1481
+ },
1482
+ "/stream": {
1483
+ "get": {
1484
+ "summary": "WebSocket",
1485
+ "operationId": "Stream",
1486
+ "responses": {
1487
+ "200": {
1488
+ "description": "A successful response.",
1489
+ "schema": {
1490
+ "$ref": "#/definitions/ResultCode"
1491
+ }
1492
+ }
1493
+ },
1494
+ "tags": [
1495
+ "ws"
1496
+ ]
1497
+ }
1498
+ }
1499
+ },
1500
+ "definitions": {
1501
+ "AccountMarketStats": {
1502
+ "type": "object",
1503
+ "properties": {
1504
+ "market_id": {
1505
+ "type": "integer",
1506
+ "format": "uin16",
1507
+ "example": "1"
1508
+ },
1509
+ "daily_trades_count": {
1510
+ "type": "integer",
1511
+ "format": "int64",
1512
+ "example": "68"
1513
+ },
1514
+ "daily_base_token_volume": {
1515
+ "type": "number",
1516
+ "format": "double",
1517
+ "example": "235.25"
1518
+ },
1519
+ "daily_quote_token_volume": {
1520
+ "type": "number",
1521
+ "format": "double",
1522
+ "example": "93566.25"
1523
+ },
1524
+ "open_position_base": {
1525
+ "type": "number",
1526
+ "format": "double",
1527
+ "example": "93.0"
1528
+ },
1529
+ "open_position_quote": {
1530
+ "type": "number",
1531
+ "format": "double",
1532
+ "example": "1276.0"
1533
+ }
1534
+ },
1535
+ "title": "AccountMarketStats"
1536
+ },
1537
+ "AccountPnL": {
1538
+ "type": "object",
1539
+ "properties": {
1540
+ "code": {
1541
+ "type": "integer",
1542
+ "format": "int32",
1543
+ "example": "100"
1544
+ },
1545
+ "message": {
1546
+ "type": "string"
1547
+ },
1548
+ "resolution": {
1549
+ "type": "string",
1550
+ "example": "15m"
1551
+ },
1552
+ "pnl": {
1553
+ "type": "array",
1554
+ "items": {
1555
+ "$ref": "#/definitions/PnLEntry"
1556
+ }
1557
+ }
1558
+ },
1559
+ "title": "AccountPnL"
1560
+ },
1561
+ "AccountPosition": {
1562
+ "type": "object",
1563
+ "properties": {
1564
+ "market_id": {
1565
+ "type": "integer",
1566
+ "format": "uin16",
1567
+ "example": "1"
1568
+ },
1569
+ "name": {
1570
+ "type": "string",
1571
+ "example": "Ethereum"
1572
+ },
1573
+ "symbol": {
1574
+ "type": "string",
1575
+ "example": "ETH"
1576
+ },
1577
+ "sign": {
1578
+ "type": "integer",
1579
+ "format": "int32",
1580
+ "example": "1"
1581
+ },
1582
+ "position": {
1583
+ "type": "string",
1584
+ "example": "3.6956"
1585
+ },
1586
+ "ask_order_size": {
1587
+ "type": "string",
1588
+ "example": "58933.9753"
1589
+ },
1590
+ "bid_order_size": {
1591
+ "type": "string",
1592
+ "example": "59010.2588"
1593
+ },
1594
+ "avg_entry_price": {
1595
+ "type": "string",
1596
+ "example": "3024.66"
1597
+ },
1598
+ "position_value": {
1599
+ "type": "string",
1600
+ "example": "3019.92"
1601
+ },
1602
+ "unrealized_pnl": {
1603
+ "type": "string",
1604
+ "example": "17.521309"
1605
+ },
1606
+ "realized_pnl": {
1607
+ "type": "string",
1608
+ "example": "2.000000"
1609
+ }
1610
+ },
1611
+ "title": "AccountPosition"
1612
+ },
1613
+ "AccountStats": {
1614
+ "type": "object",
1615
+ "properties": {
1616
+ "portfolio_value": {
1617
+ "type": "string",
1618
+ "example": "199955"
1619
+ },
1620
+ "leverage": {
1621
+ "type": "string",
1622
+ "example": "1.0"
1623
+ },
1624
+ "free_collateral": {
1625
+ "type": "string",
1626
+ "example": "199955"
1627
+ },
1628
+ "margin_usage": {
1629
+ "type": "string",
1630
+ "example": "0.0"
1631
+ },
1632
+ "buying_power": {
1633
+ "type": "string",
1634
+ "example": "199955"
1635
+ }
1636
+ },
1637
+ "title": "AccountStats"
1638
+ },
1639
+ "Block": {
1640
+ "type": "object",
1641
+ "properties": {
1642
+ "commitment": {
1643
+ "type": "string"
1644
+ },
1645
+ "height": {
1646
+ "type": "integer",
1647
+ "format": "int64"
1648
+ },
1649
+ "state_root": {
1650
+ "type": "string"
1651
+ },
1652
+ "priority_operations": {
1653
+ "type": "integer",
1654
+ "format": "int64"
1655
+ },
1656
+ "on_chain_l2_operations": {
1657
+ "type": "integer",
1658
+ "format": "int64"
1659
+ },
1660
+ "pending_on_chain_operations_pub_data": {
1661
+ "type": "string"
1662
+ },
1663
+ "committed_tx_hash": {
1664
+ "type": "string"
1665
+ },
1666
+ "committed_at": {
1667
+ "type": "integer",
1668
+ "format": "int64"
1669
+ },
1670
+ "verified_tx_hash": {
1671
+ "type": "string"
1672
+ },
1673
+ "verified_at": {
1674
+ "type": "integer",
1675
+ "format": "int64"
1676
+ },
1677
+ "txs": {
1678
+ "type": "array",
1679
+ "items": {
1680
+ "$ref": "#/definitions/Tx"
1681
+ }
1682
+ },
1683
+ "status": {
1684
+ "type": "integer",
1685
+ "format": "int64"
1686
+ },
1687
+ "size": {
1688
+ "type": "integer",
1689
+ "format": "uin16"
1690
+ }
1691
+ },
1692
+ "title": "Block"
1693
+ },
1694
+ "Blocks": {
1695
+ "type": "object",
1696
+ "properties": {
1697
+ "code": {
1698
+ "type": "integer",
1699
+ "format": "int32",
1700
+ "example": "100"
1701
+ },
1702
+ "message": {
1703
+ "type": "string"
1704
+ },
1705
+ "total": {
1706
+ "type": "integer",
1707
+ "format": "int64"
1708
+ },
1709
+ "blocks": {
1710
+ "type": "array",
1711
+ "items": {
1712
+ "$ref": "#/definitions/Block"
1713
+ }
1714
+ }
1715
+ },
1716
+ "title": "Blocks"
1717
+ },
1718
+ "Candlestick": {
1719
+ "type": "object",
1720
+ "properties": {
1721
+ "timestamp": {
1722
+ "type": "integer",
1723
+ "format": "int64",
1724
+ "example": "1640995200"
1725
+ },
1726
+ "open": {
1727
+ "type": "number",
1728
+ "format": "double",
1729
+ "example": "3024.66"
1730
+ },
1731
+ "high": {
1732
+ "type": "number",
1733
+ "format": "double",
1734
+ "example": "3034.66"
1735
+ },
1736
+ "low": {
1737
+ "type": "number",
1738
+ "format": "double",
1739
+ "example": "3014.66"
1740
+ },
1741
+ "close": {
1742
+ "type": "number",
1743
+ "format": "double",
1744
+ "example": "3024.66"
1745
+ },
1746
+ "volume0": {
1747
+ "type": "number",
1748
+ "format": "double",
1749
+ "example": "235.25"
1750
+ },
1751
+ "volume1": {
1752
+ "type": "number",
1753
+ "format": "double",
1754
+ "example": "93566.25"
1755
+ }
1756
+ },
1757
+ "title": "Candlestick"
1758
+ },
1759
+ "Candlesticks": {
1760
+ "type": "object",
1761
+ "properties": {
1762
+ "code": {
1763
+ "type": "integer",
1764
+ "format": "int32",
1765
+ "example": "100"
1766
+ },
1767
+ "message": {
1768
+ "type": "string"
1769
+ },
1770
+ "resolution": {
1771
+ "type": "string",
1772
+ "example": "15m"
1773
+ },
1774
+ "candlesticks": {
1775
+ "type": "array",
1776
+ "items": {
1777
+ "$ref": "#/definitions/Candlestick"
1778
+ }
1779
+ }
1780
+ },
1781
+ "title": "Candlesticks"
1782
+ },
1783
+ "ContractAddress": {
1784
+ "type": "object",
1785
+ "properties": {
1786
+ "name": {
1787
+ "type": "string",
1788
+ "example": "1"
1789
+ },
1790
+ "address": {
1791
+ "type": "string",
1792
+ "example": "0x70997970C51812dc3A010C7d01b50e0d17dc79C8"
1793
+ }
1794
+ },
1795
+ "title": "ContractAddress"
1796
+ },
1797
+ "CurrentHeight": {
1798
+ "type": "object",
1799
+ "properties": {
1800
+ "code": {
1801
+ "type": "integer",
1802
+ "format": "int32",
1803
+ "example": "100"
1804
+ },
1805
+ "message": {
1806
+ "type": "string"
1807
+ },
1808
+ "height": {
1809
+ "type": "integer",
1810
+ "format": "int64"
1811
+ }
1812
+ },
1813
+ "title": "CurrentHeight"
1814
+ },
1815
+ "Cursor": {
1816
+ "type": "object",
1817
+ "properties": {
1818
+ "next": {
1819
+ "type": "string"
1820
+ }
1821
+ },
1822
+ "title": "Cursor"
1823
+ },
1824
+ "DetailedAccount": {
1825
+ "type": "object",
1826
+ "properties": {
1827
+ "code": {
1828
+ "type": "integer",
1829
+ "format": "int32",
1830
+ "example": "100"
1831
+ },
1832
+ "message": {
1833
+ "type": "string"
1834
+ },
1835
+ "index": {
1836
+ "type": "integer",
1837
+ "format": "int32",
1838
+ "example": "1"
1839
+ },
1840
+ "sub_account_index": {
1841
+ "type": "integer",
1842
+ "format": "uint8",
1843
+ "example": "1"
1844
+ },
1845
+ "l1_address": {
1846
+ "type": "string",
1847
+ "example": "0x70997970C51812dc3A010C7d01b50e0d17dc79C8"
1848
+ },
1849
+ "pk": {
1850
+ "type": "string",
1851
+ "example": "3ac126b0a0a3cc8cb367ef67a5c77389a85e08e20ce8da3edf34d022e9bf1ab8"
1852
+ },
1853
+ "nonce": {
1854
+ "type": "integer",
1855
+ "format": "int64",
1856
+ "example": "722"
1857
+ },
1858
+ "status": {
1859
+ "type": "integer",
1860
+ "format": "uint8",
1861
+ "example": "1"
1862
+ },
1863
+ "collateral": {
1864
+ "type": "string",
1865
+ "example": "46342"
1866
+ },
1867
+ "collateral_type": {
1868
+ "type": "integer",
1869
+ "format": "uint8",
1870
+ "example": "1"
1871
+ },
1872
+ "positions": {
1873
+ "type": "array",
1874
+ "items": {
1875
+ "$ref": "#/definitions/AccountPosition"
1876
+ }
1877
+ },
1878
+ "total_asset_value": {
1879
+ "type": "string",
1880
+ "example": "19995"
1881
+ },
1882
+ "market_stats": {
1883
+ "type": "array",
1884
+ "items": {
1885
+ "$ref": "#/definitions/AccountMarketStats"
1886
+ }
1887
+ }
1888
+ },
1889
+ "title": "DetailedAccount"
1890
+ },
1891
+ "DetailedAccounts": {
1892
+ "type": "object",
1893
+ "properties": {
1894
+ "code": {
1895
+ "type": "integer",
1896
+ "format": "int32",
1897
+ "example": "100"
1898
+ },
1899
+ "message": {
1900
+ "type": "string"
1901
+ },
1902
+ "total": {
1903
+ "type": "integer",
1904
+ "format": "int64",
1905
+ "example": "1"
1906
+ },
1907
+ "accounts": {
1908
+ "type": "array",
1909
+ "items": {
1910
+ "$ref": "#/definitions/DetailedAccount"
1911
+ }
1912
+ }
1913
+ },
1914
+ "title": "DetailedAccounts"
1915
+ },
1916
+ "EnrichedTx": {
1917
+ "type": "object",
1918
+ "properties": {
1919
+ "code": {
1920
+ "type": "integer",
1921
+ "format": "int32",
1922
+ "example": "100"
1923
+ },
1924
+ "message": {
1925
+ "type": "string"
1926
+ },
1927
+ "hash": {
1928
+ "type": "string",
1929
+ "example": "0x70997970C51812dc3A010C7d01b50e0d17dc79C8"
1930
+ },
1931
+ "type": {
1932
+ "type": "integer",
1933
+ "format": "uint8",
1934
+ "example": "1",
1935
+ "maximum": 64,
1936
+ "minimum": 1
1937
+ },
1938
+ "info": {
1939
+ "type": "string",
1940
+ "example": "{}"
1941
+ },
1942
+ "event_info": {
1943
+ "type": "string",
1944
+ "example": "{}"
1945
+ },
1946
+ "status": {
1947
+ "type": "integer",
1948
+ "format": "int64",
1949
+ "example": "1"
1950
+ },
1951
+ "transaction_index": {
1952
+ "type": "integer",
1953
+ "format": "int64",
1954
+ "example": "8761"
1955
+ },
1956
+ "l1_address": {
1957
+ "type": "string",
1958
+ "example": "0x70997970C51812dc3A010C7d01b50e0d17dc79C8"
1959
+ },
1960
+ "account_index": {
1961
+ "type": "integer",
1962
+ "format": "int32",
1963
+ "example": "1"
1964
+ },
1965
+ "nonce": {
1966
+ "type": "integer",
1967
+ "format": "int64",
1968
+ "example": "722"
1969
+ },
1970
+ "expire_at": {
1971
+ "type": "integer",
1972
+ "format": "int64",
1973
+ "example": "1640995200"
1974
+ },
1975
+ "block_height": {
1976
+ "type": "integer",
1977
+ "format": "int64",
1978
+ "example": "45434"
1979
+ },
1980
+ "created_at": {
1981
+ "type": "integer",
1982
+ "format": "int64",
1983
+ "example": "1640995200"
1984
+ },
1985
+ "verify_at": {
1986
+ "type": "integer",
1987
+ "format": "int64",
1988
+ "example": "1640995200"
1989
+ },
1990
+ "sequence_index": {
1991
+ "type": "integer",
1992
+ "format": "int64",
1993
+ "example": "8761"
1994
+ },
1995
+ "committed_at": {
1996
+ "type": "integer",
1997
+ "format": "int64",
1998
+ "example": "1640995200"
1999
+ },
2000
+ "verified_at": {
2001
+ "type": "integer",
2002
+ "format": "int64",
2003
+ "example": "1640995200"
2004
+ },
2005
+ "executed_at": {
2006
+ "type": "integer",
2007
+ "format": "int64",
2008
+ "example": "1640995200"
2009
+ }
2010
+ },
2011
+ "title": "EnrichedTx"
2012
+ },
2013
+ "ExchangeStats": {
2014
+ "type": "object",
2015
+ "properties": {
2016
+ "code": {
2017
+ "type": "integer",
2018
+ "format": "int32",
2019
+ "example": "100"
2020
+ },
2021
+ "message": {
2022
+ "type": "string"
2023
+ },
2024
+ "total": {
2025
+ "type": "integer",
2026
+ "format": "int64",
2027
+ "example": "1"
2028
+ },
2029
+ "order_book_stats": {
2030
+ "type": "array",
2031
+ "example": "1",
2032
+ "items": {
2033
+ "$ref": "#/definitions/OrderBookStats"
2034
+ }
2035
+ },
2036
+ "daily_usd_volume": {
2037
+ "type": "number",
2038
+ "format": "double",
2039
+ "example": "93566.25"
2040
+ },
2041
+ "daily_trades_count": {
2042
+ "type": "integer",
2043
+ "format": "int64",
2044
+ "example": "68"
2045
+ }
2046
+ },
2047
+ "title": "ExchangeStats"
2048
+ },
2049
+ "Funding": {
2050
+ "type": "object",
2051
+ "properties": {
2052
+ "timestamp": {
2053
+ "type": "integer",
2054
+ "format": "int64",
2055
+ "example": "1640995200"
2056
+ },
2057
+ "value": {
2058
+ "type": "string",
2059
+ "example": "0.0001"
2060
+ },
2061
+ "rate": {
2062
+ "type": "string",
2063
+ "example": "0.0001"
2064
+ },
2065
+ "direction": {
2066
+ "type": "string",
2067
+ "example": "long"
2068
+ }
2069
+ },
2070
+ "title": "Funding"
2071
+ },
2072
+ "Fundings": {
2073
+ "type": "object",
2074
+ "properties": {
2075
+ "code": {
2076
+ "type": "integer",
2077
+ "format": "int32",
2078
+ "example": "100"
2079
+ },
2080
+ "message": {
2081
+ "type": "string"
2082
+ },
2083
+ "resolution": {
2084
+ "type": "string",
2085
+ "example": "1h"
2086
+ },
2087
+ "fundings": {
2088
+ "type": "array",
2089
+ "items": {
2090
+ "$ref": "#/definitions/Funding"
2091
+ }
2092
+ }
2093
+ },
2094
+ "title": "Fundings"
2095
+ },
2096
+ "L1ProviderInfo": {
2097
+ "type": "object",
2098
+ "properties": {
2099
+ "chainId": {
2100
+ "type": "integer",
2101
+ "format": "int64",
2102
+ "example": "1"
2103
+ },
2104
+ "networkId": {
2105
+ "type": "integer",
2106
+ "format": "int64",
2107
+ "example": "1"
2108
+ },
2109
+ "latestBlockNumber": {
2110
+ "type": "integer",
2111
+ "format": "int64",
2112
+ "example": "45434"
2113
+ },
2114
+ "NetworkRpc": {
2115
+ "type": "string"
2116
+ }
2117
+ },
2118
+ "title": "L1ProviderInfo"
2119
+ },
2120
+ "Layer1BasicInfo": {
2121
+ "type": "object",
2122
+ "properties": {
2123
+ "code": {
2124
+ "type": "integer",
2125
+ "format": "int32",
2126
+ "example": "100"
2127
+ },
2128
+ "message": {
2129
+ "type": "string"
2130
+ },
2131
+ "l1_providers": {
2132
+ "type": "array",
2133
+ "items": {
2134
+ "$ref": "#/definitions/L1ProviderInfo"
2135
+ }
2136
+ },
2137
+ "l1_providers_health": {
2138
+ "type": "boolean",
2139
+ "format": "boolean",
2140
+ "example": "true"
2141
+ },
2142
+ "validator_Info": {
2143
+ "type": "array",
2144
+ "items": {
2145
+ "$ref": "#/definitions/ValidatorInfo"
2146
+ }
2147
+ },
2148
+ "contract_addresses": {
2149
+ "type": "array",
2150
+ "items": {
2151
+ "$ref": "#/definitions/ContractAddress"
2152
+ }
2153
+ },
2154
+ "latest_l1_generic_block": {
2155
+ "type": "integer",
2156
+ "format": "int64",
2157
+ "example": "45434"
2158
+ },
2159
+ "latest_l1_governance_block": {
2160
+ "type": "integer",
2161
+ "format": "int64",
2162
+ "example": "45434"
2163
+ },
2164
+ "latest_l1_desert_block": {
2165
+ "type": "integer",
2166
+ "format": "int64",
2167
+ "example": "45434"
2168
+ }
2169
+ },
2170
+ "title": "Layer1BasicInfo"
2171
+ },
2172
+ "Layer2BasicInfo": {
2173
+ "type": "object",
2174
+ "properties": {
2175
+ "code": {
2176
+ "type": "integer",
2177
+ "format": "int32",
2178
+ "example": "100"
2179
+ },
2180
+ "message": {
2181
+ "type": "string"
2182
+ },
2183
+ "block_committed": {
2184
+ "type": "integer",
2185
+ "format": "int64",
2186
+ "example": "45434"
2187
+ },
2188
+ "block_verified": {
2189
+ "type": "integer",
2190
+ "format": "int64",
2191
+ "example": "45434"
2192
+ },
2193
+ "total_transaction_count": {
2194
+ "type": "integer",
2195
+ "format": "int64",
2196
+ "example": "75434"
2197
+ }
2198
+ },
2199
+ "title": "Layer2BasicInfo"
2200
+ },
2201
+ "MainAccount": {
2202
+ "type": "object",
2203
+ "properties": {
2204
+ "code": {
2205
+ "type": "integer",
2206
+ "format": "int32",
2207
+ "example": "100"
2208
+ },
2209
+ "message": {
2210
+ "type": "string"
2211
+ },
2212
+ "index": {
2213
+ "type": "integer",
2214
+ "format": "int32",
2215
+ "example": "1"
2216
+ },
2217
+ "l1_address": {
2218
+ "type": "string",
2219
+ "example": "0x70997970C51812dc3A010C7d01b50e0d17dc79C8"
2220
+ },
2221
+ "status": {
2222
+ "type": "integer",
2223
+ "format": "int32",
2224
+ "example": "1"
2225
+ }
2226
+ },
2227
+ "title": "MainAccount"
2228
+ },
2229
+ "MainAccounts": {
2230
+ "type": "object",
2231
+ "properties": {
2232
+ "code": {
2233
+ "type": "integer",
2234
+ "format": "int32",
2235
+ "example": "100"
2236
+ },
2237
+ "message": {
2238
+ "type": "string"
2239
+ },
2240
+ "total": {
2241
+ "type": "integer",
2242
+ "format": "int64",
2243
+ "example": "1"
2244
+ },
2245
+ "accounts": {
2246
+ "type": "array",
2247
+ "items": {
2248
+ "$ref": "#/definitions/MainAccount"
2249
+ }
2250
+ }
2251
+ },
2252
+ "title": "MainAccounts"
2253
+ },
2254
+ "MarketInfo": {
2255
+ "type": "object",
2256
+ "properties": {
2257
+ "market_id": {
2258
+ "type": "integer",
2259
+ "format": "uin16",
2260
+ "example": "1"
2261
+ },
2262
+ "index_price": {
2263
+ "type": "string",
2264
+ "example": "3024.66"
2265
+ },
2266
+ "mark_price": {
2267
+ "type": "string",
2268
+ "example": "3024.66"
2269
+ },
2270
+ "last_trade_price": {
2271
+ "type": "string",
2272
+ "example": "3024.66"
2273
+ },
2274
+ "funding_rate": {
2275
+ "type": "string",
2276
+ "example": "0.0001"
2277
+ },
2278
+ "funding_timestamp": {
2279
+ "type": "integer",
2280
+ "format": "int64",
2281
+ "example": "1640995200"
2282
+ },
2283
+ "daily_base_token_volume": {
2284
+ "type": "number",
2285
+ "format": "double",
2286
+ "example": "235.25"
2287
+ },
2288
+ "daily_quote_token_volume": {
2289
+ "type": "number",
2290
+ "format": "double",
2291
+ "example": "93566.25"
2292
+ },
2293
+ "daily_price_low": {
2294
+ "type": "number",
2295
+ "format": "double",
2296
+ "example": "3014.66"
2297
+ },
2298
+ "daily_price_high": {
2299
+ "type": "number",
2300
+ "format": "double",
2301
+ "example": "3024.66"
2302
+ },
2303
+ "daily_price_change": {
2304
+ "type": "number",
2305
+ "format": "double",
2306
+ "example": "3.66"
2307
+ }
2308
+ },
2309
+ "title": "MarketInfo"
2310
+ },
2311
+ "MarketSig": {
2312
+ "type": "object",
2313
+ "properties": {
2314
+ "code": {
2315
+ "type": "integer",
2316
+ "format": "int32",
2317
+ "example": "100"
2318
+ },
2319
+ "message": {
2320
+ "type": "string"
2321
+ },
2322
+ "can_be_filled": {
2323
+ "type": "boolean",
2324
+ "format": "boolean",
2325
+ "example": "true"
2326
+ },
2327
+ "is_ask": {
2328
+ "type": "boolean",
2329
+ "format": "boolean",
2330
+ "example": "true"
2331
+ },
2332
+ "quote_amount": {
2333
+ "type": "integer",
2334
+ "format": "int64",
2335
+ "example": "100000000"
2336
+ },
2337
+ "signature": {
2338
+ "type": "string",
2339
+ "example": "0x70997970C51812dc3A010C7d01b50e0d17dc79C8"
2340
+ }
2341
+ },
2342
+ "title": "MarketSig"
2343
+ },
2344
+ "NextNonce": {
2345
+ "type": "object",
2346
+ "properties": {
2347
+ "code": {
2348
+ "type": "integer",
2349
+ "format": "int32",
2350
+ "example": "100"
2351
+ },
2352
+ "message": {
2353
+ "type": "string"
2354
+ },
2355
+ "nonce": {
2356
+ "type": "integer",
2357
+ "format": "int64",
2358
+ "example": "722"
2359
+ }
2360
+ },
2361
+ "title": "NextNonce"
2362
+ },
2363
+ "Order": {
2364
+ "type": "object",
2365
+ "properties": {
2366
+ "market_index": {
2367
+ "type": "integer",
2368
+ "format": "uin16",
2369
+ "example": "1"
2370
+ },
2371
+ "ownerMainAccountIndex": {
2372
+ "type": "integer",
2373
+ "format": "int64",
2374
+ "description": " TODO: should we return this?"
2375
+ },
2376
+ "owner_account_index": {
2377
+ "type": "integer",
2378
+ "format": "int64",
2379
+ "example": "1"
2380
+ },
2381
+ "initial_base_amount": {
2382
+ "type": "string",
2383
+ "example": "0.1"
2384
+ },
2385
+ "remaining_base_amount": {
2386
+ "type": "string",
2387
+ "example": "0.1"
2388
+ },
2389
+ "filled_base_amount": {
2390
+ "type": "string",
2391
+ "example": "0.1"
2392
+ },
2393
+ "filled_quote_amount": {
2394
+ "type": "string",
2395
+ "example": "0.1"
2396
+ },
2397
+ "price": {
2398
+ "type": "string",
2399
+ "example": "3024.66"
2400
+ },
2401
+ "base_size": {
2402
+ "type": "integer",
2403
+ "format": "int64",
2404
+ "example": "12354"
2405
+ },
2406
+ "base_price": {
2407
+ "type": "integer",
2408
+ "format": "int64",
2409
+ "example": "3024"
2410
+ },
2411
+ "nonce": {
2412
+ "type": "integer",
2413
+ "format": "int64",
2414
+ "example": "234"
2415
+ },
2416
+ "is_ask": {
2417
+ "type": "boolean",
2418
+ "format": "boolean",
2419
+ "example": "true"
2420
+ },
2421
+ "side": {
2422
+ "type": "string",
2423
+ "example": "buy",
2424
+ "default": "buy"
2425
+ },
2426
+ "type": {
2427
+ "type": "string",
2428
+ "example": "limit",
2429
+ "enum": [
2430
+ "limit",
2431
+ "market"
2432
+ ]
2433
+ },
2434
+ "status": {
2435
+ "type": "string",
2436
+ "example": "open",
2437
+ "enum": [
2438
+ "open",
2439
+ "filled",
2440
+ "canceled"
2441
+ ]
2442
+ },
2443
+ "block_height": {
2444
+ "type": "integer",
2445
+ "format": "int64",
2446
+ "example": "45434"
2447
+ },
2448
+ "timestamp": {
2449
+ "type": "integer",
2450
+ "format": "int64",
2451
+ "example": "1640995200"
2452
+ }
2453
+ },
2454
+ "title": "Order"
2455
+ },
2456
+ "OrderBook": {
2457
+ "type": "object",
2458
+ "properties": {
2459
+ "symbol": {
2460
+ "type": "string",
2461
+ "example": "ETH"
2462
+ },
2463
+ "market_id": {
2464
+ "type": "integer",
2465
+ "format": "uin16",
2466
+ "example": "1"
2467
+ },
2468
+ "status": {
2469
+ "type": "string",
2470
+ "example": "active",
2471
+ "enum": [
2472
+ "frozen",
2473
+ "active"
2474
+ ]
2475
+ },
2476
+ "taker_fee": {
2477
+ "type": "string",
2478
+ "example": "0.0001"
2479
+ },
2480
+ "maker_fee": {
2481
+ "type": "string",
2482
+ "example": "0.0000"
2483
+ },
2484
+ "min_base_amount": {
2485
+ "type": "string",
2486
+ "example": "0.01"
2487
+ },
2488
+ "min_quote_amount": {
2489
+ "type": "string",
2490
+ "example": "0.1"
2491
+ },
2492
+ "supported_size_decimals": {
2493
+ "type": "integer",
2494
+ "format": "int64",
2495
+ "example": "4"
2496
+ },
2497
+ "supported_price_decimals": {
2498
+ "type": "integer",
2499
+ "format": "int64",
2500
+ "example": "4"
2501
+ },
2502
+ "supported_quote_decimals": {
2503
+ "type": "integer",
2504
+ "format": "int64",
2505
+ "example": "4"
2506
+ }
2507
+ },
2508
+ "title": "OrderBook"
2509
+ },
2510
+ "OrderBookDepth": {
2511
+ "type": "object",
2512
+ "properties": {
2513
+ "code": {
2514
+ "type": "integer",
2515
+ "format": "int32",
2516
+ "example": "100"
2517
+ },
2518
+ "message": {
2519
+ "type": "string"
2520
+ },
2521
+ "asks": {
2522
+ "type": "array",
2523
+ "items": {
2524
+ "$ref": "#/definitions/PriceLevel"
2525
+ }
2526
+ },
2527
+ "bids": {
2528
+ "type": "array",
2529
+ "items": {
2530
+ "$ref": "#/definitions/PriceLevel"
2531
+ }
2532
+ },
2533
+ "offset": {
2534
+ "type": "integer",
2535
+ "format": "int64",
2536
+ "example": "0"
2537
+ }
2538
+ },
2539
+ "title": "OrderBookDepth"
2540
+ },
2541
+ "OrderBookDetail": {
2542
+ "type": "object",
2543
+ "properties": {
2544
+ "symbol": {
2545
+ "type": "string",
2546
+ "example": "ETH"
2547
+ },
2548
+ "market_id": {
2549
+ "type": "integer",
2550
+ "format": "uin16",
2551
+ "example": "1"
2552
+ },
2553
+ "status": {
2554
+ "type": "string",
2555
+ "example": "active",
2556
+ "enum": [
2557
+ "frozen",
2558
+ "active"
2559
+ ]
2560
+ },
2561
+ "taker_fee": {
2562
+ "type": "string",
2563
+ "example": "0.0001"
2564
+ },
2565
+ "maker_fee": {
2566
+ "type": "string",
2567
+ "example": "0.0000"
2568
+ },
2569
+ "min_base_amount": {
2570
+ "type": "string",
2571
+ "example": "0.01"
2572
+ },
2573
+ "min_quote_amount": {
2574
+ "type": "string",
2575
+ "example": "0.1"
2576
+ },
2577
+ "supported_size_decimals": {
2578
+ "type": "integer",
2579
+ "format": "int64",
2580
+ "example": "4"
2581
+ },
2582
+ "supported_price_decimals": {
2583
+ "type": "integer",
2584
+ "format": "int64",
2585
+ "example": "4"
2586
+ },
2587
+ "supported_quote_decimals": {
2588
+ "type": "integer",
2589
+ "format": "int64",
2590
+ "example": "4"
2591
+ },
2592
+ "decimal": {
2593
+ "type": "integer",
2594
+ "format": "uint8",
2595
+ "example": "4"
2596
+ },
2597
+ "price_tick": {
2598
+ "type": "integer",
2599
+ "format": "int64",
2600
+ "example": "1"
2601
+ },
2602
+ "quote_multiplier": {
2603
+ "type": "integer",
2604
+ "format": "int64",
2605
+ "example": "10000"
2606
+ },
2607
+ "initial_margin": {
2608
+ "type": "integer",
2609
+ "format": "uin16",
2610
+ "example": "100"
2611
+ },
2612
+ "maintenance_margin": {
2613
+ "type": "integer",
2614
+ "format": "uin16",
2615
+ "example": "50"
2616
+ },
2617
+ "closeoute_margin": {
2618
+ "type": "integer",
2619
+ "format": "uin16",
2620
+ "example": "100"
2621
+ },
2622
+ "ask_nonce": {
2623
+ "type": "integer",
2624
+ "format": "int64",
2625
+ "example": "234"
2626
+ },
2627
+ "bid_nonce": {
2628
+ "type": "integer",
2629
+ "format": "int64",
2630
+ "example": "274"
2631
+ },
2632
+ "last_trade_price": {
2633
+ "type": "number",
2634
+ "format": "double",
2635
+ "example": "3024.66"
2636
+ },
2637
+ "daily_trades_count": {
2638
+ "type": "integer",
2639
+ "format": "int64",
2640
+ "example": "68"
2641
+ },
2642
+ "daily_base_token_volume": {
2643
+ "type": "number",
2644
+ "format": "double",
2645
+ "example": "235.25"
2646
+ },
2647
+ "daily_quote_token_volume": {
2648
+ "type": "number",
2649
+ "format": "double",
2650
+ "example": "93566.25"
2651
+ },
2652
+ "daily_price_low": {
2653
+ "type": "number",
2654
+ "format": "double",
2655
+ "example": "3014.66"
2656
+ },
2657
+ "daily_price_high": {
2658
+ "type": "number",
2659
+ "format": "double",
2660
+ "example": "3024.66"
2661
+ },
2662
+ "daily_price_change": {
2663
+ "type": "number",
2664
+ "format": "double",
2665
+ "example": "3.66"
2666
+ },
2667
+ "open_position_base": {
2668
+ "type": "number",
2669
+ "format": "double",
2670
+ "example": "93.0"
2671
+ },
2672
+ "open_position_quote": {
2673
+ "type": "number",
2674
+ "format": "double",
2675
+ "example": "1276.0"
2676
+ },
2677
+ "daily_chart": {
2678
+ "type": "object",
2679
+ "example": "{1640995200: 3024.66}",
2680
+ "additionalProperties": {
2681
+ "type": "number",
2682
+ "format": "double"
2683
+ }
2684
+ }
2685
+ },
2686
+ "title": "OrderBookDetail"
2687
+ },
2688
+ "OrderBookDetails": {
2689
+ "type": "object",
2690
+ "properties": {
2691
+ "code": {
2692
+ "type": "integer",
2693
+ "format": "int32",
2694
+ "example": "100"
2695
+ },
2696
+ "message": {
2697
+ "type": "string"
2698
+ },
2699
+ "order_book_details": {
2700
+ "type": "array",
2701
+ "items": {
2702
+ "$ref": "#/definitions/OrderBookDetail"
2703
+ }
2704
+ }
2705
+ },
2706
+ "title": "OrderBookDetails"
2707
+ },
2708
+ "OrderBookOrders": {
2709
+ "type": "object",
2710
+ "properties": {
2711
+ "code": {
2712
+ "type": "integer",
2713
+ "format": "int32",
2714
+ "example": "100"
2715
+ },
2716
+ "message": {
2717
+ "type": "string"
2718
+ },
2719
+ "total_asks": {
2720
+ "type": "integer",
2721
+ "format": "int64",
2722
+ "example": "1"
2723
+ },
2724
+ "asks": {
2725
+ "type": "array",
2726
+ "items": {
2727
+ "$ref": "#/definitions/SimpleOrder"
2728
+ }
2729
+ },
2730
+ "total_bids": {
2731
+ "type": "integer",
2732
+ "format": "int64",
2733
+ "example": "1"
2734
+ },
2735
+ "bids": {
2736
+ "type": "array",
2737
+ "items": {
2738
+ "$ref": "#/definitions/SimpleOrder"
2739
+ }
2740
+ }
2741
+ },
2742
+ "title": "OrderBookOrders"
2743
+ },
2744
+ "OrderBookStats": {
2745
+ "type": "object",
2746
+ "properties": {
2747
+ "symbol": {
2748
+ "type": "string",
2749
+ "example": "ETH"
2750
+ },
2751
+ "last_trade_price": {
2752
+ "type": "number",
2753
+ "format": "double",
2754
+ "example": "3024.66"
2755
+ },
2756
+ "daily_trades_count": {
2757
+ "type": "integer",
2758
+ "format": "int64",
2759
+ "example": "68"
2760
+ },
2761
+ "daily_base_token_volume": {
2762
+ "type": "number",
2763
+ "format": "double",
2764
+ "example": "235.25"
2765
+ },
2766
+ "daily_quote_token_volume": {
2767
+ "type": "number",
2768
+ "format": "double",
2769
+ "example": "93566.25"
2770
+ },
2771
+ "daily_price_change": {
2772
+ "type": "number",
2773
+ "format": "double",
2774
+ "example": "3.66"
2775
+ }
2776
+ },
2777
+ "title": "OrderBookStats"
2778
+ },
2779
+ "OrderBooks": {
2780
+ "type": "object",
2781
+ "properties": {
2782
+ "code": {
2783
+ "type": "integer",
2784
+ "format": "int32",
2785
+ "example": "100"
2786
+ },
2787
+ "message": {
2788
+ "type": "string"
2789
+ },
2790
+ "order_books": {
2791
+ "type": "array",
2792
+ "items": {
2793
+ "$ref": "#/definitions/OrderBook"
2794
+ }
2795
+ }
2796
+ },
2797
+ "title": "OrderBooks"
2798
+ },
2799
+ "Orders": {
2800
+ "type": "object",
2801
+ "properties": {
2802
+ "code": {
2803
+ "type": "integer",
2804
+ "format": "int32",
2805
+ "example": "100"
2806
+ },
2807
+ "message": {
2808
+ "type": "string"
2809
+ },
2810
+ "next": {
2811
+ "type": "string"
2812
+ },
2813
+ "orders": {
2814
+ "type": "array",
2815
+ "items": {
2816
+ "$ref": "#/definitions/Order"
2817
+ }
2818
+ }
2819
+ },
2820
+ "title": "Orders"
2821
+ },
2822
+ "Permission": {
2823
+ "type": "object",
2824
+ "properties": {
2825
+ "code": {
2826
+ "type": "integer",
2827
+ "format": "int32",
2828
+ "example": "100"
2829
+ },
2830
+ "message": {
2831
+ "type": "string"
2832
+ },
2833
+ "permit": {
2834
+ "type": "boolean",
2835
+ "format": "boolean",
2836
+ "example": "true"
2837
+ }
2838
+ },
2839
+ "title": "Permission"
2840
+ },
2841
+ "PnLEntry": {
2842
+ "type": "object",
2843
+ "properties": {
2844
+ "timestamp": {
2845
+ "type": "integer",
2846
+ "format": "int64",
2847
+ "example": "1640995200"
2848
+ },
2849
+ "value": {
2850
+ "type": "number",
2851
+ "format": "double",
2852
+ "example": "12.0"
2853
+ }
2854
+ },
2855
+ "title": "PnLEntry"
2856
+ },
2857
+ "PriceLevel": {
2858
+ "type": "object",
2859
+ "properties": {
2860
+ "price": {
2861
+ "type": "string",
2862
+ "example": "3024.66"
2863
+ },
2864
+ "size": {
2865
+ "type": "string",
2866
+ "example": "0.1"
2867
+ }
2868
+ },
2869
+ "title": "PriceLevel"
2870
+ },
2871
+ "ReqDoFaucet": {
2872
+ "type": "object",
2873
+ "properties": {
2874
+ "l1_address": {
2875
+ "type": "string"
2876
+ }
2877
+ },
2878
+ "title": "ReqDoFaucet"
2879
+ },
2880
+ "ReqGetAccount": {
2881
+ "type": "object",
2882
+ "properties": {
2883
+ "by": {
2884
+ "type": "string",
2885
+ "enum": [
2886
+ "index",
2887
+ "l1_address"
2888
+ ]
2889
+ },
2890
+ "value": {
2891
+ "type": "string"
2892
+ }
2893
+ },
2894
+ "title": "ReqGetAccount"
2895
+ },
2896
+ "ReqGetAccountActiveOrders": {
2897
+ "type": "object",
2898
+ "properties": {
2899
+ "account_index": {
2900
+ "type": "integer",
2901
+ "format": "int32"
2902
+ },
2903
+ "sub_account_index": {
2904
+ "type": "integer",
2905
+ "format": "uint8",
2906
+ "default": "255",
2907
+ "description": " NilSubAccountIndex"
2908
+ },
2909
+ "market_id": {
2910
+ "type": "integer",
2911
+ "format": "uin16"
2912
+ }
2913
+ },
2914
+ "title": "ReqGetAccountActiveOrders"
2915
+ },
2916
+ "ReqGetAccountByL1Address": {
2917
+ "type": "object",
2918
+ "properties": {
2919
+ "l1_address": {
2920
+ "type": "string"
2921
+ }
2922
+ },
2923
+ "title": "ReqGetAccountByL1Address"
2924
+ },
2925
+ "ReqGetAccountInactiveOrders": {
2926
+ "type": "object",
2927
+ "properties": {
2928
+ "account_index": {
2929
+ "type": "integer",
2930
+ "format": "int32"
2931
+ },
2932
+ "sub_account_index": {
2933
+ "type": "integer",
2934
+ "format": "uint8",
2935
+ "default": "255",
2936
+ "description": " NilSubAccountIndex"
2937
+ },
2938
+ "filter": {
2939
+ "type": "string",
2940
+ "enum": [
2941
+ "market_id",
2942
+ "all"
2943
+ ]
2944
+ },
2945
+ "market_id": {
2946
+ "type": "integer",
2947
+ "format": "uin16"
2948
+ },
2949
+ "cursor": {
2950
+ "type": "string"
2951
+ },
2952
+ "limit": {
2953
+ "type": "integer",
2954
+ "format": "int64",
2955
+ "maximum": 100,
2956
+ "minimum": 1
2957
+ }
2958
+ },
2959
+ "title": "ReqGetAccountInactiveOrders"
2960
+ },
2961
+ "ReqGetAccountOrders": {
2962
+ "type": "object",
2963
+ "properties": {
2964
+ "account_index": {
2965
+ "type": "integer",
2966
+ "format": "int32"
2967
+ },
2968
+ "market_id": {
2969
+ "type": "integer",
2970
+ "format": "uin16"
2971
+ },
2972
+ "cursor": {
2973
+ "type": "string"
2974
+ },
2975
+ "limit": {
2976
+ "type": "integer",
2977
+ "format": "int64",
2978
+ "maximum": 100,
2979
+ "minimum": 1
2980
+ }
2981
+ },
2982
+ "title": "ReqGetAccountOrders"
2983
+ },
2984
+ "ReqGetAccountPendingTxs": {
2985
+ "type": "object",
2986
+ "properties": {
2987
+ "by": {
2988
+ "type": "string",
2989
+ "enum": [
2990
+ "account_index",
2991
+ "l1_address"
2992
+ ]
2993
+ },
2994
+ "value": {
2995
+ "type": "string"
2996
+ },
2997
+ "types": {
2998
+ "type": "array",
2999
+ "items": {
3000
+ "type": "integer",
3001
+ "format": "uint8"
3002
+ }
3003
+ }
3004
+ },
3005
+ "title": "ReqGetAccountPendingTxs"
3006
+ },
3007
+ "ReqGetAccountPnL": {
3008
+ "type": "object",
3009
+ "properties": {
3010
+ "by": {
3011
+ "type": "string",
3012
+ "enum": [
3013
+ "index",
3014
+ "l1_address"
3015
+ ]
3016
+ },
3017
+ "value": {
3018
+ "type": "string"
3019
+ },
3020
+ "resolution": {
3021
+ "type": "string",
3022
+ "enum": [
3023
+ "1m",
3024
+ "5m",
3025
+ "15m",
3026
+ "1h",
3027
+ "4h",
3028
+ "1d"
3029
+ ]
3030
+ },
3031
+ "start_timestamp": {
3032
+ "type": "integer",
3033
+ "format": "int64"
3034
+ },
3035
+ "end_timestamp": {
3036
+ "type": "integer",
3037
+ "format": "int64"
3038
+ },
3039
+ "count_back": {
3040
+ "type": "integer",
3041
+ "format": "int64"
3042
+ }
3043
+ },
3044
+ "title": "ReqGetAccountPnL"
3045
+ },
3046
+ "ReqGetAccountTxs": {
3047
+ "type": "object",
3048
+ "properties": {
3049
+ "index": {
3050
+ "type": "integer",
3051
+ "format": "int64"
3052
+ },
3053
+ "limit": {
3054
+ "type": "integer",
3055
+ "format": "int64",
3056
+ "maximum": 100,
3057
+ "minimum": 1
3058
+ },
3059
+ "by": {
3060
+ "type": "string",
3061
+ "enum": [
3062
+ "account_index",
3063
+ "l1_address"
3064
+ ]
3065
+ },
3066
+ "value": {
3067
+ "type": "string"
3068
+ },
3069
+ "types": {
3070
+ "type": "array",
3071
+ "items": {
3072
+ "type": "integer",
3073
+ "format": "uint8"
3074
+ }
3075
+ }
3076
+ },
3077
+ "title": "ReqGetAccountTxs"
3078
+ },
3079
+ "ReqGetBlock": {
3080
+ "type": "object",
3081
+ "properties": {
3082
+ "by": {
3083
+ "type": "string",
3084
+ "enum": [
3085
+ "commitment",
3086
+ "height"
3087
+ ]
3088
+ },
3089
+ "value": {
3090
+ "type": "string"
3091
+ }
3092
+ },
3093
+ "title": "ReqGetBlock"
3094
+ },
3095
+ "ReqGetBlockTxs": {
3096
+ "type": "object",
3097
+ "properties": {
3098
+ "by": {
3099
+ "type": "string",
3100
+ "enum": [
3101
+ "block_height",
3102
+ "block_commitment"
3103
+ ]
3104
+ },
3105
+ "value": {
3106
+ "type": "string"
3107
+ }
3108
+ },
3109
+ "title": "ReqGetBlockTxs"
3110
+ },
3111
+ "ReqGetByAccount": {
3112
+ "type": "object",
3113
+ "properties": {
3114
+ "by": {
3115
+ "type": "string",
3116
+ "enum": [
3117
+ "account_index",
3118
+ "l1_address"
3119
+ ]
3120
+ },
3121
+ "value": {
3122
+ "type": "string"
3123
+ }
3124
+ },
3125
+ "title": "ReqGetByAccount"
3126
+ },
3127
+ "ReqGetCandlesticks": {
3128
+ "type": "object",
3129
+ "properties": {
3130
+ "market_id": {
3131
+ "type": "integer",
3132
+ "format": "uin16"
3133
+ },
3134
+ "resolution": {
3135
+ "type": "string",
3136
+ "enum": [
3137
+ "1m",
3138
+ "5m",
3139
+ "15m",
3140
+ "1h",
3141
+ "4h",
3142
+ "1d"
3143
+ ]
3144
+ },
3145
+ "start_timestamp": {
3146
+ "type": "integer",
3147
+ "format": "int64"
3148
+ },
3149
+ "end_timestamp": {
3150
+ "type": "integer",
3151
+ "format": "int64"
3152
+ },
3153
+ "count_back": {
3154
+ "type": "integer",
3155
+ "format": "int64"
3156
+ }
3157
+ },
3158
+ "title": "ReqGetCandlesticks"
3159
+ },
3160
+ "ReqGetExchangeStats": {
3161
+ "type": "object",
3162
+ "title": "ReqGetExchangeStats"
3163
+ },
3164
+ "ReqGetFundings": {
3165
+ "type": "object",
3166
+ "properties": {
3167
+ "market_id": {
3168
+ "type": "integer",
3169
+ "format": "uin16"
3170
+ },
3171
+ "resolution": {
3172
+ "type": "string",
3173
+ "enum": [
3174
+ "1h"
3175
+ ]
3176
+ },
3177
+ "start_timestamp": {
3178
+ "type": "integer",
3179
+ "format": "int64"
3180
+ },
3181
+ "end_timestamp": {
3182
+ "type": "integer",
3183
+ "format": "int64"
3184
+ },
3185
+ "count_back": {
3186
+ "type": "integer",
3187
+ "format": "int64"
3188
+ }
3189
+ },
3190
+ "title": "ReqGetFundings"
3191
+ },
3192
+ "ReqGetL1Tx": {
3193
+ "type": "object",
3194
+ "properties": {
3195
+ "hash": {
3196
+ "type": "string"
3197
+ }
3198
+ },
3199
+ "title": "ReqGetL1Tx"
3200
+ },
3201
+ "ReqGetMarketSig": {
3202
+ "type": "object",
3203
+ "properties": {
3204
+ "market_id": {
3205
+ "type": "integer",
3206
+ "format": "uin16"
3207
+ },
3208
+ "is_ask": {
3209
+ "type": "boolean",
3210
+ "format": "boolean"
3211
+ },
3212
+ "base_amount": {
3213
+ "type": "integer",
3214
+ "format": "int64"
3215
+ }
3216
+ },
3217
+ "title": "ReqGetMarketSig"
3218
+ },
3219
+ "ReqGetNextNonce": {
3220
+ "type": "object",
3221
+ "properties": {
3222
+ "account_index": {
3223
+ "type": "integer",
3224
+ "format": "int32"
3225
+ },
3226
+ "sub_account_index": {
3227
+ "type": "integer",
3228
+ "format": "uint8"
3229
+ }
3230
+ },
3231
+ "title": "ReqGetNextNonce"
3232
+ },
3233
+ "ReqGetOrderBookDetails": {
3234
+ "type": "object",
3235
+ "properties": {
3236
+ "filter": {
3237
+ "type": "string",
3238
+ "enum": [
3239
+ "market_id",
3240
+ "all"
3241
+ ]
3242
+ },
3243
+ "market_id": {
3244
+ "type": "integer",
3245
+ "format": "uin16"
3246
+ }
3247
+ },
3248
+ "title": "ReqGetOrderBookDetails"
3249
+ },
3250
+ "ReqGetOrderBookOrders": {
3251
+ "type": "object",
3252
+ "properties": {
3253
+ "market_id": {
3254
+ "type": "integer",
3255
+ "format": "uin16"
3256
+ },
3257
+ "limit": {
3258
+ "type": "integer",
3259
+ "format": "int64",
3260
+ "maximum": 100,
3261
+ "minimum": 1
3262
+ }
3263
+ },
3264
+ "title": "ReqGetOrderBookOrders"
3265
+ },
3266
+ "ReqGetOrderBooks": {
3267
+ "type": "object",
3268
+ "properties": {
3269
+ "filter": {
3270
+ "type": "string",
3271
+ "enum": [
3272
+ "market_id",
3273
+ "all"
3274
+ ]
3275
+ },
3276
+ "market_id": {
3277
+ "type": "integer",
3278
+ "format": "uin16"
3279
+ }
3280
+ },
3281
+ "title": "ReqGetOrderBooks"
3282
+ },
3283
+ "ReqGetPermission": {
3284
+ "type": "object",
3285
+ "properties": {
3286
+ "by": {
3287
+ "type": "string",
3288
+ "enum": [
3289
+ "index",
3290
+ "l1_address"
3291
+ ]
3292
+ },
3293
+ "value": {
3294
+ "type": "string"
3295
+ },
3296
+ "tx_type": {
3297
+ "type": "integer",
3298
+ "format": "uint8"
3299
+ }
3300
+ },
3301
+ "title": "ReqGetPermission"
3302
+ },
3303
+ "ReqGetRangeWithCursor": {
3304
+ "type": "object",
3305
+ "properties": {
3306
+ "cursor": {
3307
+ "type": "string"
3308
+ },
3309
+ "limit": {
3310
+ "type": "integer",
3311
+ "format": "int64",
3312
+ "maximum": 100,
3313
+ "minimum": 1
3314
+ }
3315
+ },
3316
+ "title": "ReqGetRangeWithCursor"
3317
+ },
3318
+ "ReqGetRangeWithIndex": {
3319
+ "type": "object",
3320
+ "properties": {
3321
+ "index": {
3322
+ "type": "integer",
3323
+ "format": "int64"
3324
+ },
3325
+ "limit": {
3326
+ "type": "integer",
3327
+ "format": "int64",
3328
+ "maximum": 100,
3329
+ "minimum": 1
3330
+ }
3331
+ },
3332
+ "title": "ReqGetRangeWithIndex"
3333
+ },
3334
+ "ReqGetRangeWithIndexSortable": {
3335
+ "type": "object",
3336
+ "properties": {
3337
+ "index": {
3338
+ "type": "integer",
3339
+ "format": "int64"
3340
+ },
3341
+ "limit": {
3342
+ "type": "integer",
3343
+ "format": "int64",
3344
+ "maximum": 100,
3345
+ "minimum": 1
3346
+ },
3347
+ "sort": {
3348
+ "type": "string",
3349
+ "enum": [
3350
+ "asc",
3351
+ "desc"
3352
+ ],
3353
+ "default": "asc"
3354
+ }
3355
+ },
3356
+ "title": "ReqGetRangeWithIndexSortable"
3357
+ },
3358
+ "ReqGetRecentTrades": {
3359
+ "type": "object",
3360
+ "properties": {
3361
+ "market_id": {
3362
+ "type": "integer",
3363
+ "format": "uin16"
3364
+ },
3365
+ "limit": {
3366
+ "type": "integer",
3367
+ "format": "int64",
3368
+ "maximum": 100,
3369
+ "minimum": 1
3370
+ }
3371
+ },
3372
+ "title": "ReqGetRecentTrades"
3373
+ },
3374
+ "ReqGetRollbacks": {
3375
+ "type": "object",
3376
+ "properties": {
3377
+ "from_block_height": {
3378
+ "type": "integer",
3379
+ "format": "int64"
3380
+ },
3381
+ "offset": {
3382
+ "type": "integer",
3383
+ "format": "int32",
3384
+ "maximum": 100000
3385
+ },
3386
+ "limit": {
3387
+ "type": "integer",
3388
+ "format": "int64",
3389
+ "maximum": 100,
3390
+ "minimum": 1
3391
+ }
3392
+ },
3393
+ "title": "ReqGetRollbacks"
3394
+ },
3395
+ "ReqGetSubAccount": {
3396
+ "type": "object",
3397
+ "properties": {
3398
+ "by": {
3399
+ "type": "string",
3400
+ "enum": [
3401
+ "index",
3402
+ "l1_address"
3403
+ ]
3404
+ },
3405
+ "value": {
3406
+ "type": "string"
3407
+ },
3408
+ "sub_account_index": {
3409
+ "type": "integer",
3410
+ "format": "uint8",
3411
+ "default": "255",
3412
+ "description": " NilSubAccountIndex"
3413
+ }
3414
+ },
3415
+ "title": "ReqGetSubAccount"
3416
+ },
3417
+ "ReqGetTrades": {
3418
+ "type": "object",
3419
+ "properties": {
3420
+ "market_id": {
3421
+ "type": "integer",
3422
+ "format": "uin16"
3423
+ },
3424
+ "order_index": {
3425
+ "type": "integer",
3426
+ "format": "int64"
3427
+ },
3428
+ "by": {
3429
+ "type": "string",
3430
+ "enum": [
3431
+ "block_height",
3432
+ "timestamp",
3433
+ "trade_id"
3434
+ ]
3435
+ },
3436
+ "from": {
3437
+ "type": "integer",
3438
+ "format": "int64"
3439
+ },
3440
+ "limit": {
3441
+ "type": "integer",
3442
+ "format": "int64",
3443
+ "maximum": 100,
3444
+ "minimum": 1
3445
+ }
3446
+ },
3447
+ "title": "ReqGetTrades"
3448
+ },
3449
+ "ReqGetTx": {
3450
+ "type": "object",
3451
+ "properties": {
3452
+ "by": {
3453
+ "type": "string",
3454
+ "enum": [
3455
+ "hash",
3456
+ "sequence_index"
3457
+ ]
3458
+ },
3459
+ "value": {
3460
+ "type": "string"
3461
+ }
3462
+ },
3463
+ "title": "ReqGetTx"
3464
+ },
3465
+ "ReqSearch": {
3466
+ "type": "object",
3467
+ "properties": {
3468
+ "keyword": {
3469
+ "type": "string"
3470
+ }
3471
+ },
3472
+ "title": "ReqSearch"
3473
+ },
3474
+ "ReqSendTx": {
3475
+ "type": "object",
3476
+ "properties": {
3477
+ "tx_type": {
3478
+ "type": "integer",
3479
+ "format": "uint8"
3480
+ },
3481
+ "tx_info": {
3482
+ "type": "string"
3483
+ }
3484
+ },
3485
+ "title": "ReqSendTx"
3486
+ },
3487
+ "ResultCode": {
3488
+ "type": "object",
3489
+ "properties": {
3490
+ "code": {
3491
+ "type": "integer",
3492
+ "format": "int32",
3493
+ "example": "100"
3494
+ },
3495
+ "message": {
3496
+ "type": "string"
3497
+ }
3498
+ },
3499
+ "title": "ResultCode"
3500
+ },
3501
+ "Rollback": {
3502
+ "type": "object",
3503
+ "properties": {
3504
+ "from_block_height": {
3505
+ "type": "integer",
3506
+ "format": "int64",
3507
+ "example": "45434"
3508
+ },
3509
+ "from_tx_hash": {
3510
+ "type": "string",
3511
+ "example": "0x70997970C51812dc3A010C7d01b50e0d17dc79C8"
3512
+ },
3513
+ "id": {
3514
+ "type": "integer",
3515
+ "format": "uint32",
3516
+ "example": "1"
3517
+ },
3518
+ "created_at": {
3519
+ "type": "integer",
3520
+ "format": "int64",
3521
+ "example": "1640995200"
3522
+ }
3523
+ },
3524
+ "title": "Rollback"
3525
+ },
3526
+ "Rollbacks": {
3527
+ "type": "object",
3528
+ "properties": {
3529
+ "code": {
3530
+ "type": "integer",
3531
+ "format": "int32",
3532
+ "example": "100"
3533
+ },
3534
+ "message": {
3535
+ "type": "string"
3536
+ },
3537
+ "total": {
3538
+ "type": "integer",
3539
+ "format": "int64",
3540
+ "example": "1"
3541
+ },
3542
+ "rollbacks": {
3543
+ "type": "array",
3544
+ "items": {
3545
+ "$ref": "#/definitions/Rollback"
3546
+ }
3547
+ }
3548
+ },
3549
+ "title": "Rollbacks"
3550
+ },
3551
+ "Search": {
3552
+ "type": "object",
3553
+ "properties": {
3554
+ "code": {
3555
+ "type": "integer",
3556
+ "format": "int32",
3557
+ "example": "100"
3558
+ },
3559
+ "message": {
3560
+ "type": "string"
3561
+ },
3562
+ "data_type": {
3563
+ "type": "integer",
3564
+ "format": "int32",
3565
+ "example": "1"
3566
+ }
3567
+ },
3568
+ "title": "Search"
3569
+ },
3570
+ "SignBody": {
3571
+ "type": "object",
3572
+ "properties": {
3573
+ "code": {
3574
+ "type": "integer",
3575
+ "format": "int32",
3576
+ "example": "100"
3577
+ },
3578
+ "message": {
3579
+ "type": "string"
3580
+ },
3581
+ "sign_body": {
3582
+ "type": "string",
3583
+ "example": "success"
3584
+ }
3585
+ },
3586
+ "title": "SignBody"
3587
+ },
3588
+ "SimpleOrder": {
3589
+ "type": "object",
3590
+ "properties": {
3591
+ "owner_account_index": {
3592
+ "type": "integer",
3593
+ "format": "int32",
3594
+ "example": "1"
3595
+ },
3596
+ "owner_sub_account_index": {
3597
+ "type": "integer",
3598
+ "format": "uint8",
3599
+ "example": "1"
3600
+ },
3601
+ "initial_base_amount": {
3602
+ "type": "string",
3603
+ "example": "0.1"
3604
+ },
3605
+ "remaining_base_amount": {
3606
+ "type": "string",
3607
+ "example": "0.1"
3608
+ },
3609
+ "price": {
3610
+ "type": "string",
3611
+ "example": "3024.66"
3612
+ },
3613
+ "nonce": {
3614
+ "type": "integer",
3615
+ "format": "int64",
3616
+ "example": "234"
3617
+ }
3618
+ },
3619
+ "title": "SimpleOrder"
3620
+ },
3621
+ "Status": {
3622
+ "type": "object",
3623
+ "properties": {
3624
+ "status": {
3625
+ "type": "integer",
3626
+ "format": "int32",
3627
+ "example": "1"
3628
+ },
3629
+ "network_id": {
3630
+ "type": "integer",
3631
+ "format": "int32",
3632
+ "example": "1"
3633
+ }
3634
+ },
3635
+ "title": "Status"
3636
+ },
3637
+ "SubAccount": {
3638
+ "type": "object",
3639
+ "properties": {
3640
+ "index": {
3641
+ "type": "integer",
3642
+ "format": "int32",
3643
+ "example": "1"
3644
+ },
3645
+ "sub_account_index": {
3646
+ "type": "integer",
3647
+ "format": "uint8",
3648
+ "example": "1"
3649
+ },
3650
+ "l1_address": {
3651
+ "type": "string",
3652
+ "example": "0x70997970C51812dc3A010C7d01b50e0d17dc79C8"
3653
+ },
3654
+ "pk": {
3655
+ "type": "string",
3656
+ "example": "3ac126b0a0a3cc8cb367ef67a5c77389a85e08e20ce8da3edf34d022e9bf1ab8"
3657
+ },
3658
+ "nonce": {
3659
+ "type": "integer",
3660
+ "format": "int64",
3661
+ "example": "722"
3662
+ },
3663
+ "status": {
3664
+ "type": "integer",
3665
+ "format": "uint8",
3666
+ "example": "1"
3667
+ },
3668
+ "collateral": {
3669
+ "type": "string",
3670
+ "example": "46342"
3671
+ },
3672
+ "collateral_type": {
3673
+ "type": "integer",
3674
+ "format": "uint8",
3675
+ "example": "1"
3676
+ }
3677
+ },
3678
+ "title": "SubAccount"
3679
+ },
3680
+ "SubAccounts": {
3681
+ "type": "object",
3682
+ "properties": {
3683
+ "code": {
3684
+ "type": "integer",
3685
+ "format": "int32",
3686
+ "example": "100"
3687
+ },
3688
+ "message": {
3689
+ "type": "string"
3690
+ },
3691
+ "index": {
3692
+ "type": "integer",
3693
+ "format": "int32",
3694
+ "example": "1"
3695
+ },
3696
+ "l1_address": {
3697
+ "type": "string",
3698
+ "example": "0x70997970C51812dc3A010C7d01b50e0d17dc79C8"
3699
+ },
3700
+ "status": {
3701
+ "type": "integer",
3702
+ "format": "uint8",
3703
+ "example": "1"
3704
+ },
3705
+ "sub_accounts": {
3706
+ "type": "array",
3707
+ "example": "1",
3708
+ "items": {
3709
+ "$ref": "#/definitions/SubAccount"
3710
+ }
3711
+ }
3712
+ },
3713
+ "title": "SubAccounts"
3714
+ },
3715
+ "Trade": {
3716
+ "type": "object",
3717
+ "properties": {
3718
+ "trade_id": {
3719
+ "type": "integer",
3720
+ "format": "int64",
3721
+ "example": "145"
3722
+ },
3723
+ "tx_hash": {
3724
+ "type": "string",
3725
+ "example": "0x70997970C51812dc3A010C7d01b50e0d17dc79C8"
3726
+ },
3727
+ "market_id": {
3728
+ "type": "integer",
3729
+ "format": "uin16",
3730
+ "example": "1"
3731
+ },
3732
+ "size": {
3733
+ "type": "string",
3734
+ "example": "0.1"
3735
+ },
3736
+ "price": {
3737
+ "type": "string",
3738
+ "example": "3024.66"
3739
+ },
3740
+ "ask_id": {
3741
+ "type": "integer",
3742
+ "format": "int64",
3743
+ "example": "145"
3744
+ },
3745
+ "bid_id": {
3746
+ "type": "integer",
3747
+ "format": "int64",
3748
+ "example": "245"
3749
+ },
3750
+ "maker_account_id": {
3751
+ "type": "integer",
3752
+ "format": "int64",
3753
+ "example": "1"
3754
+ },
3755
+ "taker_account_id": {
3756
+ "type": "integer",
3757
+ "format": "int64",
3758
+ "example": "3"
3759
+ },
3760
+ "is_maker_ask": {
3761
+ "type": "boolean",
3762
+ "format": "boolean",
3763
+ "example": "true"
3764
+ },
3765
+ "block_height": {
3766
+ "type": "integer",
3767
+ "format": "int64",
3768
+ "example": "45434"
3769
+ },
3770
+ "timestamp": {
3771
+ "type": "integer",
3772
+ "format": "int64",
3773
+ "example": "1640995200"
3774
+ }
3775
+ },
3776
+ "title": "Trade"
3777
+ },
3778
+ "Trades": {
3779
+ "type": "object",
3780
+ "properties": {
3781
+ "code": {
3782
+ "type": "integer",
3783
+ "format": "int32",
3784
+ "example": "100"
3785
+ },
3786
+ "message": {
3787
+ "type": "string"
3788
+ },
3789
+ "trades": {
3790
+ "type": "array",
3791
+ "items": {
3792
+ "$ref": "#/definitions/Trade"
3793
+ }
3794
+ }
3795
+ },
3796
+ "title": "Trades"
3797
+ },
3798
+ "Tx": {
3799
+ "type": "object",
3800
+ "properties": {
3801
+ "hash": {
3802
+ "type": "string",
3803
+ "example": "0x70997970C51812dc3A010C7d01b50e0d17dc79C8"
3804
+ },
3805
+ "type": {
3806
+ "type": "integer",
3807
+ "format": "uint8",
3808
+ "example": "1",
3809
+ "maximum": 64,
3810
+ "minimum": 1
3811
+ },
3812
+ "info": {
3813
+ "type": "string",
3814
+ "example": "{}"
3815
+ },
3816
+ "event_info": {
3817
+ "type": "string",
3818
+ "example": "{}"
3819
+ },
3820
+ "status": {
3821
+ "type": "integer",
3822
+ "format": "int64",
3823
+ "example": "1"
3824
+ },
3825
+ "transaction_index": {
3826
+ "type": "integer",
3827
+ "format": "int64",
3828
+ "example": "8761"
3829
+ },
3830
+ "l1_address": {
3831
+ "type": "string",
3832
+ "example": "0x70997970C51812dc3A010C7d01b50e0d17dc79C8"
3833
+ },
3834
+ "account_index": {
3835
+ "type": "integer",
3836
+ "format": "int32",
3837
+ "example": "1"
3838
+ },
3839
+ "nonce": {
3840
+ "type": "integer",
3841
+ "format": "int64",
3842
+ "example": "722"
3843
+ },
3844
+ "expire_at": {
3845
+ "type": "integer",
3846
+ "format": "int64",
3847
+ "example": "1640995200"
3848
+ },
3849
+ "block_height": {
3850
+ "type": "integer",
3851
+ "format": "int64",
3852
+ "example": "45434"
3853
+ },
3854
+ "created_at": {
3855
+ "type": "integer",
3856
+ "format": "int64",
3857
+ "example": "1640995200"
3858
+ },
3859
+ "verify_at": {
3860
+ "type": "integer",
3861
+ "format": "int64",
3862
+ "example": "1640995200"
3863
+ },
3864
+ "sequence_index": {
3865
+ "type": "integer",
3866
+ "format": "int64",
3867
+ "example": "8761"
3868
+ }
3869
+ },
3870
+ "title": "Tx"
3871
+ },
3872
+ "TxHash": {
3873
+ "type": "object",
3874
+ "properties": {
3875
+ "code": {
3876
+ "type": "integer",
3877
+ "format": "int32",
3878
+ "example": "100"
3879
+ },
3880
+ "message": {
3881
+ "type": "string"
3882
+ },
3883
+ "tx_hash": {
3884
+ "type": "string",
3885
+ "example": "0x70997970C51812dc3A010C7d01b50e0d17dc79C8"
3886
+ }
3887
+ },
3888
+ "title": "TxHash"
3889
+ },
3890
+ "Txs": {
3891
+ "type": "object",
3892
+ "properties": {
3893
+ "code": {
3894
+ "type": "integer",
3895
+ "format": "int32",
3896
+ "example": "100"
3897
+ },
3898
+ "message": {
3899
+ "type": "string"
3900
+ },
3901
+ "txs": {
3902
+ "type": "array",
3903
+ "items": {
3904
+ "$ref": "#/definitions/Tx"
3905
+ }
3906
+ }
3907
+ },
3908
+ "title": "Txs"
3909
+ },
3910
+ "ValidatorInfo": {
3911
+ "type": "object",
3912
+ "properties": {
3913
+ "address": {
3914
+ "type": "string",
3915
+ "example": "0x70997970C51812dc3A010C7d01b50e0d17dc79C8"
3916
+ },
3917
+ "is_active": {
3918
+ "type": "boolean",
3919
+ "format": "boolean",
3920
+ "example": "true"
3921
+ }
3922
+ },
3923
+ "title": "ValidatorInfo"
3924
+ }
3925
+ },
3926
+ "securityDefinitions": {
3927
+ "apiKey": {
3928
+ "type": "apiKey",
3929
+ "description": "Enter JWT Bearer token **_only_**",
3930
+ "name": "Authorization",
3931
+ "in": "header"
3932
+ }
3933
+ }
3934
+ }