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.
Metadata
Release files for barkd-client 0.8.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| barkd_client-0.8.0.tar.gz | 137.9 kB | Without provenance | Details for barkd_client-0.8.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| barkd_client-0.8.0-py3-none-any.whl | Python 3 | none | any | Details for barkd_client-0.8.0-py3-none-any.whl |
Total release size: 523.5 kB
Release files / barkd_client-0.8.0.tar.gz
| Download URL | barkd_client-0.8.0.tar.gz |
|---|---|
| Size | 137.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
63e6699bbaf8a57eccc66065c6d518ccd050b12cf4d5f5b80407b866b54ebe40
|
|
BLAKE2b-256 checksum How to use checksums |
c191430ecb5912a13dfcc436b9690ec5131137b8406de42bed4b779ccb5fe091
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.12.15
|
Release files / barkd_client-0.8.0-py3-none-any.whl
| Download URL | barkd_client-0.8.0-py3-none-any.whl |
|---|---|
| Size | 385.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
85332036d052b9e48c5517d11b45de2895e1cc8b3fb383c1c4c607db19e0b164
|
|
BLAKE2b-256 checksum How to use checksums |
18a817b134578c163bd26ed63e7d98d982da55f62249a30aec9e83ed72c23ced
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.12.15
|
Security for barkd-client 0.8.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.