Barkd
- Overview
- Install Barkd
- Start the daemon
- Authenticate
- Clients
- GETGet apiv1wallet
- DELDelete apiv1wallet
- GETGet Ark address by index
- POSTGenerate Ark address
- GETGet Ark server info
- GETGet wallet balance
- GETCheck server connection
- POSTCreate a wallet
- GETGet wallet history
- POSTImport a VTXO
- GETList movements (deprecated)deprecated
- GETGet next round time
- POSTOffboard all VTXOs
- POSTOffboard specific VTXOs
- POSTRefresh all VTXOs
- POSTRefresh received VTXOs
- POSTRefresh specific VTXOs
- GETList round participations
- POSTSend a payment
- POSTSend on-chain from Ark balance
- POSTSync wallet
- POSTSync mailbox only
- GETList VTXOs
- GETGet VTXO detail
- GETGet encoded VTXO
Run an Ark server
curl --request POST \
--url https://api.example.com/api/v1/wallet/offboard/all \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"address": "<string>"
}
'{
"offboard_txid": "<string>"
}Offboard all VTXOs
Cooperatively moves all spendable VTXOs off the Ark protocol to an on-chain address. Each VTXO is offboarded in full—partial amounts are not supported. The on-chain transaction fee is deducted from the total, and the remaining amount is sent to the destination. If no address is specified, the wallet generates a new on-chain address. To send a specific amount on-chain, use send-onchain instead.
curl --request POST \
--url https://api.example.com/api/v1/wallet/offboard/all \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"address": "<string>"
}
'{
"offboard_txid": "<string>"
}Documentation Index
Fetch the complete documentation index at: https://second.tech/docs/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
Base64url-encoded auth token
Body
Optional Bitcoin address to send to. If not provided, uses the onchain wallet's address
Response
Returns the offboard transaction id
The transaction id of the offboard transaction
Was this page helpful?