Skip to main content

List Tokens

Returns one page of a node's tokens, newest first, with optional category, origin, status and flag filters. The listing is always scoped to one node (node_id), and the caller's node must be that node or one of its ancestors. A filter that matches nothing answers an empty page, not a 404.

Required permission: token:view

Request​

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

Parameters​

NameTypeInDescription
node_idstringqueryRequired. Node whose tokens are listed.
pageintegerqueryRequired. Page number, starting at 1.
per_pageintegerqueryRequired. Page size, 1 to 100.
category_idstringqueryOptional. Keep only tokens in this category. Repeat the parameter for several (?category_id=a&category_id=b). A non-leaf category means its whole branch: the tokens filed under its sub-categories are returned too. An unknown category is refused.
originintegerqueryOptional. Keep only tokens of this origin: 0 platform, 1 external.
statusesintegerqueryOptional. Keep only these token statuses (see Token status). Repeat for several (?statuses=4&statuses=6).
is_rental_payment_activebooleanqueryOptional. true keeps only tokens whose metric.rental_payment_start_date is set.
is_expiration_activebooleanqueryOptional. true keeps only tokens whose metric.expiration_date is set and already in the past.
is_not_deletedbooleanqueryOptional. true leaves out deleted tokens. Without it, deleted tokens are listed too, with deleted_at set.

Omit a flag rather than sending false: false reads the same as unset.

Headers​

NameDescription
AuthorizationRequired. Bearer <access_token>

Example​

curl --request GET \
--url '{{baseUrl}}/v2/admin/tokens?node_id=67d6c447f47ff3adafda700d&page=1&per_page=20&statuses=6&is_not_deleted=true' \
--header 'Authorization: Bearer <access_token>'

Response​

{
"data": [
{
"id": "67d8774e903bfcbe7eb5d93e",
"category_id": "667e9251ca818a2138ed4915",
"node_id": "67d6c447f47ff3adafda700d",
"created_by_id": "",
"network_id": "6740e0a20000000000000103",
"setup_id": "6a837bb62998e4fbfed7f52a",
"status": 6,
"origin": 0,
"standard": 0,
"name": "TKN Token Name",
"description": "Token Description",
"token_name": "tkn",
"token_symbol": "TKN",
"is_public": false,
"is_api": true,
"is_open_to_otc": false,
"is_open_to_secondary_market": false,
"is_mintable": false,
"oracle": null,
"meta": {
"images": [
{
"url": "https://cdn.example.com/dev/token/67d8774e903bfcbe7eb5d93e/images/9e6e15fc-57ea-4de9-a2e1-9ee945908ce1.png",
"is_default": true
}
],
"documents": [
{
"id": "67d8774e903bfcbe7eb5d940",
"name": "prospectus.pdf",
"url": "https://bucket.s3.amazonaws.com/dev/token/67d8774e903bfcbe7eb5d93e/documents/0d295c7d-fff2-40fc-a184-3119c14ef61a.pdf?X-Amz-Expires=900&X-Amz-Signature=...",
"type": 1,
"tx_hash": "0x5b1d0c2e7f3a9b84c6d2e1f0a9b8c7d6e5f4a3b2c1d0e9f8a7b6c5d4e3f2a1b0"
}
]
},
"contract": {
"address": "0x730d22ae2267fc5b40520605868ddb48c29331a7",
"tx_hash": "0x4ecde457e62f7d6b296bf9f798bff25e62c7b9971dab89d07edcf16a073b8387"
},
"value": {
"token_price": {
"id": "68fe8c129367fd414b227c7a",
"amount": "9.6",
"decimal": 6,
"symbol": "USDT",
"address": "0x073c0196e516a0e77b1c804d1825fb1bad23895d"
},
"total_value": {
"id": "68fe8c129367fd414b227c7a",
"amount": "12000",
"decimal": 6,
"symbol": "USDT",
"address": "0x073c0196e516a0e77b1c804d1825fb1bad23895d"
},
"salable_percentage": "80",
"salable_value": {
"id": "68fe8c129367fd414b227c7a",
"amount": "9600",
"decimal": 6,
"symbol": "USDT",
"address": "0x073c0196e516a0e77b1c804d1825fb1bad23895d"
},
"max_supply": 1000,
"listed_supply": 800,
"sold_supply": 200,
"purchased_supply": 0
},
"metric": null,
"distribution_token": null,
"created_at": "2025-03-17T19:26:06.905Z",
"deleted_at": null
}
],
"total": 1,
"page": 1,
"per_page": 20
}

Response Fields​

FieldTypeDescription
dataarrayTokens on this page, in the shape Get Token returns (without category). Deleted images and documents are left out.
totalintegerNumber of tokens matching the filters.
pageintegerPage number sent in the request.
per_pageintegerPage size sent in the request.

meta.documents[].url is a signed link that opens the document for 15 minutes and is minted on every read. Read the token again for a fresh link rather than storing it.

Errors​

StatusCodeDescription
40010015Validation failed (node_id, page or per_page missing or out of range) — see details
40010016node_id or a category_id is not a valid id
40010001Node not found (node domain 2)
40310005The caller's node does not cover this node (node domain 2)
40010001A category_id names no category (category domain 4)

See Errors for the error format and common codes.