Get Token

This endpoint retrieves detailed information about a specific token, including its total supply, symbol, unlocked supply, token holders, and verification status.

URL

https://api.zelf.world/api/mina/token/:tokenId

Method

GET

Parameters

Parameter	Type	Description
tokenId	string	The unique identifier for the token to be retrieved.

Headers

Key	Value	Required	Description
Authorization	Bearer <token>	Yes	The authorization token for access.

Example Request

curl --location --request GET 'https://api.zelf.world/api/mina/token/xBxjFpJkbWbpGua7Lf36S1NLhffOEC...FCTWg' \
--header 'Authorization: Bearer <token>'

Example Response

{
  "data": {
    "tokenId": "xBxjFpJkbWbpGua7Lf36S1NLhffOEC...FCTWg",
    "tokenSymbol": "PUNK",
    "totalSupply": 1000000.000000697,
    "lockedSupply": 0,
    "unlockedSupply": 1000000.000000697,
    "unlockPercent": 100,
    "tokenOwnerPK": "B62qdWVdkjf4LJ4WYJQDTNpQZ6gZyeCzbpAFKNF7EoZzYi5gZRz8JE",
    "tokenAdminPK": null,
    "tokenHoldersCount": 8319,
    "tokenHoldersCount24": 11,
    "ownerName": null,
    "ownerImg": null,
    "createdAt": 1720086600000,
    "tokenType": "CUSTOM_TOKEN",
    "tokenName": "Punk",
    "tokenImage": "https://strapi-dev.scand.app/uploads/Punkpoll_Logo_3f85b2e29d_2e251a1e65.jpg",
    "isVerified": true,
    "isBridge": false,
    "coingeckoCoinId": null,
    "coinmarketCoinId": null
  }
}

Response Details

• tokenId: The unique identifier of the token.

• tokenSymbol: The short symbol used to represent the token.

• totalSupply: The total amount of tokens in circulation.

• lockedSupply: The portion of the total supply that is currently locked.

• unlockedSupply: The number of tokens available for transactions.

• unlockPercent: The percentage of tokens that are unlocked.

• tokenOwnerPK: The public key of the token's owner.

• tokenAdminPK: The public key of the token's admin (if applicable).

• tokenHoldersCount: The total number of unique token holders.

• tokenHoldersCount24: The number of new token holders in the last 24 hours.

• ownerName: The name of the token's owner (if available).

• ownerImg: The image associated with the token's owner (if available).

• createdAt: The timestamp (in milliseconds) when the token was created.

• tokenType: The type of token (e.g., CUSTOM_TOKEN).

• tokenName: The full name of the token.

• tokenImage: A URL pointing to the image associated with the token.

• isVerified: Whether the token is verified or not.

• isBridge: Whether the token is a bridge token.

• coingeckoCoinId: The ID of the token on Coingecko, if listed.

• coinmarketCoinId: The ID of the token on CoinMarketCap, if listed.

Error Responses

Status Code	Description
401	Unauthorized. Invalid or missing token.
404	Not Found. The token ID does not exist.
500	Internal Server Error. An error occurred on the server.

Node.js - Axios Example

const axios = require('axios');

let config = {
  method: 'get',
  maxBodyLength: Infinity,
  url: 'https://api.zelf.world/api/mina/token/xBxjFpJkbWbpGua7Lf36S1NLhffOEC...FCTWg',
  headers: {
    'Authorization': 'Bearer <token>'
  }
};

axios.request(config)
  .then((response) => {
    console.log(JSON.stringify(response.data));
  })
  .catch((error) => {
    console.log(error);
  });

Status Codes

Code	Description
200	Success. The token data is returned.
400	Bad Request. Invalid token ID format.
401	Unauthorized. Invalid authorization token.
404	Not Found. Token ID does not exist.
500	Internal Server Error.

Notes

• Ensure that the tokenId provided is valid and in the correct format.

• The API requires an Authorization token for access.