-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathopenapi.yaml
9220 lines (8793 loc) · 248 KB
/
openapi.yaml
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.3
info:
title: OpenAPI definition
version: v0.1
description: |
# Exciting News
Hey there, amazing developers! 👋
We've got some fantastic news to share that will make your experience with our product even better. We're thrilled to announce the implementation of API-Keys, which brings a new level of control and convenience to your development process. So, let's dive right into the details! ✨
## API-Keys for Enhanced Functionality 🔑
Starting now, we have introduced API-Keys to streamline your interactions with our methods. You might have noticed a slight change while making requests – now, all you need to do is include the parameter `X-API-KEY` in the Header of your request. Simple as that!
## Get Your API-Key in a Snap! ⚡️
Securing your API-Key is a breeze. We've made the process super user-friendly to ensure you can get started quickly. Just head over to our website and fill out a simple form. Once you've done that, your shiny new API-Key will be delivered straight to your email inbox. Easy peasy! 📧
[Get Your API-Key Here](https://api.rarible.org/registration)
[Configure SDK with API-key](https://github.com/rarible/sdk#api-querying)
## Unlock the Power of the Rarible Protocol 🔓
As passionate developers, we know you're always hungry for knowledge and eager to explore new frontiers. That's why we invite you to discover the incredible world of the Rarible Protocol. By visiting our dedicated protocol page, you'll gain access to a treasure trove of useful information, tips, and insights that will elevate your development skills to new heights. 🚀
[Explore the Rarible Protocol](https://rarible.org)
So, buckle up and get ready for an enhanced development journey with our API-Keys. We're excited to see what you'll create using our revamped system! 💪🚀
Stay curious, keep innovating, and happy coding! ✨
[P.S. Join our Discord Server to stay up to date and ask questions](https://discord.gg/rarifoundation)
security:
- ApiKeyAuth: [ ]
tags:
- name: "Search API"
x-controller: "SearchController"
- name: "NFT Items"
x-controller: "ItemController"
- name: "NFT Ownerships"
x-controller: "OwnershipController"
- name: "NFT Sales"
x-controller: "OrderController"
- name: "NFT Activities"
x-controller: "ActivityController"
- name: "NFT Collections"
x-controller: "CollectionController"
- name: "Collection Leader Board"
x-controller: "CollectionLeaderboardController"
- name: "Collection Statistics"
x-controller: "CollectionStatisticsController"
- name: "Charts"
x-controller: "ChartController"
- name: "NFT Data and Historical Statistics"
x-controller: "DataController"
- name: "Domain lookup"
x-controller: "DomainController"
- name: "Signature operations"
x-controller: "SignatureController"
- name: "Encode operations"
x-controller: "EncodeController"
- name: "Currencies and rates"
x-controller: "CurrencyController"
- name: "User balances"
x-controller: "BalanceController"
- name: "Indexer blocks"
x-controller: "BlockController"
- name: "Reconciliation"
x-controller: "ReconciliationController"
paths:
######################### Item API #########################
/v0.1/items/{itemId}:
get:
tags:
- "NFT Items"
summary: "Get NFT by Id"
description: "Returns NFT Item by Id"
operationId: getItemById
parameters:
- name: "itemId"
in: path
required: true
description: "ItemId in format `${blockchain}:${token}:${tokenId}`"
schema:
$ref: "#/components/schemas/ItemId"
responses:
"200":
description: "OK"
content:
application/json:
schema:
$ref: "#/components/schemas/Item"
'404':
$ref: "#/components/responses/EntityNotFound"
'400':
$ref: "#/components/responses/BadRequest"
'500':
$ref: "#/components/responses/ServerError"
/v0.1/items/byIds:
post:
tags:
- "NFT Items"
summary: "Get NFT by Ids"
description: "Returns NFT Items by specified list of Ids"
operationId: getItemByIds
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/ItemIds"
required: true
responses:
"200":
description: "OK"
content:
application/json:
schema:
$ref: "#/components/schemas/Items"
'404':
$ref: "#/components/responses/EntityNotFound"
'400':
$ref: "#/components/responses/BadRequest"
'500':
$ref: "#/components/responses/ServerError"
"/v0.1/items/{itemId}/royalties":
get:
tags:
- "NFT Items"
summary: "Get NFT royalties by Id"
description: "Returns NFT royalties by Id"
operationId: getItemRoyaltiesById
parameters:
- name: "itemId"
in: path
required: true
description: "Item Id in format `${blockchain}:${token}:${tokenId}`"
schema:
$ref: "#/components/schemas/ItemId"
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/Royalties"
'400':
$ref: "#/components/responses/BadRequest"
'500':
$ref: "#/components/responses/ServerError"
/v0.1/items/{itemId}/resetMeta:
delete:
tags:
- "NFT Items"
summary: "Reset NFT metadata"
description: "Reloads NFT metadata from the source. If source not available, old metadata stays."
operationId: resetItemMeta
parameters:
- name: "itemId"
in: path
required: true
description: "Item Id in format `${blockchain}:${token}:${tokenId}`"
schema:
$ref: "#/components/schemas/ItemId"
- name: "sync"
in: query
required: false
description: "Request meta for Item if true"
schema:
type: boolean
responses:
'200':
description: OK
'400':
$ref: "#/components/responses/BadRequest"
'500':
$ref: "#/components/responses/ServerError"
/v0.1/items/byOwner:
get:
tags:
- "NFT Items"
summary: "Get NFT owned by user"
description: "Returns list of NFTs belong to specified user and sorted by `last updated` date"
operationId: getItemsByOwner
parameters:
- name: "blockchains"
description: "Since user's address can be present in several blockchains (for example, ETHEREUM and POLYGON),
\ you can use this filter to get Orders only for specific blockchains.
\ Or keep it empty to get Order from all blockchains"
in: query
required: false
schema:
type: array
items:
$ref: "#/components/schemas/Blockchain"
- name: "owner"
in: query
required: true
description: "Address of the item owner"
schema:
$ref: "#/components/schemas/UnionAddress"
- name: "continuation"
in: query
required: false
description: "Continuation token from the previous response"
schema:
type: string
- name: "size"
in: query
required: false
description: "The number of items to return"
schema:
type: integer
- name: "searchEngine"
in: query
required: false
deprecated: true
description: "Search engine to use for search"
schema:
$ref: "#/components/schemas/SearchEngine"
responses:
"200":
description: "OK"
content:
application/json:
schema:
$ref: "#/components/schemas/Items"
'400':
$ref: "#/components/responses/BadRequest"
'500':
$ref: "#/components/responses/ServerError"
/v0.1/items/byCreator:
get:
tags:
- "NFT Items"
summary: "Get NFT created by user"
description: "Returns list of NFTs created by specified user and sorted by `last updated` date"
operationId: getItemsByCreator
parameters:
- name: "blockchains"
description: "Since user's address can be present in several blockchains (for example, ETHEREUM and POLYGON),
\ you can use this filter to get Orders only for specific blockchains.
\ Or keep it empty to get Order from all blockchains"
in: query
required: false
schema:
type: array
items:
$ref: "#/components/schemas/Blockchain"
- name: "creator"
in: query
required: true
description: "Address of the item creator"
schema:
$ref: "#/components/schemas/UnionAddress"
- name: "continuation"
in: query
required: false
description: "Continuation token from the previous response"
schema:
type: string
- name: "size"
in: query
required: false
description: "The number of items to return"
schema:
type: integer
- name: "searchEngine"
in: query
required: false
deprecated: true
description: "Search engine to use for search"
schema:
$ref: "#/components/schemas/SearchEngine"
responses:
"200":
description: "OK"
content:
application/json:
schema:
$ref: "#/components/schemas/Items"
'400':
$ref: "#/components/responses/BadRequest"
'500':
$ref: "#/components/responses/ServerError"
/v0.1/items/byCollection:
get:
tags:
- "NFT Items"
summary: "Get NFT from collection"
description: "Returns list of NFTs from specified collection and sorted by `last updated` date"
operationId: getItemsByCollection
parameters:
- name: "collection"
in: query
required: true
description: "Address of the collection"
schema:
$ref: "#/components/schemas/ContractAddress"
- name: "continuation"
in: query
required: false
description: "Continuation token from the previous response"
schema:
type: string
- name: "size"
in: query
required: false
description: "The number of items to return"
schema:
type: integer
- name: "searchEngine"
in: query
required: false
deprecated: true
description: "Search engine to use for search"
schema:
$ref: "#/components/schemas/SearchEngine"
responses:
"200":
description: "OK"
content:
application/json:
schema:
$ref: "#/components/schemas/Items"
'400':
$ref: "#/components/responses/BadRequest"
'500':
$ref: "#/components/responses/ServerError"
/v0.1/items/byOwnerWithOwnership:
get:
tags:
- "NFT Items"
summary: "Get NFT owned by user - detailed"
description: "Returns list of NFTs belong to specified user and sorted by `last updated` date of ownership"
operationId: getItemsByOwnerWithOwnership
parameters:
- name: "owner"
in: query
required: true
description: "Address of the owner"
schema:
$ref: "#/components/schemas/UnionAddress"
- name: "continuation"
in: query
required: false
description: "Continuation token from the previous response"
schema:
type: string
- name: "size"
in: query
required: false
description: "The number of items to return"
schema:
type: integer
- name: "searchEngine"
in: query
required: false
deprecated: true
description: "Search engine to use for search"
schema:
$ref: "#/components/schemas/SearchEngine"
responses:
"200":
description: "OK"
content:
application/json:
schema:
$ref: "#/components/schemas/ItemsWithOwnership"
'400':
$ref: "#/components/responses/BadRequest"
'500':
$ref: "#/components/responses/ServerError"
/v0.1/items/all:
get:
deprecated: true
tags:
- "NFT Items"
summary: "Get all NFTs"
description: "Returns all NFT Items in accordance with specified filters and sorted by `last updated` date"
operationId: getAllItems
parameters:
- name: "blockchains"
in: query
required: false
description: "Names of the blockchain networks. If no one specified, NFTs from all blockchains will be returned"
schema:
type: array
items:
$ref: "#/components/schemas/Blockchain"
- name: "continuation"
in: query
required: false
description: "Continuation token from the previous response"
schema:
type: string
- name: "size"
in: query
required: false
description: "The number of items to return"
schema:
type: integer
- name: "showDeleted"
in: query
required: false
description: "Include deleted items"
schema:
type: boolean
- name: "lastUpdatedFrom"
in: query
required: false
description: "Filter condition to return only items that have been updated after this date (timestamp)"
schema:
type: integer
format: int64
- name: "lastUpdatedTo"
in: query
required: false
description: "Filter condition to return only items that have been updated before this date (timestamp)"
schema:
type: integer
format: "int64"
- name: "searchEngine"
in: query
required: false
deprecated: true
description: "Search engine to use for search"
schema:
$ref: "#/components/schemas/SearchEngine"
responses:
"200":
description: "OK"
content:
application/json:
schema:
$ref: "#/components/schemas/Items"
'400':
$ref: "#/components/responses/BadRequest"
'500':
$ref: "#/components/responses/ServerError"
/v0.1/items/traits:
get:
tags:
- "NFT Items"
summary: "Get NFT collection traits"
description: "Returns aggregation of existing traits for specified collections with counter for each trait type/value."
operationId: queryTraits
parameters:
- name: keys
description: "Trait keys for strict filtering (if not specified - all traits will be returned)"
in: query
required: false
schema:
type: array
items:
type: string
example: "${filterTraitKey}"
- name: collectionIds
description: "Collections identifiers to which traits belong"
in: query
required: true
schema:
type: array
items:
type: string
example: "${filterCollections}"
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Traits'
'400':
$ref: "#/components/responses/BadRequest"
'500':
$ref: "#/components/responses/ServerError"
/v0.1/items/traits/search:
get:
tags:
- "Search API"
summary: "Search NFT collection traits"
description: "Returns aggregation of existing traits for specified collections with counter for each trait type/value.\\
\ This is full-text-search, where you can specify filter for trait keys not precisely\\
\ (for example, results `back` filter include `Background` trait)"
operationId: searchTraits
parameters:
- name: filter
description: filter
in: query
required: true
schema:
type: string
example: "${filterTraitKey}"
- name: collectionIds
description: "Collections identifiers to which traits belong"
in: query
required: true
schema:
type: array
items:
type: string
example: "${filterCollections}"
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Traits'
'400':
$ref: "#/components/responses/BadRequest"
'500':
$ref: "#/components/responses/ServerError"
/v0.1/items/traits/rarity:
post:
tags:
- "NFT Items"
summary: "Get NFT traits rarity"
description: "Returns the rarity of the trait"
operationId: queryTraitsWithRarity
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TraitsRarityRequest'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ExtendedTraitProperties'
/v0.1/items/search:
post:
tags:
- "Search API"
summary: "Search NFTs"
description: "Advanced search returns NFTs satisfying provided filter"
operationId: searchItems
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/ItemsSearchRequest"
example:
size: 10
filter:
blockchains: [ ETHEREUM ]
deleted: false
sellPriceFrom: 0
sellPriceTo: 100
sellCurrency: ETHEREUM:0x0000000000000000000000000000000000000000
lastUpdatedAtFrom: 2022-12-01T00:00:00Z
lastUpdatedAtTo: 2029-12-01T00:00:00Z
sort: EARLIEST
required: true
responses:
'200':
description: "OK"
content:
application/json:
schema:
$ref: "#/components/schemas/Items"
'400':
$ref: "#/components/responses/BadRequest"
'500':
$ref: "#/components/responses/ServerError"
/v0.1/items/lazy/{itemId}:
get:
tags:
- "NFT Items"
summary: "Get Lazy NFT"
description: "Returns Lazy NFT Item by Id"
operationId: getLazyItemById
parameters:
- name: "itemId"
in: path
required: true
description: "Item Id in format `${blockchain}:${token}:${tokenId}`"
schema:
$ref: "#/components/schemas/ItemId"
responses:
"200":
description: "OK"
content:
application/json:
schema:
$ref: "#/components/schemas/LazyItem"
'404':
$ref: "#/components/responses/EntityNotFound"
'400':
$ref: "#/components/responses/BadRequest"
'500':
$ref: "#/components/responses/ServerError"
/v0.1/items/lazy/mint:
post:
tags:
- "NFT Items"
summary: "Mint Lazy NFT"
description: "Create Lazy NFT (supported only for some blockchains)"
operationId: mintLazyItem
requestBody:
content:
application/json:
schema:
"$ref": "#/components/schemas/LazyItemMintForm"
required: true
responses:
"200":
description: "OK"
content:
application/json:
schema:
$ref: "#/components/schemas/Item"
'400':
$ref: "#/components/responses/BadRequest"
'404':
$ref: "#/components/responses/EntityNotFound"
'500':
$ref: "#/components/responses/ServerError"
/v0.1/items/lazy/burn:
post:
tags:
- "NFT Items"
summary: "Burn Lazy NFT"
description: "Deletes Lazy NFT (supported only for some blockchains)"
operationId: burnLazyItem
requestBody:
content:
application/json:
schema:
"$ref": "#/components/schemas/LazyItemBurnForm"
required: true
responses:
'204':
description: No Content
'400':
$ref: "#/components/responses/BadRequest"
'404':
$ref: "#/components/responses/EntityNotFound"
'500':
$ref: "#/components/responses/ServerError"
####################### Ownership API #######################
/v0.1/ownerships/{ownershipId}:
get:
tags:
- "NFT Ownerships"
summary: "Get NFT Ownership by Id"
description: "Returns Ownership by Id"
operationId: getOwnershipById
parameters:
- name: "ownershipId"
in: path
required: true
description: "Ownership Id in format: '${blockchain}:${token}:${tokenId}:${owner}'"
schema:
$ref: "#/components/schemas/OwnershipId"
responses:
"200":
description: "OK"
content:
application/json:
schema:
$ref: "#/components/schemas/Ownership"
'404':
$ref: "#/components/responses/EntityNotFound"
'400':
$ref: "#/components/responses/BadRequest"
'500':
$ref: "#/components/responses/ServerError"
/v0.1/ownerships/byIds:
post:
tags:
- "NFT Ownerships"
summary: "Get NFT Ownerships by Ids"
description: "Returns Ownerships by specified list of Ids"
operationId: getOwnershipsByIds
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/OwnershipIds"
required: true
responses:
"200":
description: "OK"
content:
application/json:
schema:
$ref: "#/components/schemas/Ownerships"
'400':
$ref: "#/components/responses/BadRequest"
'500':
$ref: "#/components/responses/ServerError"
/v0.1/ownerships/byCollection:
get:
tags:
- "NFT Ownerships"
summary: "Get NFT Collection's Ownerships"
description: "Returns list of NFTs Ownerships from specified collection and sorted by `last updated` date"
operationId: getOwnershipsByCollection
parameters:
- name: "collection"
in: query
required: true
description: "Address of the collection"
schema:
$ref: "#/components/schemas/ContractAddress"
- name: "continuation"
in: query
required: false
description: "Continuation token from the previous response"
schema:
type: string
- name: "size"
in: query
required: false
description: "The number of items to return"
schema:
type: integer
responses:
"200":
description: "OK"
content:
application/json:
schema:
$ref: "#/components/schemas/Ownerships"
'400':
$ref: "#/components/responses/BadRequest"
'500':
$ref: "#/components/responses/ServerError"
/v0.1/ownerships/byItem:
get:
tags:
- "NFT Ownerships"
summary: "Get NFTs Ownerships"
description: "Returns list of NFTs Ownerships for specified NFT and sorted by `last updated` date"
operationId: getOwnershipsByItem
parameters:
- name: "itemId"
in: query
required: true
description: "Item Id, has format `${blockchain}:${token}:${tokenId}`"
schema:
$ref: "#/components/schemas/ItemId"
- name: "continuation"
in: query
required: false
description: "Continuation token from the previous response"
schema:
type: string
- name: "size"
in: query
required: false
description: "The number of items to return"
schema:
type: integer
responses:
"200":
description: "OK"
content:
application/json:
schema:
$ref: "#/components/schemas/Ownerships"
'400':
$ref: "#/components/responses/BadRequest"
'500':
$ref: "#/components/responses/ServerError"
/v0.1/ownerships/search:
post:
tags:
- "Search API"
summary: "Search NFT Ownerships"
description: "Advanced search returns NFT Ownerships satisfying provided filter"
operationId: searchOwnerships
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/OwnershipSearchRequest"
example:
size: 10
filter:
blockchains: [ ETHEREUM ]
deleted: false
sellPriceFrom: 0
sellPriceTo: 100
sellCurrency: ETHEREUM:0x0000000000000000000000000000000000000000
lastUpdatedAtFrom: 2022-12-01T00:00:00Z
lastUpdatedAtTo: 2029-12-01T00:00:00Z
sort: EARLIEST
required: true
responses:
"200":
description: "OK"
content:
application/json:
schema:
$ref: "#/components/schemas/Ownerships"
'400':
$ref: "#/components/responses/BadRequest"
'500':
$ref: "#/components/responses/ServerError"
/v0.1/ownerships/collections:
get:
tags:
- "NFT Ownerships"
summary: "Get collections owned items by owner"
description: "Returns list of collection with owned items by specified owner"
operationId: getCollectionsWithOwnedItems
parameters:
- name: "owners"
in: query
required: true
description: "Addresses of the owner"
schema:
type: array
items:
$ref: "#/components/schemas/UnionAddress"
- name: "blockchains"
description: "Since user's address can be present in several blockchains (for example, ETHEREUM and POLYGON),
\ you can use this filter to get Orders only for specific blockchains.
\ Or keep it empty to get Order from all blockchains"
in: query
required: false
schema:
type: array
items:
$ref: "#/components/schemas/Blockchain"
- name: "continuation"
in: query
required: false
description: "Continuation token from the previous response"
schema:
type: string
- name: "size"
in: query
required: false
description: "The number of items to return"
schema:
type: integer
responses:
"200":
description: "OK"
content:
application/json:
schema:
$ref: "#/components/schemas/CollectionsWithOwnedItems"
'400':
$ref: "#/components/responses/BadRequest"
'500':
$ref: "#/components/responses/ServerError"
######################## Order API ########################
/v0.1/orders/{id}:
get:
tags:
- "NFT Sales"
summary: "Get Order"
description: "Returns Order by Id"
operationId: getOrderById
parameters:
- name: "id"
in: "path"
required: true
description: "Order Id, has format '${blockchain}:${id}'"
schema:
$ref: "#/components/schemas/OrderId"
responses:
"200":
description: "OK"
content:
application/json:
schema:
$ref: "#/components/schemas/Order"
'404':
$ref: "#/components/responses/EntityNotFound"
'400':
$ref: "#/components/responses/BadRequest"
'500':
$ref: "#/components/responses/ServerError"
/v0.1/orders/{id}/prepareTx:
post:
tags:
- "NFT Sales"
summary: "Prepare order transaction"
description: "Prepare all required data to match given order on the blockchain"
operationId: prepareOrderTransaction
parameters:
- name: "id"
in: "path"
required: true
description: "Order Id, has format '${blockchain}:${id}'"
schema:
$ref: "#/components/schemas/OrderId"
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/PrepareOrderTxForm"
responses:
"200":
description: "OK"
content:
application/json:
schema:
$ref: "#/components/schemas/PrepareOrderTxResponse"
'404':
$ref: "#/components/responses/EntityNotFound"
'400':
$ref: "#/components/responses/BadRequest"
'500':
$ref: "#/components/responses/ServerError"
/v0.1/orders/{id}/prepareCancelTx:
post:
tags:
- "NFT Sales"
summary: "Prepare order cancel transaction"
description: "Prepare all required data to cancel given order on the blockchain"
operationId: prepareOrderCancelTransaction
parameters:
- name: "id"
in: "path"
required: true
description: "Order Id, has format '${blockchain}:${id}'"
schema:
$ref: "#/components/schemas/OrderId"
responses:
"200":
description: "OK"
content:
application/json:
schema:
$ref: "#/components/schemas/PreparedOrderTx"
'404':
$ref: "#/components/responses/EntityNotFound"
'400':
$ref: "#/components/responses/BadRequest"
'500':
$ref: "#/components/responses/ServerError"
/v0.1/orders/{id}/report:
post:
tags:
- "NFT Sales"
summary: "Report Order"
description: "Report Error Order"
operationId: reportOrderById
parameters:
- name: "id"
in: "path"
required: true
description: "Order Id, has format '${blockchain}:${id}'"
schema:
$ref: "#/components/schemas/OrderId"
responses:
"200":
description: "OK"
'404':
$ref: "#/components/responses/EntityNotFound"
'400':
$ref: "#/components/responses/BadRequest"
'500':
$ref: "#/components/responses/ServerError"