Get Burn Summary

Shows what burning a token would pay. Read it before Burn Token: the burn funds a pool of the current token price times every token investors still hold, and each holder is then owed their share.

Required permission: token:transactions:view

Request

GET /v2/admin/tokens/{token_id}/burn-summary

Parameters

Name	Type	In	Description
token_id	string	path	Required. Token id.

Headers

Name	Description
Authorization	Required. Bearer <access_token>

Example

curl --request GET \
  --url '{{baseUrl}}/v2/admin/tokens/67d8774e903bfcbe7eb5d93e/burn-summary' \
  --header 'Authorization: Bearer <access_token>'

Response

{
  "token_id": "67d8774e903bfcbe7eb5d93e",
  "current_token_value": {
    "id": "68fe8c129367fd414b227c7a",
    "amount": "9.6",
    "decimal": 6,
    "symbol": "USDT",
    "address": "0x073c0196e516a0e77b1c804d1825fb1bad23895d"
  },
  "investor_count": 14,
  "total_tokens_to_be_burned": 200,
  "distribution_per_token": {
    "id": "68fe8c129367fd414b227c7a",
    "amount": "9.6",
    "decimal": 6,
    "symbol": "USDT",
    "address": "0x073c0196e516a0e77b1c804d1825fb1bad23895d"
  },
  "total_distribution": {
    "id": "68fe8c129367fd414b227c7a",
    "amount": "1920",
    "decimal": 6,
    "symbol": "USDT",
    "address": "0x073c0196e516a0e77b1c804d1825fb1bad23895d"
  }
}

Response Fields

Field	Type	Description
token_id	string	Token id.
current_token_value	price	The current token price. Same value as distribution_per_token.
investor_count	integer	Holders with a balance.
total_tokens_to_be_burned	integer	Tokens investors hold, all of which the burn removes.
distribution_per_token	price	Paid per token: the current token price.
total_distribution	price	distribution_per_token × total_tokens_to_be_burned: the pool the burn funds.

A price is {id, amount, decimal, symbol, address} with amount as a decimal string; see Amounts and Percentages.

Errors

Status	Code	Description
400	10016	token_id is not a valid id
400	10001	Token not found (token domain 5)
403	10005	The caller's node does not cover the token's node (node domain 2)

See Errors for the error format and common codes.