Get Token Details

Retrieves detailed information about a specific token.

Request

GET /v2/admin/token/{token_id}

Parameters

Name	Type	In	Description
token_id	string	path	Required. The ID of the token to retrieve

Headers

Name	Description
Authorization	Required. Bearer token for authentication

Example

curl --request GET \
  --url '\{\{baseUrl\}\}/v2/admin/token/67d8774e903bfcbe7eb5d93e' \
  --header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...' \
  --header 'User-Agent: insomnia/10.3.1'

Response

{
	"id": "67d8774e903bfcbe7eb5d93e",
	"category_id": "667e9251ca818a2138ed4915",
	"node_id": "67d6c447f47ff3adafda700d",
	"type": 0,
	"status": 4,
	"is_public": false,
	"name": "TKN Token Name 6 Updated",
	"description": "Token Description 222",
	"token_name": "tkn",
	"token_symbol": "TKN",
	"oracle": {
		"id": "677ed6e3cc111aea14a3dfc3",
		"code": "IOG"
	},
	"meta": {
		"images": [
			{
				"id": "67d8aac52b32e33603246a1f",
				"url": "https://fra1.digitaloceanspaces.com/apex/dev/token/67d8774e903bfcbe7eb5d93e/images/9fa561ea-d5c6-494a-ab1f-8aeabe211e7e.jpeg",
				"is_default": false,
				"hash": "b9edd305d6e628fa06f4f2ae33f649cb9b57cbbc4156cde981fef512df3367ab",
				"created_at": "2025-03-17T23:05:41.969Z",
				"deleted_at": null
			}
		],
		"documents": [
			{
				"id": "67d8aac62b32e33603246a20",
				"name": "Ws_20240201.pdf",
				"url": "https://fra1.digitaloceanspaces.com/apex/dev/token/67d8774e903bfcbe7eb5d93e/documents/47ffece9-4d07-4c14-a422-144ab6832df1.pdf",
				"type": 1,
				"hash": "cdb85002d5c946b618bbf9694916df129d1f570e2e763c117de425383c83af58",
				"created_at": "2025-03-17T23:05:42.97Z",
				"deleted_at": null
			}
		]
	},
	"contract": {
		"address": "0xaffdea8c3fdd521681bb5e7d44e3ae57871093e4",
		"tx_hash": "0x998a217061da05cf1bf1998470613a488b10908f0964e76a123c4063f91d77c4"
	},
	"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": "2025-01-01T00:00:00Z",
		"listing_date": "2025-01-01T00:00:00Z",
		"expiration_date": "2026-01-01T00:00:00Z"
	},
	"is_open_to_secondary_market": false,
	"is_open_to_otc": false,
	"secondary_market": {
		"min_sell_price": 25.5,
		"max_sell_price": 35.5
	},
	"distribution_token": {
		"id": "690d004e8f95a5c7b2614658",
		"external_id": "EXT123",
		"priority": 50,
		"agent": 1
	},
	"fee": {
		"platform_owner_amount": 10,
		"node_owner_amount": 5,
		"node_amount": 15
	},
	"node_contract": {
		"listing_contract_address": "0xb6627b1685d1199E3087D2247d5F432fb1721c34",
		"rent_contract_address": "0x57327F5C456B661Fc0D337473ec8F14a4ADccfb3",
		"burn_contract_address": "0x222CB82947be52A91a88B1A2E116abf4D9bA6eed",
		"fee_contract_address": "0x333CB82947be52A91a88B1A2E116abf4D9bA6eee",
		"secondary_contract_address": "0x444CB82947be52A91a88B1A2E116abf4D9bA6fff",
		"otc_contract_address": "0x555CB82947be52A91a88B1A2E116abf4D9bA6000"
	},
	"created_at": "2025-03-17T19:26:06.562Z",
	"deleted_at": null
}

Response Fields

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
updated_at	string	ISO 8601 timestamp when the token was updated
deleted_at	string/null	ISO 8601 timestamp when the token was deleted

Meta Object Fields

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

Image Object Fields

Field	Type	Description
id	string	Unique identifier of the image
url	string	URL of the image
is_default	boolean	Whether this is the default image
hash	string	Hash of the image file
created_at	string	ISO 8601 timestamp when the image was created
deleted_at	string/null	ISO 8601 timestamp when the image was deleted

Document Object Fields

Field	Type	Description
id	string	Unique identifier of the document
name	string	Document name
url	string	Document URL
type	integer	Document type (1 = Standard)
hash	string	Hash of the document file
created_at	string	ISO 8601 timestamp when the document was created
deleted_at	string/null	ISO 8601 timestamp when the document was deleted

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 (Price object)
total_value	object	Total value information (Price object)
salable_percentage	number	Percentage of tokens that are salable (0-100)
salable_value	object	Salable value information (Price object)
max_supply	integer	Maximum supply of tokens
purchased_supply	integer	Number of tokens purchased
listed_supply	integer	Number of tokens listed
sold_supply	integer	Number of tokens sold
total_fee_supply	integer	Total number of tokens allocated for fees

Price Object Fields

Field	Type	Description
id	string	Currency token ID
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	integer/null	Duration of the token term in months
min_purchase_quantity	integer	Minimum purchase quantity
max_purchase_quantity	integer	Maximum purchase quantity
min_tokens_required_for_rental_income	integer	Minimum tokens required for rental income
rental_income	object	Rental income information (Price object)
rental_payment_period_in_days	integer	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
expiration_date	string/null	ISO 8601 timestamp of expiration date

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
fee_contract_address	string/null	Fee contract address
secondary_contract_address	string/null	Secondary market contract address
otc_contract_address	string/null	OTC contract address

Secondary Market Object Fields

Field	Type	Description
min_sell_price	number/null	Minimum sell price on secondary market
max_sell_price	number/null	Maximum sell price on secondary market

Distribution Token Object Fields

Field	Type	Description
id	string	Distribution token ID
external_id	string	External identifier
priority	integer	Priority value (1-100, lower is higher priority)
agent	integer	Distribution agent (1 = Gen, 2 = Brickken)

Fee Object Fields

Field	Type	Description
platform_owner_amount	integer	Amount allocated to platform owner
node_owner_amount	integer	Amount allocated to node owner
node_amount	integer	Amount allocated to node

Token Types

Value	Description
0	Standard Token
1	Special Token

Status Codes

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

Token Status

The status field in the response indicates the current state of the token in the system. Below are the possible status values:

Status Code	Status Name	Description
1	Draft	Initial state of the token before blockchain deployment. Token details are saved but not yet submitted to the blockchain.
2	InProgress	Token is in the process of being deployed to the blockchain. Transactions are pending.
3	Error	An error occurred during token deployment or transaction processing. The blockchain operation failed.
4	NotListed	Token has been successfully deployed to the blockchain but is not yet listed on the marketplace.
5	Delisted	Token was previously listed but has been removed from the marketplace.
6	Listed	Token is successfully deployed and actively listed on the marketplace.
7	Passive	Token is in an inactive state. It exists on the blockchain but is not actively tradable.
8	Burn	Token has been permanently burned/destroyed on the blockchain.