Get Token Rents

Returns one page of the individual rental income payouts a token produced: one row per holder per distribution, across all distributions, newest first. Group the rows by external_id to match them to a distribution in Get Token Deposits.

Required permission: token:transactions:view

Request

GET /v2/admin/tokens/{token_id}/rents?page=1&per_page=20

Parameters

Name	Type	In	Description
token_id	string	path	Required. Token id.
page	integer	query	Required. Page number, starting at 1.
per_page	integer	query	Required. Page size, 1 to 100.

Headers

Name	Description
Authorization	Required. Bearer <access_token>

Example

curl --request GET \
  --url '{{baseUrl}}/v2/admin/tokens/67d8774e903bfcbe7eb5d93e/rents?page=1&per_page=20' \
  --header 'Authorization: Bearer <access_token>'

Response

{
  "data": [
    {
      "id": "6a8b6f05f9129816a6cc7b44",
      "user_id": "6a2f0b7e1c9d4e3f2a1b0c9d",
      "token_id": "67d8774e903bfcbe7eb5d93e",
      "deposit_id": "6a8b6f02f9129816a6cc7b30",
      "external_id": 3,
      "per_price": {
        "id": "68fe8c129367fd414b227c7a",
        "amount": "0.1",
        "decimal": 6,
        "symbol": "USDT",
        "address": "0x073c0196e516a0e77b1c804d1825fb1bad23895d"
      },
      "total_price": {
        "id": "68fe8c129367fd414b227c7a",
        "amount": "2.5",
        "decimal": 6,
        "symbol": "USDT",
        "address": "0x073c0196e516a0e77b1c804d1825fb1bad23895d"
      },
      "contract_created_at": "2025-05-01T10:00:12.381Z",
      "created_at": "2025-05-01T10:00:13.002Z"
    }
  ],
  "total": 1,
  "page": 1,
  "per_page": 20
}

Response Fields

Field	Type	Description
data[].id	string	Payout id.
data[].user_id	string	Holder who was paid.
data[].token_id	string	Token id.
data[].deposit_id	string	Distribution the payout belongs to.
data[].external_id	integer	The distribution's id on chain; matches the deposit's external_id.
data[].per_price	price | null	What one token earned.
data[].total_price	price | null	per_price × the holder's quantity at the distribution.
data[].contract_created_at	string | null	When the distribution was recorded on chain.
data[].created_at	string	When the row was created.
total	integer	Number of payouts.
page	integer	Page number sent in the request.
per_page	integer	Page size sent in the request.

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

Errors

Status	Code	Description
400	10015	Validation failed (page or per_page missing or out of range) — see details
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.