Get Rental Summary

Shows what the next rental income distribution of a token would pay, and to how many holders. Read it before Rent Token. The counts cover only the holders who would be paid: a holder below min_tokens_for_income (summed over their wallets) receives nothing and is left out, so investor_count is usually lower than the number of holders.

A token without rental terms still answers with the same shape: rental_configured is false and the prices are zero.

Required permission: token:transactions:view

Request

GET /v2/admin/tokens/{token_id}/rental-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/rental-summary' \
  --header 'Authorization: Bearer <access_token>'

Response

{
  "token_id": "67d8774e903bfcbe7eb5d93e",
  "investor_count": 12,
  "total_token_count": 180,
  "distribution_per_token": {
    "id": "68fe8c129367fd414b227c7a",
    "amount": "0.1",
    "decimal": 6,
    "symbol": "USDT",
    "address": "0x073c0196e516a0e77b1c804d1825fb1bad23895d"
  },
  "total_distribution": {
    "id": "68fe8c129367fd414b227c7a",
    "amount": "18",
    "decimal": 6,
    "symbol": "USDT",
    "address": "0x073c0196e516a0e77b1c804d1825fb1bad23895d"
  },
  "min_tokens_for_income": 10,
  "rental_configured": true
}

Response Fields

Field	Type	Description
token_id	string	Token id.
investor_count	integer	Holders who would be paid. When rental_configured is false, the number of holders.
total_token_count	integer	Tokens held by those holders. 0 when rental_configured is false.
distribution_per_token	price	What one token earns in one distribution.
total_distribution	price	distribution_per_token × total_token_count: what the distribution would move.
min_tokens_for_income	integer	The token's metric.min_tokens_required_for_rental_income, the threshold the counts were filtered by.
rental_configured	boolean	false when the token has no rental income set up.

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.