Get Token Investor

Returns one holder of a token, in the shape of a row of Get Token Investors. The holding is what is looked up: a user who holds none of the token, including one who sold their whole position, is reported as not found.

Required permission: token:view

Request

GET /v2/admin/tokens/{token_id}/investors/{investor_id}

Parameters

Name	Type	In	Description
token_id	string	path	Required. Token id.
investor_id	string	path	Required. User id of the investor.

Headers

Name	Description
Authorization	Required. Bearer <access_token>

Example

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

Response

{
  "id": "6a2f0b7e1c9d4e3f2a1b0c9d",
  "email": "investor@example.com",
  "name": "Ayse",
  "surname": "Yilmaz",
  "has_kyc_token": true,
  "created_at": "2025-02-11T14:20:05.118Z",
  "holding": {
    "remaining_quantity": 25,
    "total_purchased": 40,
    "total_purchased_amount": "384",
    "wallet_count": 2
  }
}

Response Fields

Field	Type	Description
id	string	User id.
email	string	Email.
name	string	First name. Absent when not on record.
surname	string	Surname. Absent when not on record.
has_kyc_token	boolean	At least one of the user's wallets holds a KYC token.
created_at	string	When the user registered.
holding.remaining_quantity	integer	Tokens held now, summed over the user's wallets.
holding.total_purchased	integer	Tokens ever bought.
holding.total_purchased_amount	string	Amount paid for total_purchased, a decimal string.
holding.wallet_count	integer	How many of the user's wallets hold the token.

Errors

Status	Code	Description
400	10016	token_id or investor_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)
400	10001	The user does not hold the token, or does not exist (user domain 1)

See Errors for the error format and common codes.