Skip to content

PhearNet/minergate-javascript

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

minergate_api

MinergateApi - JavaScript client for minergate_api MinerGate is a mining pool created by a group of cryptocoin enthusiasts. It is the first pool which provides service for merged mining. This means that while mining on our pool you can mine different coins simultaniously without decrease of hashrate for major coin. If you are interested in cooperation drop a message to janikakouki@minergate.com. | Currency Name | Currency Code (cc) | | --- | --- | | Bitcoin | btc | | Litecoin | ltc | | Bytecoin | bcn | | Monero | xmr | | FantomCoin | fcn | | QuazarCoin | qcn | | DigitalNote | xdn | | MonetaVerde | mcn | | Dashcoin | dsh | | Aeon coin | aeon | | Infinium-8 | inf8 | This SDK is automatically generated by the Swagger Codegen project:

  • API version: 1.0
  • Package version: 1.0
  • Build package: io.swagger.codegen.languages.JavascriptClientCodegen

Installation

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install minergate_api --save

git

If the library is hosted at a git repository, e.g. https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Getting Started

Please follow the installation instruction and execute the following JS code:

var MinergateApi = require('minergate_api');

var defaultClient = MinergateApi.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['token'] = "Token"

var api = new MinergateApi.AffiliatesApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAffiliateChildren(callback);

Documentation for API Endpoints

All URIs are relative to https://api.minergate.com/1.0

Class Method HTTP request Description
MinergateApi.AffiliatesApi getAffiliateChildren GET /affiliate/childrens Affiliate Childrens
MinergateApi.AffiliatesApi getAffiliateLinks GET /affiliate/links Affiliate Links
MinergateApi.AffiliatesApi getAffiliateProfit GET /affiliate/profit Affiliate Profit
MinergateApi.MiningApi getWorkers GET /workers Workers
MinergateApi.MiningApi miningStats GET /mining/stats Mining Stats
MinergateApi.PaymentsApi getInvoiceById GET /invoices/{INVOICE_ID} Invoices by Id
MinergateApi.PaymentsApi getInvoices GET /invoices Invoices
MinergateApi.ProfileApi getProfileNickname GET /profile/nickname Profile Nickname
MinergateApi.PublicApi getBlockchainStatus GET /{cc}/status Blockchain Status
MinergateApi.PublicApi getPoolProfitRating GET /pool/profit-rating Pool Profit-Rating
MinergateApi.PublicApi getPoolTopHashrate GET /pool/top/hashrate Pool Top Hashrate
MinergateApi.WalletApi getBalance GET /balance Balance
MinergateApi.WalletApi getTransfers GET /transfers/{cc} Transfers
MinergateApi.WalletApi getWithdrawals GET /withdrawals/{cc} Withdrawals by Blockchain

Documentation for Models

Documentation for Authorization

token

  • Type: API key
  • API key parameter name: token
  • Location: HTTP header

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published