@n1xyz/nord-ts 0.1.7 → 0.1.8

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 (84) hide show
  1. package/dist/actions.js +39 -82
  2. package/dist/bundle.js +79181 -0
  3. package/dist/client/Nord.d.ts +2 -2
  4. package/dist/client/Nord.js +46 -78
  5. package/dist/client/NordAdmin.d.ts +2 -2
  6. package/dist/client/NordAdmin.js +57 -89
  7. package/dist/client/NordUser.js +118 -147
  8. package/dist/const.js +5 -8
  9. package/dist/error.js +7 -5
  10. package/dist/gen/nord_pb.js +88 -92
  11. package/dist/gen/openapi.d.ts +5 -6
  12. package/dist/gen/openapi.js +1 -2
  13. package/dist/index.js +10 -49
  14. package/dist/types.d.ts +1 -0
  15. package/dist/types.js +21 -60
  16. package/dist/utils.js +38 -86
  17. package/dist/websocket/NordWebSocketClient.js +12 -17
  18. package/dist/websocket/Subscriber.js +6 -7
  19. package/dist/websocket/events.js +1 -2
  20. package/dist/websocket/index.js +10 -15
  21. package/package.json +2 -3
  22. package/dist/api/client.d.ts +0 -14
  23. package/dist/api/client.js +0 -45
  24. package/dist/bridge/client.d.ts +0 -151
  25. package/dist/bridge/client.js +0 -434
  26. package/dist/bridge/const.d.ts +0 -23
  27. package/dist/bridge/const.js +0 -47
  28. package/dist/bridge/index.d.ts +0 -4
  29. package/dist/bridge/index.js +0 -23
  30. package/dist/bridge/types.d.ts +0 -120
  31. package/dist/bridge/types.js +0 -18
  32. package/dist/bridge/utils.d.ts +0 -64
  33. package/dist/bridge/utils.js +0 -131
  34. package/dist/gen/common.d.ts +0 -68
  35. package/dist/gen/common.js +0 -215
  36. package/dist/gen/nord.d.ts +0 -882
  37. package/dist/gen/nord.js +0 -6520
  38. package/dist/idl/bridge.d.ts +0 -569
  39. package/dist/idl/bridge.js +0 -8
  40. package/dist/idl/bridge.json +0 -1506
  41. package/dist/idl/index.d.ts +0 -607
  42. package/dist/idl/index.js +0 -8
  43. package/dist/nord/api/actions.d.ts +0 -126
  44. package/dist/nord/api/actions.js +0 -397
  45. package/dist/nord/api/core.d.ts +0 -16
  46. package/dist/nord/api/core.js +0 -81
  47. package/dist/nord/api/market.d.ts +0 -36
  48. package/dist/nord/api/market.js +0 -96
  49. package/dist/nord/api/metrics.d.ts +0 -67
  50. package/dist/nord/api/metrics.js +0 -229
  51. package/dist/nord/api/queries.d.ts +0 -46
  52. package/dist/nord/api/queries.js +0 -109
  53. package/dist/nord/api/triggers.d.ts +0 -7
  54. package/dist/nord/api/triggers.js +0 -38
  55. package/dist/nord/client/Nord.d.ts +0 -396
  56. package/dist/nord/client/Nord.js +0 -747
  57. package/dist/nord/client/NordAdmin.d.ts +0 -259
  58. package/dist/nord/client/NordAdmin.js +0 -395
  59. package/dist/nord/client/NordClient.d.ts +0 -33
  60. package/dist/nord/client/NordClient.js +0 -45
  61. package/dist/nord/client/NordUser.d.ts +0 -362
  62. package/dist/nord/client/NordUser.js +0 -781
  63. package/dist/nord/index.d.ts +0 -11
  64. package/dist/nord/index.js +0 -36
  65. package/dist/nord/models/Subscriber.d.ts +0 -37
  66. package/dist/nord/models/Subscriber.js +0 -25
  67. package/dist/nord/utils/NordError.d.ts +0 -35
  68. package/dist/nord/utils/NordError.js +0 -49
  69. package/src/actions.ts +0 -333
  70. package/src/client/Nord.ts +0 -934
  71. package/src/client/NordAdmin.ts +0 -484
  72. package/src/client/NordUser.ts +0 -1122
  73. package/src/const.ts +0 -34
  74. package/src/error.ts +0 -76
  75. package/src/gen/.gitkeep +0 -0
  76. package/src/gen/nord_pb.ts +0 -5053
  77. package/src/gen/openapi.ts +0 -2904
  78. package/src/index.ts +0 -11
  79. package/src/types.ts +0 -327
  80. package/src/utils.ts +0 -266
  81. package/src/websocket/NordWebSocketClient.ts +0 -316
  82. package/src/websocket/Subscriber.ts +0 -56
  83. package/src/websocket/events.ts +0 -31
  84. package/src/websocket/index.ts +0 -105
@@ -1,2904 +0,0 @@
1
- /**
2
- * This file was auto-generated by openapi-typescript.
3
- * Do not make direct changes to the file.
4
- */
5
-
6
- export interface paths {
7
- "/openapi.json": {
8
- parameters: {
9
- query?: never;
10
- header?: never;
11
- path?: never;
12
- cookie?: never;
13
- };
14
- get: {
15
- parameters: {
16
- query?: never;
17
- header?: never;
18
- path?: never;
19
- cookie?: never;
20
- };
21
- requestBody?: never;
22
- responses: {
23
- 200: {
24
- headers: {
25
- [name: string]: unknown;
26
- };
27
- content: {
28
- "application/json": components["schemas"]["OpenApi"];
29
- };
30
- };
31
- };
32
- };
33
- put?: never;
34
- post?: never;
35
- delete?: never;
36
- options?: never;
37
- head?: never;
38
- patch?: never;
39
- trace?: never;
40
- };
41
- "/info": {
42
- parameters: {
43
- query?: never;
44
- header?: never;
45
- path?: never;
46
- cookie?: never;
47
- };
48
- /** @description List of markets and tokens. */
49
- get: {
50
- parameters: {
51
- query?: never;
52
- header?: never;
53
- path?: never;
54
- cookie?: never;
55
- };
56
- requestBody?: never;
57
- responses: {
58
- 200: {
59
- headers: {
60
- [name: string]: unknown;
61
- };
62
- content: {
63
- "application/json": components["schemas"]["MarketsInfo"];
64
- };
65
- };
66
- };
67
- };
68
- put?: never;
69
- post?: never;
70
- delete?: never;
71
- options?: never;
72
- head?: never;
73
- patch?: never;
74
- trace?: never;
75
- };
76
- "/action": {
77
- parameters: {
78
- query?: never;
79
- header?: never;
80
- path?: never;
81
- cookie?: never;
82
- };
83
- /** @description Query for past executed actions. */
84
- get: {
85
- parameters: {
86
- query: {
87
- /** @description Start action ID (exclusive) */
88
- from: number;
89
- /** @description End action ID (inclusive) */
90
- to: number;
91
- /** @description Optionally provided binary version of client, so nord server can ensure all actions provided are executable by client. */
92
- clientVersion?: components["schemas"]["ExecutableVersion"] | null;
93
- };
94
- header?: never;
95
- path?: never;
96
- cookie?: never;
97
- };
98
- requestBody?: never;
99
- responses: {
100
- 200: {
101
- headers: {
102
- [name: string]: unknown;
103
- };
104
- content: {
105
- "application/json": components["schemas"]["ActionsItem"][];
106
- };
107
- };
108
- 400: {
109
- headers: {
110
- [name: string]: unknown;
111
- };
112
- content: {
113
- "application/json": components["schemas"]["RangeTooLarge"];
114
- };
115
- };
116
- 501: {
117
- headers: {
118
- [name: string]: unknown;
119
- };
120
- content: {
121
- "application/json": components["schemas"]["NotImplemented"];
122
- };
123
- };
124
- };
125
- };
126
- put?: never;
127
- /** @description Send an action to nord to execute. This doesn't use `Protobuf<T>` since we want to length-delimit this message. `body` - (length prefix of action, action data protobuf, and signature). signature has exact length, but depend on action kind. body is exact payload used via other transports and journalled for rexecution */
128
- post: {
129
- parameters: {
130
- query?: never;
131
- header: {
132
- "content-type": string;
133
- };
134
- path?: never;
135
- cookie?: never;
136
- };
137
- requestBody: {
138
- content: {
139
- "application/octet-stream": unknown;
140
- };
141
- };
142
- responses: {
143
- /** @description byte stream */
144
- 200: {
145
- headers: {
146
- [name: string]: unknown;
147
- };
148
- content: {
149
- "application/octet-stream": unknown;
150
- };
151
- };
152
- 413: {
153
- headers: {
154
- [name: string]: unknown;
155
- };
156
- content: {
157
- "application/json": components["schemas"]["PayloadTooLarge"];
158
- };
159
- };
160
- 415: {
161
- headers: {
162
- /**
163
- * @description Expected request media type
164
- * @example application/octet-stream
165
- */
166
- accept: string;
167
- [name: string]: unknown;
168
- };
169
- content: {
170
- "application/json": components["schemas"]["AcceptedMediaType"];
171
- };
172
- };
173
- };
174
- };
175
- delete?: never;
176
- options?: never;
177
- head?: never;
178
- patch?: never;
179
- trace?: never;
180
- };
181
- "/action/last-executed-id": {
182
- parameters: {
183
- query?: never;
184
- header?: never;
185
- path?: never;
186
- cookie?: never;
187
- };
188
- /** @description Query for the last executed action id. */
189
- get: {
190
- parameters: {
191
- query?: never;
192
- header?: never;
193
- path?: never;
194
- cookie?: never;
195
- };
196
- requestBody?: never;
197
- responses: {
198
- 200: {
199
- headers: {
200
- [name: string]: unknown;
201
- };
202
- content: {
203
- "application/json": number;
204
- };
205
- };
206
- 404: {
207
- headers: {
208
- [name: string]: unknown;
209
- };
210
- content: {
211
- "application/json": components["schemas"]["ActionNotFound"];
212
- };
213
- };
214
- };
215
- };
216
- put?: never;
217
- post?: never;
218
- delete?: never;
219
- options?: never;
220
- head?: never;
221
- patch?: never;
222
- trace?: never;
223
- };
224
- "/timestamp": {
225
- parameters: {
226
- query?: never;
227
- header?: never;
228
- path?: never;
229
- cookie?: never;
230
- };
231
- /** @description Query for the current logical timestamp of the engine. */
232
- get: {
233
- parameters: {
234
- query?: never;
235
- header?: never;
236
- path?: never;
237
- cookie?: never;
238
- };
239
- requestBody?: never;
240
- responses: {
241
- 200: {
242
- headers: {
243
- [name: string]: unknown;
244
- };
245
- content: {
246
- "application/json": number;
247
- };
248
- };
249
- };
250
- };
251
- put?: never;
252
- post?: never;
253
- delete?: never;
254
- options?: never;
255
- head?: never;
256
- patch?: never;
257
- trace?: never;
258
- };
259
- "/event/last-acked-nonce": {
260
- parameters: {
261
- query?: never;
262
- header?: never;
263
- path?: never;
264
- cookie?: never;
265
- };
266
- /** @description The last acknowledged event nonce. Use this to ascertain if a given withdrawal was processed by nord. */
267
- get: {
268
- parameters: {
269
- query?: never;
270
- header?: never;
271
- path?: never;
272
- cookie?: never;
273
- };
274
- requestBody?: never;
275
- responses: {
276
- 200: {
277
- headers: {
278
- [name: string]: unknown;
279
- };
280
- content: {
281
- "application/json": number;
282
- };
283
- };
284
- };
285
- };
286
- put?: never;
287
- post?: never;
288
- delete?: never;
289
- options?: never;
290
- head?: never;
291
- patch?: never;
292
- trace?: never;
293
- };
294
- "/ws/{streams}": {
295
- parameters: {
296
- query?: never;
297
- header?: never;
298
- path?: never;
299
- cookie?: never;
300
- };
301
- /** @description Websocket subscription to `streams`. */
302
- get: {
303
- parameters: {
304
- query?: never;
305
- header?: never;
306
- path: {
307
- /** @description where `streams` is `trades@{symbol} | deltas@{symbol} | account@{account id} [&, ...]` e.g. `/ws/trades@BTCUSDC&deltas@BTCUSDC&account@42` */
308
- streams: string;
309
- };
310
- cookie?: never;
311
- };
312
- requestBody?: never;
313
- responses: {
314
- /** @description websocket upgrade */
315
- 101: {
316
- headers: {
317
- connection?: "upgrade";
318
- upgrade?: "websocket";
319
- "sec-websocket-key"?: string;
320
- "sec-websocket-protocol"?: string;
321
- [name: string]: unknown;
322
- };
323
- content?: never;
324
- };
325
- };
326
- };
327
- put?: never;
328
- post?: never;
329
- delete?: never;
330
- options?: never;
331
- head?: never;
332
- patch?: never;
333
- trace?: never;
334
- };
335
- "/market/{market_id}/fees/{fee_kind}/{account_id}": {
336
- parameters: {
337
- query?: never;
338
- header?: never;
339
- path?: never;
340
- cookie?: never;
341
- };
342
- /** @description Returns value. If negative, fee is charged from account. */
343
- get: {
344
- parameters: {
345
- query?: never;
346
- header?: never;
347
- path: {
348
- market_id: number;
349
- fee_kind: components["schemas"]["FillRole"];
350
- /** @description Account for which evaluate fee for. */
351
- account_id: number;
352
- };
353
- cookie?: never;
354
- };
355
- requestBody?: never;
356
- responses: {
357
- 200: {
358
- headers: {
359
- [name: string]: unknown;
360
- };
361
- content: {
362
- "application/json": number;
363
- };
364
- };
365
- 404: {
366
- headers: {
367
- [name: string]: unknown;
368
- };
369
- content: {
370
- "application/json": components["schemas"]["UserNotFound"];
371
- };
372
- };
373
- };
374
- };
375
- put?: never;
376
- post?: never;
377
- delete?: never;
378
- options?: never;
379
- head?: never;
380
- patch?: never;
381
- trace?: never;
382
- };
383
- "/market/{market_id}/orderbook": {
384
- parameters: {
385
- query?: never;
386
- header?: never;
387
- path?: never;
388
- cookie?: never;
389
- };
390
- /** @description Get the orderbook for a given market. */
391
- get: {
392
- parameters: {
393
- query?: never;
394
- header?: never;
395
- path: {
396
- market_id: number;
397
- };
398
- cookie?: never;
399
- };
400
- requestBody?: never;
401
- responses: {
402
- 200: {
403
- headers: {
404
- [name: string]: unknown;
405
- };
406
- content: {
407
- "application/json": components["schemas"]["OrderbookInfo"];
408
- };
409
- };
410
- 404: {
411
- headers: {
412
- [name: string]: unknown;
413
- };
414
- content: {
415
- "application/json": components["schemas"]["MarketNotFound"];
416
- };
417
- };
418
- };
419
- };
420
- put?: never;
421
- post?: never;
422
- delete?: never;
423
- options?: never;
424
- head?: never;
425
- patch?: never;
426
- trace?: never;
427
- };
428
- "/market/{market_id}/stats": {
429
- parameters: {
430
- query?: never;
431
- header?: never;
432
- path?: never;
433
- cookie?: never;
434
- };
435
- /** @description Returns stats for a given market, such as open interest, volume, index price, etc. This is for dynamic data, as opposed to /info which is static. */
436
- get: {
437
- parameters: {
438
- query?: never;
439
- header?: never;
440
- path: {
441
- market_id: number;
442
- };
443
- cookie?: never;
444
- };
445
- requestBody?: never;
446
- responses: {
447
- 200: {
448
- headers: {
449
- [name: string]: unknown;
450
- };
451
- content: {
452
- "application/json": components["schemas"]["MarketStats"];
453
- };
454
- };
455
- 404: {
456
- headers: {
457
- [name: string]: unknown;
458
- };
459
- content: {
460
- "application/json": components["schemas"]["MarketNotFound"];
461
- };
462
- };
463
- };
464
- };
465
- put?: never;
466
- post?: never;
467
- delete?: never;
468
- options?: never;
469
- head?: never;
470
- patch?: never;
471
- trace?: never;
472
- };
473
- "/tokens/{token_id}/stats": {
474
- parameters: {
475
- query?: never;
476
- header?: never;
477
- path?: never;
478
- cookie?: never;
479
- };
480
- /** @description Get the price of a given token. */
481
- get: {
482
- parameters: {
483
- query?: never;
484
- header?: never;
485
- path: {
486
- token_id: number;
487
- };
488
- cookie?: never;
489
- };
490
- requestBody?: never;
491
- responses: {
492
- 200: {
493
- headers: {
494
- [name: string]: unknown;
495
- };
496
- content: {
497
- "application/json": components["schemas"]["TokenStats"];
498
- };
499
- };
500
- 404: {
501
- headers: {
502
- [name: string]: unknown;
503
- };
504
- content: {
505
- "application/json": components["schemas"]["TokenNotFound"];
506
- };
507
- };
508
- };
509
- };
510
- put?: never;
511
- post?: never;
512
- delete?: never;
513
- options?: never;
514
- head?: never;
515
- patch?: never;
516
- trace?: never;
517
- };
518
- "/user/{pubkey}": {
519
- parameters: {
520
- query?: never;
521
- header?: never;
522
- path?: never;
523
- cookie?: never;
524
- };
525
- /** @description List account ids and sessions for a user. */
526
- get: {
527
- parameters: {
528
- query?: never;
529
- header?: never;
530
- path: {
531
- /** @description User's solana public key */
532
- pubkey: string;
533
- };
534
- cookie?: never;
535
- };
536
- requestBody?: never;
537
- responses: {
538
- 200: {
539
- headers: {
540
- [name: string]: unknown;
541
- };
542
- content: {
543
- "application/json": components["schemas"]["User"];
544
- };
545
- };
546
- 404: {
547
- headers: {
548
- [name: string]: unknown;
549
- };
550
- content: {
551
- "application/json": components["schemas"]["UserNotFound"];
552
- };
553
- };
554
- };
555
- };
556
- put?: never;
557
- post?: never;
558
- delete?: never;
559
- options?: never;
560
- head?: never;
561
- patch?: never;
562
- trace?: never;
563
- };
564
- "/account/{account_id}/fees/withdrawal": {
565
- parameters: {
566
- query?: never;
567
- header?: never;
568
- path?: never;
569
- cookie?: never;
570
- };
571
- /** @description If protocol is healthy, it will be some amount expressed in USDC unit, like 1 USDC or 0.1 USDC. For example if 1 ETH is 10_000 USDC price, and fee 1 USDC, that means that user will get 0.9999 ETH instead of 1 ETH.
572
- *
573
- * If protocol in unhealthy, withdrawal fee will be proportional to protocol debt. */
574
- get: {
575
- parameters: {
576
- query?: never;
577
- header?: never;
578
- path: {
579
- /** @description Account for which evaluate fee for. */
580
- account_id: number;
581
- };
582
- cookie?: never;
583
- };
584
- requestBody?: never;
585
- responses: {
586
- 200: {
587
- headers: {
588
- [name: string]: unknown;
589
- };
590
- content: {
591
- "application/json": number;
592
- };
593
- };
594
- };
595
- };
596
- put?: never;
597
- post?: never;
598
- delete?: never;
599
- options?: never;
600
- head?: never;
601
- patch?: never;
602
- trace?: never;
603
- };
604
- "/account/{account_id}/orders": {
605
- parameters: {
606
- query?: never;
607
- header?: never;
608
- path?: never;
609
- cookie?: never;
610
- };
611
- /** @description Get all orders for a specific account with pagination */
612
- get: {
613
- parameters: {
614
- query?: {
615
- /** @description fetch results starting with this page; query starts with first entry if page isn't specified */
616
- startInclusive?: string | null;
617
- /** @description Query returns up to 50 trades in one go. */
618
- pageSize?: number | null;
619
- };
620
- header?: never;
621
- path: {
622
- account_id: number;
623
- };
624
- cookie?: never;
625
- };
626
- requestBody?: never;
627
- responses: {
628
- 200: {
629
- headers: {
630
- [name: string]: unknown;
631
- };
632
- content: {
633
- "application/json": components["schemas"]["PageResult_for_String_and_OrderInfo"];
634
- };
635
- };
636
- };
637
- };
638
- put?: never;
639
- post?: never;
640
- delete?: never;
641
- options?: never;
642
- head?: never;
643
- patch?: never;
644
- trace?: never;
645
- };
646
- "/account/{account_id}": {
647
- parameters: {
648
- query?: never;
649
- header?: never;
650
- path?: never;
651
- cookie?: never;
652
- };
653
- /** @description Given `account_id`, returns account summary information: balances, positions, open orders for account */
654
- get: {
655
- parameters: {
656
- query?: never;
657
- header?: never;
658
- path: {
659
- account_id: number;
660
- };
661
- cookie?: never;
662
- };
663
- requestBody?: never;
664
- responses: {
665
- 200: {
666
- headers: {
667
- [name: string]: unknown;
668
- };
669
- content: {
670
- "application/json": components["schemas"]["Account"];
671
- };
672
- };
673
- 404: {
674
- headers: {
675
- [name: string]: unknown;
676
- };
677
- content: {
678
- "application/json": components["schemas"]["UserNotFound"];
679
- };
680
- };
681
- };
682
- };
683
- put?: never;
684
- post?: never;
685
- delete?: never;
686
- options?: never;
687
- head?: never;
688
- patch?: never;
689
- trace?: never;
690
- };
691
- "/account/{account_id}/pnl": {
692
- parameters: {
693
- query?: never;
694
- header?: never;
695
- path?: never;
696
- cookie?: never;
697
- };
698
- /** @description Get account's PnL (Profit and Loss) history, ordered from most recent to oldest.
699
- *
700
- * Pagination Results include account PnL records with timestamp, account_id, action_id, and pnl value. Use query parameters `since` and `until` for time-based filtering, and `startInclusive` for pagination.
701
- *
702
- * To fetch more data, use the same `since` and `until` parameters and set `startInclusive` to the `nextStartInclusive` value from the previous response. If `nextStartInclusive` is absent, it means there's no more data to fetch, even if the max number of entries were returned. */
703
- get: {
704
- parameters: {
705
- query?: {
706
- /** @description start with this timestamp (RFC3339); defaults to UNIX epoch start */
707
- since?: string;
708
- /** @description end with this timestamp (RFC3339); defaults to current date-time */
709
- until?: string;
710
- /** @description fetch results starting with this page; query starts with first entry if page isn't specified */
711
- startInclusive?: number | null;
712
- /** @description Query returns up to 50 trades in one go. */
713
- pageSize?: number | null;
714
- };
715
- header?: never;
716
- path: {
717
- /** @description Account for which to retrieve PnL history */
718
- account_id: number;
719
- };
720
- cookie?: never;
721
- };
722
- requestBody?: never;
723
- responses: {
724
- 200: {
725
- headers: {
726
- [name: string]: unknown;
727
- };
728
- content: {
729
- "application/json": components["schemas"]["PageResult_for_uint64_and_AccountPnl"];
730
- };
731
- };
732
- };
733
- };
734
- put?: never;
735
- post?: never;
736
- delete?: never;
737
- options?: never;
738
- head?: never;
739
- patch?: never;
740
- trace?: never;
741
- };
742
- "/account/{account_id}/triggers/history": {
743
- parameters: {
744
- query?: never;
745
- header?: never;
746
- path?: never;
747
- cookie?: never;
748
- };
749
- get: {
750
- parameters: {
751
- query?: {
752
- /** @description start with this timestamp (RFC3339); defaults to UNIX epoch start */
753
- since?: string;
754
- /** @description end with this timestamp (RFC3339); defaults to current date-time */
755
- until?: string;
756
- /** @description fetch results starting with this page; query starts with first entry if page isn't specified */
757
- startInclusive?: number | null;
758
- /** @description Query returns up to 50 trades in one go. */
759
- pageSize?: number | null;
760
- };
761
- header?: never;
762
- path: {
763
- account_id: number;
764
- };
765
- cookie?: never;
766
- };
767
- requestBody?: never;
768
- responses: {
769
- 200: {
770
- headers: {
771
- [name: string]: unknown;
772
- };
773
- content: {
774
- "application/json": components["schemas"]["PageResult_for_uint64_and_HistoryTriggerInfo"];
775
- };
776
- };
777
- };
778
- };
779
- put?: never;
780
- post?: never;
781
- delete?: never;
782
- options?: never;
783
- head?: never;
784
- patch?: never;
785
- trace?: never;
786
- };
787
- "/account/{account_id}/triggers": {
788
- parameters: {
789
- query?: never;
790
- header?: never;
791
- path?: never;
792
- cookie?: never;
793
- };
794
- get: {
795
- parameters: {
796
- query?: never;
797
- header?: never;
798
- path: {
799
- account_id: number;
800
- };
801
- cookie?: never;
802
- };
803
- requestBody?: never;
804
- responses: {
805
- 200: {
806
- headers: {
807
- [name: string]: unknown;
808
- };
809
- content: {
810
- "application/json": components["schemas"]["AccountTriggerInfo"][] | null;
811
- };
812
- };
813
- };
814
- };
815
- put?: never;
816
- post?: never;
817
- delete?: never;
818
- options?: never;
819
- head?: never;
820
- patch?: never;
821
- trace?: never;
822
- };
823
- "/account/{account_id}/pubkey": {
824
- parameters: {
825
- query?: never;
826
- header?: never;
827
- path?: never;
828
- cookie?: never;
829
- };
830
- get: {
831
- parameters: {
832
- query?: never;
833
- header?: never;
834
- path: {
835
- account_id: number;
836
- };
837
- cookie?: never;
838
- };
839
- requestBody?: never;
840
- responses: {
841
- 200: {
842
- headers: {
843
- [name: string]: unknown;
844
- };
845
- content: {
846
- "application/json": string;
847
- };
848
- };
849
- 404: {
850
- headers: {
851
- [name: string]: unknown;
852
- };
853
- content: {
854
- "application/json": components["schemas"]["UserNotFound"];
855
- };
856
- };
857
- };
858
- };
859
- put?: never;
860
- post?: never;
861
- delete?: never;
862
- options?: never;
863
- head?: never;
864
- patch?: never;
865
- trace?: never;
866
- };
867
- "/order/{order_id}": {
868
- parameters: {
869
- query?: never;
870
- header?: never;
871
- path?: never;
872
- cookie?: never;
873
- };
874
- /** @description Given order identifier, return order summary. Works for order which were immediately filled, partially filled, cancelled or fully filled. */
875
- get: {
876
- parameters: {
877
- query?: never;
878
- header?: never;
879
- path: {
880
- order_id: string;
881
- };
882
- cookie?: never;
883
- };
884
- requestBody?: never;
885
- responses: {
886
- /** @description Order summary. Use order_id to application side join with trades as needed. */
887
- 200: {
888
- headers: {
889
- [name: string]: unknown;
890
- };
891
- content: {
892
- "application/json": components["schemas"]["OrderInfo"];
893
- };
894
- };
895
- 404: {
896
- headers: {
897
- [name: string]: unknown;
898
- };
899
- content: {
900
- "application/json": components["schemas"]["OrderNotFound"];
901
- };
902
- };
903
- };
904
- };
905
- put?: never;
906
- post?: never;
907
- delete?: never;
908
- options?: never;
909
- head?: never;
910
- patch?: never;
911
- trace?: never;
912
- };
913
- "/order/{order_id}/trades": {
914
- parameters: {
915
- query?: never;
916
- header?: never;
917
- path?: never;
918
- cookie?: never;
919
- };
920
- /** @description Get trades for a specific order with pagination */
921
- get: {
922
- parameters: {
923
- query?: {
924
- /** @description fetch results starting with this page; query starts with first entry if page isn't specified */
925
- startInclusive?: string | null;
926
- /** @description Query returns up to 50 trades in one go. */
927
- pageSize?: number | null;
928
- };
929
- header?: never;
930
- path: {
931
- order_id: string;
932
- };
933
- cookie?: never;
934
- };
935
- requestBody?: never;
936
- responses: {
937
- 200: {
938
- headers: {
939
- [name: string]: unknown;
940
- };
941
- content: {
942
- "application/json": components["schemas"]["PageResult_for_String_and_Trade"];
943
- };
944
- };
945
- };
946
- };
947
- put?: never;
948
- post?: never;
949
- delete?: never;
950
- options?: never;
951
- head?: never;
952
- patch?: never;
953
- trace?: never;
954
- };
955
- "/trades": {
956
- parameters: {
957
- query?: never;
958
- header?: never;
959
- path?: never;
960
- cookie?: never;
961
- };
962
- /** @description Ordered from present to past.
963
- *
964
- * Pagination Besides set of trades in `trades` array, endpoint returns `accountId` and actual values for `since` and `until` if they weren't specified by client.
965
- *
966
- * To fetch it, client should pass `since` and `until` returned and add `nextStartInclusive`'s value as `startInclusive` parameter. If `nextStartInclusive` is absent, it means there's no more data to fetch, even if 50 entries were returned. */
967
- get: {
968
- parameters: {
969
- query?: {
970
- takerId?: number | null;
971
- takerSide?: components["schemas"]["Side"] | null;
972
- makerId?: number | null;
973
- marketId?: number | null;
974
- /** @description start with this timestamp (RFC3339); defaults to UNIX epoch start */
975
- since?: string;
976
- /** @description end with this timestamp (RFC3339); defaults to current date-time */
977
- until?: string;
978
- /** @description fetch results starting with this page; query starts with first entry if page isn't specified */
979
- startInclusive?: string | null;
980
- /** @description Query returns up to 50 trades in one go. */
981
- pageSize?: number | null;
982
- };
983
- header?: never;
984
- path?: never;
985
- cookie?: never;
986
- };
987
- requestBody?: never;
988
- responses: {
989
- 200: {
990
- headers: {
991
- [name: string]: unknown;
992
- };
993
- content: {
994
- "application/json": components["schemas"]["PageResult_for_String_and_Trade"];
995
- };
996
- };
997
- };
998
- };
999
- put?: never;
1000
- post?: never;
1001
- delete?: never;
1002
- options?: never;
1003
- head?: never;
1004
- patch?: never;
1005
- trace?: never;
1006
- };
1007
- "/state/download": {
1008
- parameters: {
1009
- query?: never;
1010
- header?: never;
1011
- path?: never;
1012
- cookie?: never;
1013
- };
1014
- /** @description Returns state download link and metadata, as defined by nearest(up to equality) snapshot `time` or `action_id`` or `timestamp`. If not specified, returns latest snapshot. Example: /state/download?actionId=1 /state/download?time&2025-09-22T12:34:56Z /state/download?timestamp&1695380000 - Does not implemented yet. To get the latest snap use: /state/download - w/o any params.
1015
- *
1016
- * The link from responce can be inserted to search bar in browser to download. */
1017
- get: {
1018
- parameters: {
1019
- query?: never;
1020
- header?: never;
1021
- path?: never;
1022
- cookie?: never;
1023
- };
1024
- requestBody?: never;
1025
- responses: {
1026
- 200: {
1027
- headers: {
1028
- [name: string]: unknown;
1029
- };
1030
- content: {
1031
- "application/json": components["schemas"]["StateDownloadMeta"];
1032
- };
1033
- };
1034
- 501: {
1035
- headers: {
1036
- [name: string]: unknown;
1037
- };
1038
- content: {
1039
- "application/json": components["schemas"]["NotImplemented"];
1040
- };
1041
- };
1042
- };
1043
- };
1044
- put?: never;
1045
- post?: never;
1046
- delete?: never;
1047
- options?: never;
1048
- head?: never;
1049
- patch?: never;
1050
- trace?: never;
1051
- };
1052
- "/state/download/{snapshot_id}": {
1053
- parameters: {
1054
- query?: never;
1055
- header?: never;
1056
- path?: never;
1057
- cookie?: never;
1058
- };
1059
- /** @description Typical HTTP file download endpoint. Actually same as provided by S3 storages. Means supports Range header, Content-Length, Content-Type, ETag and so on, and relevant headers. */
1060
- get: {
1061
- parameters: {
1062
- query?: never;
1063
- header?: never;
1064
- path: {
1065
- snapshot_id: string;
1066
- };
1067
- cookie?: never;
1068
- };
1069
- requestBody?: never;
1070
- responses: never;
1071
- };
1072
- put?: never;
1073
- post?: never;
1074
- delete?: never;
1075
- options?: never;
1076
- head?: never;
1077
- patch?: never;
1078
- trace?: never;
1079
- };
1080
- "/state/info": {
1081
- parameters: {
1082
- query?: never;
1083
- header?: never;
1084
- path?: never;
1085
- cookie?: never;
1086
- };
1087
- get: {
1088
- parameters: {
1089
- query?: never;
1090
- header?: never;
1091
- path?: never;
1092
- cookie?: never;
1093
- };
1094
- requestBody?: never;
1095
- responses: {
1096
- 200: {
1097
- headers: {
1098
- [name: string]: unknown;
1099
- };
1100
- content: {
1101
- "application/json": components["schemas"]["StateInfo"];
1102
- };
1103
- };
1104
- };
1105
- };
1106
- put?: never;
1107
- post?: never;
1108
- delete?: never;
1109
- options?: never;
1110
- head?: never;
1111
- patch?: never;
1112
- trace?: never;
1113
- };
1114
- "/fee/brackets/info": {
1115
- parameters: {
1116
- query?: never;
1117
- header?: never;
1118
- path?: never;
1119
- cookie?: never;
1120
- };
1121
- get: {
1122
- parameters: {
1123
- query?: never;
1124
- header?: never;
1125
- path?: never;
1126
- cookie?: never;
1127
- };
1128
- requestBody?: never;
1129
- responses: {
1130
- 200: {
1131
- headers: {
1132
- [name: string]: unknown;
1133
- };
1134
- content: {
1135
- "application/json": [
1136
- components["schemas"]["FeeTierId"],
1137
- components["schemas"]["FeeTierConfig"]
1138
- ][];
1139
- };
1140
- };
1141
- };
1142
- };
1143
- put?: never;
1144
- post?: never;
1145
- delete?: never;
1146
- options?: never;
1147
- head?: never;
1148
- patch?: never;
1149
- trace?: never;
1150
- };
1151
- "/account/{account_id}/fee/tier": {
1152
- parameters: {
1153
- query?: never;
1154
- header?: never;
1155
- path?: never;
1156
- cookie?: never;
1157
- };
1158
- get: {
1159
- parameters: {
1160
- query?: never;
1161
- header?: never;
1162
- path: {
1163
- account_id: number;
1164
- };
1165
- cookie?: never;
1166
- };
1167
- requestBody?: never;
1168
- responses: {
1169
- 200: {
1170
- headers: {
1171
- [name: string]: unknown;
1172
- };
1173
- content: {
1174
- "application/json": components["schemas"]["FeeTierId"];
1175
- };
1176
- };
1177
- 404: {
1178
- headers: {
1179
- [name: string]: unknown;
1180
- };
1181
- content: {
1182
- "application/json": components["schemas"]["UserNotFound"];
1183
- };
1184
- };
1185
- };
1186
- };
1187
- put?: never;
1188
- post?: never;
1189
- delete?: never;
1190
- options?: never;
1191
- head?: never;
1192
- patch?: never;
1193
- trace?: never;
1194
- };
1195
- "/accounts/fee-tiers": {
1196
- parameters: {
1197
- query?: never;
1198
- header?: never;
1199
- path?: never;
1200
- cookie?: never;
1201
- };
1202
- /** @description List fee tiers assigned to accounts. */
1203
- get: {
1204
- parameters: {
1205
- query?: {
1206
- /** @description fetch results starting with this page; query starts with first entry if page isn't specified */
1207
- startInclusive?: number | null;
1208
- /** @description Query returns up to 50 trades in one go. */
1209
- pageSize?: number | null;
1210
- };
1211
- header?: never;
1212
- path?: never;
1213
- cookie?: never;
1214
- };
1215
- requestBody?: never;
1216
- responses: {
1217
- 200: {
1218
- headers: {
1219
- [name: string]: unknown;
1220
- };
1221
- content: {
1222
- "application/json": components["schemas"]["PageResult_for_uint32_and_AccountFeeTier"];
1223
- };
1224
- };
1225
- };
1226
- };
1227
- put?: never;
1228
- post?: never;
1229
- delete?: never;
1230
- options?: never;
1231
- head?: never;
1232
- patch?: never;
1233
- trace?: never;
1234
- };
1235
- "/admin": {
1236
- parameters: {
1237
- query?: never;
1238
- header?: never;
1239
- path?: never;
1240
- cookie?: never;
1241
- };
1242
- /** @description List of assigned admins. */
1243
- get: {
1244
- parameters: {
1245
- query?: never;
1246
- header?: never;
1247
- path?: never;
1248
- cookie?: never;
1249
- };
1250
- requestBody?: never;
1251
- responses: {
1252
- 200: {
1253
- headers: {
1254
- [name: string]: unknown;
1255
- };
1256
- content: {
1257
- "application/json": [
1258
- string,
1259
- components["schemas"]["AclRole"]
1260
- ][];
1261
- };
1262
- };
1263
- };
1264
- };
1265
- put?: never;
1266
- post?: never;
1267
- delete?: never;
1268
- options?: never;
1269
- head?: never;
1270
- patch?: never;
1271
- trace?: never;
1272
- };
1273
- "/tv": {
1274
- parameters: {
1275
- query?: never;
1276
- header?: never;
1277
- path?: never;
1278
- cookie?: never;
1279
- };
1280
- /** @description Datafeed URL to be used in TradingView */
1281
- get: {
1282
- parameters: {
1283
- query?: never;
1284
- header?: never;
1285
- path?: never;
1286
- cookie?: never;
1287
- };
1288
- requestBody?: never;
1289
- responses: {
1290
- /** @description plain text */
1291
- 200: {
1292
- headers: {
1293
- [name: string]: unknown;
1294
- };
1295
- content: {
1296
- "text/plain; charset=utf-8": unknown;
1297
- };
1298
- };
1299
- };
1300
- };
1301
- put?: never;
1302
- post?: never;
1303
- delete?: never;
1304
- options?: never;
1305
- head?: never;
1306
- patch?: never;
1307
- trace?: never;
1308
- };
1309
- }
1310
- export type webhooks = Record<string, never>;
1311
- export interface components {
1312
- schemas: {
1313
- OpenApi: {
1314
- openapi: string;
1315
- /** @description REQUIRED. Provides metadata about the API. The metadata MAY be used by tooling as required. */
1316
- info: components["schemas"]["Info"];
1317
- /** @description The default value for the `$schema` keyword within Schema Objects contained within this OAS document. This MUST be in the form of a URI. */
1318
- jsonSchemaDialect?: string | null;
1319
- /** @description An array of Server Objects, which provide connectivity information to a target server. If the servers property is not provided, or is an empty array, the default value would be a Server Object with a url value of /. */
1320
- servers?: components["schemas"]["Server"][];
1321
- /** @description The available paths and operations for the API. */
1322
- paths?: components["schemas"]["Paths"] | null;
1323
- /** @description The incoming webhooks that MAY be received as part of this API and that the API consumer MAY choose to implement. Closely related to the `callbacks` feature, this section describes requests initiated other than by an API call, for example by an out of band registration. The key name is a unique string to refer to each webhook, while the (optionally referenced) Path Item Object describes a request that may be initiated by the API provider and the expected responses. */
1324
- webhooks?: {
1325
- [key: string]: components["schemas"]["ReferenceOr_for_PathItem"];
1326
- };
1327
- /** @description An element to hold various schemas for the document. */
1328
- components?: components["schemas"]["Components"] | null;
1329
- /** @description A declaration of which security mechanisms can be used across the API. The list of values includes alternative security requirement objects that can be used. Only one of the security requirement objects need to be satisfied to authorize a request. Individual operations can override this definition. Global security settings may be overridden on a per-path basis. */
1330
- security?: {
1331
- [key: string]: string[];
1332
- }[];
1333
- /** @description A list of tags used by the document with additional metadata. The order of the tags can be used to reflect on their order by the parsing tools. Not all tags that are used by the Operation Object must be declared. The tags that are not declared MAY be organized randomly or based on the tool's logic. Each tag name in the list MUST be unique. */
1334
- tags?: components["schemas"]["Tag"][];
1335
- /** @description Additional external documentation. */
1336
- externalDocs?: components["schemas"]["ExternalDocumentation"] | null;
1337
- } & {
1338
- [key: string]: unknown;
1339
- };
1340
- /** @description The object provides metadata about the API. The metadata MAY be used by the clients if needed, and MAY be presented in editing or documentation generation tools for convenience. */
1341
- Info: {
1342
- /** @description REQUIRED. The title of the application. */
1343
- title: string;
1344
- /** @description A short summary of the API. */
1345
- summary?: string | null;
1346
- /** @description A description of the API. CommonMark syntax MAY be used for rich text representation. */
1347
- description?: string | null;
1348
- /** @description A URL to the Terms of Service for the API. This MUST be in the format of a URL. */
1349
- termsOfService?: string | null;
1350
- /** @description The contact information for the exposed API. */
1351
- contact?: components["schemas"]["Contact"] | null;
1352
- /** @description The license information for the exposed API. */
1353
- license?: components["schemas"]["License"] | null;
1354
- /** @description REQUIRED. The version of the OpenAPI document (which is distinct from the OpenAPI Specification version or the API implementation version). */
1355
- version: string;
1356
- } & {
1357
- [key: string]: unknown;
1358
- };
1359
- /** @description Contact information for the exposed API. */
1360
- Contact: {
1361
- /** @description The identifying name of the contact person/organization. */
1362
- name?: string | null;
1363
- /** @description The URL pointing to the contact information. This MUST be in the format of a URL. */
1364
- url?: string | null;
1365
- /** @description The email address of the contact person/organization. This MUST be in the format of an email address. */
1366
- email?: string | null;
1367
- } & {
1368
- [key: string]: unknown;
1369
- };
1370
- /** @description License information for the exposed API. */
1371
- License: {
1372
- /** @description REQUIRED. The license name used for the API. */
1373
- name: string;
1374
- /** @description An [SPDX](https://spdx.org/spdx-specification-21-web-version#h.jxpfx0ykyb60) license expression for the API. The `identifier` field is mutually exclusive of the `url` field. */
1375
- identifier?: string | null;
1376
- /** @description A URL to the license used for the API. This MUST be in the form of a URL. The `url` field is mutually exclusive of the `identifier` field. */
1377
- url?: string | null;
1378
- } & {
1379
- [key: string]: unknown;
1380
- };
1381
- /** @description An object representing a Server. */
1382
- Server: {
1383
- /** @description REQUIRED. A URL to the target host. This URL supports Server Variables and MAY be relative, to indicate that the host location is relative to the location where the OpenAPI document is being served. Variable substitutions will be made when a variable is named in {brackets}. */
1384
- url: string;
1385
- /** @description An optional string describing the host designated by the URL. CommonMark syntax MAY be used for rich text representation. */
1386
- description?: string | null;
1387
- /** @description A map between a variable name and its value. The value is used for substitution in the server's URL template. */
1388
- variables?: {
1389
- [key: string]: components["schemas"]["ServerVariable"];
1390
- };
1391
- } & {
1392
- [key: string]: unknown;
1393
- };
1394
- /** @description An object representing a Server Variable for server URL template substitution. */
1395
- ServerVariable: {
1396
- /** @description An enumeration of string values to be used if the substitution options are from a limited set. */
1397
- enum?: string[];
1398
- /** @description REQUIRED. The default value to use for substitution, and to send, if an alternate value is not supplied. Unlike the Schema Object's default, this value MUST be provided by the consumer. */
1399
- default: string;
1400
- /** @description An optional description for the server variable. CommonMark syntax MAY be used for rich text representation. */
1401
- description?: string | null;
1402
- } & {
1403
- [key: string]: unknown;
1404
- };
1405
- /** @description Holds the relative paths to the individual endpoints and their operations. The path is appended to the URL from the Server Object in order to construct the full URL. The Paths MAY be empty, due to Access Control List (ACL) constraints. */
1406
- Paths: {
1407
- [key: string]: unknown;
1408
- };
1409
- ReferenceOr_for_PathItem: {
1410
- /** @description REQUIRED. The reference identifier. This MUST be in the form of a URI. */
1411
- $ref: string;
1412
- /** @description A short summary which by default SHOULD override that of the referenced component. If the referenced object-type does not allow a `summary` field, then this field has no effect. */
1413
- summary?: string | null;
1414
- /** @description A description which by default SHOULD override that of the referenced component. CommonMark syntax MAY be used for rich text representation. If the referenced object-type does not allow a `description` field, then this field has no effect. */
1415
- description?: string | null;
1416
- } | components["schemas"]["PathItem"];
1417
- /** @description Describes the operations available on a single path. A Path Item MAY be empty, due to ACL constraints. The path itself is still exposed to the documentation viewer but they will not know which operations and parameters are available. */
1418
- PathItem: {
1419
- /** @description Allows for a referenced definition of this path item. The referenced structure MUST be in the form of a Path Item Object. In case a Path Item Object field appears both in the defined object and the referenced object, the behavior is undefined. See the rules for resolving Relative References. */
1420
- $ref?: string | null;
1421
- /** @description An optional, string summary, intended to apply to all operations in this path. */
1422
- summary?: string | null;
1423
- /** @description An optional, string description, intended to apply to all operations in this path. CommonMark syntax MAY be used for rich text representation. */
1424
- description?: string | null;
1425
- get?: components["schemas"]["Operation"] | null;
1426
- put?: components["schemas"]["Operation"] | null;
1427
- post?: components["schemas"]["Operation"] | null;
1428
- delete?: components["schemas"]["Operation"] | null;
1429
- options?: components["schemas"]["Operation"] | null;
1430
- head?: components["schemas"]["Operation"] | null;
1431
- patch?: components["schemas"]["Operation"] | null;
1432
- trace?: components["schemas"]["Operation"] | null;
1433
- /** @description An alternative server array to service all operations in this path. */
1434
- servers?: components["schemas"]["Server"][];
1435
- /** @description A list of parameters that are applicable for all the operations described under this path. These parameters can be overridden at the operation level, but cannot be removed there. The list MUST NOT include duplicated parameters. A unique parameter is defined by a combination of a name and location. The list can use the Reference Object to link to parameters that are defined at the OpenAPI Object's components/parameters. */
1436
- parameters?: components["schemas"]["ReferenceOr_for_Parameter"][];
1437
- } & {
1438
- [key: string]: unknown;
1439
- };
1440
- /** @description Describes a single API operation on a path. */
1441
- Operation: {
1442
- /** @description A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier. */
1443
- tags?: string[];
1444
- /** @description A short summary of what the operation does. */
1445
- summary?: string | null;
1446
- /** @description A verbose explanation of the operation behavior. CommonMark syntax MAY be used for rich text representation. */
1447
- description?: string | null;
1448
- /** @description Additional external documentation for this operation. */
1449
- externalDocs?: components["schemas"]["ExternalDocumentation"] | null;
1450
- /** @description Unique string used to identify the operation. The id MUST be unique among all operations described in the API. Tools and libraries MAY use the operationId to uniquely identify an operation, therefore, it is RECOMMENDED to follow common programming naming conventions. */
1451
- operationId?: string | null;
1452
- /** @description A list of parameters that are applicable for this operation. If a parameter is already defined at the Path Item, the new definition will override it but can never remove it. The list MUST NOT include duplicated parameters. A unique parameter is defined by a combination of a name and location. The list can use the Reference Object to link to parameters that are defined at the OpenAPI Object's components/parameters. */
1453
- parameters?: components["schemas"]["ReferenceOr_for_Parameter"][];
1454
- /** @description The request body applicable for this operation. The requestBody is fully supported in HTTP methods where the HTTP 1.1 specification RFC7231 has explicitly defined semantics for request bodies. In other cases where the HTTP spec is vague (such as [GET](https://tools.ietf.org/html/rfc7231#section-4.3.1), [HEAD](https://tools.ietf.org/html/rfc7231#section-4.3.2) and [DELETE](https://tools.ietf.org/html/rfc7231#section-4.3.5)), requestBody is permitted but does not have well-defined semantics and SHOULD be avoided if possible. */
1455
- requestBody?: components["schemas"]["ReferenceOr_for_RequestBody"] | null;
1456
- /** @description The list of possible responses as they are returned from executing this operation. */
1457
- responses?: components["schemas"]["Responses"] | null;
1458
- /** @description Declares this operation to be deprecated.Default value is false. */
1459
- deprecated?: boolean;
1460
- /** @description A declaration of which security mechanisms can be used for this operation. The list of values includes alternative security requirement objects that can be used. Only one of the security requirement objects need to be satisfied to authorize a request. This definition overrides any declared top-level security. To remove a top-level security declaration, an empty array can be used. */
1461
- security?: {
1462
- [key: string]: string[];
1463
- }[];
1464
- /** @description An alternative server array to service this operation. If an alternative server object is specified at the Path Item Object or Root level, it will be overridden by this value. */
1465
- servers?: components["schemas"]["Server"][];
1466
- /** @description Callbacks for the operation. */
1467
- callbacks?: {
1468
- [key: string]: components["schemas"]["ReferenceOr_for_Map_of_ReferenceOr_for_PathItem"];
1469
- };
1470
- } & {
1471
- [key: string]: unknown;
1472
- };
1473
- /** @description Allows referencing an external resource for extended documentation. */
1474
- ExternalDocumentation: {
1475
- /** @description A description of the target documentation. CommonMark syntax MAY be used for rich text representation. */
1476
- description?: string | null;
1477
- /** @description REQUIRED. The URL for the target documentation. This MUST be in the format of a URL. */
1478
- url: string;
1479
- } & {
1480
- [key: string]: unknown;
1481
- };
1482
- ReferenceOr_for_Parameter: {
1483
- /** @description REQUIRED. The reference identifier. This MUST be in the form of a URI. */
1484
- $ref: string;
1485
- /** @description A short summary which by default SHOULD override that of the referenced component. If the referenced object-type does not allow a `summary` field, then this field has no effect. */
1486
- summary?: string | null;
1487
- /** @description A description which by default SHOULD override that of the referenced component. CommonMark syntax MAY be used for rich text representation. If the referenced object-type does not allow a `description` field, then this field has no effect. */
1488
- description?: string | null;
1489
- } | components["schemas"]["Parameter"];
1490
- Parameter: (({
1491
- /** @enum {string} */
1492
- in: "query";
1493
- /** @description Determines whether the parameter value SHOULD allow reserved characters, as defined by RFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. This property only applies to parameters with an in value of query. The default value is false. */
1494
- allow_reserved?: boolean;
1495
- /** @description Describes how the parameter value will be serialized depending on the type of the parameter value. Default values (based on value of in): for query - form; for path - simple; for header - simple; for cookie - form. */
1496
- style?: components["schemas"]["QueryStyle"];
1497
- /** @description Sets the ability to pass empty-valued parameters. This is valid only for query parameters and allows sending a parameter with an empty value. Default value is false. If style is used, and if behavior is n/a (cannot be serialized), the value of allowEmptyValue SHALL be ignored. */
1498
- allow_empty_value?: boolean | null;
1499
- /** @description REQUIRED. The name of the parameter. Parameter names are case sensitive. If in is "path", the name field MUST correspond to the associated path segment from the path field in the Paths Object. See Path Templating for further information.
1500
- *
1501
- * If in is "header" and the name field is "Accept", "Content-Type" or "Authorization", the parameter definition SHALL be ignored.
1502
- *
1503
- * For all other cases, the name corresponds to the parameter name used by the in property. */
1504
- name: string;
1505
- /** @description A brief description of the parameter. This could contain examples of use. CommonMark syntax MAY be used for rich text representation. */
1506
- description?: string | null;
1507
- /** @description Determines whether this parameter is mandatory. If the parameter location is "path", this property is REQUIRED and its value MUST be true. Otherwise, the property MAY be included and its default value is false. */
1508
- required?: boolean;
1509
- /** @description Specifies that a parameter is deprecated and SHOULD be transitioned out of usage. */
1510
- deprecated?: boolean | null;
1511
- example?: unknown;
1512
- examples?: {
1513
- [key: string]: components["schemas"]["ReferenceOr_for_Example"];
1514
- };
1515
- explode?: boolean | null;
1516
- } & {
1517
- [key: string]: unknown;
1518
- }) & ({
1519
- schema: components["schemas"]["SchemaObject"];
1520
- } | {
1521
- content: {
1522
- [key: string]: components["schemas"]["MediaType"];
1523
- };
1524
- })) | (({
1525
- /** @enum {string} */
1526
- in: "header";
1527
- /** @description Describes how the parameter value will be serialized depending on the type of the parameter value. Default values (based on value of in): for query - form; for path - simple; for header - simple; for cookie - form. */
1528
- style?: components["schemas"]["HeaderStyle"];
1529
- /** @description REQUIRED. The name of the parameter. Parameter names are case sensitive. If in is "path", the name field MUST correspond to the associated path segment from the path field in the Paths Object. See Path Templating for further information.
1530
- *
1531
- * If in is "header" and the name field is "Accept", "Content-Type" or "Authorization", the parameter definition SHALL be ignored.
1532
- *
1533
- * For all other cases, the name corresponds to the parameter name used by the in property. */
1534
- name: string;
1535
- /** @description A brief description of the parameter. This could contain examples of use. CommonMark syntax MAY be used for rich text representation. */
1536
- description?: string | null;
1537
- /** @description Determines whether this parameter is mandatory. If the parameter location is "path", this property is REQUIRED and its value MUST be true. Otherwise, the property MAY be included and its default value is false. */
1538
- required?: boolean;
1539
- /** @description Specifies that a parameter is deprecated and SHOULD be transitioned out of usage. */
1540
- deprecated?: boolean | null;
1541
- example?: unknown;
1542
- examples?: {
1543
- [key: string]: components["schemas"]["ReferenceOr_for_Example"];
1544
- };
1545
- explode?: boolean | null;
1546
- } & {
1547
- [key: string]: unknown;
1548
- }) & ({
1549
- schema: components["schemas"]["SchemaObject"];
1550
- } | {
1551
- content: {
1552
- [key: string]: components["schemas"]["MediaType"];
1553
- };
1554
- })) | (({
1555
- /** @enum {string} */
1556
- in: "path";
1557
- /** @description Describes how the parameter value will be serialized depending on the type of the parameter value. Default values (based on value of in): for query - form; for path - simple; for header - simple; for cookie - form. */
1558
- style?: components["schemas"]["PathStyle"];
1559
- /** @description REQUIRED. The name of the parameter. Parameter names are case sensitive. If in is "path", the name field MUST correspond to the associated path segment from the path field in the Paths Object. See Path Templating for further information.
1560
- *
1561
- * If in is "header" and the name field is "Accept", "Content-Type" or "Authorization", the parameter definition SHALL be ignored.
1562
- *
1563
- * For all other cases, the name corresponds to the parameter name used by the in property. */
1564
- name: string;
1565
- /** @description A brief description of the parameter. This could contain examples of use. CommonMark syntax MAY be used for rich text representation. */
1566
- description?: string | null;
1567
- /** @description Determines whether this parameter is mandatory. If the parameter location is "path", this property is REQUIRED and its value MUST be true. Otherwise, the property MAY be included and its default value is false. */
1568
- required?: boolean;
1569
- /** @description Specifies that a parameter is deprecated and SHOULD be transitioned out of usage. */
1570
- deprecated?: boolean | null;
1571
- example?: unknown;
1572
- examples?: {
1573
- [key: string]: components["schemas"]["ReferenceOr_for_Example"];
1574
- };
1575
- explode?: boolean | null;
1576
- } & {
1577
- [key: string]: unknown;
1578
- }) & ({
1579
- schema: components["schemas"]["SchemaObject"];
1580
- } | {
1581
- content: {
1582
- [key: string]: components["schemas"]["MediaType"];
1583
- };
1584
- })) | (({
1585
- /** @enum {string} */
1586
- in: "cookie";
1587
- /** @description Describes how the parameter value will be serialized depending on the type of the parameter value. Default values (based on value of in): for query - form; for path - simple; for header - simple; for cookie - form. */
1588
- style?: components["schemas"]["CookieStyle"];
1589
- /** @description REQUIRED. The name of the parameter. Parameter names are case sensitive. If in is "path", the name field MUST correspond to the associated path segment from the path field in the Paths Object. See Path Templating for further information.
1590
- *
1591
- * If in is "header" and the name field is "Accept", "Content-Type" or "Authorization", the parameter definition SHALL be ignored.
1592
- *
1593
- * For all other cases, the name corresponds to the parameter name used by the in property. */
1594
- name: string;
1595
- /** @description A brief description of the parameter. This could contain examples of use. CommonMark syntax MAY be used for rich text representation. */
1596
- description?: string | null;
1597
- /** @description Determines whether this parameter is mandatory. If the parameter location is "path", this property is REQUIRED and its value MUST be true. Otherwise, the property MAY be included and its default value is false. */
1598
- required?: boolean;
1599
- /** @description Specifies that a parameter is deprecated and SHOULD be transitioned out of usage. */
1600
- deprecated?: boolean | null;
1601
- example?: unknown;
1602
- examples?: {
1603
- [key: string]: components["schemas"]["ReferenceOr_for_Example"];
1604
- };
1605
- explode?: boolean | null;
1606
- } & {
1607
- [key: string]: unknown;
1608
- }) & ({
1609
- schema: components["schemas"]["SchemaObject"];
1610
- } | {
1611
- content: {
1612
- [key: string]: components["schemas"]["MediaType"];
1613
- };
1614
- }));
1615
- /** @enum {string} */
1616
- QueryStyle: "form" | "spaceDelimited" | "pipeDelimited" | "deepObject";
1617
- ReferenceOr_for_Example: {
1618
- /** @description REQUIRED. The reference identifier. This MUST be in the form of a URI. */
1619
- $ref: string;
1620
- /** @description A short summary which by default SHOULD override that of the referenced component. If the referenced object-type does not allow a `summary` field, then this field has no effect. */
1621
- summary?: string | null;
1622
- /** @description A description which by default SHOULD override that of the referenced component. CommonMark syntax MAY be used for rich text representation. If the referenced object-type does not allow a `description` field, then this field has no effect. */
1623
- description?: string | null;
1624
- } | components["schemas"]["Example"];
1625
- Example: {
1626
- /** @description Short description for the example. */
1627
- summary?: string | null;
1628
- /** @description Long description for the example. CommonMark syntax MAY be used for rich text representation. */
1629
- description?: string | null;
1630
- /** @description Embedded literal example. The `value` field and `externalValue` field are mutually exclusive. To represent examples of media types that cannot naturally represented in JSON or YAML, use a string value to contain the example, escaping where necessary. */
1631
- value?: unknown;
1632
- /** @description A URI that points to the literal example. This provides the capability to reference examples that cannot easily be included in JSON or YAML documents. The `value` field and `externalValue` field are mutually exclusive. See the rules for resolving Relative References. */
1633
- externalValue?: string | null;
1634
- } & {
1635
- [key: string]: unknown;
1636
- };
1637
- /** @description A JSON Schema. */
1638
- SchemaObject: {
1639
- /** @description Additional external documentation for this schema. */
1640
- externalDocs?: components["schemas"]["ExternalDocumentation"] | null;
1641
- /** @description A free-form property to include an example of an instance for this schema. To represent examples that cannot be naturally represented in JSON or YAML, a string value can be used to contain the example with escaping where necessary. **Deprecated:** The `example` property has been deprecated in favor of the JSON Schema `examples` keyword. Use of `example` is discouraged, and later versions of this specification may remove it. */
1642
- example?: unknown;
1643
- } | boolean | components["schemas"]["SchemaObject2"];
1644
- /** @description A JSON Schema object. */
1645
- SchemaObject2: {
1646
- /** @description The `type` keyword.
1647
- *
1648
- * See [JSON Schema Validation 6.1.1. "type"](https://tools.ietf.org/html/draft-handrews-json-schema-validation-02#section-6.1.1) and [JSON Schema 4.2.1. Instance Data Model](https://tools.ietf.org/html/draft-handrews-json-schema-02#section-4.2.1). */
1649
- type?: components["schemas"]["SingleOrVec_for_InstanceType"] | null;
1650
- /** @description The `format` keyword.
1651
- *
1652
- * See [JSON Schema Validation 7. A Vocabulary for Semantic Content With "format"](https://tools.ietf.org/html/draft-handrews-json-schema-validation-02#section-7). */
1653
- format?: string | null;
1654
- /** @description The `enum` keyword.
1655
- *
1656
- * See [JSON Schema Validation 6.1.2. "enum"](https://tools.ietf.org/html/draft-handrews-json-schema-validation-02#section-6.1.2) */
1657
- enum?: unknown[] | null;
1658
- /** @description The `const` keyword.
1659
- *
1660
- * See [JSON Schema Validation 6.1.3. "const"](https://tools.ietf.org/html/draft-handrews-json-schema-validation-02#section-6.1.3) */
1661
- const?: unknown;
1662
- /** @description The `$ref` keyword.
1663
- *
1664
- * See [JSON Schema 8.2.4.1. Direct References with "$ref"](https://tools.ietf.org/html/draft-handrews-json-schema-02#section-8.2.4.1). */
1665
- $ref?: string | null;
1666
- /** @description The `$id` keyword.
1667
- *
1668
- * See [JSON Schema 8.2.2. The "$id" Keyword](https://tools.ietf.org/html/draft-handrews-json-schema-02#section-8.2.2). */
1669
- $id?: string | null;
1670
- /** @description The `title` keyword.
1671
- *
1672
- * See [JSON Schema Validation 9.1. "title" and "description"](https://tools.ietf.org/html/draft-handrews-json-schema-validation-02#section-9.1). */
1673
- title?: string | null;
1674
- /** @description The `description` keyword.
1675
- *
1676
- * See [JSON Schema Validation 9.1. "title" and "description"](https://tools.ietf.org/html/draft-handrews-json-schema-validation-02#section-9.1). */
1677
- description?: string | null;
1678
- /** @description The `default` keyword.
1679
- *
1680
- * See [JSON Schema Validation 9.2. "default"](https://tools.ietf.org/html/draft-handrews-json-schema-validation-02#section-9.2). */
1681
- default?: unknown;
1682
- /** @description The `deprecated` keyword.
1683
- *
1684
- * See [JSON Schema Validation 9.3. "deprecated"](https://tools.ietf.org/html/draft-handrews-json-schema-validation-02#section-9.3). */
1685
- deprecated?: boolean;
1686
- /** @description The `readOnly` keyword.
1687
- *
1688
- * See [JSON Schema Validation 9.4. "readOnly" and "writeOnly"](https://tools.ietf.org/html/draft-handrews-json-schema-validation-02#section-9.4). */
1689
- readOnly?: boolean;
1690
- /** @description The `writeOnly` keyword.
1691
- *
1692
- * See [JSON Schema Validation 9.4. "readOnly" and "writeOnly"](https://tools.ietf.org/html/draft-handrews-json-schema-validation-02#section-9.4). */
1693
- writeOnly?: boolean;
1694
- /** @description The `examples` keyword.
1695
- *
1696
- * See [JSON Schema Validation 9.5. "examples"](https://tools.ietf.org/html/draft-handrews-json-schema-validation-02#section-9.5). */
1697
- examples?: unknown[];
1698
- /** @description The `allOf` keyword.
1699
- *
1700
- * See [JSON Schema 9.2.1.1. "allOf"](https://tools.ietf.org/html/draft-handrews-json-schema-02#section-9.2.1.1). */
1701
- allOf?: components["schemas"]["Schema"][] | null;
1702
- /** @description The `anyOf` keyword.
1703
- *
1704
- * See [JSON Schema 9.2.1.2. "anyOf"](https://tools.ietf.org/html/draft-handrews-json-schema-02#section-9.2.1.2). */
1705
- anyOf?: components["schemas"]["Schema"][] | null;
1706
- /** @description The `oneOf` keyword.
1707
- *
1708
- * See [JSON Schema 9.2.1.3. "oneOf"](https://tools.ietf.org/html/draft-handrews-json-schema-02#section-9.2.1.3). */
1709
- oneOf?: components["schemas"]["Schema"][] | null;
1710
- /** @description The `not` keyword.
1711
- *
1712
- * See [JSON Schema 9.2.1.4. "not"](https://tools.ietf.org/html/draft-handrews-json-schema-02#section-9.2.1.4). */
1713
- not?: components["schemas"]["Schema"] | null;
1714
- /** @description The `if` keyword.
1715
- *
1716
- * See [JSON Schema 9.2.2.1. "if"](https://tools.ietf.org/html/draft-handrews-json-schema-02#section-9.2.2.1). */
1717
- if?: components["schemas"]["Schema"] | null;
1718
- /** @description The `then` keyword.
1719
- *
1720
- * See [JSON Schema 9.2.2.2. "then"](https://tools.ietf.org/html/draft-handrews-json-schema-02#section-9.2.2.2). */
1721
- then?: components["schemas"]["Schema"] | null;
1722
- /** @description The `else` keyword.
1723
- *
1724
- * See [JSON Schema 9.2.2.3. "else"](https://tools.ietf.org/html/draft-handrews-json-schema-02#section-9.2.2.3). */
1725
- else?: components["schemas"]["Schema"] | null;
1726
- /**
1727
- * Format: double
1728
- * @description The `multipleOf` keyword.
1729
- *
1730
- * See [JSON Schema Validation 6.2.1. "multipleOf"](https://tools.ietf.org/html/draft-handrews-json-schema-validation-02#section-6.2.1).
1731
- */
1732
- multipleOf?: number | null;
1733
- /**
1734
- * Format: double
1735
- * @description The `maximum` keyword.
1736
- *
1737
- * See [JSON Schema Validation 6.2.2. "maximum"](https://tools.ietf.org/html/draft-handrews-json-schema-validation-02#section-6.2.2).
1738
- */
1739
- maximum?: number | null;
1740
- /**
1741
- * Format: double
1742
- * @description The `exclusiveMaximum` keyword.
1743
- *
1744
- * See [JSON Schema Validation 6.2.3. "exclusiveMaximum"](https://tools.ietf.org/html/draft-handrews-json-schema-validation-02#section-6.2.3).
1745
- */
1746
- exclusiveMaximum?: number | null;
1747
- /**
1748
- * Format: double
1749
- * @description The `minimum` keyword.
1750
- *
1751
- * See [JSON Schema Validation 6.2.4. "minimum"](https://tools.ietf.org/html/draft-handrews-json-schema-validation-02#section-6.2.4).
1752
- */
1753
- minimum?: number | null;
1754
- /**
1755
- * Format: double
1756
- * @description The `exclusiveMinimum` keyword.
1757
- *
1758
- * See [JSON Schema Validation 6.2.5. "exclusiveMinimum"](https://tools.ietf.org/html/draft-handrews-json-schema-validation-02#section-6.2.5).
1759
- */
1760
- exclusiveMinimum?: number | null;
1761
- /**
1762
- * Format: uint32
1763
- * @description The `maxLength` keyword.
1764
- *
1765
- * See [JSON Schema Validation 6.3.1. "maxLength"](https://tools.ietf.org/html/draft-handrews-json-schema-validation-02#section-6.3.1).
1766
- */
1767
- maxLength?: number | null;
1768
- /**
1769
- * Format: uint32
1770
- * @description The `minLength` keyword.
1771
- *
1772
- * See [JSON Schema Validation 6.3.2. "minLength"](https://tools.ietf.org/html/draft-handrews-json-schema-validation-02#section-6.3.2).
1773
- */
1774
- minLength?: number | null;
1775
- /** @description The `pattern` keyword.
1776
- *
1777
- * See [JSON Schema Validation 6.3.3. "pattern"](https://tools.ietf.org/html/draft-handrews-json-schema-validation-02#section-6.3.3). */
1778
- pattern?: string | null;
1779
- /** @description The `items` keyword.
1780
- *
1781
- * See [JSON Schema 9.3.1.1. "items"](https://tools.ietf.org/html/draft-handrews-json-schema-02#section-9.3.1.1). */
1782
- items?: components["schemas"]["SingleOrVec_for_Schema"] | null;
1783
- /** @description The `additionalItems` keyword.
1784
- *
1785
- * See [JSON Schema 9.3.1.2. "additionalItems"](https://tools.ietf.org/html/draft-handrews-json-schema-02#section-9.3.1.2). */
1786
- additionalItems?: components["schemas"]["Schema"] | null;
1787
- /**
1788
- * Format: uint32
1789
- * @description The `maxItems` keyword.
1790
- *
1791
- * See [JSON Schema Validation 6.4.1. "maxItems"](https://tools.ietf.org/html/draft-handrews-json-schema-validation-02#section-6.4.1).
1792
- */
1793
- maxItems?: number | null;
1794
- /**
1795
- * Format: uint32
1796
- * @description The `minItems` keyword.
1797
- *
1798
- * See [JSON Schema Validation 6.4.2. "minItems"](https://tools.ietf.org/html/draft-handrews-json-schema-validation-02#section-6.4.2).
1799
- */
1800
- minItems?: number | null;
1801
- /** @description The `uniqueItems` keyword.
1802
- *
1803
- * See [JSON Schema Validation 6.4.3. "uniqueItems"](https://tools.ietf.org/html/draft-handrews-json-schema-validation-02#section-6.4.3). */
1804
- uniqueItems?: boolean | null;
1805
- /** @description The `contains` keyword.
1806
- *
1807
- * See [JSON Schema 9.3.1.4. "contains"](https://tools.ietf.org/html/draft-handrews-json-schema-02#section-9.3.1.4). */
1808
- contains?: components["schemas"]["Schema"] | null;
1809
- /**
1810
- * Format: uint32
1811
- * @description The `maxProperties` keyword.
1812
- *
1813
- * See [JSON Schema Validation 6.5.1. "maxProperties"](https://tools.ietf.org/html/draft-handrews-json-schema-validation-02#section-6.5.1).
1814
- */
1815
- maxProperties?: number | null;
1816
- /**
1817
- * Format: uint32
1818
- * @description The `minProperties` keyword.
1819
- *
1820
- * See [JSON Schema Validation 6.5.2. "minProperties"](https://tools.ietf.org/html/draft-handrews-json-schema-validation-02#section-6.5.2).
1821
- */
1822
- minProperties?: number | null;
1823
- /** @description The `required` keyword.
1824
- *
1825
- * See [JSON Schema Validation 6.5.3. "required"](https://tools.ietf.org/html/draft-handrews-json-schema-validation-02#section-6.5.3). */
1826
- required?: string[];
1827
- /** @description The `properties` keyword.
1828
- *
1829
- * See [JSON Schema 9.3.2.1. "properties"](https://tools.ietf.org/html/draft-handrews-json-schema-02#section-9.3.2.1). */
1830
- properties?: {
1831
- [key: string]: components["schemas"]["Schema"];
1832
- };
1833
- /** @description The `patternProperties` keyword.
1834
- *
1835
- * See [JSON Schema 9.3.2.2. "patternProperties"](https://tools.ietf.org/html/draft-handrews-json-schema-02#section-9.3.2.2). */
1836
- patternProperties?: {
1837
- [key: string]: components["schemas"]["Schema"];
1838
- };
1839
- /** @description The `additionalProperties` keyword.
1840
- *
1841
- * See [JSON Schema 9.3.2.3. "additionalProperties"](https://tools.ietf.org/html/draft-handrews-json-schema-02#section-9.3.2.3). */
1842
- additionalProperties?: components["schemas"]["Schema"] | null;
1843
- /** @description The `propertyNames` keyword.
1844
- *
1845
- * See [JSON Schema 9.3.2.5. "propertyNames"](https://tools.ietf.org/html/draft-handrews-json-schema-02#section-9.3.2.5). */
1846
- propertyNames?: components["schemas"]["Schema"] | null;
1847
- } & {
1848
- [key: string]: unknown;
1849
- };
1850
- /** @description A type which can be serialized as a single item, or multiple items.
1851
- *
1852
- * In some contexts, a `Single` may be semantically distinct from a `Vec` containing only item. */
1853
- SingleOrVec_for_InstanceType: components["schemas"]["InstanceType"] | components["schemas"]["InstanceType"][];
1854
- /**
1855
- * @description The possible types of values in JSON Schema documents.
1856
- *
1857
- * See [JSON Schema 4.2.1. Instance Data Model](https://tools.ietf.org/html/draft-handrews-json-schema-02#section-4.2.1).
1858
- * @enum {string}
1859
- */
1860
- InstanceType: "null" | "boolean" | "object" | "array" | "number" | "string" | "integer";
1861
- /** @description A JSON Schema. */
1862
- Schema: boolean | components["schemas"]["SchemaObject2"];
1863
- /** @description A type which can be serialized as a single item, or multiple items.
1864
- *
1865
- * In some contexts, a `Single` may be semantically distinct from a `Vec` containing only item. */
1866
- SingleOrVec_for_Schema: components["schemas"]["Schema"] | components["schemas"]["Schema"][];
1867
- MediaType: {
1868
- schema?: components["schemas"]["SchemaObject"] | null;
1869
- example?: unknown;
1870
- examples?: {
1871
- [key: string]: components["schemas"]["ReferenceOr_for_Example"];
1872
- };
1873
- encoding?: {
1874
- [key: string]: components["schemas"]["Encoding"];
1875
- };
1876
- } & {
1877
- [key: string]: unknown;
1878
- };
1879
- /** @description A single encoding definition applied to a single schema property. */
1880
- Encoding: {
1881
- /** @description The Content-Type for encoding a specific property. Default value depends on the property type: for object - application/json; for array – the default is defined based on the inner type. for all other cases the default is `application/octet-stream`. The value can be a specific media type (e.g. application/json), a wildcard media type (e.g. image/*), or a comma-separated list of the two types. */
1882
- contentType?: string | null;
1883
- /** @description A map allowing additional information to be provided as headers, for example Content-Disposition. Content-Type is described separately and SHALL be ignored in this section. This property SHALL be ignored if the request body media type is not a multipart. */
1884
- headers?: {
1885
- [key: string]: components["schemas"]["ReferenceOr_for_Header"];
1886
- };
1887
- /** @description Describes how a specific property value will be serialized depending on its type. See Parameter Object for details on the style property. The behavior follows the same values as query parameters, including default values. This property SHALL be ignored if the request body media type is not application/x-www-form-urlencoded or multipart/form-data. If a value is explicitly defined, then the value of `contentType` (implicit or explicit) SHALL be ignored. */
1888
- style?: components["schemas"]["QueryStyle"] | null;
1889
- /** @description When this is true, property values of type array or object generate separate parameters for each value of the array, or key-value-pair of the map. For other types of properties this property has no effect. When style is form, the default value is true. For all other styles, the default value is false. This property SHALL be ignored if the request body media type is not application/x-www-form-urlencoded or multipart/form-data. If a value is explicitly defined, then the value of `contentType` (implicit or explicit) SHALL be ignored.
1890
- *
1891
- * In this Library this value defaults to false always despite the specification. */
1892
- explode?: boolean;
1893
- /** @description Determines whether the parameter value SHOULD allow reserved characters, as defined by RFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default value is false. This property SHALL be ignored if the request body media type is not application/x-www-form-urlencoded or multipart/form-data. If a value is explicitly defined, then the value of `contentType` (implicit or explicit) SHALL be ignored. */
1894
- allowReserved?: boolean;
1895
- } & {
1896
- [key: string]: unknown;
1897
- };
1898
- ReferenceOr_for_Header: {
1899
- /** @description REQUIRED. The reference identifier. This MUST be in the form of a URI. */
1900
- $ref: string;
1901
- /** @description A short summary which by default SHOULD override that of the referenced component. If the referenced object-type does not allow a `summary` field, then this field has no effect. */
1902
- summary?: string | null;
1903
- /** @description A description which by default SHOULD override that of the referenced component. CommonMark syntax MAY be used for rich text representation. If the referenced object-type does not allow a `description` field, then this field has no effect. */
1904
- description?: string | null;
1905
- } | components["schemas"]["Header"];
1906
- /** @description The Header Object follows the structure of the Parameter Object with the following changes:
1907
- *
1908
- * 1) name MUST NOT be specified, it is given in the corresponding headers map. 2) in MUST NOT be specified, it is implicitly in header. 3) All traits that are affected by the location MUST be applicable to a location of header (for example, style). */
1909
- Header: ({
1910
- /** @description A brief description of the parameter. This could contain examples of use. CommonMark syntax MAY be used for rich text representation. */
1911
- description?: string | null;
1912
- /** @default simple */
1913
- style: components["schemas"]["HeaderStyle"];
1914
- /** @description Determines whether this parameter is mandatory. If the parameter location is "path", this property is REQUIRED and its value MUST be true. Otherwise, the property MAY be included and its default value is false. */
1915
- required?: boolean;
1916
- /** @description Specifies that a parameter is deprecated and SHOULD be transitioned out of usage. */
1917
- deprecated?: boolean | null;
1918
- example?: unknown;
1919
- examples?: {
1920
- [key: string]: components["schemas"]["ReferenceOr_for_Example"];
1921
- };
1922
- } & {
1923
- [key: string]: unknown;
1924
- }) & ({
1925
- schema: components["schemas"]["SchemaObject"];
1926
- } | {
1927
- content: {
1928
- [key: string]: components["schemas"]["MediaType"];
1929
- };
1930
- });
1931
- /** @enum {string} */
1932
- HeaderStyle: "simple";
1933
- /** @enum {string} */
1934
- PathStyle: "matrix" | "label" | "simple";
1935
- /** @enum {string} */
1936
- CookieStyle: "form";
1937
- ReferenceOr_for_RequestBody: {
1938
- /** @description REQUIRED. The reference identifier. This MUST be in the form of a URI. */
1939
- $ref: string;
1940
- /** @description A short summary which by default SHOULD override that of the referenced component. If the referenced object-type does not allow a `summary` field, then this field has no effect. */
1941
- summary?: string | null;
1942
- /** @description A description which by default SHOULD override that of the referenced component. CommonMark syntax MAY be used for rich text representation. If the referenced object-type does not allow a `description` field, then this field has no effect. */
1943
- description?: string | null;
1944
- } | components["schemas"]["RequestBody"];
1945
- RequestBody: {
1946
- /** @description A brief description of the request body. This could contain examples of use. CommonMark syntax MAY be used for rich text representation. */
1947
- description?: string | null;
1948
- /** @description REQUIRED. The content of the request body. The key is a media type or media type range and the value describes it. For requests that match multiple keys, only the most specific key is applicable. e.g. text/plain overrides text/* */
1949
- content?: {
1950
- [key: string]: components["schemas"]["MediaType"];
1951
- };
1952
- /** @description Determines if the request body is required in the request. Defaults to false. */
1953
- required?: boolean;
1954
- } & {
1955
- [key: string]: unknown;
1956
- };
1957
- Responses: {
1958
- /** @description The documentation of responses other than the ones declared for specific HTTP response codes. Use this field to cover undeclared responses. */
1959
- default?: components["schemas"]["ReferenceOr_for_Response"] | null;
1960
- } & {
1961
- [key: string]: unknown;
1962
- };
1963
- ReferenceOr_for_Response: {
1964
- /** @description REQUIRED. The reference identifier. This MUST be in the form of a URI. */
1965
- $ref: string;
1966
- /** @description A short summary which by default SHOULD override that of the referenced component. If the referenced object-type does not allow a `summary` field, then this field has no effect. */
1967
- summary?: string | null;
1968
- /** @description A description which by default SHOULD override that of the referenced component. CommonMark syntax MAY be used for rich text representation. If the referenced object-type does not allow a `description` field, then this field has no effect. */
1969
- description?: string | null;
1970
- } | components["schemas"]["Response"];
1971
- Response: {
1972
- /** @description REQUIRED. A description of the response. CommonMark syntax MAY be used for rich text representation. */
1973
- description: string;
1974
- /** @description Maps a header name to its definition. RFC7230 states header names are case insensitive. If a response header is defined with the name "Content-Type", it SHALL be ignored. */
1975
- headers?: {
1976
- [key: string]: components["schemas"]["ReferenceOr_for_Header"];
1977
- };
1978
- /** @description A map containing descriptions of potential response payloads. The key is a media type or media type range and the value describes it. For responses that match multiple keys, only the most specific key is applicable. e.g. text/plain overrides text/* */
1979
- content?: {
1980
- [key: string]: components["schemas"]["MediaType"];
1981
- };
1982
- /** @description A map of operations links that can be followed from the response. The key of the map is a short name for the link, following the naming constraints of the names for Component Objects. */
1983
- links?: {
1984
- [key: string]: components["schemas"]["ReferenceOr_for_Link"];
1985
- };
1986
- } & {
1987
- [key: string]: unknown;
1988
- };
1989
- ReferenceOr_for_Link: {
1990
- /** @description REQUIRED. The reference identifier. This MUST be in the form of a URI. */
1991
- $ref: string;
1992
- /** @description A short summary which by default SHOULD override that of the referenced component. If the referenced object-type does not allow a `summary` field, then this field has no effect. */
1993
- summary?: string | null;
1994
- /** @description A description which by default SHOULD override that of the referenced component. CommonMark syntax MAY be used for rich text representation. If the referenced object-type does not allow a `description` field, then this field has no effect. */
1995
- description?: string | null;
1996
- } | components["schemas"]["Link"];
1997
- /** @description The Link object represents a possible design-time link for a response. The presence of a link does not guarantee the caller's ability to successfully invoke it, rather it provides a known relationship and traversal mechanism between responses and other operations.
1998
- *
1999
- * Unlike dynamic links (i.e. links provided in the response payload), the OAS linking mechanism does not require link information in the runtime response.
2000
- *
2001
- * For computing links, and providing instructions to execute them, a runtime expression is used for accessing values in an operation and using them as parameters while invoking the linked operation. */
2002
- Link: ({
2003
- /** @description A description of the link. CommonMark syntax MAY be used for rich text representation. */
2004
- description?: string | null;
2005
- /** @description A literal value or {expression} to use as a request body when calling the target operation. */
2006
- requestBody?: unknown;
2007
- /** @description A map representing parameters to pass to an operation as specified with operationId or identified via operationRef. The key is the parameter name to be used, whereas the value can be a constant or an expression to be evaluated and passed to the linked operation. The parameter name can be qualified using the parameter location [{in}.]{name} for operations that use the same parameter name in different locations (e.g. path.id). */
2008
- parameters?: {
2009
- [key: string]: unknown;
2010
- };
2011
- /** @description A server object to be used by the target operation. */
2012
- server?: components["schemas"]["Server"] | null;
2013
- } & {
2014
- [key: string]: unknown;
2015
- }) & ({
2016
- operationRef: string;
2017
- } | {
2018
- operationId: string;
2019
- });
2020
- ReferenceOr_for_Map_of_ReferenceOr_for_PathItem: {
2021
- /** @description REQUIRED. The reference identifier. This MUST be in the form of a URI. */
2022
- $ref: string;
2023
- /** @description A short summary which by default SHOULD override that of the referenced component. If the referenced object-type does not allow a `summary` field, then this field has no effect. */
2024
- summary?: string | null;
2025
- /** @description A description which by default SHOULD override that of the referenced component. CommonMark syntax MAY be used for rich text representation. If the referenced object-type does not allow a `description` field, then this field has no effect. */
2026
- description?: string | null;
2027
- } | {
2028
- [key: string]: components["schemas"]["ReferenceOr_for_PathItem"];
2029
- };
2030
- /** @description Holds a set of reusable objects for different aspects of the OAS. All objects defined within the components object will have no effect on the API unless they are explicitly referenced from properties outside the components object. */
2031
- Components: {
2032
- /** @description An object to hold reusable Security Scheme Objects. */
2033
- securitySchemes?: {
2034
- [key: string]: components["schemas"]["ReferenceOr_for_SecurityScheme"];
2035
- };
2036
- /** @description An object to hold reusable Response Objects. */
2037
- responses?: {
2038
- [key: string]: components["schemas"]["ReferenceOr_for_Response"];
2039
- };
2040
- /** @description An object to hold reusable Parameter Objects. */
2041
- parameters?: {
2042
- [key: string]: components["schemas"]["ReferenceOr_for_Parameter"];
2043
- };
2044
- /** @description An object to hold reusable Example Objects. */
2045
- examples?: {
2046
- [key: string]: components["schemas"]["ReferenceOr_for_Example"];
2047
- };
2048
- /** @description An object to hold reusable Request Body Objects. */
2049
- requestBodies?: {
2050
- [key: string]: components["schemas"]["ReferenceOr_for_RequestBody"];
2051
- };
2052
- /** @description An object to hold reusable Header Objects. */
2053
- headers?: {
2054
- [key: string]: components["schemas"]["ReferenceOr_for_Header"];
2055
- };
2056
- /** @description An object to hold reusable Schema Objects. */
2057
- schemas?: {
2058
- [key: string]: components["schemas"]["SchemaObject"];
2059
- };
2060
- /** @description An object to hold reusable Link Objects. */
2061
- links?: {
2062
- [key: string]: components["schemas"]["ReferenceOr_for_Link"];
2063
- };
2064
- /** @description An object to hold reusable Callback Objects. */
2065
- callbacks?: {
2066
- [key: string]: components["schemas"]["ReferenceOr_for_Map_of_ReferenceOr_for_PathItem"];
2067
- };
2068
- /** @description An object to hold reusable Path Item Objects. */
2069
- pathItems?: {
2070
- [key: string]: components["schemas"]["ReferenceOr_for_PathItem"];
2071
- };
2072
- } & {
2073
- [key: string]: unknown;
2074
- };
2075
- ReferenceOr_for_SecurityScheme: {
2076
- /** @description REQUIRED. The reference identifier. This MUST be in the form of a URI. */
2077
- $ref: string;
2078
- /** @description A short summary which by default SHOULD override that of the referenced component. If the referenced object-type does not allow a `summary` field, then this field has no effect. */
2079
- summary?: string | null;
2080
- /** @description A description which by default SHOULD override that of the referenced component. CommonMark syntax MAY be used for rich text representation. If the referenced object-type does not allow a `description` field, then this field has no effect. */
2081
- description?: string | null;
2082
- } | components["schemas"]["SecurityScheme"];
2083
- /** @description Defines a security scheme that can be used by the operations. Supported schemes are HTTP authentication, an API key (either as a header or as a query parameter), OAuth2's common flows (implicit, password, application and access code) as defined in RFC6749, and OpenID Connect Discovery. */
2084
- SecurityScheme: ({
2085
- /** @enum {string} */
2086
- type: "apiKey";
2087
- in: components["schemas"]["ApiKeyLocation"];
2088
- name: string;
2089
- description?: string | null;
2090
- } & {
2091
- [key: string]: unknown;
2092
- }) | ({
2093
- /** @enum {string} */
2094
- type: "http";
2095
- scheme: string;
2096
- bearerFormat?: string | null;
2097
- description?: string | null;
2098
- } & {
2099
- [key: string]: unknown;
2100
- }) | ({
2101
- /** @enum {string} */
2102
- type: "oauth2";
2103
- flows: components["schemas"]["OAuth2Flows"];
2104
- description?: string | null;
2105
- } & {
2106
- [key: string]: unknown;
2107
- }) | ({
2108
- /** @enum {string} */
2109
- type: "openIdConnect";
2110
- openIdConnectUrl: string;
2111
- description?: string | null;
2112
- } & {
2113
- [key: string]: unknown;
2114
- }) | ({
2115
- /** @enum {string} */
2116
- type: "mutualTLS";
2117
- description?: string | null;
2118
- } & {
2119
- [key: string]: unknown;
2120
- });
2121
- /** @enum {string} */
2122
- ApiKeyLocation: "query" | "header" | "cookie";
2123
- OAuth2Flows: {
2124
- implicit: {
2125
- authorizationUrl: string;
2126
- refreshUrl?: string | null;
2127
- /** @default {} */
2128
- scopes: {
2129
- [key: string]: string;
2130
- };
2131
- };
2132
- } | {
2133
- password: {
2134
- refreshUrl?: string | null;
2135
- tokenUrl: string;
2136
- /** @default {} */
2137
- scopes: {
2138
- [key: string]: string;
2139
- };
2140
- };
2141
- } | {
2142
- clientCredentials: {
2143
- refreshUrl?: string | null;
2144
- tokenUrl: string;
2145
- /** @default {} */
2146
- scopes: {
2147
- [key: string]: string;
2148
- };
2149
- };
2150
- } | {
2151
- authorizationCode: {
2152
- authorizationUrl: string;
2153
- tokenUrl: string;
2154
- refreshUrl?: string | null;
2155
- /** @default {} */
2156
- scopes: {
2157
- [key: string]: string;
2158
- };
2159
- };
2160
- };
2161
- /** @description Adds metadata to a single tag that is used by the Operation Object. It is not mandatory to have a Tag Object per tag defined in the Operation Object instances. */
2162
- Tag: {
2163
- /** @description REQUIRED. The name of the tag. */
2164
- name: string;
2165
- /** @description A description for the tag. CommonMark syntax MAY be used for rich text representation. */
2166
- description?: string | null;
2167
- /** @description Additional external documentation for this tag. */
2168
- externalDocs?: components["schemas"]["ExternalDocumentation"] | null;
2169
- } & {
2170
- [key: string]: unknown;
2171
- };
2172
- MarketsInfo: {
2173
- markets: components["schemas"]["MarketInfo"][];
2174
- tokens: components["schemas"]["TokenInfo"][];
2175
- };
2176
- MarketInfo: {
2177
- /** Format: uint32 */
2178
- marketId: number;
2179
- symbol: string;
2180
- /** Format: uint8 */
2181
- priceDecimals: number;
2182
- /** Format: uint8 */
2183
- sizeDecimals: number;
2184
- /** Format: uint32 */
2185
- baseTokenId: number;
2186
- /** Format: uint32 */
2187
- quoteTokenId: number;
2188
- /** Format: double */
2189
- imf: number;
2190
- /** Format: double */
2191
- mmf: number;
2192
- /** Format: double */
2193
- cmf: number;
2194
- };
2195
- TokenInfo: {
2196
- /** Format: uint32 */
2197
- tokenId: number;
2198
- symbol: string;
2199
- /** Format: uint8 */
2200
- decimals: number;
2201
- mintAddr: string;
2202
- /** Format: uint16 */
2203
- weightBps: number;
2204
- };
2205
- AcceptedMediaType: {
2206
- expected: string;
2207
- };
2208
- PayloadTooLarge: {
2209
- /** Format: uint */
2210
- limit: number;
2211
- };
2212
- ActionsQuery: {
2213
- /**
2214
- * Format: uint64
2215
- * @description Start action ID (exclusive)
2216
- */
2217
- from: number;
2218
- /**
2219
- * Format: uint64
2220
- * @description End action ID (inclusive)
2221
- */
2222
- to: number;
2223
- /** @description Optionally provided binary version of client, so nord server can ensure all actions provided are executable by client. */
2224
- clientVersion?: components["schemas"]["ExecutableVersion"] | null;
2225
- };
2226
- ExecutableVersion: string;
2227
- ActionsItem: {
2228
- /** Format: uint64 */
2229
- actionId: number;
2230
- physicalTime: string;
2231
- payload: string;
2232
- };
2233
- RangeTooLarge: {
2234
- /** Format: uint64 */
2235
- requested: number;
2236
- /** Format: uint16 */
2237
- maximal: number;
2238
- };
2239
- NotImplemented: {
2240
- /** @description Human readable message describing what to expect next. */
2241
- message: string;
2242
- };
2243
- ActionNotFound: null;
2244
- /** @description Returns fee parts per market per balance change per action per account. Fee is taken from user without return. Please note that some operations need some deposit which will be returned - these are not part of fees. */
2245
- FillRole: "maker" | "taker";
2246
- UserNotFound: null;
2247
- OrderbookInfo: {
2248
- /** Format: uint64 */
2249
- updateId: number;
2250
- asks: [
2251
- number,
2252
- number
2253
- ][];
2254
- bids: [
2255
- number,
2256
- number
2257
- ][];
2258
- asksSummary: components["schemas"]["SideSummary"];
2259
- bidsSummary: components["schemas"]["SideSummary"];
2260
- };
2261
- SideSummary: {
2262
- /** Format: double */
2263
- sum: number;
2264
- /** Format: uint32 */
2265
- count: number;
2266
- };
2267
- MarketNotFound: {
2268
- /** Format: uint32 */
2269
- market_id: number;
2270
- };
2271
- MarketStats: {
2272
- /** Format: double */
2273
- indexPrice: number;
2274
- /** Format: double */
2275
- indexPriceConf: number;
2276
- frozen?: boolean;
2277
- /** Format: double */
2278
- volume24h: number;
2279
- /** Format: double */
2280
- high24h: number;
2281
- /** Format: double */
2282
- low24h: number;
2283
- perpStats?: components["schemas"]["PerpMarketStats"] | null;
2284
- };
2285
- PerpMarketStats: {
2286
- /** Format: double */
2287
- mark_price?: number | null;
2288
- /** Format: double */
2289
- aggregated_funding_index: number;
2290
- /** Format: double */
2291
- funding_rate: number;
2292
- next_funding_time: string;
2293
- /** Format: double */
2294
- open_interest: number;
2295
- };
2296
- TokenStats: {
2297
- symbol: string;
2298
- /** Format: uint8 */
2299
- decimals: number;
2300
- mintAddr: string;
2301
- /** Format: uint16 */
2302
- weightBps: number;
2303
- oracleSymbol: string;
2304
- /** @description Index price for the token */
2305
- indexPrice?: components["schemas"]["TokenPrice"] | null;
2306
- };
2307
- TokenPrice: {
2308
- /** Format: double */
2309
- median: number;
2310
- /** Format: double */
2311
- confidence: number;
2312
- };
2313
- TokenNotFound: null;
2314
- User: {
2315
- accountIds: number[];
2316
- sessions: {
2317
- [key: string]: components["schemas"]["UserSession"];
2318
- };
2319
- };
2320
- UserSession: {
2321
- pubkey: string;
2322
- expiry: string;
2323
- };
2324
- PageQueryPart_for_String: {
2325
- /** @description fetch results starting with this page; query starts with first entry if page isn't specified */
2326
- startInclusive?: string | null;
2327
- /**
2328
- * Format: uint8
2329
- * @description Query returns up to 50 trades in one go.
2330
- * @default null
2331
- */
2332
- pageSize: number | null;
2333
- };
2334
- PageResult_for_String_and_OrderInfo: {
2335
- /** @description Set of items for requested by query. */
2336
- items: components["schemas"]["OrderInfo"][];
2337
- /** @description If request contains more data, this is the id is set with which next request should be performed to get next page. If no more data, then it is undefined. */
2338
- nextStartInclusive?: string | null;
2339
- };
2340
- /** @description Order summary. Use order_id to application side join with trades as needed. */
2341
- OrderInfo: {
2342
- addedAt: string;
2343
- updatedAt: string;
2344
- tradeId: string;
2345
- /** Format: uint32 */
2346
- traderId: number;
2347
- /** Format: uint32 */
2348
- marketId: number;
2349
- orderId: string;
2350
- side: components["schemas"]["Side"];
2351
- /** Format: double */
2352
- placedSize: number;
2353
- /** Format: double */
2354
- filledSize?: number | null;
2355
- /** Format: uint64 */
2356
- updateActionId: number;
2357
- isReduceOnly: boolean;
2358
- fillMode: components["schemas"]["FillMode"];
2359
- /** Format: double */
2360
- placedPrice: number;
2361
- /** Format: double */
2362
- originalSizeLimit?: number | null;
2363
- /** Format: double */
2364
- originalPriceLimit?: number | null;
2365
- placementOrigin: components["schemas"]["PlacementOrigin"];
2366
- finalizationReason?: components["schemas"]["FinalizationReason"] | null;
2367
- marketSymbol: string;
2368
- tokenSymbol: string;
2369
- };
2370
- Side: "ask" | "bid";
2371
- FillMode: "Limit" | "PostOnly" | "ImmediateOrCancel" | "FillOrKill";
2372
- /** @enum {string} */
2373
- PlacementOrigin: "User" | "Trigger" | "Liquidation";
2374
- /** @enum {string} */
2375
- FinalizationReason: "Filled" | "Canceled" | "Taken";
2376
- Account: {
2377
- /** Format: uint64 */
2378
- updateId: number;
2379
- orders: components["schemas"]["OpenOrder"][];
2380
- positions: components["schemas"]["PositionSummary"][];
2381
- balances: components["schemas"]["Balance"][];
2382
- margins: components["schemas"]["AccountMarginsView"];
2383
- };
2384
- OpenOrder: {
2385
- orderId: string;
2386
- /** Format: uint32 */
2387
- marketId: number;
2388
- side: components["schemas"]["Side"];
2389
- /** Format: double */
2390
- size: number;
2391
- /** Format: double */
2392
- price: number;
2393
- /** Format: double */
2394
- originalOrderSize: number;
2395
- /** Format: uint64 */
2396
- clientOrderId?: number | null;
2397
- };
2398
- /** @description Summary of position. Does not provide details information about specific orders. */
2399
- PositionSummary: {
2400
- /** Format: uint32 */
2401
- marketId: number;
2402
- /** Format: uint16 */
2403
- openOrders: number;
2404
- perp?: components["schemas"]["PerpPosition"] | null;
2405
- /** Format: uint64 */
2406
- actionId: number;
2407
- };
2408
- PerpPosition: {
2409
- /** Format: double */
2410
- baseSize: number;
2411
- /** Format: double */
2412
- price: number;
2413
- /** Format: double */
2414
- updatedFundingRateIndex: number;
2415
- /**
2416
- * Format: double
2417
- * @description In stable coin, USDC
2418
- */
2419
- fundingPaymentPnl: number;
2420
- /**
2421
- * Format: double
2422
- * @description In stable coin, USDC
2423
- */
2424
- sizePricePnl: number;
2425
- isLong: boolean;
2426
- };
2427
- Balance: {
2428
- /** Format: uint32 */
2429
- tokenId: number;
2430
- token: string;
2431
- /** Format: double */
2432
- amount: number;
2433
- };
2434
- /** @description Represents account health state. Each field expressed in USD basis points per account. For example: - value of 1.0000 means 1 USD. - value of 123.0004 means 123 USD and 0.04 cent.
2435
- *
2436
- * All values are actual only at specific moment in time - because both market and oracle prices fluctuate all the time */
2437
- AccountMarginsView: {
2438
- /**
2439
- * Format: double
2440
- * @description Somewhat proportional to USD weighted value of account, its tokens and positive PnL; sub negative PnL, debt.
2441
- *
2442
- * See MARKETS.md for details. Specifically have MF as basis points, divide by `pn`
2443
- */
2444
- omf: number;
2445
- /**
2446
- * Format: double
2447
- * @description Similar to OMF. See distinguishing in MARKETS.md.
2448
- *
2449
- * Specifically have MF as basis points, divide by `pon`.
2450
- */
2451
- mf: number;
2452
- /**
2453
- * Format: double
2454
- * @description Compare with OMF. Divide by PON to get basis points value. Tells when account may or may not open orders.
2455
- */
2456
- imf: number;
2457
- /**
2458
- * Format: double
2459
- * @description Compare with OMF. Divide by PON to get basis points value. Tells when account's orders to be cancelled.
2460
- */
2461
- cmf: number;
2462
- /**
2463
- * Format: double
2464
- * @description Compare with MF. Divide by PON to get basis points value. Tells when account positions reduced and assets sold.
2465
- */
2466
- mmf: number;
2467
- /**
2468
- * Format: double
2469
- * @description Expressed in USD, can be zero. See PON in MARKETS.md for details. Somewhat proportional to open position size and orders size in OB.
2470
- */
2471
- pon: number;
2472
- /**
2473
- * Format: double
2474
- * @description Similar to `pon`. See PN in MARKETS.md.
2475
- */
2476
- pn: number;
2477
- /** @description See `bankruptcy` in MARKETS.md. In general happens if account does not have enough weighted tokens to covert his debt and negative PnL. */
2478
- bankruptcy: boolean;
2479
- };
2480
- AccountPnlQuery: {
2481
- /**
2482
- * @description start with this timestamp (RFC3339); defaults to UNIX epoch start
2483
- * @default null
2484
- */
2485
- since: string;
2486
- /**
2487
- * @description end with this timestamp (RFC3339); defaults to current date-time
2488
- * @default null
2489
- */
2490
- until: string;
2491
- /**
2492
- * Format: uint64
2493
- * @description fetch results starting with this page; query starts with first entry if page isn't specified
2494
- */
2495
- startInclusive?: number | null;
2496
- /**
2497
- * Format: uint8
2498
- * @description Query returns up to 50 trades in one go.
2499
- * @default null
2500
- */
2501
- pageSize: number | null;
2502
- };
2503
- PageResult_for_uint64_and_AccountPnl: {
2504
- /** @description Set of items for requested by query. */
2505
- items: components["schemas"]["AccountPnl"][];
2506
- /**
2507
- * Format: uint64
2508
- * @description If request contains more data, this is the id is set with which next request should be performed to get next page. If no more data, then it is undefined.
2509
- */
2510
- nextStartInclusive?: number | null;
2511
- };
2512
- AccountPnl: {
2513
- time: string;
2514
- /** Format: uint64 */
2515
- actionId: number;
2516
- /** Format: uint32 */
2517
- accountId: number;
2518
- /** Format: double */
2519
- pnl: number;
2520
- };
2521
- AccountTriggersQuery: {
2522
- /**
2523
- * @description start with this timestamp (RFC3339); defaults to UNIX epoch start
2524
- * @default null
2525
- */
2526
- since: string;
2527
- /**
2528
- * @description end with this timestamp (RFC3339); defaults to current date-time
2529
- * @default null
2530
- */
2531
- until: string;
2532
- /**
2533
- * Format: uint64
2534
- * @description fetch results starting with this page; query starts with first entry if page isn't specified
2535
- */
2536
- startInclusive?: number | null;
2537
- /**
2538
- * Format: uint8
2539
- * @description Query returns up to 50 trades in one go.
2540
- * @default null
2541
- */
2542
- pageSize: number | null;
2543
- };
2544
- PageResult_for_uint64_and_HistoryTriggerInfo: {
2545
- /** @description Set of items for requested by query. */
2546
- items: components["schemas"]["HistoryTriggerInfo"][];
2547
- /**
2548
- * Format: uint64
2549
- * @description If request contains more data, this is the id is set with which next request should be performed to get next page. If no more data, then it is undefined.
2550
- */
2551
- nextStartInclusive?: number | null;
2552
- };
2553
- HistoryTriggerInfo: {
2554
- /** Format: uint32 */
2555
- accountId: number;
2556
- /** Format: uint32 */
2557
- marketId: number;
2558
- /** Format: uint64 */
2559
- price: number;
2560
- side: components["schemas"]["Side"];
2561
- kind: components["schemas"]["TriggerKind"];
2562
- status: components["schemas"]["TriggerStatus"];
2563
- /** Format: uint64 */
2564
- createdAtActionId: number;
2565
- /** Format: uint64 */
2566
- finalizedAtActionId?: number | null;
2567
- createdAt: string;
2568
- finalizedAt: string;
2569
- };
2570
- /** @enum {string} */
2571
- TriggerKind: "stopLoss" | "takeProfit";
2572
- /** @enum {string} */
2573
- TriggerStatus: "Active" | "Success" | "Removed" | "Canceled";
2574
- /** @description Trigger into per account. */
2575
- AccountTriggerInfo: {
2576
- /** Format: uint32 */
2577
- marketId: number;
2578
- key: components["schemas"]["TriggerKey"];
2579
- triggerPrices: components["schemas"]["TriggerPrice"];
2580
- /** Format: uint64 */
2581
- actionId: number;
2582
- };
2583
- TriggerKey: {
2584
- side: components["schemas"]["Side"];
2585
- kind: components["schemas"]["TriggerKind"];
2586
- };
2587
- TriggerPrice: {
2588
- trigger: components["schemas"]["PositivePriceMantissa"];
2589
- settlement?: components["schemas"]["PositivePriceMantissa"] | null;
2590
- };
2591
- /**
2592
- * Format: uint64
2593
- * @description 63 bit integer, which is always positive
2594
- */
2595
- PositivePriceMantissa: number;
2596
- OrderNotFound: null;
2597
- PageResult_for_String_and_Trade: {
2598
- /** @description Set of items for requested by query. */
2599
- items: components["schemas"]["Trade"][];
2600
- /** @description If request contains more data, this is the id is set with which next request should be performed to get next page. If no more data, then it is undefined. */
2601
- nextStartInclusive?: string | null;
2602
- };
2603
- Trade: {
2604
- time: string;
2605
- actionId: string;
2606
- tradeId: string;
2607
- /** Format: uint32 */
2608
- takerId: number;
2609
- takerSide: components["schemas"]["Side"];
2610
- /** Format: uint32 */
2611
- makerId: number;
2612
- /** Format: uint32 */
2613
- marketId: number;
2614
- orderId: string;
2615
- /** Format: double */
2616
- price: number;
2617
- /** Format: double */
2618
- baseSize: number;
2619
- };
2620
- TradesQuery: {
2621
- /**
2622
- * Format: uint32
2623
- * @default null
2624
- */
2625
- takerId: number | null;
2626
- /** @default null */
2627
- takerSide: components["schemas"]["Side"] | null;
2628
- /**
2629
- * Format: uint32
2630
- * @default null
2631
- */
2632
- makerId: number | null;
2633
- /**
2634
- * Format: uint32
2635
- * @default null
2636
- */
2637
- marketId: number | null;
2638
- /**
2639
- * @description start with this timestamp (RFC3339); defaults to UNIX epoch start
2640
- * @default null
2641
- */
2642
- since: string;
2643
- /**
2644
- * @description end with this timestamp (RFC3339); defaults to current date-time
2645
- * @default null
2646
- */
2647
- until: string;
2648
- /** @description fetch results starting with this page; query starts with first entry if page isn't specified */
2649
- startInclusive?: string | null;
2650
- /**
2651
- * Format: uint8
2652
- * @description Query returns up to 50 trades in one go.
2653
- * @default null
2654
- */
2655
- pageSize: number | null;
2656
- };
2657
- DownloadFilter: components["schemas"]["Op_for_DataDateTime"] | components["schemas"]["Op_for_uint64"] | components["schemas"]["Op_for_uint64"] | null;
2658
- /** @description Parses tag (anycase), and value in round braces using `from_str`. */
2659
- Op_for_DataDateTime: {
2660
- le: components["schemas"]["DataDateTime"];
2661
- };
2662
- DataDateTime: string;
2663
- /** @description Parses tag (anycase), and value in round braces using `from_str`. */
2664
- Op_for_uint64: {
2665
- /** Format: uint64 */
2666
- le: number;
2667
- };
2668
- StateDownloadMeta: {
2669
- /** @description Hash of the state file. Used as ETag. */
2670
- hash: number[];
2671
- /**
2672
- * Format: uri
2673
- * @description Link to download the state file.
2674
- */
2675
- link: string;
2676
- /** @description Version of binary which produced this state snapshot. So can decide whether it is compatible with client. todo(repl): After upgrade release make it non-optional. */
2677
- version?: components["schemas"]["BinaryId"] | null;
2678
- };
2679
- BinaryId: string;
2680
- StateInfo: {
2681
- version: components["schemas"]["ExecutableVersion"];
2682
- state: components["schemas"]["EngineStateHeader"];
2683
- };
2684
- EngineStateHeader: {
2685
- /** Format: uint16 */
2686
- version: number;
2687
- /** Format: uint64 */
2688
- action_id: number;
2689
- /** Format: uint64 */
2690
- action_nonce: number;
2691
- /** Format: uint64 */
2692
- timestamp: number;
2693
- paused: boolean;
2694
- };
2695
- /** Format: uint32 */
2696
- FeeTierId: number;
2697
- FeeTierConfig: {
2698
- /** Format: uint16 */
2699
- maker_fee_bps: number;
2700
- /** Format: uint16 */
2701
- taker_fee_bps: number;
2702
- };
2703
- PageQueryPart_for_uint32: {
2704
- /**
2705
- * Format: uint32
2706
- * @description fetch results starting with this page; query starts with first entry if page isn't specified
2707
- */
2708
- startInclusive?: number | null;
2709
- /**
2710
- * Format: uint8
2711
- * @description Query returns up to 50 trades in one go.
2712
- * @default null
2713
- */
2714
- pageSize: number | null;
2715
- };
2716
- PageResult_for_uint32_and_AccountFeeTier: {
2717
- /** @description Set of items for requested by query. */
2718
- items: components["schemas"]["AccountFeeTier"][];
2719
- /**
2720
- * Format: uint32
2721
- * @description If request contains more data, this is the id is set with which next request should be performed to get next page. If no more data, then it is undefined.
2722
- */
2723
- nextStartInclusive?: number | null;
2724
- };
2725
- AccountFeeTier: {
2726
- /** Format: uint32 */
2727
- accountId: number;
2728
- feeTier: components["schemas"]["FeeTierId"];
2729
- };
2730
- /** Format: uint32 */
2731
- AclRole: number;
2732
- /** @description TV config query response https://www.tradingview.com/charting-library-docs/latest/connecting_data/UDF/#data-feed-configuration-data */
2733
- TvConfigResponse: {
2734
- supported_resolutions: components["schemas"]["Resolution"][];
2735
- supports_group_request: boolean;
2736
- supports_marks: boolean;
2737
- supports_search: boolean;
2738
- supports_timescale_marks: boolean;
2739
- };
2740
- /**
2741
- * @description More limited resolution than history one, used in some HTTP queries
2742
- * @enum {string}
2743
- */
2744
- Resolution: "1" | "5" | "15" | "30" | "60" | "1D" | "1W" | "1M";
2745
- /** @description TV symbols query */
2746
- TvSymbolsQuery: {
2747
- symbol: string;
2748
- };
2749
- TvSymbolsResult: {
2750
- description: string;
2751
- exchange: string;
2752
- has_intraday: boolean;
2753
- format: components["schemas"]["TvSymbolsFormat"];
2754
- listed_exchange: string;
2755
- /** Format: int64 */
2756
- minmov: number;
2757
- name: string;
2758
- /** Format: int64 */
2759
- pricescale: number;
2760
- session: string;
2761
- supported_resolutions: components["schemas"]["Resolution"][];
2762
- ticker: string;
2763
- timezone: string;
2764
- type: string;
2765
- };
2766
- /** @enum {string} */
2767
- TvSymbolsFormat: "price" | "volume";
2768
- MarketSymbolNotFound: {
2769
- symbol: string;
2770
- };
2771
- TvSearchQuery: {
2772
- query: string;
2773
- type: string;
2774
- exchange: string;
2775
- /** Format: uint32 */
2776
- limit: number;
2777
- };
2778
- TvSearchResponseItem: {
2779
- description: string;
2780
- exchange: string;
2781
- symbol: string;
2782
- ticker: string;
2783
- type: string;
2784
- };
2785
- /** @description History query https://www.tradingview.com/charting-library-docs/latest/connecting_data/UDF/#bars
2786
- *
2787
- * # Extension: Accepts either: * `market_id` - raw market identifier * `symbol` - market symbol from original spec, picks first market which matches it */
2788
- TvHistoryQuery: {
2789
- /** Format: uint32 */
2790
- market_id?: number | null;
2791
- symbol?: string | null;
2792
- from?: string;
2793
- to: string;
2794
- resolution: components["schemas"]["Resolution"];
2795
- /** Format: uint16 */
2796
- countback?: number | null;
2797
- };
2798
- TvHistoryResponse: {
2799
- /** @enum {string} */
2800
- s: "no_data";
2801
- nextTime?: string;
2802
- } | {
2803
- /** @enum {string} */
2804
- s: "ok";
2805
- t: number[];
2806
- o: number[];
2807
- c: number[];
2808
- h: number[];
2809
- l: number[];
2810
- v: number[];
2811
- };
2812
- error: {
2813
- errmsg: string;
2814
- };
2815
- TvQuotesQuery: {
2816
- /** @description Comma-delimited list of symbols */
2817
- symbols: string;
2818
- };
2819
- ok: {
2820
- d: components["schemas"]["TvQuotesItem"][];
2821
- };
2822
- /** @description Quotes entry, see https://www.tradingview.com/charting-library-docs/latest/api/modules/Datafeed/#quotedata */
2823
- TvQuotesItem: {
2824
- /** @enum {string} */
2825
- s: "ok";
2826
- n: string;
2827
- v: components["schemas"]["TvQuotesValues"];
2828
- } | {
2829
- /** @enum {string} */
2830
- s: "error";
2831
- n: string;
2832
- v: components["schemas"]["TvQuotesErrorValues"];
2833
- };
2834
- /** @description Datafeed quote values, see https://www.tradingview.com/charting-library-docs/latest/api/interfaces/Datafeed.DatafeedQuoteValues/ for details Field renames are due to spec */
2835
- TvQuotesValues: {
2836
- /**
2837
- * Format: double
2838
- * @description Current best, i.e. lowest, ask price, if present
2839
- */
2840
- ask?: number | null;
2841
- /**
2842
- * Format: double
2843
- * @description Current best, i.e. highest, bid price, if present
2844
- */
2845
- bid?: number | null;
2846
- /**
2847
- * Format: double
2848
- * @description Delta between last price and previous close price
2849
- */
2850
- ch?: number | null;
2851
- /**
2852
- * Format: double
2853
- * @description Percentage delta between last price and previous close price
2854
- */
2855
- chp?: number | null;
2856
- description?: string | null;
2857
- exchange?: string | null;
2858
- /** Format: double */
2859
- high_price?: number | null;
2860
- /** Format: double */
2861
- low_price?: number | null;
2862
- /**
2863
- * Format: double
2864
- * @description Current last trade price, no matter whether it was bid or ask
2865
- */
2866
- lp?: number | null;
2867
- /**
2868
- * Format: double
2869
- * @description Trade price of the first trade which happened in current session
2870
- */
2871
- open_price?: number | null;
2872
- original_name?: string | null;
2873
- /**
2874
- * Format: double
2875
- * @description Last trade price of previous session
2876
- */
2877
- prev_close_price?: number | null;
2878
- /** Format: double */
2879
- rch?: number | null;
2880
- /** Format: double */
2881
- rchp?: number | null;
2882
- /** Format: double */
2883
- rtc?: number | null;
2884
- rtc_time?: string;
2885
- short_name?: string | null;
2886
- /**
2887
- * Format: double
2888
- * @description Delta between current bid and ask prices
2889
- */
2890
- spread?: number | null;
2891
- /** Format: double */
2892
- volume?: number | null;
2893
- };
2894
- /** @description Empty object, to make quotes item conform to API error spec */
2895
- TvQuotesErrorValues: Record<string, never>;
2896
- };
2897
- responses: never;
2898
- parameters: never;
2899
- requestBodies: never;
2900
- headers: never;
2901
- pathItems: never;
2902
- }
2903
- export type $defs = Record<string, never>;
2904
- export type operations = Record<string, never>;