Skip to main content

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

  • <input type="checkbox" checked="" disabled="" /> Retrieve an account
  • <input type="checkbox" checked="" disabled="" /> Retrieve the balance of an account
  • <input type="checkbox" checked="" disabled="" /> Retrieve the public key of an account
  • <input type="checkbox" checked="" disabled="" /> Retrieve the delegate registration fee
  • <input type="checkbox" checked="" disabled="" /> Retrieve the voted delegate of an account

Blocks Endpoint

  • <input type="checkbox" checked="" disabled="" /> Retrieve for a block
  • <input type="checkbox" checked="" disabled="" /> List all blocks
  • <input type="checkbox" checked="" disabled="" /> Retrieve the epoch of the blockchain
  • <input type="checkbox" checked="" disabled="" /> Retrieve the height of the blockchain
  • <input type="checkbox" checked="" disabled="" /> Retrieve the nethash of the blockchain
  • <input type="checkbox" checked="" disabled="" /> Retrieve a fee
  • <input type="checkbox" checked="" disabled="" /> List all fees of the blockchain
  • <input type="checkbox" checked="" disabled="" /> Retrieve the milestone of the blockchain
  • <input type="checkbox" checked="" disabled="" /> Retrieve the reward of the blockchain
  • <input type="checkbox" checked="" disabled="" /> Retrieve the supply of the blockchain
  • <input type="checkbox" checked="" disabled="" /> Retrieve the status of the blockchain

Delegates Endpoint

  • <input type="checkbox" checked="" disabled="" /> Retrieve a delegate
  • <input type="checkbox" checked="" disabled="" /> Retrieve the total count of delegates
  • <input type="checkbox" checked="" disabled="" /> Retrieve the delegate registration fee
  • <input type="checkbox" checked="" disabled="" /> Retrieve the total forged of a delegate
  • <input type="checkbox" checked="" disabled="" /> List all voters of a delegate
  • <input type="checkbox" checked="" disabled="" /> List all delegates
  • <input type="checkbox" checked="" disabled="" /> Search all delegates
  • <input type="checkbox" checked="" disabled="" /> List the next forgers
  • <input type="checkbox" checked="" disabled="" /> Retrieve the forging status of a delegate

Loader Endpoint

  • <input type="checkbox" checked="" disabled="" /> Retrieve the status of the connected node
  • <input type="checkbox" checked="" disabled="" /> Retrieve the synchronisation status of the connected node
  • <input type="checkbox" checked="" disabled="" /> Retrieve the configuration of the connected node

Multisignature Endpoint

  • <input type="checkbox" checked="" disabled="" /> Retrieve the pending multisignature transactions of an account
  • <input type="checkbox" disabled="" /> Retrieve a multisignature account

Peers Endpoint

  • <input type="checkbox" checked="" disabled="" /> Retrieve a peer
  • <input type="checkbox" checked="" disabled="" /> List all peers
  • <input type="checkbox" checked="" disabled="" /> Retrieve the core version

Signatures Endpoint

  • <input type="checkbox" checked="" disabled="" /> Retrieve the signature registration fee

Transaction Endpoint

  • <input type="checkbox" checked="" disabled="" /> Retrieve a transaction
  • <input type="checkbox" checked="" disabled="" /> List all transactions
  • <input type="checkbox" checked="" disabled="" /> Retrieve an unconfirmed transaction
  • <input type="checkbox" checked="" disabled="" /> List all unconfirmed transactions
  • <input type="checkbox" checked="" disabled="" /> Send a transaction

Endpoint Entity

  • <input type="checkbox" checked="" disabled="" /> GET
  • <input type="checkbox" checked="" disabled="" /> POST
  • <input type="checkbox" checked="" disabled="" /> PUT
  • <input type="checkbox" checked="" disabled="" /> 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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for bpl-api, version 0.1.0
Filename, size File type Python version Upload date Hashes
Filename, size bpl_api-0.1.0-py3-none-any.whl (9.0 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size bpl-api-0.1.0.tar.gz (5.2 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page