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

Analytics

PreviousCollection

Last updated 3 years ago

Get User Analytics

get

Returns analytic information of specified user

Path parameters
walletAddressstringRequired

Wallet address of user

Example: 0x999357CBCA500ffc60821E127657d4591eCa5b9dPattern: ^0x[0-9A-Fa-f]{40}$
Header parameters
API-Secret-TokenstringRequired
Responses
200
Example response
application/json
get
GET /analytics/user/{walletAddress} HTTP/1.1
Host: api.pentas.io
API-Secret-Token: text
Accept: */*
200

Example response

{
  "tradedVolume": 1,
  "mintCount": 1,
  "saleCount": 1,
  "uniqueOwners": 1,
  "floorPrice": 1
}

Get Collection Analytics

get

Returns analytic information of specified collection

Path parameters
collectionSlugstring · min: 1Required

Collection name

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

Example response

{
  "tradedVolume": 1,
  "mintCount": 1,
  "saleCount": 1,
  "uniqueOwners": 1,
  "floorPrice": 1
}

Get Top 100 Buyers

get

Returns the top 100 buyers

Query parameters
pagenumber · min: 1OptionalDefault: 1Example: 1
Header parameters
API-Secret-TokenstringRequired
Responses
200
Example response
application/json
get
GET /analytics/top/buyer HTTP/1.1
Host: api.pentas.io
API-Secret-Token: text
Accept: */*
200

Example response

{
  "count": 1,
  "pageCount": 1,
  "page": "text",
  "data": [
    {
      "webuser": {
        "id": 1,
        "name": "text",
        "username": "text",
        "address": "text",
        "profileImage": "text",
        "verified": true,
        "bannerUrl": "text",
        "collectorBadge": true
      },
      "analytics": {
        "tradedVolume": 1,
        "mintCount": 1,
        "saleCount": 1,
        "uniqueOwners": 1,
        "floorPrice": 1
      },
      "buyVolume": 1,
      "saleVolume": 1
    }
  ]
}

Get Top 100 User by Traded Volume

get

Returns the top 100 user by traded volume

Query parameters
pagenumber · min: 1OptionalDefault: 1Example: 1
Header parameters
API-Secret-TokenstringRequired
Responses
200
Example response
application/json
get
GET /analytics/top/volume HTTP/1.1
Host: api.pentas.io
API-Secret-Token: text
Accept: */*
200

Example response

{
  "count": 1,
  "pageCount": 1,
  "page": "text",
  "data": [
    {
      "webuser": {
        "id": 1,
        "name": "text",
        "username": "text",
        "address": "text",
        "profileImage": "text",
        "verified": true,
        "bannerUrl": "text",
        "collectorBadge": true
      },
      "analytics": {
        "tradedVolume": 1,
        "mintCount": 1,
        "saleCount": 1,
        "uniqueOwners": 1,
        "floorPrice": 1
      },
      "buyVolume": 1,
      "saleVolume": 1
    }
  ]
}
  • GETGet User Analytics
  • GETGet Collection Analytics
  • GETGet Top 100 Buyers
  • GETGet Top 100 User by Traded Volume