Skip to main content

EstuaryClient.MinerApi

All URIs are relative to https://api.estuary.tech

MethodHTTP requestDescription
publicMinersDealsMinerGetGET /public/miners/deals/{miner}Get all miners deals
publicMinersStatsMinerGetGET /public/miners/stats/{miner}Get miner stats
# **publicMinersDealsMinerGet** > publicMinersDealsMinerGet(miner, opts)

Get all miners deals

This endpoint returns all miners deals

Example

var EstuaryClient = require('estuary-client');
var defaultClient = EstuaryClient.ApiClient.instance;

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

var apiInstance = new EstuaryClient.MinerApi();

var miner = "miner_example"; // String | Filter by miner

var opts = {
'ignoreFailed': "ignoreFailed_example" // String | Ignore Failed
};

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

Parameters

NameTypeDescriptionNotes
minerStringFilter by miner
ignoreFailedStringIgnore Failed[optional]

Return type

null (empty response body)

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json
# **publicMinersStatsMinerGet** > publicMinersStatsMinerGet(miner)

Get miner stats

This endpoint returns miner stats

Example

var EstuaryClient = require('estuary-client');
var defaultClient = EstuaryClient.ApiClient.instance;

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

var apiInstance = new EstuaryClient.MinerApi();

var miner = "miner_example"; // String | Filter by miner


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

Parameters

NameTypeDescriptionNotes
minerStringFilter by miner

Return type

null (empty response body)

Authorization

bearerAuth

HTTP request headers

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