barkd REST API
Endpoints
- 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
- GETList VTXOs
Send on-chain from Ark balance
Copy
curl --request POST \
--url https://api.example.com/api/v1/wallet/send-onchain \
--header 'Content-Type: application/json' \
--data '
{
"amount_sat": 1,
"destination": "<string>"
}
'Copy
{
"offboard_txid": "<string>"
}wallet
Send on-chain from Ark balance
Sends the specified amount to an on-chain address using the wallet’s off-chain Ark balance. The on-chain transaction fee is paid on top of the specified amount. Internally creates an out-of-round transaction to consolidate VTXOs into the exact amount needed, then cooperatively sends the on-chain payment via the Ark server. To offboard entire VTXOs without specifying an amount, use offboard/vtxos or offboard/all instead.
POST
/
api
/
v1
/
wallet
/
send-onchain
Send on-chain from Ark balance
Copy
curl --request POST \
--url https://api.example.com/api/v1/wallet/send-onchain \
--header 'Content-Type: application/json' \
--data '
{
"amount_sat": 1,
"destination": "<string>"
}
'Copy
{
"offboard_txid": "<string>"
}Was this page helpful?
⌘I