For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
This endpoint creates an unbond request for DOT. This will unbond the selected amount. The unbonded funds will then be locked for 28 days, and can be claimed when unlocked with a DOT WithdrawUnbonded request.
Required role: RequestCreator.
This API can be made idempotent by generating an ID for the Request beforehand and passing it as the externalRequestId attribute
Authentication
AuthorizationBearer
Bearer authentication of the form Bearer <token>, where token is your auth token.
Request
This endpoint expects an object.
fromAddressIdstringRequiredformat: "uint64"
uint64; The ID of the source address for funds.
amountstringRequired
numeric; Amount in the smallest currency unit, based on the currency decimals. Example: 1500000000000000000 WEI (smallest ETH unit) corresponds to 1.5 ETH (ETH has 18 decimals places)
feeLimitstringOptional
numeric; Maximum amount of fees to be paid for the transaction.
commentstringOptional
A reconciliation note can be given when initiating a request and this will be included in transaction history.
transactionReferencestringOptional
Deprecated: use externalRequestId instead
externalRequestIdstringOptional
Identifier for the request in the user's system. This must be unique. Attempting to create a request with an existing externalRequestId will do nothing and return the originally created request