-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathopenapi3-dart.yml
4747 lines (4527 loc) · 154 KB
/
openapi3-dart.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.2
info:
version: 0.8.9
title: Catapult REST Endpoints
description: OpenAPI Specification of catapult-rest 1.0.20.22
license:
name: Apache 2.0
url: 'http://www.apache.org/licenses/LICENSE-2.0.html'
tags:
- name: Account routes
- name: Block routes
- name: Chain routes
- name: Metadata routes
- name: Mosaic routes
- name: Multisig routes
- name: Namespace routes
- name: Network routes
- name: Node routes
- name: Restriction Mosaic routes
- name: Restriction Account routes
- name: Receipt routes
- name: Transaction routes
paths:
'/account/{accountId}':
get:
tags:
- Account routes
summary: Get account information
description: Returns the account information.
operationId: getAccountInfo
parameters:
- $ref: '#/components/parameters/accountIdPath'
responses:
'200':
description: success
content:
application/json:
schema:
$ref: '#/components/schemas/AccountInfoDTO'
'404':
$ref: '#/components/responses/ResourceNotFound'
'409':
$ref: '#/components/responses/InvalidArgument'
/account:
post:
tags:
- Account routes
summary: Get accounts information
description: Returns the account information for an array of accounts.
operationId: getAccountsInfo
requestBody:
$ref: '#/components/requestBodies/accountIds'
responses:
'200':
description: success
content:
application/json:
schema:
type: array
description: Array of accounts information.
items:
$ref: '#/components/schemas/AccountInfoDTO'
'400':
$ref: '#/components/responses/InvalidContent'
'409':
$ref: '#/components/responses/InvalidArgument'
'/account/{accountId}/transactions':
get:
tags:
- Account routes
summary: Get confirmed transactions
description: >-
Gets an array of transactions for which an account is the sender or
receiver.
operationId: getAccountConfirmedTransactions
parameters:
- $ref: '#/components/parameters/accountIdPath'
- $ref: '#/components/parameters/pageSizeQuery'
- $ref: '#/components/parameters/idQuery'
- $ref: '#/components/parameters/orderingQuery'
- $ref: '#/components/parameters/transactionTypeQuery'
responses:
'200':
description: success
content:
application/json:
schema:
type: array
description: Array of confirmed transactions.
items:
$ref: '#/components/schemas/TransactionInfoDTO'
'409':
$ref: '#/components/responses/InvalidArgument'
'/account/{accountId}/transactions/incoming':
get:
tags:
- Account routes
summary: Get incoming transactions
description: >
Gets an array of incoming transactions. A transaction is said to be
incoming with respect to an account
if the account is the recipient of the transaction.
operationId: getAccountIncomingTransactions
parameters:
- $ref: '#/components/parameters/accountIdPath'
- $ref: '#/components/parameters/pageSizeQuery'
- $ref: '#/components/parameters/idQuery'
- $ref: '#/components/parameters/orderingQuery'
- $ref: '#/components/parameters/transactionTypeQuery'
responses:
'200':
description: success
content:
application/json:
schema:
type: array
description: Array of incoming transactions.
items:
$ref: '#/components/schemas/TransactionInfoDTO'
'409':
$ref: '#/components/responses/InvalidArgument'
'/account/{accountId}/transactions/outgoing':
get:
tags:
- Account routes
summary: Get outgoing transactions
description: >
Gets an array of outgoing transactions. A transaction is said to be
outgoing with respect to an account
if the account is the sender of the transaction.
operationId: getAccountOutgoingTransactions
parameters:
- $ref: '#/components/parameters/accountIdPath'
- $ref: '#/components/parameters/pageSizeQuery'
- $ref: '#/components/parameters/idQuery'
- $ref: '#/components/parameters/orderingQuery'
- $ref: '#/components/parameters/transactionTypeQuery'
responses:
'200':
description: success
content:
application/json:
schema:
type: array
description: Array of outgoing transactions.
items:
$ref: '#/components/schemas/TransactionInfoDTO'
'409':
$ref: '#/components/responses/InvalidArgument'
'/account/{accountId}/transactions/unconfirmed':
get:
tags:
- Account routes
summary: Get unconfirmed transactions
description: >-
Gets the array of transactions not included in a block where an account
is the sender or receiver.
operationId: getAccountUnconfirmedTransactions
parameters:
- $ref: '#/components/parameters/accountIdPath'
- $ref: '#/components/parameters/pageSizeQuery'
- $ref: '#/components/parameters/idQuery'
- $ref: '#/components/parameters/orderingQuery'
- $ref: '#/components/parameters/transactionTypeQuery'
responses:
'200':
description: success
content:
application/json:
schema:
type: array
description: Array of unconfirmed transactions.
items:
$ref: '#/components/schemas/TransactionInfoDTO'
'409':
$ref: '#/components/responses/InvalidArgument'
'/account/{accountId}/transactions/partial':
get:
tags:
- Account routes
summary: Get aggregate bonded transactions information
description: >
Gets an array of aggregate bonded transactions where the account is the
sender, recipient, or requires to cosign the transaction.
operationId: getAccountPartialTransactions
parameters:
- $ref: '#/components/parameters/accountIdPath'
- $ref: '#/components/parameters/pageSizeQuery'
- $ref: '#/components/parameters/idQuery'
- $ref: '#/components/parameters/orderingQuery'
- $ref: '#/components/parameters/transactionTypeQuery'
responses:
'200':
description: success
content:
application/json:
schema:
type: array
description: Array of aggregate bonded transactions.
items:
$ref: '#/components/schemas/TransactionInfoDTO'
'409':
$ref: '#/components/responses/InvalidArgument'
'/block/{height}':
get:
tags:
- Block routes
summary: Get block information
description: Gets a block from the chain that has the given height.
operationId: getBlockByHeight
parameters:
- $ref: '#/components/parameters/heightPath'
responses:
'200':
description: success
content:
application/json:
schema:
$ref: '#/components/schemas/BlockInfoDTO'
'404':
$ref: '#/components/responses/ResourceNotFound'
'409':
$ref: '#/components/responses/InvalidArgument'
'/blocks/{height}/limit/{limit}':
get:
tags:
- Block routes
summary: Get blocks information
description: Gets up to limit number of blocks after given block height.
operationId: getBlocksByHeightWithLimit
parameters:
- $ref: '#/components/parameters/heightPath'
- $ref: '#/components/parameters/limitPath'
responses:
'200':
description: success
content:
application/json:
schema:
type: array
description: Array of blocks information.
items:
$ref: '#/components/schemas/BlockInfoDTO'
'409':
$ref: '#/components/responses/InvalidArgument'
'/block/{height}/transactions':
get:
tags:
- Block routes
summary: Get transactions from a block
description: >-
Returns an array of transactions included in a block for a given block
height.
operationId: getBlockTransactions
parameters:
- $ref: '#/components/parameters/heightPath'
- $ref: '#/components/parameters/pageSizeQuery'
- $ref: '#/components/parameters/idQuery'
responses:
'200':
description: success
content:
application/json:
schema:
type: array
description: Array of transactions.
items:
$ref: '#/components/schemas/TransactionInfoDTO'
'404':
$ref: '#/components/responses/ResourceNotFound'
'409':
$ref: '#/components/responses/InvalidArgument'
'/block/{height}/transaction/{hash}/merkle':
get:
tags:
- Block routes
summary: Get the merkle path for a given a transaction and block
description: >
Returns the merkle path for a transaction included in a block.
The merkle path is the minimum number of nodes needed to calculate the
merkle root.
Steps to calculate the merkle root:
1. proofHash = hash (leaf).
2. Concatenate proofHash with the first unprocessed item from the
merklePath list as follows:
* a) If item.position == left -> proofHash = sha_256(item.hash +
proofHash).
* b) If item.position == right -> proofHash = sha_256(proofHash+
item.hash).
3. Repeat 2. for every item in the merklePath list.
4. Compare if the calculated proofHash equals the one recorded in the
block header (block.transactionsHash) to verify if the transaction was
included in the block.
operationId: getMerkleTransaction
parameters:
- $ref: '#/components/parameters/heightPath'
- $ref: '#/components/parameters/transactionHashPath'
responses:
'200':
description: success
content:
application/json:
schema:
$ref: '#/components/schemas/MerkleProofInfoDTO'
'404':
$ref: '#/components/responses/ResourceNotFound'
'409':
$ref: '#/components/responses/InvalidArgument'
/chain/height:
get:
tags:
- Chain routes
summary: Get the current height of the chain
description: Returns the current height of the blockchain.
operationId: getChainHeight
responses:
'200':
description: success
content:
application/json:
schema:
$ref: '#/components/schemas/HeightInfoDTO'
/chain/score:
get:
tags:
- Chain routes
summary: Get the current score of the chain
description: >
Gets the current score of the blockchain. The higher the score, the
better the chain.
During synchronization, nodes try to get the best blockchain in the
network.
The score for a block is derived from its difficulty and the time (in
seconds) that has elapsed since the last block:
block score = difficulty − time elapsed since last block
operationId: getChainScore
responses:
'200':
description: success
content:
application/json:
schema:
$ref: '#/components/schemas/ChainScoreDTO'
/network:
get:
tags:
- Network routes
summary: Get the current network type of the chain
description: Returns the current network type.
operationId: getNetworkType
responses:
'200':
description: success
content:
application/json:
schema:
$ref: '#/components/schemas/NetworkTypeDTO'
/network/fees/rental:
get:
tags:
- Network routes
summary: Get rental fees information
description: >
Returns the estimated effective rental fees for namespaces and mosaics.
This endpoint is only available if the REST instance has access to
catapult-server ``resources/config-network.properties`` file.
To activate this feature, add the setting "network.propertiesFilePath"
in the configuration file (rest/resources/rest.json).
operationId: getRentalFees
responses:
'200':
description: success
content:
application/json:
schema:
$ref: '#/components/schemas/RentalFeesDTO'
'409':
$ref: '#/components/responses/InvalidArgument'
/network/fees/transaction:
get:
tags:
- Network routes
summary: Get transaction fees information
description: >
Returns the average, median, highest and lower fee multiplier over the
last "numBlocksTransactionFeeStats".
The setting "numBlocksTransactionFeeStats" is adjustable via the
configuration file (rest/resources/rest.json) per REST instance.
operationId: getTransactionFees
responses:
'200':
description: success
content:
application/json:
schema:
$ref: '#/components/schemas/TransactionFeesDTO'
/network/properties:
get:
tags:
- Network routes
summary: Get the network properties
description: >
Returns the content from a catapult-server network configuration file
(resources/config-network.properties).
To enable this feature, the REST setting "network.propertiesFilePath"
must define where the file is located.
This is adjustable via the configuration file (rest/resources/rest.json)
per REST instance.
operationId: getNetworkProperties
responses:
'200':
description: success
content:
application/json:
schema:
$ref: '#/components/schemas/NetworkConfigurationDTO'
'409':
$ref: '#/components/responses/InvalidArgument'
/node/health:
get:
tags:
- Node routes
summary: Get the node health information
description: Supplies information regarding the connection and services status.
operationId: getNodeHealth
responses:
'200':
description: Both API node and database services are reachable from REST server.
content:
application/json:
schema:
$ref: '#/components/schemas/NodeHealthInfoDTO'
'503':
description: >-
Either API node or database service is unavailable or unreachable
from REST server.
content:
application/json:
schema:
$ref: '#/components/schemas/NodeHealthInfoDTO'
/node/info:
get:
tags:
- Node routes
summary: Get the node information
description: Supplies additional information about the application running on a node.
operationId: getNodeInfo
responses:
'200':
description: success
content:
application/json:
schema:
$ref: '#/components/schemas/NodeInfoDTO'
/node/peers:
get:
tags:
- Node routes
summary: Get peers information
description: Gets the list of peers visible by the node.
operationId: getNodePeers
responses:
'200':
description: success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/NodeInfoDTO'
/node/storage:
get:
tags:
- Node routes
summary: Get the storage information of the node
description: Returns storage information about the node.
operationId: getNodeStorage
responses:
'200':
description: success
content:
application/json:
schema:
$ref: '#/components/schemas/StorageInfoDTO'
/node/time:
get:
tags:
- Node routes
summary: Get the node time
description: Gets the node time at the moment the reply was sent and received.
operationId: getNodeTime
responses:
'200':
description: success
content:
application/json:
schema:
$ref: '#/components/schemas/NodeTimeDTO'
/node/server:
get:
tags:
- Node routes
summary: Get the version of the running REST component
description: Returns the version of the running catapult-rest component.
operationId: getServerInfo
responses:
'200':
description: success
content:
application/json:
schema:
$ref: '#/components/schemas/ServerInfoDTO'
'/transaction/{transactionId}':
get:
tags:
- Transaction routes
summary: Get transaction information
description: Returns transaction information given a transactionId or hash.
operationId: getTransaction
parameters:
- $ref: '#/components/parameters/transactionIdPath'
responses:
'200':
description: success
content:
application/json:
schema:
$ref: '#/components/schemas/TransactionInfoDTO'
'404':
$ref: '#/components/responses/ResourceNotFound'
'409':
$ref: '#/components/responses/InvalidArgument'
/transaction:
post:
tags:
- Transaction routes
summary: Get transactions information
description: Returns transactions information for a given array of transactionIds.
operationId: getTransactions
requestBody:
$ref: '#/components/requestBodies/transactionIds'
responses:
'200':
description: success
content:
application/json:
schema:
type: array
description: Array of transactions information.
items:
$ref: '#/components/schemas/TransactionInfoDTO'
'400':
$ref: '#/components/responses/InvalidContent'
'409':
$ref: '#/components/responses/InvalidArgument'
put:
tags:
- Transaction routes
summary: Announce a new transaction
description: >
Announces a transaction to the network.
We recommended to use the Symbol-SDKs to announce transactions because
they should be serialized.
operationId: announceTransaction
requestBody:
$ref: '#/components/requestBodies/transactionPayload'
responses:
'202':
description: success
content:
application/json:
schema:
$ref: '#/components/schemas/AnnounceTransactionInfoDTO'
'400':
$ref: '#/components/responses/InvalidContent'
'409':
$ref: '#/components/responses/InvalidArgument'
'/transaction/{hash}/status':
get:
tags:
- Transaction routes
summary: Get transaction status
description: Returns the transaction status for a given hash.
operationId: getTransactionStatus
parameters:
- $ref: '#/components/parameters/transactionHashPath'
responses:
'200':
description: success
content:
application/json:
schema:
$ref: '#/components/schemas/TransactionStatusDTO'
'404':
$ref: '#/components/responses/ResourceNotFound'
'409':
$ref: '#/components/responses/InvalidArgument'
/transaction/statuses:
post:
tags:
- Transaction routes
summary: Get transactions status
description: >-
Returns an array of transaction statuses for a given array of
transaction hashes.
operationId: getTransactionsStatuses
requestBody:
$ref: '#/components/requestBodies/transactionHashes'
responses:
'200':
description: success
content:
application/json:
schema:
type: array
description: Array of transactions status.
items:
$ref: '#/components/schemas/TransactionStatusDTO'
'400':
$ref: '#/components/responses/InvalidContent'
'409':
$ref: '#/components/responses/InvalidArgument'
/transaction/partial:
put:
tags:
- Transaction routes
summary: Announce an aggregate bonded transaction
description: Announces an aggregate bonded transaction to the network.
operationId: announcePartialTransaction
requestBody:
$ref: '#/components/requestBodies/transactionPayload'
responses:
'202':
description: success
content:
application/json:
schema:
$ref: '#/components/schemas/AnnounceTransactionInfoDTO'
'400':
$ref: '#/components/responses/InvalidContent'
'409':
$ref: '#/components/responses/InvalidArgument'
/transaction/cosignature:
put:
tags:
- Transaction routes
summary: Announce a cosignature transaction
description: Announces a cosignature transaction to the network.
operationId: announceCosignatureTransaction
requestBody:
$ref: '#/components/requestBodies/cosignature'
responses:
'202':
description: success
content:
application/json:
schema:
$ref: '#/components/schemas/AnnounceTransactionInfoDTO'
'400':
$ref: '#/components/responses/InvalidContent'
'409':
$ref: '#/components/responses/InvalidArgument'
'/metadata/account/{accountId}':
get:
tags:
- Metadata routes
summary: Get account metadata
description: Returns the account metadata given an account id.
operationId: getAccountMetadata
parameters:
- $ref: '#/components/parameters/accountIdPath'
- $ref: '#/components/parameters/pageSizeQuery'
- $ref: '#/components/parameters/idQuery'
- $ref: '#/components/parameters/orderingQuery'
responses:
'200':
description: success
content:
application/json:
schema:
$ref: '#/components/schemas/MetadataEntriesDTO'
'404':
$ref: '#/components/responses/ResourceNotFound'
'409':
$ref: '#/components/responses/InvalidArgument'
'/metadata/mosaic/{mosaicId}':
get:
tags:
- Metadata routes
summary: Get mosaic metadata
description: Returns the mosaic metadata given a mosaic id.
operationId: getMosaicMetadata
parameters:
- $ref: '#/components/parameters/mosaicIdPath'
- $ref: '#/components/parameters/pageSizeQuery'
- $ref: '#/components/parameters/idQuery'
- $ref: '#/components/parameters/orderingQuery'
responses:
'200':
description: success
content:
application/json:
schema:
$ref: '#/components/schemas/MetadataEntriesDTO'
'404':
$ref: '#/components/responses/ResourceNotFound'
'409':
$ref: '#/components/responses/InvalidArgument'
'/metadata/namespace/{namespaceId}':
get:
tags:
- Metadata routes
summary: Get namespace metadata
description: Returns the namespace metadata given a namespace id.
operationId: getNamespaceMetadata
parameters:
- $ref: '#/components/parameters/namespaceIdPath'
- $ref: '#/components/parameters/pageSizeQuery'
- $ref: '#/components/parameters/idQuery'
- $ref: '#/components/parameters/orderingQuery'
responses:
'200':
description: success
content:
application/json:
schema:
$ref: '#/components/schemas/MetadataEntriesDTO'
'404':
$ref: '#/components/responses/ResourceNotFound'
'409':
$ref: '#/components/responses/InvalidArgument'
'/metadata/account/{accountId}/key/{key}':
get:
tags:
- Metadata routes
summary: Get account metadata
description: Returns the account metadata given an account id and a key.
operationId: getAccountMetadataByKey
parameters:
- $ref: '#/components/parameters/accountIdPath'
- $ref: '#/components/parameters/metadataKeyPath'
responses:
'200':
description: success
content:
application/json:
schema:
$ref: '#/components/schemas/MetadataEntriesDTO'
'404':
$ref: '#/components/responses/ResourceNotFound'
'409':
$ref: '#/components/responses/InvalidArgument'
'/metadata/mosaic/{mosaicId}/key/{key}':
get:
tags:
- Metadata routes
summary: Get mosaic metadata
description: Returns the mosaic metadata given a mosaic id and a key.
operationId: getMosaicMetadataByKey
parameters:
- $ref: '#/components/parameters/mosaicIdPath'
- $ref: '#/components/parameters/metadataKeyPath'
responses:
'200':
description: success
content:
application/json:
schema:
$ref: '#/components/schemas/MetadataEntriesDTO'
'404':
$ref: '#/components/responses/ResourceNotFound'
'409':
$ref: '#/components/responses/InvalidArgument'
'/metadata/namespace/{namespaceId}/key/{key}':
get:
tags:
- Metadata routes
summary: Get namespace metadata
description: Returns the namespace metadata given a namespace id and a key.
operationId: getNamespaceMetadataByKey
parameters:
- $ref: '#/components/parameters/namespaceIdPath'
- $ref: '#/components/parameters/metadataKeyPath'
responses:
'200':
description: success
content:
application/json:
schema:
$ref: '#/components/schemas/MetadataEntriesDTO'
'404':
$ref: '#/components/responses/ResourceNotFound'
'409':
$ref: '#/components/responses/InvalidArgument'
'/metadata/account/{accountId}/key/{key}/sender/{publicKey}':
get:
tags:
- Metadata routes
summary: Get account metadata
description: 'Returns the account metadata given an account id, a key, and a sender.'
operationId: getAccountMetadataByKeyAndSender
parameters:
- $ref: '#/components/parameters/accountIdPath'
- $ref: '#/components/parameters/metadataKeyPath'
- $ref: '#/components/parameters/publicKeyPath'
responses:
'200':
description: success
content:
application/json:
schema:
$ref: '#/components/schemas/MetadataDTO'
'404':
$ref: '#/components/responses/ResourceNotFound'
'409':
$ref: '#/components/responses/InvalidArgument'
'/metadata/mosaic/{mosaicId}/key/{key}/sender/{publicKey}':
get:
tags:
- Metadata routes
summary: Get mosaic metadata
description: 'Returns the mosaic metadata given a mosaic id, a key, and a sender.'
operationId: getMosaicMetadataByKeyAndSender
parameters:
- $ref: '#/components/parameters/mosaicIdPath'
- $ref: '#/components/parameters/metadataKeyPath'
- $ref: '#/components/parameters/publicKeyPath'
responses:
'200':
description: success
content:
application/json:
schema:
$ref: '#/components/schemas/MetadataDTO'
'404':
$ref: '#/components/responses/ResourceNotFound'
'409':
$ref: '#/components/responses/InvalidArgument'
'/metadata/namespace/{namespaceId}/key/{key}/sender/{publicKey}':
get:
tags:
- Metadata routes
summary: Get namespace metadata
description: >-
Returns the namespace metadata given a namespace id, a key, and a
sender.
operationId: getNamespaceMetadataByKeyAndSender
parameters:
- $ref: '#/components/parameters/namespaceIdPath'
- $ref: '#/components/parameters/metadataKeyPath'
- $ref: '#/components/parameters/publicKeyPath'
responses:
'200':
description: success
content:
application/json:
schema:
$ref: '#/components/schemas/MetadataDTO'
'404':
$ref: '#/components/responses/ResourceNotFound'
'409':
$ref: '#/components/responses/InvalidArgument'
'/mosaic/{mosaicId}':
get:
tags:
- Mosaic routes
summary: Get mosaic information
description: Gets the mosaic definition for a given mosaic identifier.
operationId: getMosaic
parameters:
- $ref: '#/components/parameters/mosaicIdPath'
responses:
'200':
description: success
content:
application/json:
schema:
$ref: '#/components/schemas/MosaicInfoDTO'
'404':
$ref: '#/components/responses/ResourceNotFound'
'409':
$ref: '#/components/responses/InvalidArgument'
/mosaic:
post:
tags:
- Mosaic routes
summary: Get mosaics information for an array of mosaics
description: Gets an array of mosaic definition.
operationId: getMosaics
requestBody:
$ref: '#/components/requestBodies/mosaicIds'
responses:
'200':
description: success
content:
application/json:
schema:
type: array
description: Array of mosaics information.
items:
$ref: '#/components/schemas/MosaicInfoDTO'
'400':
$ref: '#/components/responses/InvalidContent'
'409':
$ref: '#/components/responses/InvalidArgument'
'/account/{accountId}/mosaics':
get:
tags:
- Mosaic routes
summary: Get mosaics created by an account
description: Gets an array of mosaics created for a given account address.
operationId: getMosaicsFromAccount
parameters:
- $ref: '#/components/parameters/accountIdPath'
responses:
'200':
description: success
content:
application/json:
schema:
$ref: '#/components/schemas/MosaicsInfoDTO'
'404':
$ref: '#/components/responses/ResourceNotFound'
'409':
$ref: '#/components/responses/InvalidArgument'
/account/mosaics:
post:
tags:
- Mosaic routes
summary: Get mosaics created for given array of addresses
description: Gets mosaics created for a given array of addresses.
operationId: getMosaicsFromAccounts
requestBody:
$ref: '#/components/requestBodies/accountIds'
responses:
'200':
description: success
content:
application/json:
schema:
$ref: '#/components/schemas/MosaicsInfoDTO'
'400':
$ref: '#/components/responses/InvalidContent'
'409':
$ref: '#/components/responses/InvalidArgument'
'/account/{accountId}/multisig':
get:
tags:
- Multisig routes
summary: Get multisig account information
description: Returns the multisig account information.
operationId: getAccountMultisig
parameters:
- $ref: '#/components/parameters/accountIdPath'
responses:
'200':
description: success
content:
application/json:
schema:
$ref: '#/components/schemas/MultisigAccountInfoDTO'
'404':
$ref: '#/components/responses/ResourceNotFound'
'409':
$ref: '#/components/responses/InvalidArgument'
'/account/{accountId}/multisig/graph':
get:
tags:
- Multisig routes
summary: Get multisig account graph information
description: Returns the multisig account graph.
operationId: getAccountMultisigGraph
parameters:
- $ref: '#/components/parameters/accountIdPath'
responses:
'200':
description: success
content: