List Tokens

Retrieves a list of tokens in the system with pagination support.

Request

POST /v2/admin/token/nodes/{node_id}/search

Parameters

Name	Type	In	Description
node_id	string	path	Required. The ID of the node to search tokens under
page	number	body	Optional. Page number for pagination (default: 1)
per_page	number	body	Optional. Number of items per page (default: 20)

Headers

Name	Description
Authorization	Required. Bearer token for authentication
Content-Type	Required. Must be application/json

Example

curl --request POST \
  --url '\{\{baseUrl\}\}/v2/admin/token/nodes/67d6c447f47ff3adafda700d/search' \
  --header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...' \
  --header 'Content-Type: application/json' \
  --data '{
	"page": 1,
	"per_page": 20
}'

Response

{
	"data": [
		{
			"id": "67d76014d9c4853c097bcf9a",
			"category_id": "667e9251ca818a2138ed4915",
			"node_id": "67d6c447f47ff3adafda700d",
			"type": 0,
			"status": 4,
			"name": "TKN Token Name 6",
			"description": "Token Description",
			"token_name": "tkn",
			"token_symbol": "TKN",
			"is_public": false,
			"oracle": {
				"id": "677ed6e3cc111aea14a3dfc3",
				"code": "IOG"
			},
			"meta": {
				"images": [
					{
						"url": "https://fra1.digitaloceanspaces.com/apex/dev/token/67d76014d9c4853c097bcf9a/images/9e6e15fc-57ea-4de9-a2e1-9ee945908ce1.png",
						"is_default": true
					}
				],
				"documents": [
					{
						"name": "data.pdf",
						"url": "https://fra1.digitaloceanspaces.com/apex/dev/token/67d76014d9c4853c097bcf9a/documents/0d295c7d-fff2-40fc-a184-3119c14ef61a.pdf",
						"type": 1
					}
				]
			},
			"contract": {
				"address": "0x730d22ae2267fc5b40520605868ddb48c29331a7",
				"tx_hash": "0x4ecde457e62f7d6b296bf9f798bff25e62c7b9971dab89d07edcf16a073b8387"
			},
			"value": {
				"token_price": {
					"id": "68fe8c129367fd414b227c7a",
					"amount": 30,
					"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,
				"purchased_supply": 150,
				"listed_supply": 800,
				"sold_supply": 200,
				"total_fee_supply": 50
			},
			"metric": {
				"term_duration_in_months": 12,
				"min_purchase_quantity": 1,
				"max_purchase_quantity": 100,
				"min_tokens_required_for_rental_income": 10,
				"rental_income": {
					"id": "68fe8c129367fd414b227c7a",
					"amount": 100,
					"decimal": 6,
					"symbol": "USDT",
					"address": "0x073c0196e516a0e77b1c804d1825fb1bad23895d"
				},
				"rental_payment_period_in_days": 30,
				"rental_payment_start_date": null,
				"listing_date": null,
				"expiration_date": null
			},
			"is_open_to_secondary_market": false,
			"is_open_to_otc": false,
			"secondary_market": null,
			"distribution_token": null,
			"fee": null,
			"node_contract": null,
			"created_at": "2025-03-16T23:34:44.905Z",
			"deleted_at": null
		}
	],
	"total": 7,
	"page": 1,
	"per_page": 20
}

Response Fields

Pagination Object

Field	Type	Description
data	array	Array of token objects
total	integer	Total number of tokens
page	integer	Current page number
per_page	integer	Number of items per page

Token Object Fields

Field	Type	Description
id	string	Unique identifier for the token
category_id	string	Category ID of the token
node_id	string	ID of the associated node
type	integer	Token type (0 = standard, 1 = special)
status	integer	Status code of the token
name	string	Display name of the token
description	string	Description of the token
token_name	string	Token name
token_symbol	string	Token symbol
is_public	boolean	Whether the token is public
is_open_to_secondary_market	boolean	Whether the token is open to secondary market
is_open_to_otc	boolean	Whether the token is open to OTC trading
oracle	object/null	Oracle information for price reference
oracle.id	string	Oracle ID
oracle.code	string	Oracle code
meta	object	Metadata including images and documents
contract	object/null	Token contract information
node_contract	object/null	Node contract addresses
value	object	Token value and supply information
metric	object/null	Token metrics and rental information
secondary_market	object/null	Secondary market price constraints
distribution_token	object/null	Distribution token information
fee	object/null	Token fee distribution information
created_at	string	ISO 8601 timestamp when the token was created
deleted_at	string/null	ISO 8601 timestamp when the token was deleted

For detailed field descriptions of nested objects (meta, contract, value, metric), see the Get Token Details documentation.

Status Codes

Status Code	Description
200	Success
400	Bad Request - Invalid parameters
401	Unauthorized - Invalid or missing authentication token
404	Not Found - Node ID does not exist
500	Internal Server Error