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/sync/mailbox \
--header 'Authorization: Bearer <token>'{
"checkpoint": 1
}Sync mailbox only
Triggers an immediate mailbox sync without running any of the other off-chain sync steps. Fetches any pending mailbox messages from the Ark server, processes them (incoming arkoor payments, lightning receive notifications), and returns the new mailbox checkpoint (tip). Useful in daemon_manual_sync mode where background mailbox subscription is disabled and the operator needs a granular way to pull incoming events.
curl --request POST \
--url https://api.example.com/api/v1/wallet/sync/mailbox \
--header 'Authorization: Bearer <token>'{
"checkpoint": 1
}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
Response
Returns the mailbox tip after sync
The mailbox checkpoint (tip) the wallet has consumed up to after the sync. Monotonically non-decreasing across successful syncs.
x >= 0Was this page helpful?