Pentas Docs
  • Overview
  • Quick Start
  • Reference
    • API Reference
      • NFT
      • User
      • Collection
      • Analytics
Powered by GitBook
On this page
  1. Reference
  2. API Reference

Collection

PreviousUserNextAnalytics

Last updated 3 years ago

If you're interested in Collection Analytics, please refer to the Analytics section of this documentation.

Get Collection Information

get

Returns information of collection

Path parameters
collectionSlugstring · min: 1Required

Collection name

Example: pentastx
Header parameters
API-Secret-TokenstringRequired
Responses
200
Example response
application/json
get
GET /collection/{collectionSlug} HTTP/1.1
Host: api.pentas.io
API-Secret-Token: text
Accept: */*
200

Example response

{
  "id": 1,
  "created": "text",
  "name": "text",
  "description": "text",
  "slug": "text",
  "collectionImage": "text",
  "bannerImage": "text",
  "externalLink": "text",
  "ownerDetails": {
    "id": 1,
    "name": "text",
    "username": "text",
    "address": "text",
    "profileImage": "text",
    "verified": true,
    "bannerUrl": "text",
    "collectorBadge": true
  },
  "mintCount": 1
}

Get NFTs of Collection

get

Returns NFTs in specified collection

Path parameters
collectionSlugstring · min: 1Required

Collection name

Example: pentastx
Query parameters
pagenumber · min: 1OptionalDefault: 1Example: 1
sortstring · enumOptionalDefault: latestPossible values:
Header parameters
API-Secret-TokenstringRequired
Responses
200
Example response
application/json
get
GET /collection/{collectionSlug}/assets HTTP/1.1
Host: api.pentas.io
API-Secret-Token: text
Accept: */*
200

Example response

No content

  • GETGet Collection Information
  • GETGet NFTs of Collection