mirror of
https://github.com/cryptoadvance/specter-desktop.git
synced 2026-08-17 13:07:37 +02:00
28e13ca93c
* mkdocs * adding mkdocs for netlify * fix theme * link to Readme * deleting symlink again * deleting index.md * fix release-notes * several doc improvements and elements installation * move DEVELOPMENT.md and CONTRIBUTING.md in subfolder * multi-site setup * changes site_dir * revert * adding mkdoc-wrapper.sh * removing mkdocs from prod-requirements * more docs * fix test ... no more warning |
||
|---|---|---|
| .. | ||
| ep_liveness.md | ||
| ep_readyness.md | ||
| ep_specter.md | ||
| ep_specter_fulltxlist.md | ||
| ep_wallets_psbt.md | ||
| ep_wallets_wallet.md | ||
| README.md | ||
Specter API
Specter provides a Rest-API which is, by default, in production deactivated. In order to activate, you need to export a variable like that:
export SPECTER_API_ACTIVE=True
The Authentication is also necessary if you don't activate any Authentication mechanism.
In order to make reasonable assumptions about how stable a specific endpoint is, we're versioning them via the URL. Currently, all endpoints are preset with v1alpha which pretty much don't give you any guarantee.
Basic Usage
Curl:
curl -u admin:secret -X GET http://127.0.0.1:25441/api/v1alpha/specter | jq .
Python:
import requests
response = requests.get('http://127.0.0.1:25441/api/v1alpha/specter', auth=('admin', 'secret'))
json.loads(response.text)
Endpoints
- Liveness: Is specter up and running?
- Readyness: Is specter ready to serve requests?
- Specter: Get details about the instance
- Specter Full Tx List: Gives a full tx_list of all transactions.
- Wallet: Details about a specific Wallet
- Wallet PSBT: Listing and creating PSBTs