npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

miningrigrentals-api

v1.0.3

Published

Node JS Module interface with the Mining Rig Rentals API easily

Downloads

17

Readme

miningrigrentals-api

miningrigrentals-api is a simple, easy to use way to interface with the API provided by Mining Rig Rentals.

Installation

Install using npm install miningrigrentals-api --save

Sample Usage Code

Before we begin, you will need to initialize the module by using the code provided below. Be sure to swap out api-key and api-secret for your own created in your account.

var MiningRigRentalsAPI = require('miningrigrentals-api');

var MRRAPI = new MiningRigRentalsAPI('api-key', 'api-secret');

Rig List

List all rigs available, pass in any arguments supported by API

MRRAPI.listRigs({ type: 'scrypt' }, function(error, response){
	if (error){
		console.log(error);
		return;
	}
	console.log(response);
});

Rig Detail

Get more details about a specific rig

MRRAPI.getRigDetail(1234, function(error, response){
	if (error){
		console.log(error);
		return;
	}
	console.log(response);
});

List "My Rigs"

List all the rigs you own.

MRRAPI.listMyRigs(function(error, response){
	if (error){
		console.log(error);
		return;
	}
	console.log(response);
});

List "My Rentals"

List all of your current rentals.

MRRAPI.listMyRentals(function(error, response){
	if (error){
		console.log(error);
		return;
	}
	console.log(response);
});

Get Rental Details

Get more details about a rental.

MRRAPI.getRentalDetails(1234, function(error, response){
	if (error){
		console.log(error);
		return;
	}
	console.log(response);
});

Update Rig

Update a rig that is attached to your account

var args = {
	id: 1234,
	name: 'New Name'
}
MRRAPI.updateRig(args, function(error, response){
	if (error){
		console.log(error);
		return;
	}
	console.log(response);
});

Rent Rig

Rents a rig using the provided details.

var args = {
	id: 1234,
	length: 24, // In hours
	profileid: 4321
}
MRRAPI.rentRig(args, function(error, response){
	if (error){
		console.log(error);
		return;
	}
	console.log(response);
});

Get Balance

Get your accounts balance.

MRRAPI.getBalance(function(error, response){
	if (error){
		console.log(error);
		return;
	}
	console.log(response);
});

List Pools

List the pools attached to your account.

MRRAPI.listFavoritePools(function(error, response){
	if (error){
		console.log(error);
		return;
	}
	console.log(response);
});

List Profiles

List the profiles currently on your account.

MRRAPI.listProfiles(function(error, response){
	if (error){
		console.log(error);
		return;
	}
	console.log(response);
});

More Info

You can view the API docs for Mining Rig Rentals here: https://www.miningrigrentals.com/apidoc