# Bolivarcoin/Bolicoin API (RPC)
### Node API Rpc main class for Bolivarcoin/Bolicoin
#### Para español vaya a [README en español](./README_ES.md)
___
_WARNING_: _This document and documentation is in development, and it will be available on next releases_
_WARNING_: _This is a BETA stable version, issues and pull request are very welcome_
____
This project is a first public beta version
of [Propuesta DAO a superbloque 764,336 para desarrollo API y APPs periféricas alrededor del núcleo](https://bit.ly/Superbloque764336)
This API is a first layer to communicate with Bolivarcoin/Bolicoin blockchain using a common node or masternode with user
credentials.
On top of this API, developers can build Apps, frontends, bots, remote wallets, notifiers, transactions, monitoring, etc.
_____
## Bolivarcoin Blockchain Compatibility
**Bolivarcoin version**: 2000002 (v2.0.0.2-g)
**Protocol version**: 70212
You can to verify version using _getinfo_ command on node console.
Example:
> getinfo
```json
{
"version": 2000002,
"protocolversion": 70212,
"walletversion": 120200,
"balance": 15658.49718641,
"privatesend_balance": 0.00000000,
"blocks": 1234567,
"timeoffset": 0,
"connections": 8,
"proxy": "",
"difficulty": 12345678.901234,
"testnet": false,
"keypoololdest": 1440858873,
"keypoolsize": 1999,
"paytxfee": 0.00000000,
"relayfee": 0.00001000,
"errors": ""
}
```
_____
## Installation
From PyPi:
pip install boli_orbital_api
From source code:
git clone https://github.com/Visionario/BoliOrbitalAPI
_____
## Usage
Basic use:
Communicate with your local node, it must be running on same pc
```python
from boli_orbital_api import Node
node = Node(rpc_user="user", rpc_password="password")
node.is_online
# True
node.getinfo()
# {'result': {'version': 2000002, 'protocolversion': 70212, 'walletversion': 120200, 'balance': 15658.49718641, 'privatesend_balance': 0.0, 'blocks': 1234567, 'timeoffset': 0, 'connections': 8, 'proxy': '', 'difficulty': 36237.78062774216, 'testnet': False, 'keypoololdest': 1440858873, 'keypoolsize': 1999, 'paytxfee': 0.0, 'relayfee': 1e-05, 'errors': ''}, 'errors': False}
```
```json
{
"result": {
"version": 2000002,
"protocolversion": 70212,
"walletversion": 120200,
"balance": 15658.49718641,
"privatesend_balance": 0.00000000,
"blocks": 1234567,
"timeoffset": 0,
"connections": 8,
"proxy": "",
"difficulty": 12345678.901234,
"testnet": false,
"keypoololdest": 1440858873,
"keypoolsize": 1999,
"paytxfee": 0.00000000,
"relayfee": 0.00001000,
"errors": ""
},
"errors": false
}
```
Orbital API sends a json with {"result":..., "errors":...}
Please take a look to [docs](./docs/using.md) for details.
____
Raw data
{
"_id": null,
"home_page": "https://orbital.center",
"name": "boli-orbital-api",
"maintainer": "Asdrubal Velasquez Lagrave",
"docs_url": null,
"requires_python": ">=3.10,<4.0",
"maintainer_email": "hello@orbital.center",
"keywords": "bolicoin,bolivarcoin,criptocurrency,blockchain,api",
"author": "Asdrubal Velasquez Lagrave",
"author_email": "hello@orbital.center",
"download_url": "https://files.pythonhosted.org/packages/08/b8/71bc39fa261472e7898411a94ee756c5b39ad5aae89e63d2250ebf3d39aa/boli_orbital_api-0.9b17.tar.gz",
"platform": null,
"description": "# Bolivarcoin/Bolicoin API (RPC)\n\n### Node API Rpc main class for Bolivarcoin/Bolicoin\n\n#### Para espa\u00f1ol vaya a [README en espa\u00f1ol](./README_ES.md)\n\n___\n_WARNING_: _This document and documentation is in development, and it will be available on next releases_\n\n_WARNING_: _This is a BETA stable version, issues and pull request are very welcome_\n____\nThis project is a first public beta version\nof [Propuesta DAO a superbloque 764,336 para desarrollo API y APPs perif\u00e9ricas alrededor del n\u00facleo](https://bit.ly/Superbloque764336)\n\nThis API is a first layer to communicate with Bolivarcoin/Bolicoin blockchain using a common node or masternode with user\ncredentials.\n\nOn top of this API, developers can build Apps, frontends, bots, remote wallets, notifiers, transactions, monitoring, etc.\n\n_____\n\n## Bolivarcoin Blockchain Compatibility\n\n**Bolivarcoin version**: 2000002 (v2.0.0.2-g) \n**Protocol version**: 70212\n\nYou can to verify version using _getinfo_ command on node console.\nExample:\n> getinfo\n\n```json\n{\n \"version\": 2000002,\n \"protocolversion\": 70212,\n \"walletversion\": 120200,\n \"balance\": 15658.49718641,\n \"privatesend_balance\": 0.00000000,\n \"blocks\": 1234567,\n \"timeoffset\": 0,\n \"connections\": 8,\n \"proxy\": \"\",\n \"difficulty\": 12345678.901234,\n \"testnet\": false,\n \"keypoololdest\": 1440858873,\n \"keypoolsize\": 1999,\n \"paytxfee\": 0.00000000,\n \"relayfee\": 0.00001000,\n \"errors\": \"\"\n}\n```\n\n_____\n\n## Installation\n\nFrom PyPi:\npip install boli_orbital_api\n\nFrom source code:\ngit clone https://github.com/Visionario/BoliOrbitalAPI\n\n_____\n\n## Usage\n\nBasic use:\nCommunicate with your local node, it must be running on same pc\n\n```python\nfrom boli_orbital_api import Node\n\nnode = Node(rpc_user=\"user\", rpc_password=\"password\")\nnode.is_online\n# True\nnode.getinfo()\n# {'result': {'version': 2000002, 'protocolversion': 70212, 'walletversion': 120200, 'balance': 15658.49718641, 'privatesend_balance': 0.0, 'blocks': 1234567, 'timeoffset': 0, 'connections': 8, 'proxy': '', 'difficulty': 36237.78062774216, 'testnet': False, 'keypoololdest': 1440858873, 'keypoolsize': 1999, 'paytxfee': 0.0, 'relayfee': 1e-05, 'errors': ''}, 'errors': False}\n\n```\n\n```json\n{\n \"result\": {\n \"version\": 2000002,\n \"protocolversion\": 70212,\n \"walletversion\": 120200,\n \"balance\": 15658.49718641,\n \"privatesend_balance\": 0.00000000,\n \"blocks\": 1234567,\n \"timeoffset\": 0,\n \"connections\": 8,\n \"proxy\": \"\",\n \"difficulty\": 12345678.901234,\n \"testnet\": false,\n \"keypoololdest\": 1440858873,\n \"keypoolsize\": 1999,\n \"paytxfee\": 0.00000000,\n \"relayfee\": 0.00001000,\n \"errors\": \"\"\n },\n \"errors\": false\n}\n```\n\nOrbital API sends a json with {\"result\":..., \"errors\":...}\n\nPlease take a look to [docs](./docs/using.md) for details.\n____\n\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Orbital API RPC for Bolivarcoin/Bolicoin blockchain",
"version": "0.9b17",
"project_urls": {
"Homepage": "https://orbital.center",
"Repository": "https://github.com/Visionario/BoliOrbitalAPI"
},
"split_keywords": [
"bolicoin",
"bolivarcoin",
"criptocurrency",
"blockchain",
"api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "05b10eb82a409cb4e291898c2283141199b594229ecaa625c622a28a6bb40c8f",
"md5": "96ead93f9c87254077fc16528acfd868",
"sha256": "88215981c3a110dfbf21ac5fcf49d8e49fe4e1b4bd43d07587261150b4a1235c"
},
"downloads": -1,
"filename": "boli_orbital_api-0.9b17-py3-none-any.whl",
"has_sig": false,
"md5_digest": "96ead93f9c87254077fc16528acfd868",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10,<4.0",
"size": 27583,
"upload_time": "2023-06-23T20:11:38",
"upload_time_iso_8601": "2023-06-23T20:11:38.886184Z",
"url": "https://files.pythonhosted.org/packages/05/b1/0eb82a409cb4e291898c2283141199b594229ecaa625c622a28a6bb40c8f/boli_orbital_api-0.9b17-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "08b871bc39fa261472e7898411a94ee756c5b39ad5aae89e63d2250ebf3d39aa",
"md5": "7870989656cd9645e992017f8e81abe5",
"sha256": "7985191019ca78285f7c3e0abf9579eb607a054906377c307d3cb009d3f22a57"
},
"downloads": -1,
"filename": "boli_orbital_api-0.9b17.tar.gz",
"has_sig": false,
"md5_digest": "7870989656cd9645e992017f8e81abe5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10,<4.0",
"size": 25621,
"upload_time": "2023-06-23T20:11:40",
"upload_time_iso_8601": "2023-06-23T20:11:40.336357Z",
"url": "https://files.pythonhosted.org/packages/08/b8/71bc39fa261472e7898411a94ee756c5b39ad5aae89e63d2250ebf3d39aa/boli_orbital_api-0.9b17.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-23 20:11:40",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Visionario",
"github_project": "BoliOrbitalAPI",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "boli-orbital-api"
}
JSON
