WalletApi.md

MinergateApi.WalletApi

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

Method	HTTP request	Description
getBalance	GET /balance	Balance
getTransfers	GET /transfers/{cc}	Transfers
getWithdrawals	GET /withdrawals/{cc}	Withdrawals by Blockchain

getBalance

Object getBalance()

Balance

Returns the user’s balance. Requires authorization.

Example

var MinergateApi = require('minergate_api');
var defaultClient = MinergateApi.ApiClient.default;

// 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';

var apiInstance = new MinergateApi.WalletApi();

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

Parameters

This endpoint does not need any parameter.

Return type

Object

Authorization

token

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getTransfers

getTransfers(cc)

Transfers

Returns the list of user’s transfers. Requires authorization.

Example

var MinergateApi = require('minergate_api');
var defaultClient = MinergateApi.ApiClient.default;

// 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';

var apiInstance = new MinergateApi.WalletApi();

var cc = "cc_example"; // String | Shorthand name for crypto currency. e.g. Bitcoin = btc 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.getTransfers(cc, callback);

Parameters

Name	Type	Description	Notes
cc	String	Shorthand name for crypto currency. e.g. Bitcoin = btc

Return type

null (empty response body)

Authorization

token

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getWithdrawals

getWithdrawals(cc)

Withdrawals by Blockchain

Returns the list of user’s withdrawals for all the currencies or a specific currency if such parameter is set. Requires authorization.

Example

var MinergateApi = require('minergate_api');
var defaultClient = MinergateApi.ApiClient.default;

// 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';

var apiInstance = new MinergateApi.WalletApi();

var cc = "cc_example"; // String | Shorthand name for crypto currency. e.g. Bitcoin = btc 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.getWithdrawals(cc, callback);

Parameters

Name	Type	Description	Notes
cc	String	Shorthand name for crypto currency. e.g. Bitcoin = btc

Return type

null (empty response body)

Authorization

token

HTTP request headers

• Content-Type: Not defined
• Accept: application/json