@xoxno/sdk-js 0.1.354 → 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,839 +0,0 @@
1
- import type { IEventDoc } from './event';
2
- import type { ActivityChain, CollectionInfo, Media, NftData, NFTMetadata, Owner, SaleInfo } from './nft';
3
- import type { NftActivityType } from './trading';
4
- import type { CreatorProfile, IUserProfileSearch, OfferBody } from './user';
5
- export interface ISocials {
6
- twitter: string;
7
- instagram: string;
8
- website: string;
9
- telegram: string;
10
- discord: string;
11
- facebook: string;
12
- youtube: string;
13
- }
14
- export interface IMintInfo {
15
- dataType: string;
16
- collection: string;
17
- contractAddress: string;
18
- collectionTag: string;
19
- cid: string;
20
- mediaType: string;
21
- baseNftName: string;
22
- hasAttributes: boolean;
23
- ownerTransferred: boolean;
24
- collectionSize: number;
25
- totalNftMinted: number;
26
- globalWalletLimit: number;
27
- royalties: number;
28
- oldVersion: boolean;
29
- nameShuffle: boolean;
30
- nftTransferLimited: boolean;
31
- allowsPublicBurn: boolean;
32
- kycRequired: boolean;
33
- allowsRefund: boolean;
34
- hasBotProtection: boolean;
35
- hasReveal: boolean;
36
- tags: string[];
37
- id: string;
38
- _ts: number;
39
- }
40
- export interface IMintInfoExtended extends IMintInfo {
41
- collectionInfo: CollectionInfo;
42
- }
43
- export interface CollectionCreatorInfo extends CreatorProfile {
44
- listing: IMintInfoExtended[];
45
- }
46
- export interface EventCreatorInfo extends CreatorProfile {
47
- events: IEventDoc[];
48
- }
49
- export interface CreatorInfo extends CollectionCreatorInfo, EventCreatorInfo {
50
- }
51
- export interface CollectionStatisticsProfile {
52
- tradeData: TradeData;
53
- mintData: MintStatistics;
54
- other: OtherStatistics;
55
- }
56
- export interface Rule {
57
- type: 'kiosk_lock_rule' | 'royalty_rule';
58
- amount_bp?: number;
59
- min_amount?: string;
60
- }
61
- export interface TransferPolicy {
62
- id: string;
63
- type: string;
64
- rules: Rule[];
65
- is_origin_byte: boolean;
66
- }
67
- export interface ICollectionProfile {
68
- dataType: 'collectionProfile';
69
- collection: string;
70
- name: string;
71
- description: string;
72
- isVisible: boolean;
73
- isVerified: boolean;
74
- profile: string;
75
- banner: string;
76
- statistics: CollectionStatisticsProfile;
77
- owner: string;
78
- creator: string;
79
- isMintable: boolean;
80
- hasStaking: boolean;
81
- id: string;
82
- socials: ISocials;
83
- type: string;
84
- chain?: ActivityChain;
85
- transferPolicies: TransferPolicy[];
86
- royalty?: number;
87
- minSalePrice?: string;
88
- lastVerifiedTimestamp: number;
89
- lastVerifiedBy: string;
90
- customConfig?: {
91
- collection: string;
92
- reversedCutFees: boolean;
93
- reversedRoyalties: boolean;
94
- customRoyalties: boolean;
95
- minRoyalties: number;
96
- maxRoyalties: number;
97
- extraFees: {
98
- amount: number;
99
- address: string;
100
- };
101
- };
102
- _ts: number;
103
- }
104
- export interface AttributeData {
105
- attributeOccurrence: number;
106
- floorPrice: number;
107
- onSaleCount: number;
108
- usdValue: number;
109
- }
110
- export interface MetadataAttribute {
111
- trait_type: string;
112
- value: string;
113
- }
114
- export interface TraitValues {
115
- [traitValue: string]: AttributeData;
116
- }
117
- export interface ICollectionAttributes {
118
- [traitType: string]: TraitValues;
119
- }
120
- export declare enum Marketplace {
121
- XO = "xoxno",
122
- FM = "frameit",
123
- DR = "deadrare",
124
- KG = "krogan"
125
- }
126
- export interface GlobalOffer {
127
- attributes: MetadataAttribute[];
128
- collection: string;
129
- isActive: boolean;
130
- marketplace: string;
131
- offer_id: number;
132
- owner: string;
133
- ownerProfile?: string;
134
- ownerUsername?: string;
135
- payment_nonce: number;
136
- payment_token: string;
137
- price: string;
138
- quantity: number;
139
- short_price: number;
140
- timestamp: number;
141
- }
142
- export declare enum FieldsToSelect {
143
- Rank = "metadata.rarity.rank",
144
- Attributes = "metadata.attributes",
145
- Description = "metadata.description",
146
- Name = "name",
147
- OnSale = "onSale",
148
- SaleInfo = "saleInfo",
149
- Royalties = "royalties",
150
- Identifier = "identifier",
151
- Collection = "collection",
152
- OriginalURL = "url",
153
- Nonce = "nonce",
154
- ContentType = "originalMedia.contentType",
155
- WasProcessed = "wasProcessed",
156
- AvifURL = "avifUrl",
157
- WebpURL = "webpUrl",
158
- Type = "type"
159
- }
160
- export declare enum SearchOrderBy {
161
- PriceHighToLow = "saleInfo.minBidShort desc",
162
- PriceLowToHigh = "saleInfo.minBidShort asc",
163
- MaxPriceHighToLow = "saleInfo.maxBidShort desc",
164
- MaxPriceLowToHigh = "saleInfo.maxBidShort asc",
165
- BidPriceHighToLow = "saleInfo.currentBidShort desc",
166
- BidPriceLowToHigh = "saleInfo.currentBidShort asc",
167
- RarityHighToLow = "metadata.rarity.rank desc",
168
- RarityLowToHigh = "metadata.rarity.rank asc",
169
- NonceHighToLow = "nonce desc",
170
- NonceLowToHigh = "nonce asc",
171
- RecentListed = "saleInfo.timestamp desc",
172
- OldestListed = "saleInfo.timestamp asc",
173
- EndingLate = "saleInfo.deadline desc",
174
- EndingSoon = "saleInfo.deadline asc"
175
- }
176
- export declare enum DropsOderBy {
177
- EndingLate = "startTime desc",
178
- EndingSoon = "startTime asc"
179
- }
180
- export declare enum SuggestOrderBy {
181
- TotalVolumeHighToLow = "statistics/tradeData/totalEgldVolume desc",
182
- FollowersHighToLow = "statistics/other/followCount desc",
183
- IsVerifiedTrueToFalse = "isVerified desc",
184
- HasImageTrueToFalse = "profile desc",
185
- HasBannerTrueToFalse = "banner desc"
186
- }
187
- export declare enum CollectionsOrderBy {
188
- WeekVolumeHighToLow = "statistics.tradeData.weekEgldVolume desc",
189
- WeekVolumeLowToHigh = "statistics.tradeData.weekEgldVolume asc",
190
- DailyVolumeHighToLow = "statistics.tradeData.dayEgldVolume desc",
191
- DailyVolumeLowToHigh = "statistics.tradeData.dayEgldVolume asc",
192
- TotalVolumeHighToLow = "statistics.tradeData.totalEgldVolume desc",
193
- TotalVolumeLowToHigh = "statistics.tradeData.totalEgldVolume asc",
194
- AvgVolumePriceHighToLow = "statistics.tradeData.averageEgldPrice desc",
195
- AvgVolumePriceLowToHigh = "statistics.tradeData.averageEgldPrice asc",
196
- ATHHighToLow = "statistics.tradeData.athEgldPrice desc",
197
- ATHLowToHigh = "statistics.tradeData.athEgldPrice asc",
198
- TotalTradesHighToLow = "statistics.tradeData.totalTrades desc",
199
- TotalTradesLowToHigh = "statistics.tradeData.totalTrades asc",
200
- SupplyHighToLow = "statistics.other.nftCount desc",
201
- SupplyLowToHigh = "statistics.other.nftCount asc",
202
- FollowersHighToLow = "statistics.other.followCount desc",
203
- FollowersLowToHigh = "statistics.other.followCount asc"
204
- }
205
- export declare enum GlobalOfferOrderBy {
206
- PriceHighToLow = "priceShort desc",
207
- PriceLowToHigh = "priceShort asc",
208
- OfferIdHighToLow = "offerIddesc",
209
- OfferIdLowToHigh = "offerId asc",
210
- RecentListed = "timestamp desc",
211
- OldestListed = "timestamp asc"
212
- }
213
- export declare enum CollectionsFieldsToSelect {
214
- Profile = "profile",
215
- Description = "description",
216
- Creator = "creator",
217
- Owner = "owner",
218
- Socials = "socials",
219
- Type = "type",
220
- HasStaking = "hasStaking",
221
- Name = "name",
222
- Banner = "banner",
223
- IsVerified = "isVerified",
224
- IsMintable = "isMintable",
225
- Statistics = "statistics",
226
- Collection = "collection"
227
- }
228
- export declare enum GlobalOfferFieldsToSelect {
229
- Attributes = "attributes",
230
- Collection = "collection",
231
- Marketplace = "marketplace",
232
- PaymentToken = "paymentToken",
233
- LongPrice = "price",
234
- ShortPrice = "priceShort"
235
- }
236
- export interface Filter {
237
- dataType?: string[];
238
- identifier?: string[];
239
- chain?: ActivityChain[];
240
- collection?: string[];
241
- mintToken?: string[];
242
- type?: string[];
243
- nonce?: number[];
244
- onSale?: boolean;
245
- owner?: string[];
246
- currentOwner?: string[];
247
- saleInfo?: {
248
- seller?: string[];
249
- paymentToken?: string[];
250
- marketplace?: string[];
251
- auctionType?: string[];
252
- };
253
- range?: RangeFilter[];
254
- metadata?: {
255
- attributes?: NftMetadataAttributes[];
256
- };
257
- wasProcessed?: boolean;
258
- cp_staked?: boolean;
259
- activeAuction?: boolean;
260
- customFilter?: string;
261
- verifiedOnly?: boolean;
262
- }
263
- export interface NftMetadataAttributes {
264
- trait_type: string;
265
- value: string;
266
- }
267
- export interface SearchNFTs {
268
- name?: string;
269
- filters: Filter;
270
- applyNftExtraDetails?: boolean;
271
- select?: string[];
272
- strictSelect?: boolean;
273
- orderBy?: string[];
274
- top?: number;
275
- skip?: number;
276
- includeCount?: boolean;
277
- }
278
- export declare enum AuctionTypes {
279
- FixedPrice = "FixedPrice",
280
- Auctions = "Auctions",
281
- All = "All",
282
- AllListed = "AllListed"
283
- }
284
- export interface GetNFTsArgs {
285
- /** Listed by different users */
286
- listedBy?: string[];
287
- /** Owned by different users */
288
- ownedBy?: string[];
289
- identifiers?: string[];
290
- auctionType: AuctionTypes;
291
- /** If set, will return only NFTs from the specified collections */
292
- collections?: string[];
293
- chain?: ActivityChain[];
294
- /** If set, will return only NFTs from verified collections */
295
- onlyVerified?: boolean;
296
- /** If true, will return only NFTs that are on sale */
297
- onlyOnSale?: boolean;
298
- /** If true, will return only NFTs that are active, deadline not expired */
299
- activeAuctions?: boolean;
300
- /** If true the extra details of an NFT will be appended to each NFT, such as collection size and owners name */
301
- applyNftExtraDetails?: boolean;
302
- /** If set, will return only NFTs with a price in the specified range */
303
- priceRange?: {
304
- min: number;
305
- max: number;
306
- };
307
- /** If set, will return only NFTs listed in the specified tokens */
308
- listedInToken?: string[];
309
- /** If set, will return only NFTs with a rank in the specified range */
310
- rankRange?: {
311
- min: number;
312
- max: number;
313
- };
314
- /** If set, will return only NFTs with a cantina level in the specified range */
315
- cantinaLevelRange?: {
316
- min: number;
317
- max: number;
318
- };
319
- /** If set, will return the total count of the NFTs, recommended to be set true only for the first call, then false for the next pages */
320
- includeCount?: boolean;
321
- /** If set, will apply the extra manual filters on top of the main payload */
322
- extraSearch?: string[];
323
- /** If set, will return only NFTs with a name that contains the specified string */
324
- searchName?: string;
325
- /** The number of results to return */
326
- top?: number;
327
- /** The order by to use */
328
- skip?: number;
329
- /** Document type */
330
- dataType?: string[];
331
- /** The nonces of the NFTs */
332
- nonces?: number[];
333
- /** If set, will return only NFTs that are staked */
334
- isStaked?: boolean;
335
- /** The order of the results based on a field */
336
- orderBy?: SearchOrderBy[];
337
- /** If set, will return only the specified fields */
338
- onlySelectFields?: FieldsToSelect[];
339
- /** If set, will return only NFTs listed in the specified marketplaces */
340
- listedOnlyOn?: Marketplace[];
341
- /** If set, will return only NFTs with the specified attributes */
342
- attributes?: MetadataAttribute[];
343
- /** If set, will return only the selected fields */
344
- strictSelect?: boolean;
345
- name?: string;
346
- }
347
- export interface GETDropsArgs {
348
- name?: string;
349
- /** If set, will return only NFTs from the specified collections */
350
- collections?: string[];
351
- chain?: ActivityChain[];
352
- /** If set, will return only NFTs from verified collections */
353
- onlyVerified?: boolean;
354
- /** If set, will return only NFTs listed in the specified tokens */
355
- listedInToken?: string[];
356
- /** If set, will return only NFTs with a cantina level in the specified range */
357
- timeRange?: {
358
- min: number;
359
- max: number;
360
- };
361
- /** If set, will return the total count of the NFTs, recommended to be set true only for the first call, then false for the next pages */
362
- includeCount?: boolean;
363
- /** The number of results to return */
364
- top?: number;
365
- /** The order by to use */
366
- skip?: number;
367
- /** The order of the results based on a field */
368
- orderBy?: DropsOderBy[];
369
- /** If set, will return only the specified fields */
370
- onlySelectFields?: FieldsToSelect[];
371
- }
372
- export interface SuggestNFTsArgs {
373
- /** If set, will return only collections or users with a name that contains the specified string */
374
- name: string;
375
- /** The number of results to return */
376
- top?: number;
377
- /** The order by to use */
378
- skip?: number;
379
- /** The order of the results based on a field */
380
- orderBy?: SuggestOrderBy[];
381
- chain?: ActivityChain[];
382
- }
383
- export interface SearchNFTsResponse {
384
- /** The total count of the results for the specific query */
385
- count?: number;
386
- /** The results for the current page */
387
- resources: NftData[];
388
- /** The payload to use to get the next page */
389
- getNextPagePayload: GetNFTsArgs;
390
- /** If there are more results to fetch */
391
- hasMoreResults: boolean;
392
- }
393
- export interface GetDropsResponse {
394
- /** The total count of the results for the specific query */
395
- count?: number;
396
- /** The results for the current page */
397
- resources: GetCollectionMintInfo[];
398
- /** The payload to use to get the next page */
399
- getNextPagePayload: GETDropsArgs;
400
- /** If there are more results to fetch */
401
- hasMoreResults: boolean;
402
- }
403
- export interface OfferFilters {
404
- isActive?: boolean[];
405
- identifier?: string[];
406
- collection?: string[];
407
- owner?: string[];
408
- nftOwner?: string[];
409
- marketplace?: Marketplace[];
410
- range?: {
411
- min: number;
412
- max: number;
413
- field: string;
414
- }[];
415
- }
416
- export interface GetOffersArgs {
417
- select?: string[];
418
- strictSelect?: boolean;
419
- orderBy?: string[];
420
- top?: number;
421
- skip?: number;
422
- includeCount?: boolean;
423
- filters?: OfferFilters;
424
- }
425
- export interface GetOffersResponse {
426
- count?: number;
427
- resources: OfferBody[];
428
- hasMoreResults: boolean;
429
- }
430
- export type ActivityData = {
431
- collection: string;
432
- identifier: string;
433
- price: number;
434
- paymentToken: string;
435
- scId: number;
436
- usdValue: number;
437
- egldValue: number;
438
- nftInfo: Pick<NftData, 'identifier' | 'collection' | 'name' | 'metadata' | 'url' | 'wasProcessed' | 'media'>;
439
- collectionInfo: ShortCollectionInfo;
440
- originalTokenAmount?: string;
441
- originalTokenAmountShort?: number;
442
- originalTokenEgldValue?: number;
443
- originalTokenUsdValue?: number;
444
- originalTokenIdentifier?: string;
445
- };
446
- export type ShortCollectionInfo = Pick<ICollectionProfile, 'name' | 'isVerified' | 'isVisible' | 'profile' | 'description'> & {
447
- collectionSize: number;
448
- holderCount: number;
449
- followCount: number;
450
- };
451
- export type TradingActivity = {
452
- id: string;
453
- txHash: string;
454
- eventIdentifier: string;
455
- timestamp: number;
456
- activityType: NftActivityType;
457
- source: string;
458
- from: Owner;
459
- to: Owner;
460
- activityData: ActivityData;
461
- chain?: ActivityChain;
462
- };
463
- export interface GetCollectionsArgs {
464
- /** The collections to fetch the profile */
465
- collections?: string[];
466
- chain?: ActivityChain[];
467
- /** If true, will return only NFTs that are mintable */
468
- onlyMintable?: boolean;
469
- /** The number of results to return */
470
- top?: number;
471
- /** The order by to use */
472
- skip?: number;
473
- /** The order of the results based on a field */
474
- orderBy?: CollectionsOrderBy;
475
- /** If set, will return only the specified fields */
476
- onlySelectFields?: CollectionsFieldsToSelect[];
477
- }
478
- export interface GetGlobalOffersArgs {
479
- /** The collections to fetch the profile */
480
- collections?: string[];
481
- /** The number of results to return */
482
- top?: number;
483
- /** The order by to use */
484
- skip?: number;
485
- /** The order of the results based on a field */
486
- orderBy?: GlobalOfferOrderBy[];
487
- /** If set, will return only the offers with required attributes */
488
- withAttributes?: boolean;
489
- /** If set, will return only the specified fields */
490
- onlySelectFields?: GlobalOfferFieldsToSelect[];
491
- onlyActive?: boolean;
492
- offerIds?: number[];
493
- ownedBy?: string[];
494
- listedOnlyOn?: Marketplace[];
495
- priceRange?: RangeFilter;
496
- attributes?: MetadataAttribute[];
497
- }
498
- export interface CollectionsNFTsResponse {
499
- /** The results count for the current page */
500
- resultsCount: number;
501
- /** The results for the current page */
502
- results: ICollectionProfile[];
503
- /** If the results are empty */
504
- empty: boolean;
505
- /** The payload to use to get the next page */
506
- getNextPagePayload: GetCollectionsArgs;
507
- /** If there are more results to fetch */
508
- hasMoreResults: boolean;
509
- }
510
- export interface SuggestResults {
511
- count: number;
512
- hasMoreResults: boolean;
513
- resources: ResultsBody;
514
- }
515
- export interface ResultsBody {
516
- collections: (ICollectionProfile & {
517
- floorPrice: number;
518
- })[];
519
- users: IUserProfileSearch[];
520
- nft: NftData[];
521
- }
522
- export interface OtherStatistics {
523
- nftCount: number;
524
- followCount: number;
525
- holdersCount?: number;
526
- }
527
- export interface TradeData {
528
- dayEgldVolume: number;
529
- weekEgldVolume: number;
530
- totalEgldVolume: number;
531
- averageEgldPrice: number;
532
- athEgldPrice: number;
533
- athTxHash: string;
534
- totalTrades: number;
535
- }
536
- export interface MintStatistics {
537
- totalMintEgldVolume: number;
538
- weekMintEgldVolume: number;
539
- dayMintEgldVolume: number;
540
- }
541
- export interface CollectionVolume {
542
- Day: string;
543
- DR_Trades: number;
544
- DR_Volume: number;
545
- DR_VolumeUSD: number;
546
- DR_Buyers: number;
547
- DR_Sellers: number;
548
- DR_FeesPaid: number;
549
- DR_FeesPaidUSD: number;
550
- DR_RoyaltiesPaid: number;
551
- DR_RoyaltiesPaidUSD: number;
552
- FM_Trades: number;
553
- FM_Volume: number;
554
- FM_VolumeUSD: number;
555
- FM_Buyers: number;
556
- FM_Sellers: number;
557
- FM_FeesPaid: number;
558
- FM_FeesPaidUSD: number;
559
- FM_RoyaltiesPaid: number;
560
- FM_RoyaltiesPaidUSD: number;
561
- KG_Trades: number;
562
- KG_Volume: number;
563
- KG_VolumeUSD: number;
564
- KG_Buyers: number;
565
- KG_Sellers: number;
566
- KG_FeesPaid: number;
567
- KG_FeesPaidUSD: number;
568
- KG_RoyaltiesPaid: number;
569
- KG_RoyaltiesPaidUSD: number;
570
- Total_Trades: number;
571
- Total_Volume: number;
572
- Total_VolumeUSD: number;
573
- Total_Buyers: number;
574
- Total_Sellers: number;
575
- Total_FeesPaid: number;
576
- Total_FeesPaidUSD: number;
577
- Total_RoyaltiesPaid: number;
578
- Total_RoyaltiesPaidUSD: number;
579
- XO_Trades: number;
580
- XO_Volume: number;
581
- XO_VolumeUSD: number;
582
- XO_Buyers: number;
583
- XO_Sellers: number;
584
- XO_FeesPaid: number;
585
- XO_FeesPaidUSD: number;
586
- XO_RoyaltiesPaid: number;
587
- XO_RoyaltiesPaidUSD: number;
588
- }
589
- export interface FloorPriceHistory {
590
- Day: string;
591
- FloorPrice: number;
592
- AveragePrice: number;
593
- }
594
- export type FungibleAssets = {
595
- id?: string;
596
- identifier: string;
597
- collection?: string;
598
- dataType?: string;
599
- decimals: number;
600
- name: string;
601
- type: string;
602
- category: string[];
603
- svgUrl: string;
604
- pngUrl: string;
605
- ticker: string;
606
- usdPrice?: number;
607
- isAshSupported: boolean;
608
- _ts?: number;
609
- chain?: ActivityChain;
610
- };
611
- export type FungibleAssetsMap = {
612
- [key: string]: FungibleAssets;
613
- };
614
- export declare enum AssetCategory {
615
- ALL = "all",
616
- Trade = "trade",
617
- P2P = "p2p",
618
- Staking = "staking",
619
- Minting = "minting"
620
- }
621
- export type ISingleHolder = {
622
- address: string;
623
- username?: string;
624
- count: number;
625
- weight: number;
626
- };
627
- export type IOwners = {
628
- totalSupply: number;
629
- onMarket: HoldedDetails;
630
- staked: HoldedDetails;
631
- otherSCs: HoldedDetails;
632
- burnWallet: HoldedDetails;
633
- uniqueHolders: HoldedDetails;
634
- holded: AvgHolder;
635
- walletDetails: ISingleHolder[];
636
- };
637
- export type HoldedDetails = {
638
- count: number;
639
- weight: number;
640
- };
641
- export interface AvgHolder extends HoldedDetails {
642
- avgPerHodler: number;
643
- }
644
- export type GlobalOffersResult = {
645
- resources: GlobalOffers[];
646
- hasMoreResults: boolean;
647
- lastSkip: number;
648
- getNextPagePayload?: GetGlobalOffersArgs;
649
- };
650
- export type GlobalOffers = {
651
- offerId: number;
652
- collection: string;
653
- quantity: number;
654
- paymentToken: string;
655
- price: string;
656
- priceShort: number;
657
- owner: Owner;
658
- usdValue: string;
659
- marketplace: string;
660
- timestamp: number;
661
- attributes: MetadataAttribute[];
662
- collectionInfo?: CollectionInfo;
663
- isActive: boolean;
664
- floorPrice: number;
665
- floorPriceMargin: number | null;
666
- chain?: ActivityChain;
667
- };
668
- export type GlobalOfferOwner = {
669
- address: string;
670
- userName: string;
671
- profile: string;
672
- };
673
- export type CollectionRanksExport = Partial<Pick<NftData, 'identifier' | 'name'>> & {
674
- rank: number;
675
- };
676
- export type GetCollectionMintInfo = {
677
- collection: string;
678
- contractAddress: string;
679
- collectionTag: string;
680
- startTime: number;
681
- prices?: StagePrice[];
682
- nftTransferLimited: boolean;
683
- hasBotProtection: boolean;
684
- kycRequired: boolean;
685
- totalNftMinted: number;
686
- collectionSize: number;
687
- globalWalletLimit: number;
688
- cid: string;
689
- hasMetadata: boolean;
690
- mediaType: string;
691
- mintStages: MintStage[];
692
- collectionInfo: CollectionInfo;
693
- creatorInfo: CreatorProfile;
694
- isExcludedFromMint: boolean;
695
- };
696
- export type MintStage = {
697
- name: string;
698
- startTime: number;
699
- endTime: number;
700
- mintCount: number;
701
- mintLimit: number;
702
- mintEnabled: boolean;
703
- isWhitelist: boolean;
704
- walletLimit: number;
705
- maxBuyable?: number;
706
- walletLimitReached?: boolean;
707
- userMintsPerStage?: number;
708
- prices?: StagePrice[];
709
- isSoldOut: boolean;
710
- };
711
- export type StagePrice = {
712
- tokenIdentifier: string;
713
- tokenNonce: string;
714
- amount: string;
715
- amountShort: number;
716
- usdValue: number;
717
- decimals: number;
718
- };
719
- export type CollectionStatsResults = {
720
- resources: CollectionStatsDoc[];
721
- hasMoreResults: boolean;
722
- getNextPagePayload?: GetCollectionStatsArgs;
723
- };
724
- export type GetCollectionStatsArgs = {
725
- filters?: {
726
- chain?: ActivityChain[];
727
- collection?: string[];
728
- verifiedOnly?: boolean;
729
- range?: RangeFilter[];
730
- };
731
- orderBy?: CollectionStatsOrderBy[];
732
- select?: CollectionStatsSelectFields[];
733
- top: number;
734
- skip: number;
735
- };
736
- export declare enum CollectionStatsSelectFields {
737
- TradingStats = "tradingStats"
738
- }
739
- export interface RangeFilter {
740
- min?: number;
741
- max?: number;
742
- field?: string;
743
- }
744
- export declare enum CollectionStatsOrderBy {
745
- ListedCountDesc = "tradingStats.listedCount DESC",
746
- ListedCountAsc = "tradingStats.listedCount ASC",
747
- FloorPriceDesc = "tradingStats.floorPrice DESC",
748
- FloorPriceAsc = "tradingStats.floorPrice ASC",
749
- TotalVolumeDesc = "tradingStats.totalVolume DESC",
750
- TotalVolumeAsc = "tradingStats.totalVolume ASC",
751
- TotalTradesDesc = "tradingStats.totalTrades DESC",
752
- TotalTradesAsc = "tradingStats.totalTrades ASC",
753
- AllTimeHighDesc = "tradingStats.allTimeHigh.price DESC",
754
- AllTimeHighAsc = "tradingStats.allTimeHigh.price ASC",
755
- DayVolumeDesc = "tradingStats.day.volume DESC",
756
- DayVolumeAsc = "tradingStats.day.volume ASC",
757
- DayVolumeMarginDesc = "tradingStats.day.volumeMargin DESC",
758
- DayVolumeMarginAsc = "tradingStats.day.volumeMargin ASC",
759
- DayTradesDesc = "tradingStats.day.trades DESC",
760
- DayTradesAsc = "tradingStats.day.trades ASC",
761
- DayTradesMarginDesc = "tradingStats.day.tradesMargin DESC",
762
- DayTradesMarginAsc = "tradingStats.day.tradesMargin ASC",
763
- WeekVolumeDesc = "tradingStats.week.volume DESC",
764
- WeekVolumeAsc = "tradingStats.week.volume ASC",
765
- WeekVolumeMarginDesc = "tradingStats.week.volumeMargin DESC",
766
- WeekVolumeMarginAsc = "tradingStats.week.volumeMargin ASC",
767
- WeekTradesDesc = "tradingStats.week.trades DESC",
768
- WeekTradesAsc = "tradingStats.week.trades ASC",
769
- WeekTradesMarginDesc = "tradingStats.week.tradesMargin DESC",
770
- WeekTradesMarginAsc = "tradingStats.week.tradesMargin ASC",
771
- MonthVolumeDesc = "tradingStats.month.volume DESC",
772
- MonthVolumeAsc = "tradingStats.month.volume ASC",
773
- MonthVolumeMarginDesc = "tradingStats.month.volumeMargin DESC",
774
- MonthVolumeMarginAsc = "tradingStats.month.volumeMargin ASC",
775
- MonthTradesDesc = "tradingStats.month.trades DESC",
776
- MonthTradesAsc = "tradingStats.month.trades ASC",
777
- MonthTradesMarginDesc = "tradingStats.month.tradesMargin DESC",
778
- MonthTradesMarginAsc = "tradingStats.month.tradesMargin ASC",
779
- YearVolumeDesc = "tradingStats.year.volume DESC",
780
- YearVolumeAsc = "tradingStats.year.volume ASC",
781
- YearVolumeMarginDesc = "tradingStats.year.volumeMargin DESC",
782
- YearVolumeMarginAsc = "tradingStats.year.volumeMargin ASC",
783
- YearTradesDesc = "tradingStats.year.trades DESC",
784
- YearTradesAsc = "tradingStats.year.trades ASC",
785
- YearTradesMarginDesc = "tradingStats.year.tradesMargin DESC",
786
- YearTradesMarginAsc = "tradingStats.year.tradesMargin ASC"
787
- }
788
- export type CollectionStatsDoc = {
789
- collection: string;
790
- listedCount: number;
791
- floorPrice: number;
792
- tradingStats: {
793
- totalVolume: number;
794
- totalTrades: number;
795
- allTimeHigh: {
796
- price: number;
797
- timestamp: number;
798
- txHash: string;
799
- identifier: string;
800
- };
801
- day: TradingDataSummary;
802
- week: TradingDataSummary;
803
- month: TradingDataSummary;
804
- quarter: TradingDataSummary;
805
- halfYear: TradingDataSummary;
806
- year: TradingDataSummary;
807
- };
808
- collectionInfo: CollectionInfo;
809
- id: string;
810
- };
811
- export type TradingDataSummary = {
812
- volume: number;
813
- volumeMargin: number;
814
- trades: number;
815
- tradesMargin: number;
816
- minPrice?: number;
817
- maxPrice?: number;
818
- averagePrice?: number;
819
- };
820
- export interface CollectionListings {
821
- density: Density[];
822
- listings: Pick<NftData, 'name' | 'collection' | 'metadata' | 'saleInfo' | 'wasProcessed' | 'media' | 'url' | 'identifier' | 'id'>[];
823
- }
824
- export interface Density {
825
- key: string;
826
- intervalName: string;
827
- intervalCount: number;
828
- totalCount: number;
829
- }
830
- export interface Listing {
831
- identifier: string;
832
- name: string;
833
- collection: string;
834
- metadata: Pick<NFTMetadata, 'rarity'>;
835
- url: string;
836
- media: Media;
837
- wasProcessed: boolean;
838
- saleInfo: Pick<SaleInfo, 'minBidShort'>;
839
- }