Skip to content

4iar/nicehash-api-cpp

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

43 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Nicehash API wrapper (C++)

License: MIT Build Status Docs

A C++ API wrapper for the NiceHash cloud cryptomining service.

Requirements

  • cURL libs (e.g. Fedora: libcurl-devel, Ubuntu/Debian: libcurl-dev)

  • CMake >= 3.1

Setup

See example CMakeLists.txt in the examples/ folder that uses ExternalProject to integrate nicehash-api-cpp with an existing CMake project.

Alternatively, manually build the library as below, then link libnicehash-api-cpp.so.

git clone https://github.com/4iar/nicehash-api-cpp.git && cd nicehash-api-cpp
mkdir build && cd build
cmake ..
make

Offline documentation can be built using doxygen

make doc

Usage

#include <nicehash-api.hpp>

...

    // Initialise client
    NiceHashApi niceHashApi;

    // Run a query
    // (see docs below for all API functions)
    std::string algorithm_name = "equihash";
    std::string stats = niceHashApi.getOrdersByAlgorithm(algorithm_name, 0)

API

Official documentation @ NiceHash.com

Public

niceHashApi.getApiVersion()

Global

stats.global.current

Get current profitability (price) and hashing speed for all algorithms. Refreshed every 30 seconds.

niceHashApi.getAverageGlobalStats()

stats.global.24h

Get average profitability (price) and hashing speed for all algorithms in past 24 hours.

niceHashApi.getCurrentGlobalStats()

Provider

stats.provider

Get current stats for provider for all algorithms. Refreshed every 30 seconds. It also returns past 56 payments.

niceHashApi.getProviderStats (std::string address)

stats.provider.ex

Get detailed stats for provider for all algorithms including history data and past 56 payments.

niceHashApi.getDetailedProviderStats (std::string address)

stats.provider.workers

Get detailed stats for provider's workers (rigs).

niceHashApi.getProviderWorkerStats (std::string address, int algorithm_id)

or

niceHashApi.getProviderWorkerStats (std::string address, std::string algorithm_name)

Orders

orders.get

Get all orders for certain algorithm. Refreshed every 30 seconds.

niceHashApi.getOrdersByAlgorithm (int algorithm_id, int location_id)

or

niceHashApi.getOrdersByAlgorithm (std::string algorithm_name, int location_id)

Algorithms

multialgo.info

Get information about Multi-Algorithm Mining.

simplemultialgo.info

Get information about Simple Multi-Algorithm Mining.

Private

orders.get&my
orders.create
orders.refill
orders.remove
orders.set.price
orders.set.price.decrease
orders.set.limit
balance

About

NiceHash API wrapper for C++

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published