# Class: CollectionStatsDoc\ Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:142](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts#L142) ## Extends - [`BaseStatsDoc`](https://docs.bitbadges.io/sdk/reference/classes/base-stats-doc)\<`T`\> ## Type Parameters ### T `T` *extends* [`NumberType`](https://docs.bitbadges.io/sdk/reference/type-aliases/number-type) ## Implements - [`iCollectionStatsDoc`](https://docs.bitbadges.io/sdk/reference/interfaces/i-collection-stats-doc)\<`T`\> ## Constructors ### Constructor > **new CollectionStatsDoc**\<`T`\>(`data`): `CollectionStatsDoc`\<`T`\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:149](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts#L149) #### Parameters ##### data [`iCollectionStatsDoc`](https://docs.bitbadges.io/sdk/reference/interfaces/i-collection-stats-doc)\<`T`\> #### Returns `CollectionStatsDoc`\<`T`\> #### Overrides [`BaseStatsDoc`](https://docs.bitbadges.io/sdk/reference/classes/base-stats-doc).[`constructor`](https://docs.bitbadges.io/sdk/reference/classes/base-stats-doc#constructor) ## Properties ### \_docId > **\_docId**: `string` Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:102](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts#L102) A unique stringified document ID #### Implementation of [`iCollectionStatsDoc`](https://docs.bitbadges.io/sdk/reference/interfaces/i-collection-stats-doc).[`_docId`](https://docs.bitbadges.io/sdk/reference/interfaces/i-collection-stats-doc#_docid) #### Inherited from [`BaseStatsDoc`](https://docs.bitbadges.io/sdk/reference/classes/base-stats-doc).[`_docId`](https://docs.bitbadges.io/sdk/reference/classes/base-stats-doc#_docid) *** ### \_id? > `optional` **\_id?**: `string` Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:103](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts#L103) A unique document ID (Mongo DB ObjectID) #### Implementation of [`iCollectionStatsDoc`](https://docs.bitbadges.io/sdk/reference/interfaces/i-collection-stats-doc).[`_id`](https://docs.bitbadges.io/sdk/reference/interfaces/i-collection-stats-doc#_id) #### Inherited from [`BaseStatsDoc`](https://docs.bitbadges.io/sdk/reference/classes/base-stats-doc).[`_id`](https://docs.bitbadges.io/sdk/reference/classes/base-stats-doc#_id) *** ### collectionId > **collectionId**: `string` Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:143](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts#L143) The collection ID #### Implementation of [`iCollectionStatsDoc`](https://docs.bitbadges.io/sdk/reference/interfaces/i-collection-stats-doc).[`collectionId`](https://docs.bitbadges.io/sdk/reference/interfaces/i-collection-stats-doc#collectionid) *** ### dailyVolume > **dailyVolume**: [`CosmosCoin`](https://docs.bitbadges.io/sdk/reference/classes/cosmos-coin)\<`T`\>[] Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:107](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts#L107) The daily volume of the collection #### Implementation of [`iCollectionStatsDoc`](https://docs.bitbadges.io/sdk/reference/interfaces/i-collection-stats-doc).[`dailyVolume`](https://docs.bitbadges.io/sdk/reference/interfaces/i-collection-stats-doc#dailyvolume) #### Inherited from [`BaseStatsDoc`](https://docs.bitbadges.io/sdk/reference/classes/base-stats-doc).[`dailyVolume`](https://docs.bitbadges.io/sdk/reference/classes/base-stats-doc#dailyvolume) *** ### floorPriceHistory? > `optional` **floorPriceHistory?**: [`FloorPriceHistory`](https://docs.bitbadges.io/sdk/reference/classes/floor-price-history)\<`T`\>[] Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:146](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts#L146) Floor price history #### Implementation of [`iCollectionStatsDoc`](https://docs.bitbadges.io/sdk/reference/interfaces/i-collection-stats-doc).[`floorPriceHistory`](https://docs.bitbadges.io/sdk/reference/interfaces/i-collection-stats-doc#floorpricehistory) *** ### floorPrices? > `optional` **floorPrices?**: [`CosmosCoin`](https://docs.bitbadges.io/sdk/reference/classes/cosmos-coin)\<`T`\>[] Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:144](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts#L144) Floor price of the collection #### Implementation of [`iCollectionStatsDoc`](https://docs.bitbadges.io/sdk/reference/interfaces/i-collection-stats-doc).[`floorPrices`](https://docs.bitbadges.io/sdk/reference/interfaces/i-collection-stats-doc#floorprices) *** ### lastUpdatedAt > **lastUpdatedAt**: `T` Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:115](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts#L115) Last set timestamp #### Implementation of [`iCollectionStatsDoc`](https://docs.bitbadges.io/sdk/reference/interfaces/i-collection-stats-doc).[`lastUpdatedAt`](https://docs.bitbadges.io/sdk/reference/interfaces/i-collection-stats-doc#lastupdatedat) #### Inherited from [`BaseStatsDoc`](https://docs.bitbadges.io/sdk/reference/classes/base-stats-doc).[`lastUpdatedAt`](https://docs.bitbadges.io/sdk/reference/classes/base-stats-doc#lastupdatedat) *** ### monthlyVolume > **monthlyVolume**: [`CosmosCoin`](https://docs.bitbadges.io/sdk/reference/classes/cosmos-coin)\<`T`\>[] Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:111](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts#L111) The monthly volume of the collection #### Implementation of [`iCollectionStatsDoc`](https://docs.bitbadges.io/sdk/reference/interfaces/i-collection-stats-doc).[`monthlyVolume`](https://docs.bitbadges.io/sdk/reference/interfaces/i-collection-stats-doc#monthlyvolume) #### Inherited from [`BaseStatsDoc`](https://docs.bitbadges.io/sdk/reference/classes/base-stats-doc).[`monthlyVolume`](https://docs.bitbadges.io/sdk/reference/classes/base-stats-doc#monthlyvolume) *** ### overallVolume > **overallVolume**: [`CosmosCoin`](https://docs.bitbadges.io/sdk/reference/classes/cosmos-coin)\<`T`\>[] Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:105](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts#L105) The overall volume of the collection #### Implementation of [`iCollectionStatsDoc`](https://docs.bitbadges.io/sdk/reference/interfaces/i-collection-stats-doc).[`overallVolume`](https://docs.bitbadges.io/sdk/reference/interfaces/i-collection-stats-doc#overallvolume) #### Inherited from [`BaseStatsDoc`](https://docs.bitbadges.io/sdk/reference/classes/base-stats-doc).[`overallVolume`](https://docs.bitbadges.io/sdk/reference/classes/base-stats-doc#overallvolume) *** ### payoutRewards? > `optional` **payoutRewards?**: [`CosmosCoin`](https://docs.bitbadges.io/sdk/reference/classes/cosmos-coin)\<`T`\>[] Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:147](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts#L147) The payout reward #### Implementation of [`iCollectionStatsDoc`](https://docs.bitbadges.io/sdk/reference/interfaces/i-collection-stats-doc).[`payoutRewards`](https://docs.bitbadges.io/sdk/reference/interfaces/i-collection-stats-doc#payoutrewards) *** ### uniqueOwners > **uniqueOwners**: [`BalanceArray`](https://docs.bitbadges.io/sdk/reference/classes/balance-array)\<`T`\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:145](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts#L145) Number of unique owners by time #### Implementation of [`iCollectionStatsDoc`](https://docs.bitbadges.io/sdk/reference/interfaces/i-collection-stats-doc).[`uniqueOwners`](https://docs.bitbadges.io/sdk/reference/interfaces/i-collection-stats-doc#uniqueowners) *** ### weeklyVolume > **weeklyVolume**: [`CosmosCoin`](https://docs.bitbadges.io/sdk/reference/classes/cosmos-coin)\<`T`\>[] Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:109](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts#L109) The weekly volume of the collection #### Implementation of [`iCollectionStatsDoc`](https://docs.bitbadges.io/sdk/reference/interfaces/i-collection-stats-doc).[`weeklyVolume`](https://docs.bitbadges.io/sdk/reference/interfaces/i-collection-stats-doc#weeklyvolume) #### Inherited from [`BaseStatsDoc`](https://docs.bitbadges.io/sdk/reference/classes/base-stats-doc).[`weeklyVolume`](https://docs.bitbadges.io/sdk/reference/classes/base-stats-doc#weeklyvolume) *** ### yearlyVolume > **yearlyVolume**: [`CosmosCoin`](https://docs.bitbadges.io/sdk/reference/classes/cosmos-coin)\<`T`\>[] Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:113](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts#L113) The yearly volume of the collection #### Implementation of [`iCollectionStatsDoc`](https://docs.bitbadges.io/sdk/reference/interfaces/i-collection-stats-doc).[`yearlyVolume`](https://docs.bitbadges.io/sdk/reference/interfaces/i-collection-stats-doc#yearlyvolume) #### Inherited from [`BaseStatsDoc`](https://docs.bitbadges.io/sdk/reference/classes/base-stats-doc).[`yearlyVolume`](https://docs.bitbadges.io/sdk/reference/classes/base-stats-doc#yearlyvolume) ## Methods ### clone() > **clone**(): [`BaseStatsDoc`](https://docs.bitbadges.io/sdk/reference/classes/base-stats-doc) Defined in: [packages/bitbadgesjs-sdk/src/common/base.ts:151](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/common/base.ts#L151) Deep copies the object and returns a new instance. #### Returns [`BaseStatsDoc`](https://docs.bitbadges.io/sdk/reference/classes/base-stats-doc) #### Inherited from [`BaseStatsDoc`](https://docs.bitbadges.io/sdk/reference/classes/base-stats-doc).[`clone`](https://docs.bitbadges.io/sdk/reference/classes/base-stats-doc#clone) *** ### convert() > **convert**\<`U`\>(`convertFunction`, `options?`): `CollectionStatsDoc`\<`U`\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:164](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts#L164) Converts the object to a different NumberType equivalent. #### Type Parameters ##### U `U` *extends* [`NumberType`](https://docs.bitbadges.io/sdk/reference/type-aliases/number-type) #### Parameters ##### convertFunction (`val`) => `U` ##### options? [`ConvertOptions`](https://docs.bitbadges.io/sdk/reference/interfaces/convert-options) #### Returns `CollectionStatsDoc`\<`U`\> #### Overrides [`BaseStatsDoc`](https://docs.bitbadges.io/sdk/reference/classes/base-stats-doc).[`convert`](https://docs.bitbadges.io/sdk/reference/classes/base-stats-doc#convert) *** ### equals() > **equals**\<`U`\>(`other`, `normalizeNumberTypes?`): `boolean` Defined in: [packages/bitbadgesjs-sdk/src/common/base.ts:147](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/common/base.ts#L147) Compares this object's fields to another object's fields for equality. Equality is determined by comparing the JSON representations of the objects. If `normalizeNumberTypes` is true, then all number types will be compared as strings (i.e. "1n" === "1" === 1). Else, they will be compared as their native types (i.e. 1n !== 1 !== "1"). #### Type Parameters ##### U `U` *extends* [`CustomType`](https://docs.bitbadges.io/sdk/reference/interfaces/custom-type)\<`U`\> #### Parameters ##### other [`CustomType`](https://docs.bitbadges.io/sdk/reference/interfaces/custom-type)\<`U`\> \| `null` \| `undefined` ##### normalizeNumberTypes? `boolean` #### Returns `boolean` #### Inherited from [`BaseStatsDoc`](https://docs.bitbadges.io/sdk/reference/classes/base-stats-doc).[`equals`](https://docs.bitbadges.io/sdk/reference/classes/base-stats-doc#equals) *** ### getNumberFieldNames() > **getNumberFieldNames**(): `string`[] Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:160](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts#L160) Internal helper method to convert the number fields of the object to a different NumberType equivalent. #### Returns `string`[] #### Overrides [`BaseStatsDoc`](https://docs.bitbadges.io/sdk/reference/classes/base-stats-doc).[`getNumberFieldNames`](https://docs.bitbadges.io/sdk/reference/classes/base-stats-doc#getnumberfieldnames) *** ### hasNumberFields() > **hasNumberFields**(): `boolean` Defined in: [packages/bitbadgesjs-sdk/src/common/base.ts:161](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/common/base.ts#L161) Checks if the object has number fields. #### Returns `boolean` #### Inherited from [`BaseStatsDoc`](https://docs.bitbadges.io/sdk/reference/classes/base-stats-doc).[`hasNumberFields`](https://docs.bitbadges.io/sdk/reference/classes/base-stats-doc#hasnumberfields) *** ### toJson() > **toJson**(): `JsonObject` Defined in: [packages/bitbadgesjs-sdk/src/common/base.ts:139](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/common/base.ts#L139) Converts the object to a JSON object with all primitive types. #### Returns `JsonObject` #### Inherited from [`BaseStatsDoc`](https://docs.bitbadges.io/sdk/reference/classes/base-stats-doc).[`toJson`](https://docs.bitbadges.io/sdk/reference/classes/base-stats-doc#tojson) *** ### toJsonString() > **toJsonString**(): `string` Defined in: [packages/bitbadgesjs-sdk/src/common/base.ts:143](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/common/base.ts#L143) Converts the object to a JSON string. #### Returns `string` #### Inherited from [`BaseStatsDoc`](https://docs.bitbadges.io/sdk/reference/classes/base-stats-doc).[`toJsonString`](https://docs.bitbadges.io/sdk/reference/classes/base-stats-doc#tojsonstring)