Each collection on PopRank is represented as a Collection object.
| Property | Description | Type(s) |
|---|---|---|
| slug | The identifier of the collection used in the collection URL. | string |
| address | The smart contract address associated with this collection. | string |
| name | The display name of the collection (does not have to be unique). | string |
| description | A summary that describes the collection. | string |
| profileUrl | Link to the collection's profile image (square). | string |
| featureUrl | Link to the collection's feature image (landscape). | string |
| size | The number of items in the collection. | number |
| threshold | size multiplied by threshold is the number of played rounds needed to achieve aesthetic rank reliability (ARR). | number |
| active | If false, the collection exists on PopRank but is inaccessible. | boolean |
| traits | The JSON of all collection traits. | object |
| featured | A positive integer means the collection is featured on PopRank's home page. | number |
| timestamp | The date and time the collection was listed on PopRank. | string |
| sample_id | An example of the length and format of the token IDs in the collection. | string |
| chain | A list of blockchains the collection is live on. | ('ethereum' | 'polygon' | 'solana')[] |
| categories | The categories that apply to the collection. | ('gen-art' | 'gaming' | 'avatar')[] |
| lastUpdated | The UNIX timestamp since the last collection update. | number |
| collectionType | The type of collection. Currently always default to default. | string |
| privateAddresses | The array of addresses that are allowed to see this collection. A defined value here means the collection is private. | string[] |
| floorPrice | The current floor price of the collection. | number |
| seen | The number of times the collection's NFTs have been seen. | number |
| validPlayed | The number of rounds played that have been deemed valid after processing. | number |
| percentSeen | The percentage of the collection's NFTs that have been in one or more rounds. | number |