The Collection resource is the collectibles element of Loyi. A collection consists of a fixed number of collectibles. The collection, therefore, serves like a container.Key Features#
Optional Blockchain Support: A collection can be backed by smart contracts
Flexible Distribution Models:oneToOne
: Unique collectibles (1:1 relationship between collectibles and users)
oneToMany
: Duplicable collectibles (many users can get the same collectible)
Media Support: Supports both image and video collectibles
Batch Management: Collections can contain multiple collectibles (specified by amount
)
Group Organization: Collections can be classified using a Collection Group. A Collection Group can contain one or more collections and has a position to determine how the Collection Groups are sorted.
Claim Tracking: Detailed records of which users claimed which collectibles
Data Structure#
Endpoints#
Method | Endpoint | Description |
---|
GET | /collection | Retrieve all collections |
POST | /collection | Create new collection (multipart form) |
GET | /collection/{id} | Get specific collection |
PUT | /collection/{id} | Update collection |
DELETE | /collection/{id} | Delete collection |
POST | /collection/{id}/claim | Claim collectible from collection |
GET | /collection/{id}/rewards | List rewards airdropped to collection |
GET | /collection/{id}/collectibles | View collectibles in collection |
GET | /collection/{id}/owners | View users who own the collection |
In POST /collection
, the collectibles
field can either be videos or images. In case of a video, a thumbnail
image should be provided.
The image
of the collection is like a teaser image for the collection. Modified at 2025-08-08 11:40:32