EstuaryClient.MinerApi

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

Method	HTTP request	Description
publicMinersDealsMinerGet	GET /public/miners/deals/{miner}	Get all miners deals
publicMinersStatsMinerGet	GET /public/miners/stats/{miner}	Get miner stats

publicMinersDealsMinerGet

'String' publicMinersDealsMinerGet(miner, opts)

Get all miners deals

This endpoint returns all miners deals

Example

import {EstuaryClient} from 'estuary-client';
let defaultClient = EstuaryClient.ApiClient.instance;

// Configure API key authorization: bearerAuth
let 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';

let apiInstance = new EstuaryClient.MinerApi();
let miner = "miner_example"; // String | Filter by miner
let opts = { 
  'ignoreFailed': "ignoreFailed_example" // String | Ignore Failed
};
apiInstance.publicMinersDealsMinerGet(miner, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description	Notes
miner	String	Filter by miner
ignoreFailed	String	Ignore Failed	[optional]

Return type

'String'

Authorization

bearerAuth

HTTP request headers

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

publicMinersStatsMinerGet

'String' publicMinersStatsMinerGet(miner)

Get miner stats

This endpoint returns miner stats

Example

import {EstuaryClient} from 'estuary-client';
let defaultClient = EstuaryClient.ApiClient.instance;

// Configure API key authorization: bearerAuth
let 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';

let apiInstance = new EstuaryClient.MinerApi();
let miner = "miner_example"; // String | Filter by miner

apiInstance.publicMinersStatsMinerGet(miner, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description	Notes
miner	String	Filter by miner

Return type

'String'

Authorization

bearerAuth

HTTP request headers

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