-
Notifications
You must be signed in to change notification settings - Fork 0
/
tokenized-securities.json
4393 lines (4393 loc) · 132 KB
/
tokenized-securities.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"info": {
"description": "<h2>Overview</h2>\n <p>XFT API for enterprise usage. To authenticate, click on \"Authenticate\" on the left sidebar and follow the instructions.</p>\n <h2>Terms</h2>\n <p>IMPORTANT: Each user that purchases dShares must agree to our <a href=\"https://XFT.com/terms\">terms</a> and have undergone KYC and AML.</p>\n <p>When using this API to allow your users to purchase dShares, please ensure that the user understands their rights and restrictions before purchasing. Present the terms linked <a href=\"https://XFT.com/terms\">here</a> to your users and have them accept before purchasing dShares.</p>\n <h2 id=\"app-types\">App Types</h2>\n <p>There are four types of apps that can be created:</p>\n <h3>XFT Managed Wallet</h3>\n <p>Partner uses a XFT Managed Wallet to purchase dShares.</p>\n <h3>Customer Managed Wallet</h3>\n <p>Partner uses an existing owned wallet to purchase dShares.</p>\n <h3>Non-custodial Managed KYC</h3>\n <p>Customers use their own wallet to purchase dShares, XFT manages KYC verification.</p>\n <h3>Non-custodial Partner KYC</h3>\n <p>Customers use their own wallet to purchase dShares, Partners manage KYC verification (subject to approval)</p>\n <h2><a href=\"#tag--Stocks\">Stocks</a></h2>\n <p>Get information about available stocks, such as current and historical stock prices, aggregated summary information, and news articles from these endpoints.</p>\n <h2>Managed Accounts Solution</h2>\n <p>Our managed accounts solution offers a more traditional way to integrate with us as a trading platform without the need for in-depth blockchain knowledge or expertise. We handle the details of all the blockchain transactions so that your organization can focus more on delivering for your own users. <strong>This endpoint can only be reached with a XFT Managed Wallet App</strong></p>\n <h3><a href=\"#tag--Managed-Accounts\">Managed Accounts</a></h2>\n <p>Find a list of account portfolio items (cash and stock assets) through the \"Get Portfolio\" endpoint, or get a list of your organization's accounts with the \"Get Acccounts\" endpoint.</p>\n <h3><a href=\"#tag--Managed-Stock-Orders\">Managed Stock Orders</a></h3>\n <p>Get, place, or cancel orders with these endpoints directly without needing to worry about token contracts or deciphering unfamiliar Web3 errors.</p>\n ",
"contact": {
"email": "[email protected]"
},
"license": {
"name": "Contact us"
},
"termsOfService": "https://XFT.com/terms",
"title": "XFT API [Enterprise]",
"version": "v20240829-a6945c1"
},
"components": {
"securitySchemes": {
"BearerAuth": {
"type": "http",
"scheme": "bearer",
"in": "header",
"name": "Authorization",
"bearerFormat": "api_key",
"description": "The provided API key should be set here"
}
},
"schemas": {
"ApiError": {
"type": "object",
"properties": {
"status": {
"type": "integer",
"description": "HTTP Status Code"
},
"message": {
"type": "string",
"description": "Error message"
},
"error": {
"type": "string",
"default": null,
"description": "Error description and traceback",
"nullable": true
}
},
"required": [
"message",
"status"
],
"description": "API response for errors (HTTP status code >= 400)"
},
"PaginationMetadataSchema": {
"type": "object",
"properties": {
"total": {
"type": "integer"
},
"total_pages": {
"type": "integer"
},
"first_page": {
"type": "integer"
},
"last_page": {
"type": "integer"
},
"page": {
"type": "integer"
},
"previous_page": {
"type": "integer"
},
"next_page": {
"type": "integer"
}
}
},
"HealthCheck": {
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "Status of server"
}
},
"required": [
"status"
]
},
"BrokerageOrderStatus": {
"type": "string",
"enum": [
"PENDING_SUBMIT",
"PENDING_CANCEL",
"PENDING_ESCROW",
"PENDING_FILL",
"ESCROWED",
"SUBMITTED",
"CANCELLED",
"FILLED",
"REJECTED",
"REQUIRING_CONTACT",
"ERROR"
]
},
"OrderSide": {
"type": "string",
"enum": [
"BUY",
"SELL"
]
},
"OrderType": {
"type": "string",
"enum": [
"MARKET",
"LIMIT"
]
},
"OrderTif": {
"type": "string",
"enum": [
"DAY",
"GTC",
"IOC",
"FOK"
]
},
"Web3Order_sBlG": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Identifier"
},
"brokerage_order_status": {
"description": "Status of the order",
"$ref": "#/components/schemas/BrokerageOrderStatus"
},
"chain_id": {
"type": "integer",
"description": "Blockchain that transaction is ran on"
},
"order_id": {
"type": "string",
"description": "Unique identifier of Order from Smart Contracts. NOTE: order_id is returned as {requester address}_{index}"
},
"order_transaction_hash": {
"type": "string",
"description": "Transaction hash for the order"
},
"cancel_transaction_hash": {
"type": "string",
"description": "Transaction hash for cancellation of order",
"nullable": true
},
"order_contract_address": {
"type": "string",
"description": "Smart Contract address that order came from"
},
"order_side": {
"description": "Indicates if order is a buy or sell",
"$ref": "#/components/schemas/OrderSide"
},
"order_type": {
"description": "Indicates what type of order",
"$ref": "#/components/schemas/OrderType"
},
"order_tif": {
"description": "Indicates how long order is valid",
"$ref": "#/components/schemas/OrderTif"
},
"asset_token_quantity": {
"type": "number",
"description": "Total amount of asset token involved (in wei)"
},
"payment_token_quantity": {
"type": "number",
"description": "Total amount of payment token involved (in wei)"
},
"fees": {
"type": "array",
"description": "List of fees associated with order",
"items": {
"type": "object",
"additionalProperties": {
"nullable": true
}
},
"nullable": true
},
"network_fee_in_usd": {
"type": "number",
"description": "Total amount of network fee taken in USD",
"nullable": true
}
},
"required": [
"asset_token_quantity",
"brokerage_order_status",
"chain_id",
"id",
"order_contract_address",
"order_id",
"order_side",
"order_tif",
"order_transaction_hash",
"order_type",
"payment_token_quantity"
]
},
"StockInfo": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "bigint",
"description": "Identifier"
},
"name": {
"type": "string",
"description": "Name of Stock"
},
"symbol": {
"type": "string",
"description": "Symbol of Stock"
},
"composite_figi": {
"type": "string",
"description": "Refer to https://www.openfigi.com/about/figi"
},
"cusip": {
"type": "string",
"description": "Refer to https://www.cusip.com/identifiers.html",
"nullable": true
},
"cik": {
"type": "string",
"description": "Refer to https://www.sec.gov/edgar/searchedgar/cik",
"nullable": true
},
"display_name": {
"type": "string",
"description": "Name of Stock for application display"
}
},
"required": [
"composite_figi",
"display_name",
"id",
"name",
"symbol"
],
"description": "This is an object representing the details of a stock"
},
"Web3OrderFulfillment_J5Ym": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Identifier"
},
"transaction_hash": {
"type": "string",
"description": "Transaction hash for this action"
},
"transaction_dt": {
"type": "string",
"format": "date-time",
"description": "Time when transaction occurred"
},
"asset_token_filled": {
"type": "number",
"description": "Amount of asset token filled (in wei)"
},
"asset_token_spent": {
"type": "number",
"description": "Amount of asset token spent (in wei)"
},
"payment_token_filled": {
"type": "number",
"description": "Amount of payment token filled (in wei)"
},
"payment_token_spent": {
"type": "number",
"description": "Amount of payment token spent (in wei)"
},
"payment_token_fee": {
"type": "number",
"description": "Fee amount of payment token spent (in wei)",
"nullable": true
}
},
"required": [
"asset_token_filled",
"asset_token_spent",
"id",
"payment_token_filled",
"payment_token_spent",
"transaction_dt",
"transaction_hash"
]
},
"OrderSchema": {
"type": "object",
"properties": {
"order": {
"$ref": "#/components/schemas/Web3Order_sBlG"
},
"stock": {
"$ref": "#/components/schemas/StockInfo"
},
"fulfillments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Web3OrderFulfillment_J5Ym"
}
}
},
"required": [
"order",
"stock"
]
},
"StockDetails": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "bigint",
"description": "Unique identifier for the stock"
},
"name": {
"type": "string",
"description": "Stock Name"
},
"symbol": {
"type": "string",
"description": "Ticker symbol of the stock"
},
"composite_figi": {
"type": "string",
"default": null,
"description": "Refer to [this link](https://www.openfigi.com/about/figi)",
"nullable": true
},
"cusip": {
"type": "string",
"default": null,
"description": "Refer to [this link](https://www.cusip.com/identifiers.html)",
"nullable": true
},
"cik": {
"type": "string",
"default": null,
"description": "Refer to [this link](https://www.sec.gov/edgar/searchedgar/cik.html)",
"nullable": true
},
"display_name": {
"type": "string",
"default": null,
"description": "Name of Stock for application display",
"nullable": true
},
"description": {
"type": "string",
"default": null,
"description": "Description of the company and what they do/offer.",
"nullable": true
},
"logo_url": {
"type": "string",
"default": null,
"description": "The URL of the logo of the stock. The preferred format is svg.",
"nullable": true
}
},
"required": [
"id",
"name",
"symbol"
],
"description": "This is an object representing the details of a stock"
},
"StockQuote": {
"type": "object",
"properties": {
"stock_id": {
"type": "string",
"format": "bigint"
},
"price": {
"type": "number",
"description": "The ask price."
},
"change": {
"type": "number",
"description": "The change in price from the previous close."
},
"change_percent": {
"type": "number",
"description": "The percentage change in price from the previous close."
},
"previous_close": {
"type": "number",
"description": "The close price for the symbol for the previous trading day."
},
"close": {
"type": "number",
"description": "The close price for the symbol in the given time period."
},
"high": {
"type": "number",
"description": "The highest price for the symbol in the given time period"
},
"low": {
"type": "number",
"description": "The lowest price for the symbol in the given time period."
},
"open": {
"type": "number",
"description": "The open price for the symbol in the given time period."
},
"volume": {
"type": "number",
"description": "The trading volume of the symbol in the given time period."
}
},
"required": [
"change",
"change_percent",
"close",
"high",
"low",
"open",
"previous_close",
"price",
"stock_id",
"volume"
]
},
"MarketHours": {
"type": "object",
"properties": {
"is_market_open": {
"type": "boolean",
"description": "Whether or not the market is open."
},
"current_session_open_dt": {
"type": "string",
"format": "date-time",
"default": null,
"description": "Time at which the current session opened or null if the market is currently closed",
"nullable": true
},
"current_session_close_dt": {
"type": "string",
"format": "date-time",
"default": null,
"description": "Time at which the current session closes or null if the market is currently closed",
"nullable": true
},
"next_session_open_dt": {
"type": "string",
"format": "date-time",
"description": "Time at which the next session opens."
},
"next_session_close_dt": {
"type": "string",
"format": "date-time",
"description": "Time at which the next session closes."
}
},
"required": [
"is_market_open",
"next_session_close_dt",
"next_session_open_dt"
]
},
"StockTickTimespan": {
"type": "string",
"enum": [
"DAY",
"WEEK",
"MONTH",
"YEAR"
]
},
"StockTickData": {
"type": "object",
"properties": {
"open": {
"type": "number",
"description": "Open price of the stock in the given time period."
},
"close": {
"type": "number",
"description": "Close price of the stock in the given time period."
},
"high": {
"type": "number",
"description": "Highest price of the stock in the given time period."
},
"low": {
"type": "number",
"description": "Lowest price of the stock in the given time period."
},
"timestamp": {
"type": "integer",
"description": "The Unix seconds timestamp for the start of the aggregate window."
}
},
"required": [
"close",
"high",
"low",
"open",
"timestamp"
],
"description": "A stock tick datum, each object represents a single tick in the candle stick chart"
},
"StockNewsArticleInfo": {
"type": "object",
"properties": {
"article_url": {
"type": "string",
"description": "URL of the news article"
},
"amp_url": {
"type": "string",
"default": null,
"description": "The mobile friendly Accelerated Mobile Page (AMP) URL of the news article if available",
"nullable": true
},
"description": {
"type": "string",
"description": "Description of the news article"
},
"image_url": {
"type": "string",
"description": "URL of the image for the news article"
},
"published_utc": {
"type": "string",
"description": "The UTC date and time the article was published"
},
"publisher": {
"type": "string",
"description": "The publisher of the news article"
}
},
"required": [
"article_url",
"description",
"image_url",
"published_utc",
"publisher"
],
"description": "This is an object representing a news article relating to a stock ticker symbol which includes a summary of the article and a link to the original source."
},
"StockMarketDetails": {
"type": "object",
"properties": {
"ticker_symbol": {
"type": "string",
"description": "The ticker symbol of the stock"
},
"market_cap": {
"type": "integer",
"default": null,
"description": "The most recent close price of the ticker multiplied by weighted outstanding shares",
"nullable": true
},
"weighted_shares_outstanding": {
"type": "integer",
"default": null,
"description": "The shares outstanding calculated assuming all shares of other share classes are converted to this share class",
"nullable": true
}
},
"required": [
"ticker_symbol"
],
"description": "This is an object representing the market cap and outstanding shares of a stock"
},
"StockDividendDetail": {
"type": "object",
"properties": {
"cash_amount": {
"type": "number",
"description": "The cash amount of the dividend per share owned."
},
"currency": {
"type": "string",
"default": null,
"description": "The currency in which the dividend is paid.",
"nullable": true
},
"declaration_date": {
"type": "string",
"default": null,
"description": "The date that the dividend was announced.",
"nullable": true
},
"dividend_type": {
"type": "string",
"description": "The type of dividend. Dividends that have been paid and/or are expected to be paid \n on consistent schedules are denoted as CD. Special Cash dividends that have been paid that are \n infrequent or unusual, and/or can not be expected to occur in the future are denoted as SC.\n Long-Term and Short-Term capital gain distributions are denoted as LT and ST, respectively.\n "
},
"ex_dividend_date": {
"type": "string",
"description": "The date that the stock first trades without the dividend, determined by the exchange."
},
"frequency": {
"type": "integer",
"description": "The frequency of the dividend. The following values are possible:<br>\n 1 - Annual <br>\n 2 - Semi-Annual <br>\n 4 - Quarterly <br>\n 12 - Monthly <br>\n 52 - Weekly <br>\n 365 - Daily\n "
},
"pay_date": {
"type": "string",
"default": null,
"description": "The date that the dividend is paid out.",
"nullable": true
},
"record_date": {
"type": "string",
"default": null,
"description": "The date that the stock must be held to receive the dividend, set by the company.",
"nullable": true
},
"ticker": {
"type": "string",
"description": "The ticker symbol of the dividend."
}
},
"required": [
"cash_amount",
"dividend_type",
"ex_dividend_date",
"frequency",
"ticker"
],
"description": "StockDividendDetail contains data for a historical dividend for a stock, including the ticker\n symbol, declaration date, ex-dividend date, record date, pay date, frequency, and amount. Note that this\n data applies only to actual stocks, and the yield received for holding a dShare may differ from this.\n "
},
"StockSplitStatus": {
"type": "string",
"enum": [
"PENDING",
"IN_PROGRESS",
"COMPLETE"
]
},
"StockSplit": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "bigint",
"description": "Unique identifier for the stock split",
"example": "1"
},
"stock_id": {
"type": "string",
"format": "bigint",
"description": "Reference to the id of the stock for this split",
"example": "8"
},
"split_from": {
"type": "number",
"description": "The number of shares before the split. In a 10-for-1 split, this would be 1.",
"example": "1"
},
"split_to": {
"type": "number",
"description": "The number of shares after the split. In a 10-for-1 split, this would be 10.",
"example": "10"
},
"record_date": {
"type": "string",
"format": "date",
"description": "Record date (Eastern Time Zone) of the split, for company to determine where to send \n their new shares. Mainly for record keeping by brokerages, who forward the shares to eventual owners. \n Typically is first in the process.\n ",
"example": "2024-06-06"
},
"payable_date": {
"type": "string",
"format": "date",
"description": "Payable date (Eastern Time Zone) of the split. Date when company will send out the \n new shares. Mainly for record keeping by brokerages, who forward the shares to eventual owners. \n Typically is second in the process.",
"example": "2024-06-07"
},
"ex_date": {
"type": "string",
"format": "date",
"description": "Ex-date of the split (Eastern Time Zone). First day the stock trades at post-split \n prices. Typically is last in the process, and the main important date for investors.",
"example": "2024-06-10"
},
"status": {
"description": "The status of XFT's processing of the split. Stocks for which a split is \n `IN_PROGRESS` will not be available for trading.",
"$ref": "#/components/schemas/StockSplitStatus"
}
},
"required": [
"ex_date",
"id",
"payable_date",
"record_date",
"split_from",
"split_to",
"status",
"stock_id"
],
"description": "StockSplit contains data for a stock split, including the stock id, the number of shares before\n and after the split, the record date, payable date, ex-date, and the status of the split.\n "
},
"StockToken_MeaA": {
"type": "object",
"properties": {
"address": {
"type": "string",
"description": "ERC-20 token address"
},
"chain_id": {
"type": "integer",
"description": "Blockchain that transaction is ran on"
},
"version": {
"type": "string",
"description": "Version of ERC-20 token"
},
"is_active": {
"type": "boolean",
"description": "Indicates if token is active"
},
"symbol": {
"type": "string",
"description": "ERC-20 token symbol"
},
"is_primary": {
"type": "boolean",
"description": "Indicates if token is the primary one for this blockchain"
},
"decimals": {
"type": "integer",
"description": "ERC-20 token decimals"
},
"image_url": {
"type": "string",
"description": "URL of image associated with the stock token",
"nullable": true
}
},
"required": [
"address",
"chain_id",
"decimals",
"is_active",
"is_primary",
"symbol",
"version"
]
},
"StockAndTokenSchema": {
"type": "object",
"properties": {
"stock": {
"$ref": "#/components/schemas/StockDetails"
},
"token": {
"$ref": "#/components/schemas/StockToken_MeaA"
}
},
"required": [
"stock",
"token"
]
},
"WalletBalance": {
"type": "object",
"properties": {
"token_symbol": {
"type": "string",
"description": "The symbol of the dshare token (e.g. AAPL.d)"
},
"token_address": {
"type": "string",
"description": "The contract address of the dshare token"
},
"token_decimals": {
"type": "integer",
"description": "The number of decimal places of the dshare token"
},
"quantity_in_eth": {
"type": "number",
"description": "The quantity of the dshare token in ETH <a href='https://ethereum.org/en/developers/docs/intro-to-ether/#what-is-ether' target='_blank'>(what is ETH?)</a>"
},
"quantity_in_wei": {
"type": "number",
"description": "The quantity of the dshare token in wei <a href='https://ethereum.org/en/developers/docs/intro-to-ether/#denominations' target='_blank'>(what is wei?)</a>"
},
"current_market_value": {
"type": "number",
"description": "The current market value of the dshare token"
},
"current_market_value_currency": {
"type": "string",
"description": "The currency of the current market value (e.g. USD)"
},
"chain_id": {
"type": "integer",
"description": "The chain id of the dshare token"
}
},
"required": [
"chain_id",
"current_market_value",
"current_market_value_currency",
"quantity_in_eth",
"quantity_in_wei",
"token_address",
"token_decimals",
"token_symbol"
]
},
"EntityWalletBalances": {
"type": "object",
"properties": {
"wallet": {
"type": "string",
"description": "The address of the wallet"
},
"balances": {
"type": "array",
"description": "An array of balances for the wallet",
"items": {
"$ref": "#/components/schemas/WalletBalance"
}
}
},
"required": [
"balances",
"wallet"
]
},
"StockOrder": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "ID of order. This is the primary identifier for the `/orders` endpoint"
},
"created": {
"type": "integer",
"description": "Time at which the stock order was created. Measured in seconds since the Unix epoch."
},
"account_id": {
"type": "string",
"format": "bigint",
"description": "ID of account that placed the order"
},
"order_status": {
"description": "Status of order",
"$ref": "#/components/schemas/BrokerageOrderStatus"
},
"order_side": {
"description": "Side of order (BUY or SELL)",
"$ref": "#/components/schemas/OrderSide"
},
"order_type": {
"description": "Type of order (MARKET or LIMIT) more info on order types [here](https://www.investopedia.com/investing/basics-trading-stock-know-your-orders/)",
"$ref": "#/components/schemas/OrderType"
},
"asset_quantity": {
"type": "number",
"description": "Quantity of asset"
},
"payment_amount": {
"type": "number",
"description": "Cash paid for stock assets bought for buy orders, or cash received for stock assets sold for sell orders, excluding fees"
},
"payment_currency": {
"type": "string",
"description": "Currency of payment (I.E. USD)"
},
"fee_amount": {
"type": "number",
"description": "Cash amount paid for fees for the order"
},
"total_payment_amount": {
"type": "number",
"description": "Total cash exchanged for stock assets including fees. <p>For buy orders, this is `payment_amount` + `fee_amount`. <br/>For sell orders, this is `payment_amount` - `fee_amount`."
}
},
"required": [
"account_id",
"asset_quantity",
"created",
"fee_amount",
"id",
"order_side",
"order_status",
"order_type",
"payment_amount",
"payment_currency",
"total_payment_amount"
],
"description": "The StockOrder object represents the stock order detailing stock asset quantities, payment amounts, fees, and order details"
},
"StockOrderFulfillment": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "ID of order fulfillment"
},
"created": {
"type": "integer",
"description": "Time at which the order fulfillment was created. Measured in seconds since the Unix epoch."
},
"asset_quantity": {
"type": "number",
"description": "Quantity of asset"
},
"payment_amount": {
"type": "number",
"description": "Quantity of payment"
},
"payment_currency": {
"type": "string",
"description": "Currency of payment (I.E. USD)"
}
},
"required": [
"asset_quantity",
"created",
"id",
"payment_amount",
"payment_currency"
],
"description": "The StockOrderFulfillment object represents the full or partial fulfillment of a stock order detailing stock asset quantities and payment amounts that were fulfilled"
},
"ManagedStockOrder": {
"type": "object",
"properties": {
"order": {
"$ref": "#/components/schemas/StockOrder"
},
"fulfillments": {
"type": "array",
"description": "Fulfillment details. Note that fulfillment for an order can have multiple fulfillments or only be partially filled depending on market conditions. Details on order fills [here](https://www.investopedia.com/terms/f/fill.asp)",
"items": {
"$ref": "#/components/schemas/StockOrderFulfillment"
}
},
"stock": {
"$ref": "#/components/schemas/StockInfo"
}
},
"required": [
"fulfillments",
"order",
"stock"
],
"description": "This is an object representing the details of a stock order covering stock details, order specifics, and fulfillment data"
},
"CreateMarketStockOrderBuyInput": {
"type": "object",
"properties": {
"account_id": {
"type": "string",
"format": "bigint",
"description": "ID of account placing the order"
},
"stock_id": {
"type": "string",
"format": "bigint",
"description": "ID of stock, as returned by the `/stocks` endpoint, e.g. 1"
},
"payment_amount": {
"type": "number",
"description": "Amount of USD to pay or receive for the order. Must be a positive number with a precision of up to 2 decimal places."
},
"include_fees": {
"type": "boolean",
"default": false,
"description": "Whether to include fees in the `payment_amount` input field."
}
},
"required": [
"account_id",
"payment_amount",
"stock_id"
],
"description": "Input parameters for placing a market order buy."
},
"Web3SponsoredOrderStatus": {
"type": "string",
"enum": [
"PENDING",
"SUBMITTED",
"ERROR",
"CANCELLED"
]