{ "info": { "author": "Alistair O'Brien", "author_email": "alistair.o'brien@ellesmere.com", "bugtrack_url": null, "classifiers": [], "description": "# BPL API\n\n> A simple Python API for the Blockpool blockchain\n\nThis 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](https://github.com/blockpool-io/BPL-node)\n\n## Features\n\n### Accounts Endpoint\n- [x] Retrieve an account\n- [x] Retrieve the balance of an account\n- [x] Retrieve the public key of an account\n- [x] Retrieve the delegate registration fee\n- [x] Retrieve the voted delegate of an account\n\n### Blocks Endpoint\n- [x] Retrieve for a block\n- [x] List all blocks\n- [x] Retrieve the epoch of the blockchain\n- [x] Retrieve the height of the blockchain\n- [x] Retrieve the nethash of the blockchain\n- [x] Retrieve a fee\n- [x] List all fees of the blockchain\n- [x] Retrieve the milestone of the blockchain\n- [x] Retrieve the reward of the blockchain\n- [x] Retrieve the supply of the blockchain\n- [x] Retrieve the status of the blockchain\n\n### Delegates Endpoint\n- [x] Retrieve a delegate\n- [x] Retrieve the total count of delegates\n- [x] Retrieve the delegate registration fee\n- [x] Retrieve the total forged of a delegate\n- [x] List all voters of a delegate\n- [x] List all delegates\n- [x] Search all delegates\n- [x] List the next forgers\n- [x] Retrieve the forging status of a delegate\n\n### Loader Endpoint\n- [x] Retrieve the status of the connected node\n- [x] Retrieve the synchronisation status of the connected node\n- [x] Retrieve the configuration of the connected node\n\n### Multisignature Endpoint\n- [x] Retrieve the pending multisignature transactions of an account\n- [ ] Retrieve a multisignature account\n\n### Peers Endpoint\n- [x] Retrieve a peer\n- [x] List all peers\n- [x] Retrieve the core version\n\n### Signatures Endpoint\n- [x] Retrieve the signature registration fee\n\n### Transaction Endpoint\n- [x] Retrieve a transaction\n- [x] List all transactions\n- [x] Retrieve an unconfirmed transaction\n- [x] List all unconfirmed transactions\n- [x] Send a transaction\n\n### Endpoint Entity\n- [x] GET\n- [x] POST\n- [x] PUT\n- [x] DELETE\n\n## Installation\n```sh\npip install bpl-api\n```\n\nNote: not working as of 2018-07-26\n\n## Usage\n\nThere are 8 API endpoints in bpl-api:\n\n- ``accounts``\n- ``blocks``\n- ``delegates``\n- ``loader``\n- ``multisignatures``\n- ``peers``\n- ``signatures``\n- ``transactions``\n\nEach endpoint can be accessed using the `Client` interface, for example:\n```python\nfrom bpl_api import Client\n\naccounts_endpoint = Client(\"s01.mc.blockpool.io:9030\").api(\"accounts\")\n```\n\nSee the documented code for how each endpoint may be used.\n\n## Security or Errors\n\n\nIf you discover a security vulnerability or error within this package, please email [me](mailto:alistair.o'brien@ellesmere.com) or message me on the [BPL discord](https://discordapp.com/invite/67HxSKq).\n\n## Credits\n\n- [Alistair O'Brien](https://github.com/johnyob)\n\n", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/DuneRoot/bpl-api", "keywords": "", "license": "", "maintainer": "", "maintainer_email": "", "name": "bpl-api", "package_url": "https://pypi.org/project/bpl-api/", "platform": "", "project_url": "https://pypi.org/project/bpl-api/", "project_urls": { "Homepage": "https://github.com/DuneRoot/bpl-api" }, "release_url": "https://pypi.org/project/bpl-api/0.1.0/", "requires_dist": [ "requests" ], "requires_python": "", "summary": "An API for the Blockpool Blockchain.", "version": "0.1.0" }, "last_serial": 4168843, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "6365b85d91b0a8d02d11be418d37cc78", "sha256": "5ba5ad9f33a600d86e85cc6f19ab32eaa45ef2d3f0d6f9e3711cb74fd7579ac9" }, "downloads": -1, "filename": "bpl_api-0.1.0-py3-none-any.whl", "has_sig": false, "md5_digest": "6365b85d91b0a8d02d11be418d37cc78", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 8976, "upload_time": "2018-08-14T10:35:37", "url": "https://files.pythonhosted.org/packages/20/30/c6cd7e790501f5ed883ee64e6d5f10beb1b310a4418c5072f04319e23905/bpl_api-0.1.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "8eb40b051719dcb7f3ca261d36acf25f", "sha256": "572db6c466076f9ea3a86788d679ce9957555eff3d3ae9c24cc3503bd0145a84" }, "downloads": -1, "filename": "bpl-api-0.1.0.tar.gz", "has_sig": false, "md5_digest": "8eb40b051719dcb7f3ca261d36acf25f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5215, "upload_time": "2018-08-14T10:35:38", "url": "https://files.pythonhosted.org/packages/77/db/e01a451208e5a58e211be940d6e63c06ed3c434e26bf726af48f04835c97/bpl-api-0.1.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "6365b85d91b0a8d02d11be418d37cc78", "sha256": "5ba5ad9f33a600d86e85cc6f19ab32eaa45ef2d3f0d6f9e3711cb74fd7579ac9" }, "downloads": -1, "filename": "bpl_api-0.1.0-py3-none-any.whl", "has_sig": false, "md5_digest": "6365b85d91b0a8d02d11be418d37cc78", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 8976, "upload_time": "2018-08-14T10:35:37", "url": "https://files.pythonhosted.org/packages/20/30/c6cd7e790501f5ed883ee64e6d5f10beb1b310a4418c5072f04319e23905/bpl_api-0.1.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "8eb40b051719dcb7f3ca261d36acf25f", "sha256": "572db6c466076f9ea3a86788d679ce9957555eff3d3ae9c24cc3503bd0145a84" }, "downloads": -1, "filename": "bpl-api-0.1.0.tar.gz", "has_sig": false, "md5_digest": "8eb40b051719dcb7f3ca261d36acf25f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5215, "upload_time": "2018-08-14T10:35:38", "url": "https://files.pythonhosted.org/packages/77/db/e01a451208e5a58e211be940d6e63c06ed3c434e26bf726af48f04835c97/bpl-api-0.1.0.tar.gz" } ] }