Get Token

Returns one token with its active (not deleted) images and documents. The token's fields are at the root of the response; include_category_data=true adds the token's category alongside them. The caller's node must cover the node that owns the token.

Required permission: token:view

Request

GET /v2/admin/tokens/{token_id}

Parameters

Name	Type	In	Description
`token_id`	string	path	Required. Token id.
`include_category_data`	boolean	query	Optional. `true` adds the token's `category` (with its `tokenization_rules`) to the response.

Headers

Name	Description
`Authorization`	Required. `Bearer <access_token>`

Example

curl --request GET \
  --url '{{baseUrl}}/v2/admin/tokens/67d8774e903bfcbe7eb5d93e?include_category_data=true' \
  --header 'Authorization: Bearer <access_token>'

Response

{
  "id": "67d8774e903bfcbe7eb5d93e",
  "category_id": "667e9251ca818a2138ed4915",
  "node_id": "67d6c447f47ff3adafda700d",
  "created_by_id": "665b372f3a72d7d0791596ba",
  "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": false,
  "is_open_to_otc": true,
  "is_open_to_secondary_market": false,
  "is_mintable": false,
  "oracle": {
    "id": "677ed6e3cc111aea14a3dfc3",
    "code": "IOG"
  },
  "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": {
    "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-04-01T00:00:00Z",
    "listing_date": "2025-03-18T09:12:44.512Z"
  },
  "distribution_token": null,
  "created_at": "2025-03-17T19:26:06.905Z",
  "deleted_at": null,
  "category": {
    "id": "667e9251ca818a2138ed4915",
    "parent_id": null,
    "name": { "en": "Real Estate", "tr": "Gayrimenkul" },
    "path": "1",
    "int_id": 1,
    "image_svg": null,
    "image_url": null,
    "is_leaf": true,
    "show_on_dashboard": true,
    "tokenization_rules": {
      "lock_salable_percentage_at_100": false,
      "rental_income_as_percentage": false,
      "sync_max_supply_with_total_value": false,
      "rental_payment_period_days": 30,
      "disallow_min_purchase_quantity": false,
      "disallow_max_purchase_quantity": false,
      "disallow_min_tokens_required_for_rental_income": false
    },
    "created_at": "2024-06-28T10:02:57.112Z"
  }
}

Response Fields

Token object

Field	Type	Description
`id`	string	Token id.
`category_id`	string	Category the token is filed under.
`node_id`	string	Node the token was created under.
`created_by_id`	string	Supervisor who created the token; `""` when an API client created it.
`network_id`	string	Network the token's contracts live on (its setup's network); `""` for a token created before tokens were bound to a network.
`setup_id`	string	Setup (the node's deployment on one wallet and network) the token was tokenized on; `""` for a token created before setup binding.
`status`	integer	Lifecycle status, see Token status.
`origin`	integer	`0` platform (issued here), `1` external (distributed from an owner installation).
`standard`	integer	On-chain standard: `0` ERC-20, `1` ERC-721, `2` ERC-1155, `3` ERC-3643, `4` ERC-4380. Tokens created through this API are `0`.
`name`	string	Display name.
`description`	string	Description.
`token_name`	string	On-chain token name.
`token_symbol`	string	On-chain token symbol.
`is_public`	boolean	Holders may transfer the token freely. Changed with Public Transfer Token.
`is_api`	boolean	The token was created through the partner API by an API client, not by a supervisor.
`is_open_to_otc`	boolean	The token may be offered over the counter. Changed with Open Token to OTC.
`is_open_to_secondary_market`	boolean	The token may be listed on the secondary market. Changed with Open Token to Secondary Market.
`is_mintable`	boolean	The token contract was deployed as mintable. Tokens created through this API are `false`.
`oracle`	object \| null	Price oracle the token follows: `id` (oracle id) and `code` (the oracle's integration code).
`meta.images[]`	array	Active images: `url` and `is_default` (the first uploaded image is the default).
`meta.documents[]`	array	Active documents: `id`, `name` (file name), `url`, `type` (`1` standard document) and `tx_hash` (present once the document's hash was anchored on chain).
`contract`	object \| null	Token contract `address` and deploy `tx_hash`. `null` until tokenization settles.
`value`	object	Price and supply, see below.
`metric`	object \| null	Purchase bounds and rental terms, see below. `null` until Update Token Metric sets them.
`distribution_token`	object \| null	Set on an external token: `agent` (`1` Gen, `2` Brickken, `3` Rudiq Brokerage) and `integration` (`network_id`, `abi`, `contract_address`, `function_name`, `currency_token_address`, `is_approved`, `args[]` with `type`, `value`, `description`).
`created_at`	string	Creation time (RFC 3339).
`deleted_at`	string \| null	Deletion time; `null` while the token exists.
`category`	object	Only with `include_category_data=true`: the category with `id`, `parent_id`, `name` (`en`, `tr`), `path`, `int_id`, `image_svg`, `image_url`, `is_leaf`, `show_on_dashboard`, `tokenization_rules` (when the category has rules) and `created_at`.

meta.documents[].url is a signed link that opens the document for 15 minutes and is minted on every read: documents are private objects and the token record keeps only their key. Read the token again for a fresh link rather than storing it. A document of an external token is signed by the owner installation it came from; when the owner cannot be reached, the link the owner sent is returned as recorded.

`value`

Field	Type	Description
`token_price`	price	Price of one token: `salable_value` divided by `max_supply`.
`total_value`	price	Value of the whole asset, in the currency token chosen at creation.
`salable_percentage`	string	Share of the asset offered for sale, `"0"` to `"100"`.
`salable_value`	price	`total_value` × `salable_percentage`.
`max_supply`	integer	Total number of tokens.
`listed_supply`	integer	Tokens offered for primary sale.
`sold_supply`	integer	Tokens sold to investors on the primary market.
`purchased_supply`	integer	Tokens bought back from investors over OTC; they return to the salable pool.

A price object is {id, amount, decimal, symbol, address}: the currency token's id, the amount as a decimal string, the currency's decimals, symbol and contract address. See Amounts and Percentages.

`metric`

Field	Type	Description
`term_duration_in_months`	integer \| null	Term of the asset in months.
`min_purchase_quantity`	integer	Minimum tokens per purchase.
`max_purchase_quantity`	integer	Maximum tokens per purchase.
`min_tokens_required_for_rental_income`	integer	Minimum tokens a holder needs to receive rental income.
`rental_income`	price	Rental income per distribution. With a category whose `rental_income_as_percentage` is on, `amount` is a percentage of the total value.
`rental_payment_period_in_days`	integer	Days between distributions.
`rental_payment_start_date`	string \| null	When rental payments start.
`listing_date`	string \| null	When the token was listed.

Token status

Value	Name	Meaning
`0`	None	No status set.
`1`	Draft	Created, tokenization not started yet.
`2`	InProgress	Tokenization transaction running.
`3`	Error	Tokenization failed. Retry with Retokenize Token.
`4`	NotListed	Tokenized, not offered for sale.
`5`	Delisted	Removed from sale with Delist Token.
`6`	Listed	Offered for primary sale with List Token.
`7`	Passive	Stopped with Passive Token.
`8`	Burn	Burned; holders are paid out (see Get Burn Payouts).

Errors

Status	Code	Description
400	`10016`	`token_id` is not a valid id
400	`10001`	Token not found (token domain `5`)
403	`10005`	The caller's node does not cover the token's node (node domain `2`)

See Errors for the error format and common codes.

Request​

Parameters​

Headers​

Example​

Response​

Response Fields​

Token object​

value​

metric​

Token status​

Errors​