EstuaryClient.NetApi

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

Method	HTTP request	Description
netAddrsGet	GET /net/addrs	Net Addrs
publicMinersFailuresMinerGet	GET /public/miners/failures/{miner}	Get all miners
publicMinersGet	GET /public/miners	Get all miners
publicNetAddrsGet	GET /public/net/addrs	Net Addrs
publicNetPeersGet	GET /public/net/peers	Net Peers

# **netAddrsGet** > ['String'] netAddrsGet()

Net Addrs

This endpoint is used to get net addrs

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.NetApi();

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

Parameters

This endpoint does not need any parameter.

Return type

['String']

Authorization

bearerAuth

HTTP request headers

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

# **publicMinersFailuresMinerGet** > publicMinersFailuresMinerGet(miner)

Get all miners

This endpoint returns all miners

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.NetApi();

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.publicMinersFailuresMinerGet(miner, callback);

Parameters

Name	Type	Description	Notes
miner	String	Filter by miner

Return type

null (empty response body)

Authorization

bearerAuth

HTTP request headers

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

# **publicMinersGet** > publicMinersGet()

Get all miners

This endpoint returns all miners

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.NetApi();

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

Parameters

This endpoint does not need any parameter.

Return type

null (empty response body)

Authorization

bearerAuth

HTTP request headers

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

# **publicNetAddrsGet** > ['String'] publicNetAddrsGet()

Net Addrs

This endpoint is used to get net addrs

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.NetApi();

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

Parameters

This endpoint does not need any parameter.

Return type

['String']

Authorization

bearerAuth

HTTP request headers

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

# **publicNetPeersGet** > ['String'] publicNetPeersGet()

Net Peers

This endpoint is used to get net peers

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.NetApi();

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

Parameters

This endpoint does not need any parameter.

Return type

['String']

Authorization

bearerAuth

HTTP request headers

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