Skip to main content

🐍 Pythonic wrapper for Flexpool API v2

Project description

py-flexpoolapi-v2

PyPI Latest Release

Structured Python wrapper for Flexpool.io API v2.

Installation

Install py-flexpoolapi-v2.

Using pip

pip3 install flexpoolapi-v2

Build from source

git clone https://github.com/nekusu/py-flexpoolapi-v2.git
cd py-flexpoolapi-v2
pip3 install -r requirements.txt
sudo make install  # or `sudo python3 setup.py install`

Usage

Quick example:

>>> import flexpoolapi
>>> from flexpoolapi.utils import *

# Coins
>>> coins = flexpoolapi.poolapi.coins()
>>> coins[0].name
'Ethereum'
>>> coins[1].name
'Chia'

# ETH Pool
>>> eth_pool = flexpoolapi.pool("eth")
>>> format_hashrate(eth_pool.hashrate().total, "eth")
'11.2 TH/s'
>>> eth_pool.miner_count()
20600
>>> eth_pool.worker_count()
50987

# XCH Pool
>>> xch_pool = flexpoolapi.pool("xch")
>>> format_hashrate(xch_pool.hashrate().total, "xch")
'207.9 PB'
>>> xch_pool.miner_count()
3530
>>> xch_pool.worker_count()
4933

# ETH Miner
>>> eth_miner = flexpoolapi.miner("eth", eth_pool.top_miners()[0].address)
>>> format_decimals(eth_miner.balance().balance, "eth")
'1.01524 ETH'
>>> format_hashrate(eth_miner.stats().current_effective_hashrate, "eth")
'1.6 TH/s'

# XCH Miner
>>> xch_miner = flexpoolapi.miner("xch", xch_pool.top_miners()[0].address)
>>> format_decimals(xch_miner.balance().balance, "xch")
'0.1692 XCH'
>>> format_hashrate(xch_miner.stats().current_effective_hashrate, "xch")
'2.3 PB'

# Locate Address
>>> flexpoolapi.minerapi.locate_address(eth_pool.top_miners()[0].address)
'eth'

For better understanding, I recommend reading the Flexpool APIv2 documentation. All variables/functions names were renamed from camelCase to snake_case.

Undocumented endpoints added

Miner API

  • /miner/details (GET)
  • /miner/payoutSettings (POST)
  • /miner/notificationSettings (POST)

License

MIT - Copyright (c) 2020 Flexpool

Project details


Download files

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

Source Distribution

flexpoolapi-v2-2.2.4.post7.tar.gz (10.3 kB view hashes)

Uploaded Source

Built Distribution

flexpoolapi_v2-2.2.4.post7-py3-none-any.whl (14.8 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page