Get Active Node
Returns the node your access token is scoped to — your own node — with the same detail as Get Node. Use it when you do not know your node's id: it is resolved from the token, so the request takes no parameters.
Get Node
Returns one node. The node must be your own node or one below it in the hierarchy; any other node is refused with 10005.
List Children Nodes
Lists the direct children of a node, newest first, with pagination. For every node below a node at any depth use List Node Descendants.
List Node Descendants
Lists every node below a node, excluding the node itself, newest first, with pagination. The list is flat, so each row carries path_name — the names of its ancestors and itself joined by / , root first — to show where it sits without walking the tree again. For the immediate children only, use List Children Nodes.
Create Node
Creates a node under a parent node. The node type is not chosen by the caller: it follows from the parent — a child of the platform node is an account (2), a child of an account or of a sub-account is a sub-account (3).
Update Node
Renames a node and updates its branding: logo and brand colours. The request is a multipart/form-data form so the logo can be uploaded in the same call. name is always required — send the current name to change only the branding.
Delete Node
Deletes a node. Only an empty node can be deleted: a node that still has child nodes, supervisors or tokens is refused, each with its own code.
List Node Investors
Lists the users who hold a positive balance of the node's tokens, with pagination. There is one row per investor, not per holding: a user holding several of the node's tokens, or holding them in several wallets, appears once.
List Node Wallets
Lists a node's custody wallets: id, chain, address, label and status. A node can hold several wallets, including several on the same chain, because each (wallet, network) pair backs its own setup. Wallet ids from this list are what setups, deploys and withdrawals take as wallet_id.
Create Node Wallet
Provisions a new custody wallet for an account node or for the platform node, on the chain you select. The platform node can only be targeted with an access token issued on the platform node itself. A node may hold several wallets, including several on the same chain, so this never replaces an existing one. Sub-account nodes cannot hold a wallet (10027).
Withdraw
Sends the network's native coin or a currency token from one of the node's custody wallets to an address. You choose both the wallet (walletid) and the network (networkid); the server never picks them for you. The wallet must belong to the node and sit on the network's chain.
List Node Transactions
Lists a node's on-chain transaction records, newest first, with pagination: contract deploys and upgrades, fee updates, KYC operations, withdrawals and the rest. Every asynchronous node operation writes one of these records; this is where you watch it reach Done or Error. To poll a single record use Get Node Transaction.
Get Node Transaction
Returns one of a node's transactions by id. Use it to poll a single operation to a final status instead of re-listing. The node is part of the key: a transaction that belongs to another node is reported as not found.
List Node Payments
Lists the settled transfers out of a node's wallets, newest first, with pagination. A payment is written when a Withdraw is confirmed on chain; it records where the funds went, how much and the transaction hash. To follow a withdrawal that has not settled yet, use List Node Transactions.
Setups
9 items