Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stylesuxx/python-ethermine
Python ethermine API wrapper.
https://github.com/stylesuxx/python-ethermine
Last synced: about 1 month ago
JSON representation
Python ethermine API wrapper.
- Host: GitHub
- URL: https://github.com/stylesuxx/python-ethermine
- Owner: stylesuxx
- License: mit
- Created: 2021-01-04T15:49:22.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2021-01-04T16:51:41.000Z (almost 4 years ago)
- Last Synced: 2024-08-09T07:45:48.441Z (3 months ago)
- Language: Python
- Size: 5.86 KB
- Stars: 4
- Watchers: 4
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Python API wrapper for ehermine.org
[](https://travis-ci.org/stylesuxx/python-ethermine)
> Access Etherium related mining data in the [Ethermine mining pool](https://ethermine.org).
All publicly [available Ethermine API endpoints](https://ethermine.org/api/pool) are wrapped. All endpoints return dicts containing the API data or **None** if response status code was not 200. Check the tests or API documentation to see all available fields.
## Installation
Install via PIP:
```bash
pip install ethermine
```
## Usage
```python
from ethermine import Ethermine
ethermine = Ethermine()
```
### Pool
#### /poolStats
```python
stats = ethermine.pool_stats()
```
#### /blocks/history
```python
history = ethermine.blocks_history()
```
#### /networkStats
```python
stats = ethermine.network_stats()
```
#### /server/history
```python
history = ethermine.server_history()
```
### Miner
#### /miner/:miner/dashboard
```python
dashboard = ethermine.miner_dashboard("address")
```
#### /miner/:miner/history
```python
history = ethermine.miner_history("address")
```
#### /miner/:miner/payouts
```python
payouts = ethermine.miner_payouts("address")
```
#### /miner/:miner/rounds
```python
rounds = ethermine.miner_rounds("address")
```
#### /miner/:miner/settings
```python
settings = ethermine.miner_settings("address")
```
#### /miner/:miner/currentStats
```python
stats = ethermine.miner_current_stats("address")
```
### Worker
#### /miner/:miner/workers
```python
workers = ethermine.miner_workers("address")
```
#### /miner/:miner/worker/:worker/history
```python
history = ethermine.miner_worker("address", "worker")
```
#### /miner/:miner/worker/:worker/currentStats
```python
stats = ethermine.miner_worker_current_stats("address", "worker")
```
#### /miner/:miner/worker/:worker/monitor
```python
monitors = ethermine.miner_worker_monitor("address", "worker")
```
## Development
PR's are welcome - especially should the API change. Please also add tests - the tests should always represent the current state of the API including all fields.
## Building Dist Package
To build a distributable package run:
```bash
python setup.py sdist
```