Search Tokens

Searches for available tokens with pagination support.

Request

POST /v2/admin/token/users/search

Headers

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

Request Body

Field	Type	Description
page	integer	Required. Page number for pagination (starts from 1)
per_page	integer	Required. Number of items per page

Example

curl --location '\{\{baseUrl\}\}/v2/admin/token/users/search' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...' \
--data '{
    "page": 1,
    "per_page": 10
}'

Response

A successful response returns paginated token data:

{
  "data": [
    {
      "id": "68aeb272d9336c619ce249f6",
      "category_id": "667e9251ca818a2138ed4915",
      "type": 1,
      "node_id": "6810a8e5b45680e7d2f95bad",
      "node_name": "",
      "listing_contract_address": "",
      "status": 6,
      "name": "Hiper House 23 (Yeni)",
      "description": "Hiper house token 2",
      "token_name": "TokenName Yeni",
      "token_symbol": "HPHE",
      "node_contract": {
        "listing_contract_address": null,
        "rent_contract_address": null,
        "burn_contract_address": null,
        "secondary_contract_address": null,
        "otc_contract_address": null
      },
      "meta": {
        "images": [
          {
            "url": "https://fra1.digitaloceanspaces.com/apex/dev/token/680a89d5dcaf5609fe5374cd/images/af8fd0e2-d3c9-4b15-982c-13ed669fc904.jpeg",
            "is_default": true
          }
        ],
        "documents": [
          {
            "id": "689ee76a5ca4c34ad0bc346d",
            "name": "c8985d4a-0855-4f2c-913a-27b2871ac556.pdf",
            "url": "https://fra1.digitaloceanspaces.com/apex/dev/token/689c4fd02e09b543ffed72a0/documents/9c7ce825-729c-4af2-a91a-44a08b66ddb1.pdf",
            "type": 1
          }
        ]
      },
      "contract": {
        "address": "0xaaf6574c752a8cb8e4f220afc195240f347ffe95",
        "tx_hash": ""
      },
      "value": {
        "token_price": {
          "amount": 1000,
          "decimal": 6,
          "symbol": "USDT",
          "address": "0xdb2e8354c2a2a0f9c7c889ec27cdd424d49c8fd1"
        },
        "total_value": {
          "amount": 0,
          "decimal": 0,
          "symbol": "",
          "address": ""
        },
        "salable_percentage": 0,
        "salable_value": {
          "amount": 0,
          "decimal": 0,
          "symbol": "",
          "address": ""
        },
        "max_supply": 300,
        "listed_supply": 300,
        "sold_supply": 0
      },
      "distribution_token": {
        "agent": 1
      },
      "metric": {
        "term_duration_in_months": 10,
        "min_purchase_quantity": 1,
        "max_purchase_quantity": 30,
        "min_tokens_required_for_rental_income": 10,
        "rental_income": {
          "amount": 10,
          "decimal": 6,
          "symbol": "USDT",
          "address": ""
        },
        "rental_payment_period_in_days": 10,
        "rental_payment_start_date": null,
        "listing_date": null
      },
      "created_at": "2025-08-27T07:23:30.666Z"
    }
  ],
  "total": 2,
  "page": 1,
  "per_page": 10
}

Response Fields

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
type	integer	Token type (0 = standard, 1 = special)
node_id	string	ID of the associated node
node_name	string	Name of the associated node
listing_contract_address	string	Listing contract address
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
node_contract	object	Node contract addresses
meta	object	Metadata including images and documents
contract	object	Token contract information
value	object	Token value and supply information
distribution_token	object/null	Distribution token information
metric	object	Token metrics and rental information
created_at	string	ISO 8601 timestamp when the token was created

Node Contract Object Fields

Field	Type	Description
listing_contract_address	string/null	Listing contract address
rent_contract_address	string/null	Rent contract address
burn_contract_address	string/null	Burn contract address
secondary_contract_address	string/null	Secondary market contract address
otc_contract_address	string/null	OTC contract address

Meta Object Fields

Field	Type	Description
images	array	Array of image objects
documents	array	Array of document objects

Image Object Fields

Field	Type	Description
url	string	URL of the image
is_default	boolean	Whether this is the default image

Document Object Fields

Field	Type	Description
id	string	Document ID
name	string	Document name
url	string	Document URL
type	integer	Document type

Contract Object Fields

Field	Type	Description
address	string	Token contract address
tx_hash	string	Transaction hash

Value Object Fields

Field	Type	Description
token_price	object	Token price information
total_value	object	Total value information
salable_percentage	number	Percentage of tokens that are salable
salable_value	object	Salable value information
max_supply	number	Maximum supply of tokens
listed_supply	number	Number of tokens listed
sold_supply	number	Number of tokens sold

Price Object Fields

Field	Type	Description
amount	number	Price amount
decimal	integer	Number of decimal places
symbol	string	Price symbol (e.g., USDT)
address	string	Contract address of the price token

Metric Object Fields

Field	Type	Description
term_duration_in_months	number/null	Duration of the token term in months
min_purchase_quantity	number	Minimum purchase quantity
max_purchase_quantity	number	Maximum purchase quantity
min_tokens_required_for_rental_income	number	Minimum tokens required for rental income
rental_income	object	Rental income information
rental_payment_period_in_days	number	Rental payment period in days
rental_payment_start_date	string/null	ISO 8601 timestamp of rental payment start date
listing_date	string/null	ISO 8601 timestamp of listing date

Token Types

Value	Description
0	Standard Token
1	Special Token

Status Codes

Status Code	Description
200	Success - Tokens retrieved successfully
400	Bad Request - Invalid request parameters
401	Unauthorized - Invalid or missing authentication token
500	Internal Server Error