The Mineful Developer Hub

Welcome to the Mineful developer hub. You'll find comprehensive guides and documentation to help you start working with Mineful as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    

In order to activate the Miner, you will need to be issued with an Organisation License Key, by your Mineful account representative.

We will issue you a License so that you can test your integration of the Mineful Client Libraries. You'll need a Product License when you wish to roll out your mining application to more than a 100 workers. This will also enable you to get payments to your Publisher Wallet and receive Orders to the miner determines the most profitable currency to mine at any given time.

This is normally issued once your integration has been reviewed by the Mineful team, in relation to following the best practise UX guidelines.

We do this to ensure that Publishers do not fall into the traps of using this technology in a way that creates a negative experience for their users, for the concept of cryptocurrency mining as a form of value exchange.

Once your License Key has been issued, you can use it to initialise the Miner in your client application.

You can also check if your License Key is valid, using our API and a special Authorisation Key in the request header.

curl -X GET \
  https://developers.mineful.com/v1/license \
  -H 'Cache-Control: no-cache' \
  -H 'License-Authorization: <LICENSE_KEY>'

Which will return a response much like this...

    "organisation": "ACME Company",
    "status": "OK",
    "message": "Authorized"


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.