List Tokens
Returns one page of a node's tokens, newest first, with optional category, origin, status and flag filters. The listing is always scoped to one node (node_id), and the caller's node must be that node or one of its ancestors. A filter that matches nothing answers an empty page, not a 404.
Get Token
Returns one token with its active (not deleted) images and documents. The token's fields are at the root of the response; includecategorydata=true adds the token's category alongside them. The caller's node must cover the node that owns the token.
Create Token
Creates a token under a node and starts its tokenization on a setup. The call is asynchronous when it reaches 3 (Done) the token is in status 4 (NotListed) with its contract set; when it reaches 4 (Error) the token is in status 3 (Error) and can be retried with Retokenize Token.
Update Token
Updates a token's name, description, value, images, documents and oracle. The change is written to the token at once. Only one change reaches the chain null and is complete when the call returns.
Update Token Metric
Sets a token's listed supply, purchase bounds, term and rental terms. Every field is applied as sent: an omitted number is read as 0, an omitted termdurationinmonths as null and an omitted rentalincomecurrencytoken_id clears the rental currency, so send the full metric each time.
Delete Token
Deletes a token that never reached the market: only a token in status 1 (Draft), 3 (Error) or 4 (NotListed) can be deleted. The deletion is immediate and off-chain; the token is soft-deleted (it keeps its record with deletedat set, and List Tokens still returns it unless isnot_deleted=true). A token that is listed between the check and the write is refused rather than deleted.
List Token
Offers a token for primary sale. The call is asynchronous when it reaches 3 (Done) the token is in status 6 (Listed).
Delist Token
Removes a listed token from primary sale. The token must be in status 6 (Listed) or 5 (Delisted). The call is asynchronous when it reaches 3 (Done) the token is in status 5 (Delisted).
Passive Token
Stops a token. The token must be in status 6 (Listed) or 5 (Delisted). The call is asynchronous when it reaches 3 (Done) the token is in status 7 (Passive).
Burn Token
Ends a token's term: burns every token investors still hold and funds a payout pool at the current token price. The token must be in status 6 (Listed) or 4 (NotListed) and at least one token must be held by investors. Read Get Burn Summary first to see the amount the burn will move.
Rent Token
Distributes one period of the token's rental income to its holders. Only holders with at least metric.mintokensrequiredforrental_income tokens are paid. The token's rental terms must be set (see Update Token Metric); read Get Rental Summary first to see what the distribution will pay.
Public Transfer Token
Allows or restricts free transfer of a token between holders. The call is asynchronous: it queues a PublicTransferToken transaction (type 8) and answers with its id. is_public on the token changes only when the transaction reaches 3 (Done); poll it with Get Token Transaction By ID.
Open Token to OTC
Opens a token to over-the-counter (OTC) trading or closes it. The call is asynchronous: it queues an OpenToOtc transaction (type 12) and answers with its id. isopento_otc on the token changes only when the transaction reaches 3 (Done); poll it with Get Token Transaction By ID.
Open Token to Secondary Market
Opens a token to the secondary market (holders listing their tokens for other investors) or closes it. The call is asynchronous: it queues an OpenToSecondaryMarket transaction (type 11) in the token's own transactions and answers with its id. isopentosecondarymarket on the token changes only when the transaction reaches 3 (Done); poll it with Get Token Transaction By ID.
Retokenize Token
Retries the tokenization of a token whose previous attempt failed. Only a token in status 3 (Error) qualifies, and its setup must still have all its contracts deployed. Use this instead of creating the token again: a second Create Token would make a second record for the same asset.
List Token Transactions
Returns one page of a token's on-chain transactions, newest first, optionally narrowed to one transaction type. Every asynchronous token endpoint answers with the id of the transaction it started; poll that one with Get Token Transaction By ID. Use this list for the transactions a call starts without returning them (the AddDocumentToToken transactions of List Token and Update Token) and for a token's history of operations.
Get Token Transaction By ID
Returns one transaction of a token. This is the read to poll after any asynchronous token endpoint: call it with the transaction_id the endpoint answered with until status is 3 (Done) or 4 (Error). A transaction of another token is reported as not found.
Get Token History
Returns one page of a token's history, newest first. Each row is a snapshot of the token's value, metric and meta (images and documents) at one change. User-facing token reads show the latest row, so the history is what investors see:
Get Rental Summary
Shows what the next rental income distribution of a token would pay, and to how many holders. Read it before Rent Token. The counts cover only the holders who would be paid: a holder below mintokensforincome (summed over their wallets) receives nothing and is left out, so investorcount is usually lower than the number of holders.
Get Token Deposits
Returns one page of a token's rental income distributions, newest first. Each row is one distribution started by Rent Token, with the on-chain transaction behind it and the documents attached to it. The individual payouts of a distribution are in Get Token Rents, joined by external_id.
Get Deposit Transaction
Returns the on-chain transaction behind one rental income distribution: its hash when it settled, its error when it did not. It is the same object a row of Get Token Deposits carries under transaction, read directly by deposit id. The response is null when the distribution predates the link to its transaction and no match is found. A deposit of another token is reported as not found.
Get Token Rents
Returns one page of the individual rental income payouts a token produced: one row per holder per distribution, across all distributions, newest first. Group the rows by external_id to match them to a distribution in Get Token Deposits.
Get Burn Summary
Shows what burning a token would pay. Read it before Burn Token: the burn funds a pool of the current token price times every token investors still hold, and each holder is then owed their share.
Get Burn Payouts
Lists what a settled burn owes each wallet and how far each claim got. When the Burn Token transaction settles, one payout is recorded per (investor, wallet) that held the token: the wallet's quantity times the token price the pool was funded at. Investors claim their payouts themselves. Before the burn settles, the summary counts are 0, its amounts null, and data is empty. The list is not paginated; rows are oldest first.
Get Token Investors
Returns one page of the users currently holding a token, largest position first. Only current holders are listed: someone who bought and then sold everything is not an investor any more. A holder with several wallets is one row, with the position summed across those wallets.
Get Token Investor
Returns one holder of a token, in the shape of a row of Get Token Investors. The holding is what is looked up: a user who holds none of the token, including one who sold their whole position, is reported as not found.
Tokenization Suggest
Sends a free-text description of an asset to an AI provider and returns suggested values for the Create Token form: name, description, token name and symbol, total value, max supply and salable percentage. Nothing is stored. The AI providers are configured by the platform; list the ones you can pick with Get Tokenization Providers. Without provider, the first provider serving tokenization suggestions answers.
Get Tokenization Providers
Lists the AI providers you can name in a tokenization request, in the platform's pick order: the enabled providers marked for the feature. The first one answers a request that names none. An empty list means the feature is off and the request would be refused.
Generate Tokenization Image
Draws an image of the asset for a new token's form with an AI provider. The picture is drawn from the values you send (name, and when given category_name, description and a free-text instruction) with a fixed prompt; nothing is read from the store, so the token does not need to exist yet. Nothing is stored either: the image comes back base64-encoded, ready to be uploaded as one of the token's images in Create Token or Update Token.