Skip to main content

Get Token by ID

Retrieves detailed information about a specific token by its ID.

Request​

GET /v2/admin/token/users/{token_id}

Parameters​

NameTypeInDescription
token_idstringpathRequired. The ID of the token to retrieve

Headers​

NameDescription
AuthorizationRequired. Bearer token for authentication
Content-TypeRequired. Must be application/json

Example​

curl --location --request GET '\{\{baseUrl\}\}/v2/admin/token/users/68aeb272d9336c619ce249f6' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...'

Response​

A successful response returns detailed token information:

{
  "id": "68aeb272d9336c619ce249f6",
  "category_id": "667e9251ca818a2138ed4915",
  "type": 1,
  "node_id": "6810a8e5b45680e7d2f95bad",
  "node_name": "Oha",
  "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
      },
      {
        "url": "https://fra1.digitaloceanspaces.com/apex/dev/token/689c4fd02e09b543ffed72a0/images/d38c0e8e-f327-491f-8a6f-170bb09777ff.png",
        "is_default": false
      }
    ],
    "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"
}

Response Fields​

Token Object Fields​

FieldTypeDescription
idstringUnique identifier for the token
category_idstringCategory ID of the token
typeintegerToken type (0 = standard, 1 = special)
node_idstringID of the associated node
node_namestringName of the associated node
listing_contract_addressstringListing contract address
statusintegerStatus code of the token
namestringDisplay name of the token
descriptionstringDescription of the token
token_namestringToken name
token_symbolstringToken symbol
node_contractobjectNode contract addresses
metaobjectMetadata including images and documents
contractobjectToken contract information
valueobjectToken value and supply information
distribution_tokenobject/nullDistribution token information
metricobjectToken metrics and rental information
created_atstringISO 8601 timestamp when the token was created

Node Contract Object Fields​

FieldTypeDescription
listing_contract_addressstring/nullListing contract address
rent_contract_addressstring/nullRent contract address
burn_contract_addressstring/nullBurn contract address
secondary_contract_addressstring/nullSecondary market contract address
otc_contract_addressstring/nullOTC contract address

Meta Object Fields​

FieldTypeDescription
imagesarrayArray of image objects
documentsarrayArray of document objects

Image Object Fields​

FieldTypeDescription
urlstringURL of the image
is_defaultbooleanWhether this is the default image

Document Object Fields​

FieldTypeDescription
idstringDocument ID
namestringDocument name
urlstringDocument URL
typeintegerDocument type

Contract Object Fields​

FieldTypeDescription
addressstringToken contract address
tx_hashstringTransaction hash

Value Object Fields​

FieldTypeDescription
token_priceobjectToken price information
total_valueobjectTotal value information
salable_percentagenumberPercentage of tokens that are salable
salable_valueobjectSalable value information
max_supplynumberMaximum supply of tokens
listed_supplynumberNumber of tokens listed
sold_supplynumberNumber of tokens sold

Price Object Fields​

FieldTypeDescription
amountnumberPrice amount
decimalintegerNumber of decimal places
symbolstringPrice symbol (e.g., USDT)
addressstringContract address of the price token

Metric Object Fields​

FieldTypeDescription
term_duration_in_monthsnumber/nullDuration of the token term in months
min_purchase_quantitynumberMinimum purchase quantity
max_purchase_quantitynumberMaximum purchase quantity
min_tokens_required_for_rental_incomenumberMinimum tokens required for rental income
rental_incomeobjectRental income information
rental_payment_period_in_daysnumberRental payment period in days
rental_payment_start_datestring/nullISO 8601 timestamp of rental payment start date
listing_datestring/nullISO 8601 timestamp of listing date

Token Types​

ValueDescription
0Standard Token
1Special Token

Status Codes​

Status CodeDescription
200Success - Token information retrieved successfully
400Bad Request - Invalid request parameters
401Unauthorized - Invalid or missing authentication token
404Not Found - Token ID does not exist
500Internal Server Error