An API for the Blockpool Blockchain.
Project description
BPL API
A simple Python API for the Blockpool blockchain
This is a easy-to-use Python API for interacting with a Blockpool blockchain. This API provides a Python wrapper for the majority of the API endpoints for BPL-Node
Features
Accounts Endpoint
- Retrieve an account
- Retrieve the balance of an account
- Retrieve the public key of an account
- Retrieve the delegate registration fee
- Retrieve the voted delegate of an account
Blocks Endpoint
- Retrieve for a block
- List all blocks
- Retrieve the epoch of the blockchain
- Retrieve the height of the blockchain
- Retrieve the nethash of the blockchain
- Retrieve a fee
- List all fees of the blockchain
- Retrieve the milestone of the blockchain
- Retrieve the reward of the blockchain
- Retrieve the supply of the blockchain
- Retrieve the status of the blockchain
Delegates Endpoint
- Retrieve a delegate
- Retrieve the total count of delegates
- Retrieve the delegate registration fee
- Retrieve the total forged of a delegate
- List all voters of a delegate
- List all delegates
- Search all delegates
- List the next forgers
- Retrieve the forging status of a delegate
Loader Endpoint
- Retrieve the status of the connected node
- Retrieve the synchronisation status of the connected node
- Retrieve the configuration of the connected node
Multisignature Endpoint
- Retrieve the pending multisignature transactions of an account
- Retrieve a multisignature account
Peers Endpoint
- Retrieve a peer
- List all peers
- Retrieve the core version
Signatures Endpoint
- Retrieve the signature registration fee
Transaction Endpoint
- Retrieve a transaction
- List all transactions
- Retrieve an unconfirmed transaction
- List all unconfirmed transactions
- Send a transaction
Endpoint Entity
- GET
- POST
- PUT
- DELETE
Installation
pip install bpl-api
Note: not working as of 2018-07-26
Usage
There are 8 API endpoints in bpl-api:
accounts
blocks
delegates
loader
multisignatures
peers
signatures
transactions
Each endpoint can be accessed using the Client
interface, for example:
from bpl_api import Client
accounts_endpoint = Client("s01.mc.blockpool.io:9030").api("accounts")
See the documented code for how each endpoint may be used.
Security or Errors
If you discover a security vulnerability or error within this package, please email me or message me on the BPL discord.
Credits
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
bpl-api-0.1.0.tar.gz
(5.2 kB
view hashes)