barkd

barkd-client

Auto-generated Python client for the barkd REST API, built from its OpenAPI specification.

Installation

pip install barkd-client

Usage

import barkd_client
from barkd_client.rest import ApiException

config = barkd_client.Configuration(
    host="http://localhost:3535",
)

with barkd_client.ApiClient(config) as api_client:
    wallet = barkd_client.WalletApi(api_client)
    balance = wallet.balance()

API Endpoints

All URIs are relative to http://localhost

Class Method HTTP request Description
BitcoinApi tip GET /api/v1/bitcoin/tip Get bitcoin tip height
BoardsApi board_all POST /api/v1/boards/board-all Board all on-chain bitcoin
BoardsApi board_amount POST /api/v1/boards/board-amount Board a specific amount
BoardsApi get_pending_boards GET /api/v1/boards/pending List pending boards
DefaultApi ping GET /ping Ping
ExitsApi emergency_exit_fee GET /api/v1/exits/fee Estimate emergency exit fee
ExitsApi exit_cancel POST /api/v1/exits/cancel/{vtxo_id} Cancel an exit
ExitsApi exit_claim_all POST /api/v1/exits/claim/all Claim all exited VTXOs
ExitsApi exit_claim_vtxos POST /api/v1/exits/claim/vtxos Claim specific exited VTXOs
ExitsApi exit_progress POST /api/v1/exits/progress Progress exits
ExitsApi exit_start_all POST /api/v1/exits/start/all Start exit for all VTXOs
ExitsApi exit_start_vtxos POST /api/v1/exits/start/vtxos Start exit for specific VTXOs
ExitsApi get_all_exit_status GET /api/v1/exits/status/all List all exit statuses
ExitsApi get_all_exit_status_deprecated GET /api/v1/exits/status List all exit statuses (deprecated)
ExitsApi get_exit_status_by_vtxo_id GET /api/v1/exits/status/vtxo/{vtxo_id} Get VTXO exit status
ExitsApi get_exit_status_by_vtxo_id_deprecated GET /api/v1/exits/status/{vtxo_id} Get exit status (deprecated)
ExitsApi get_finished_exits GET /api/v1/exits/status/finished List finished exits
ExitsApi get_live_exit_status GET /api/v1/exits/status/live List live exit statuses
FeesApi board_fee GET /api/v1/fees/board Estimate board fee
FeesApi lightning_receive_fee GET /api/v1/fees/lightning/receive Estimate Lightning receive fee
FeesApi lightning_send_fee GET /api/v1/fees/lightning/pay Estimate Lightning send fee
FeesApi offboard_all_fee GET /api/v1/fees/offboard-all Estimate offboard-all fee
FeesApi offboard_fee POST /api/v1/fees/offboard Estimate offboard fee
FeesApi onchain_fee_rates GET /api/v1/fees/onchain Get on-chain fee rates
FeesApi send_onchain_fee GET /api/v1/fees/send-onchain Estimate send-onchain fee
HistoryApi list GET /api/v1/history Get wallet history
HistoryApi update_metadata POST /api/v1/history/{id}/metadata Patch movement metadata
LightningApi cancel_receive DELETE /api/v1/lightning/receives/{identifier} Cancel a pending receive
LightningApi generate_invoice POST /api/v1/lightning/receives/invoice Create a BOLT11 invoice
LightningApi generate_invoice_for_address POST /api/v1/lightning/receives/invoice/for-address Create a BOLT11 invoice for an Ark address
LightningApi get_receive_status GET /api/v1/lightning/receives/{identifier} Get receive status
LightningApi get_send_status GET /api/v1/lightning/sends/{identifier} Get send status
LightningApi list_receive_statuses GET /api/v1/lightning/receives List all pending receive statuses
LightningApi pay POST /api/v1/lightning/pay Send a Lightning payment
MessageApi sign_message POST /api/v1/message/sign Sign a message
MessageApi verify_message POST /api/v1/message/verify Verify a signed message
NotificationsApi wait_notification GET /api/v1/notifications/wait Long-poll for wallet notifications
NotificationsApi websocket_ticket GET /api/v1/notifications/ws/ticket Create a websocket ticket
OnchainApi onchain_address POST /api/v1/onchain/addresses/next Generate on-chain address
OnchainApi onchain_balance GET /api/v1/onchain/balance Get on-chain balance
OnchainApi onchain_drain POST /api/v1/onchain/drain Drain on-chain wallet
OnchainApi onchain_send POST /api/v1/onchain/send Send on-chain payment
OnchainApi onchain_send_many POST /api/v1/onchain/send-many Send to multiple addresses
OnchainApi onchain_sync POST /api/v1/onchain/sync Sync on-chain wallet
OnchainApi onchain_transactions GET /api/v1/onchain/transactions List on-chain transactions
OnchainApi onchain_utxos GET /api/v1/onchain/utxos List on-chain UTXOs
WalletApi address POST /api/v1/wallet/addresses/next Generate Ark address
WalletApi ark_info GET /api/v1/wallet/ark-info Get Ark server info
WalletApi balance GET /api/v1/wallet/balance Get wallet balance
WalletApi bip321_uri POST /api/v1/wallet/bip321 Build a BIP 321 payment URI
WalletApi connected GET /api/v1/wallet/connected Check server connection
WalletApi create_wallet POST /api/v1/wallet/create Create a wallet
WalletApi get_vtxo GET /api/v1/wallet/vtxos/{id} Get VTXO detail
WalletApi get_vtxo_encoded GET /api/v1/wallet/vtxos/{id}/encoded Get encoded VTXO
WalletApi history GET /api/v1/wallet/history Get wallet history (deprecated)
WalletApi import_vtxo POST /api/v1/wallet/import-vtxo Import a VTXO
WalletApi mnemonic GET /api/v1/wallet/mnemonic Get wallet mnemonic
WalletApi movements GET /api/v1/wallet/movements List movements (deprecated)
WalletApi next_round GET /api/v1/wallet/next-round Get next round time
WalletApi offboard_all POST /api/v1/wallet/offboard/all Offboard all VTXOs
WalletApi offboard_vtxos POST /api/v1/wallet/offboard/vtxos Offboard specific VTXOs
WalletApi peek_address GET /api/v1/wallet/addresses/index/{index} Get Ark address by index
WalletApi pending_rounds GET /api/v1/wallet/rounds List round participations
WalletApi refresh_all POST /api/v1/wallet/refresh/all Refresh all VTXOs
WalletApi refresh_counterparty POST /api/v1/wallet/refresh/counterparty Refresh received VTXOs
WalletApi refresh_delegated POST /api/v1/wallet/refresh/delegated/vtxos Refresh VTXOs in delegated mode
WalletApi refresh_vtxos POST /api/v1/wallet/refresh/vtxos Refresh specific VTXOs
WalletApi send POST /api/v1/wallet/send Send a payment
WalletApi send_onchain POST /api/v1/wallet/send-onchain Send on-chain from Ark balance
WalletApi sync POST /api/v1/wallet/sync Sync wallet
WalletApi sync_mailbox POST /api/v1/wallet/sync/mailbox Sync mailbox only
WalletApi vtxos GET /api/v1/wallet/vtxos List VTXOs
WalletApi wallet_delete DELETE /api/v1/wallet Delete the wallet
WalletApi wallet_exists GET /api/v1/wallet

License

Released under the MIT license.

Project links

Data verified by PyPI on Sep 9, 2026
Data provided by the project maintainers, verified at the time the release was uploaded to PyPI.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (0.7.2)

Owner

PyPI data
Data sourced directly from PyPI's database.

Credits

Author: Second Team

GitLab Statistics

Data verified by PyPI on Sep 9, 2026
The GitLab source repository was provided by the project maintainers and verified by PyPI at the time of upload. Stars, forks, and open issues/PRs are derived from that repository and have not been independently verified.

License

MIT

Requires

Python >=3.9

Tags

OpenAPI OpenAPI-Generator barkd REST API

Report project as malware

Metadata

Project links

Data verified by PyPI on Sep 9, 2026
Data provided by the project maintainers, verified at the time the release was uploaded to PyPI.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (0.7.2)

Owner

PyPI data
Data sourced directly from PyPI's database.

Credits

Author: Second Team

GitLab Statistics

Data verified by PyPI on Sep 9, 2026
The GitLab source repository was provided by the project maintainers and verified by PyPI at the time of upload. Stars, forks, and open issues/PRs are derived from that repository and have not been independently verified.

License

MIT

Requires

Python >=3.9

Tags

OpenAPI OpenAPI-Generator barkd REST API

Report project as malware

Release files for barkd-client 0.7.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for barkd-client 0.7.0
File Size Uploaded
barkd_client-0.7.0.tar.gz 133.9 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for barkd-client 0.7.0
File Interpreter ABI Platform
barkd_client-0.7.0-py3-none-any.whl 375.4 kB Python 3 none any Details

Total release size: 509.3 kB

Release files / barkd_client-0.7.0.tar.gz

Download URL barkd_client-0.7.0.tar.gz
Size 133.9 kB
Tags Source
SHA-256 checksum
How to use checksums 		c4c62e3d0a1e52382c00d8b6c84ea78f0bab60668a2f052869c31c624bdd3d1c
BLAKE2b-256 checksum
How to use checksums 		189f3dcdfef2d739eff71be918ec76d3402d5b20ce1d15fac880fb20d7aaf3ab
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing? 		Yes
Uploaded via twine/7.0.0 CPython/3.12.14

Release files / barkd_client-0.7.0-py3-none-any.whl

Download URL barkd_client-0.7.0-py3-none-any.whl
Size 375.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums 		e0dae9389d53abba7ef5e9a963e7c54b17230cba5383bddac8d2b06f38efc611
BLAKE2b-256 checksum
How to use checksums 		6a7b090bc01bac20f96b45872ea219d20f58779138579ee91db2cbff9aec49c1
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing? 		Yes
Uploaded via twine/7.0.0 CPython/3.12.14

Release history Release notifications | RSS feed

0.7.2

2 release files

0.7.1

2 release files

This release

0.7.0 This release

2 release files

0.6.2

2 release files

0.6.1

2 release files

0.6.0

2 release files

0.5.0

2 release files

0.4.0

2 release files

0.3.0

2 release files

0.2.5

2 release files

0.2.4

2 release files

0.2.3

2 release files

0.2.2

2 release files

0.2.1

2 release files

0.2.0

2 release files

0.1.5

2 release files

0.1.4

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page