Wallet API
Both the wallet and server use JSON-RPC over the same endpoint.
CLI commands accept an optional --wallet
parameter to specify which wallet to use. If not specified, it defaults to default
.
RPC commands differ from their CLI counterparts due to legacy compatibility reasons. This may be harmonized in future releases.
Create wallet
walletcreate
creates and loads a new wallet
name
string
Wallet name
space-cli createwallet -w newwallet
Example Response
null
Load wallet
walletload
creates and loads a new wallet
name
string
Wallet name
space-cli loadwallet
Example Response
null
Export wallet
walletexport
exports the wallet in JSON format. CLI command saves the response to the target file.
Params
name
string
Wallet name
space-cli exportwallet -w mywallet wallet.json
Example Response
{
"descriptor": "...",
"blockheight": 41530,
"label": "mywallet"
}
Import wallet
importwallet
imports the wallet from JSON description. CLI command loads the description from the source file.
Params
content
string (json)
space-cli importwallet wallet.json
Example Response
null
Get Wallet Info
getwalletinfo
retrieve the wallet info
Params
name
string
Wallet name
space-cli getwalletinfo -w mywallet
Example Response
{
"label": "mywallet",
"start_block": 56801,
"tip": 56821,
"descriptors": [
{
"descriptor": "...",
"internal": false,
"spaces": true
},
{
"descriptor": "...",
"internal": true,
"spaces": true
}
]
}
Get Balance
balance
gets the wallet balance
Params
name
string
Wallet name
space-cli balance -w mywallet
Example Response
{
"balance": 0,
"details": {
"immature": 0,
"trusted_pending": 0,
"untrusted_pending": 0,
"confirmed": 0,
"dust": 0
}
}
Get New Address
CLI has separate commands instead for different kind
values.
getnewaddress
gets a new Bitcoin address suitable for receiving coins compatible with most bitcoin wallets.
getnewspaceaddress
gets a new Bitcoin address suitable for receiving spaces and coins (Spaces compatible bitcoin wallets only).
Params
name
string
Wallet name
kind
string
Coin
or Space
space-cli getnewaddress -w mywallet
Example Response
"tb1phg2rcjunxew9eqruehs2ejqmyjhzwnzfzrvmyl3ugaezpvf5d87qwj763n"
Send Request
walletsendrequest
send one or multiple requests
CLI has separate commands instead: open
, bid
, register
, transfer
, renew
and createbidouts
Params
name
string
Wallet name
request
Request containing one or more transactions
Batch Request Type
bidouts
number (optional)
Create the specified number of auction outputs. These are output pairs used during the bidding process. If null, it will create several to satisfy the requests.
requests
Bundles one or multiple requests
fee_rate
number (optional)
Fee rate in sat/vB. If null, it will attempt to use estimatesmartfee
instead.
dust
number (optional)
Custom dust amount to use for auction outputs
force
bool
Forces the transaction to be created even if it will be rejected by the protocol or results in revoking the space (mainly used for testing)
confirmed_only
bool
Use only confirmed UTXOs
skip_tx_check
bool
Skip tx checker (not recommended)
Wallet Request Type
A single wallet request
request
string
The transaction/request type. Can be open
, bid
, register
, transfer
, sendcoins
or execute
.
name
string
The space name. Required for open
, bid
and register
transactions.
spaces
array of strings
The spaces names. Required for transfer
transaction.
amount
string
Amount in satoshis. Required for open
, bid
and sendcoins
transactions.
to
string
Recipient Bitcoin address or a space name. Required for transfer
and sendcoins
requests. Optional for register
transactions.
space-cli open @mynewspace 1000
Response
[
{
"txid": "3529a729fc2dff2184339f1accf7c8fc3139bcc25f0b874816b6522daea7ee5b",
"tags": [
"bidouts",
"commitment"
]
},
{
"txid": "747c3877dea45c065b40a61b190d2160e917124bc46054c6c80e7f6ee6bc7995",
"tags": [
"open"
]
}
]
Bump Fee
bumpfee
bumps the fee for the given wallet transaction
Params
name
string
Wallet name
txid
string
The transaction id as a hex string
fee_rate
number (optional)
Fee rate in sat/vB
skip_tx_check
bool
Skip tx checker (not recommended)
space-cli bumpfee 14804a155846b56a87c6d90088d8174e8e8640d5bcaa00132a4968e105b48d27 --fee-rate 1000
Response
[
{
"txid":"65dcad71550fc2f59553b7525d131f8c3b416d1310b46e5aa6428feaf742b0e4",
"tags":[
"fee-bump"
]
}
]
Sell
walletsell
creates PSBT which can be used to sell the space
Params
name
string
Wallet name
space
string
The space name
price
number
Price in satoshis
space-cli sell @space3 10000
Example Response
{
"space": "@space",
"price": 10000,
"seller": "bcrts1pr5ux9k9jngxy8jjxyhwv7w0hvztyteklsn5y47urtwhcmdppgqpqrj9p9g",
"signature": "........"
}
Verify Listing
verifylisting
verify the space sale listing
Params
listing
object
The walletsell
output
space-cli verifylisting --signature ........ --seller bcrts1pr5ux9k9jngxy8jjxyhwv7w0hvztyteklsn5y47urtwhcmdppgqpqrj9p9g @space 10000
Example Response
null
Buy
walletbuy
buy space using the sell output
Params
name
string
Wallet name
listing
object
The walletsell
output
fee_rate
number (optional)
Fee rate in sat/vB
skip_tx_check
bool
Skip tx checker (not recommended)
space-cli buy --signature ........ --seller bcrts1pr5ux9k9jngxy8jjxyhwv7w0hvztyteklsn5y47urtwhcmdppgqpqrj9p9g @space 10000
Example Response
{
"txid": "f51c8c474f53a846187e9eb4c0fa0a44226b35e4fd5693f138d170d57f9bb977",
"events": [
{
"type": "buy",
"space": "@space",
"previous_spaceout": "a04100e569761211716e1452ae17a95d4d3ddd9fe8d03e8371ed8fa58b0504f6:1"
}
]
}
Sign Message
walletsignmessage
signs the message
Params
name
string
Wallet name
space
string
The space name
message
string
Message as hex string
space-cli signmessage @testspace message
Example Response
"673ef14b408979ab8bc9fcae23dc309187999189fdd429128f899763de8951ded9337f0861cb60e50eded5a9344796a6810bf2186a4bc9fd27d2bb45ee23ded8"
Verify Message
verifymessage
verify a signed message
Params
space
string
The space name
message
string
Message as hex string
signature
string
Signature as hex string
space-cli --signature 673ef14b408979ab8bc9fcae23dc309187999189fdd429128f899763de8951ded9337f0861cb60e50eded5a9344796a6810bf2186a4bc9fd27d2bb45ee23ded8 @testspace message
Example Response
null
List Spaces
walletlistspaces
list all spaces currently owned by the wallet including ones actively in auction
Params
name
string
Wallet name
space-cli listspaces
Response
{
"winning": [
{
"txid": "9c44384840b40ef159764801a185a87f84947919d60d9e87771cbd47044e0467",
"n": 3,
"name": "@space2",
"covenant": {
"type": "bid",
"burn_increment": 10000,
"signature": "........",
"total_burned": 10000,
"claim_height": 9937
},
"value": 662,
"script_pubkey": "........"
}
],
"outbid": [
{
"txid": "c2d156cde1437915eafdc551018abc594c4737ef65c0033a3ea6c1c6d779fefa",
"n": 1,
"name": "@space1",
"covenant": {
"type": "transfer",
"expire_height": 55121,
"data": null
},
"value": 666,
"script_pubkey": "........"
}
],
"owned": [
{
"txid": "a04100e569761211716e1452ae17a95d4d3ddd9fe8d03e8371ed8fa58b0504f6",
"n": 1,
"name": "@space3",
"covenant": {
"type": "transfer",
"expire_height": 55121,
"data": null
},
"value": 666,
"script_pubkey": "........"
}
]
}
List Unspent
walletlistunspent
list unspent transaction outputs
Params
name
string
Wallet name
space-cli listunspent
Response
[
{
"outpoint": "838948b831a81119e20637a807ad0fe09bae248af6183fdd668168e7f58449b2:1",
"txout": {
"value": 666,
"script_pubkey": "........"
},
"keychain": "External",
"is_spent": false,
"derivation_index": 4,
"chain_position": {
"Confirmed": {
"anchor": {
"block_id": {
"height": 6301,
"hash": "6e4630c207d973ad8e59b2c0e245f50496fc6b31fc6c6c4fceedba886b83ea28"
},
"confirmation_time": 1738698507
},
"transitively": null
}
},
"space": {
"name": "@space",
"covenant": {
"type": "transfer",
"expire_height": 58861,
"data": null
}
},
"is_spaceout": true
},
{
"outpoint": "643aefc51869a615e8313db5c85e70058341ae48289afdf7be88438817986a6e:5",
"txout": {
"value": 662,
"script_pubkey": "........"
},
"keychain": "External",
"is_spent": false,
"derivation_index": 7,
"chain_position": {
"Confirmed": {
"anchor": {
"block_id": {
"height": 8371,
"hash": "6055898710bdfc75ef3a96e752ae11ba89190fb8e53beb527a86999e5789160f"
},
"confirmation_time": 1738705621
},
"transitively": null
}
},
"space": null,
"is_spaceout": true
},
{
"outpoint": "7b235a4c5e87406315efbeebf2671124e0b05276441700a1232a7b14eb325751:0",
"txout": {
"value": 10000,
"script_pubkey": "........"
},
"keychain": "External",
"is_spent": false,
"derivation_index": 8,
"chain_position": {
"Confirmed": {
"anchor": {
"block_id": {
"height": 8471,
"hash": "24ee232b4c0d9c9ff60bb2e460bd80ef076ea63adedefecaa2a594431feb03dc"
},
"confirmation_time": 1738705638
},
"transitively": null
}
},
"space": null,
"is_spaceout": false
}
]
List Auction Outputs
walletlistbidouts
lists all output pairs that can be used during bids
Params
name
string
Wallet name
space-cli listbidouts
Response
[
{
"spend": {
"outpoint": "d8907044ae65355b244395f42318a250eeabed49bc1dab63a5cf2553daaed2ad:0",
"txout": {
"value": 664,
"script_pubkey": "........"
}
},
"auction": {
"outpoint": "d8907044ae65355b244395f42318a250eeabed49bc1dab63a5cf2553daaed2ad:1",
"txout": {
"value": 662,
"script_pubkey": "........"
}
},
"confirmed": false
}
]
List Transactions
listtransactions
lists all the transactions starting from the most recent one
Params
name
string
Wallet name
count
number
The maximum number of transactions to be shown
skip
number
The number of transactions to be skipped from the beginning
space-cli listtransactions
Response
[
{
"txid": "9d32499b14810a2f10033c9ed1e20b01449e34a4b2613274ba875f3fdf81a0c8",
"confirmed": false,
"sent": 88950412,
"received": 88850537,
"fee": 99537,
"events": [
{
"type": "open",
"space": "@space1",
"initial_bid": 1000
}
]
},
{
"txid": "f51c8c474f53a846187e9eb4c0fa0a44226b35e4fd5693f138d170d57f9bb977",
"confirmed": false,
"sent": 88851203,
"received": 88789693,
"fee": 61510,
"events": [
{
"type": "buy",
"space": "@space3",
"previous_spaceout": "a04100e569761211716e1452ae17a95d4d3ddd9fe8d03e8371ed8fa58b0504f6:1"
}
]
},
{
"txid": "4806424d1afed83e538baf1d55f508481efd10e4a6b2bae24923c0fb6e460717",
"confirmed": false,
"sent": 9999999,
"received": 9968178,
"fee": 31159,
"events": [
{
"type": "commit",
"space": "@space1"
}
]
},
{
"txid": "7b235a4c5e87406315efbeebf2671124e0b05276441700a1232a7b14eb325751",
"confirmed": true,
"sent": 88990907,
"received": 88959748,
"fee": 31159,
"events": [
{
"type": "send",
"amount": 10000,
"recipient_script_pubkey": "........"
}
]
},
{
"txid": "cb6de0439f34b2bf0b26f0d87c79218026379ef7d26d76b55e1883d13f5901f9",
"confirmed": true,
"sent": 99666094,
"received": 99558633,
"fee": 98123,
"events": [
{
"type": "open",
"space": "@space2",
"initial_bid": 10000
}
]
}
]
Last updated
Was this helpful?