bark-rest-client
| Crates.io | bark-rest-client |
| lib.rs | bark-rest-client |
| version | 0.1.0-beta.6 |
| created_at | 2026-01-23 13:57:16.007925+00 |
| updated_at | 2026-01-23 13:57:16.007925+00 |
| description | A simple REST API for Barkd |
| homepage | |
| repository | |
| max_upload_size | |
| id | 2064562 |
| size | 312,625 |
Steven Roose (stevenroose)
documentation
README
Rust API client for bark-rest-client
A simple REST API for Barkd
Overview
This API client was generated by the OpenAPI Generator project. By using the openapi-spec from a remote server, you can easily generate an API client.
- API version: 0.1.0-beta.6
- Package version: 0.1.0-beta.6
- Generator version: 7.17.0
- Build package:
org.openapitools.codegen.languages.RustClientCodegen
Installation
Put the package under your project folder in a directory named bark-rest-client and add the following to Cargo.toml under [dependencies]:
bark-rest-client = { path = "./bark-rest-client" }
Documentation for API Endpoints
All URIs are relative to http://localhost
| Class | Method | HTTP request | Description |
|---|
BitcoinApi | tip | GET /api/v1/bitcoin/tip | BoardsApi | board_all | POST /api/v1/boards/board-all | BoardsApi | board_amount | POST /api/v1/boards/board-amount | BoardsApi | get_pending_boards | GET /api/v1/boards/ | DefaultApi | ping | GET /ping | ExitsApi | exit_claim_all | POST /api/v1/exits/claim/all | ExitsApi | exit_claim_vtxos | POST /api/v1/exits/claim/vtxos | ExitsApi | exit_progress | POST /api/v1/exits/progress | ExitsApi | exit_start_all | POST /api/v1/exits/start/all | ExitsApi | exit_start_vtxos | POST /api/v1/exits/start/vtxos | ExitsApi | get_all_exit_status | GET /api/v1/exits/status | ExitsApi | get_exit_status_by_vtxo_id | GET /api/v1/exits/status/{vtxo_id} | LightningApi | generate_invoice | POST /api/v1/lightning/receives/invoice | LightningApi | get_receive_status | GET /api/v1/lightning/receives/{identifier} | LightningApi | list_receive_statuses | GET /api/v1/lightning/receives | LightningApi | pay | POST /api/v1/lightning/pay | OnchainApi | onchain_address | POST /api/v1/onchain/addresses/next | OnchainApi | onchain_balance | GET /api/v1/onchain/balance | OnchainApi | onchain_drain | POST /api/v1/onchain/drain | OnchainApi | onchain_send | POST /api/v1/onchain/send | OnchainApi | onchain_send_many | POST /api/v1/onchain/send-many | OnchainApi | onchain_sync | POST /api/v1/onchain/sync | OnchainApi | onchain_transactions | GET /api/v1/onchain/transactions | OnchainApi | onchain_utxos | GET /api/v1/onchain/utxos | WalletApi | address | POST /api/v1/wallet/addresses/next | WalletApi | ark_info | GET /api/v1/wallet/ark-info | WalletApi | balance | GET /api/v1/wallet/balance | WalletApi | connected | GET /api/v1/wallet/connected | WalletApi | create_wallet | POST /api/v1/wallet/create | WalletApi | history | GET /api/v1/wallet/history | WalletApi | movements | GET /api/v1/wallet/movements | WalletApi | offboard_all | POST /api/v1/wallet/offboard/all | WalletApi | offboard_vtxos | POST /api/v1/wallet/offboard/vtxos | WalletApi | peak_address | GET /api/v1/wallet/addresses/index/{index} | WalletApi | pending_rounds | GET /api/v1/wallet/rounds | WalletApi | refresh_all | POST /api/v1/wallet/refresh/all | WalletApi | refresh_counterparty | POST /api/v1/wallet/refresh/counterparty | WalletApi | refresh_vtxos | POST /api/v1/wallet/refresh/vtxos | WalletApi | send | POST /api/v1/wallet/send | WalletApi | send_onchain | POST /api/v1/wallet/send-onchain | WalletApi | sync | POST /api/v1/wallet/sync | WalletApi | vtxos | GET /api/v1/wallet/vtxos |
Documentation For Models
To get access to the crate's generated documentation, use:
cargo doc --open