EstuaryClient.PublicApi

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

Method	HTTP request	Description
getCidGet	GET /get/{cid}	Get Full Content by Cid
publicByCidCidGet	GET /public/by-cid/{cid}	Get Content by Cid
publicInfoGet	GET /public/info	Get public node info
publicMetricsDealsOnChainGet	GET /public/metrics/deals-on-chain	Get deal metrics
publicMinersDealsMinerGet	GET /public/miners/deals/{miner}	Get all miners deals
publicMinersFailuresMinerGet	GET /public/miners/failures/{miner}	Get all miners
publicMinersGet	GET /public/miners	Get all miners
publicMinersStatsMinerGet	GET /public/miners/stats/{miner}	Get miner stats
publicNetAddrsGet	GET /public/net/addrs	Net Addrs
publicNetPeersGet	GET /public/net/peers	Net Peers
publicStatsGet	GET /public/stats	Public stats

getCidGet

getCidGet(cid)

Get Full Content by Cid

This endpoint returns the content associated with a CID

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.PublicApi();
let cid = "cid_example"; // String | Cid

apiInstance.getCidGet(cid, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});

Parameters

Name	Type	Description	Notes
cid	String	Cid

Return type

null (empty response body)

Authorization

bearerAuth

HTTP request headers

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

publicByCidCidGet

'String' publicByCidCidGet(cid)

Get Content by Cid

This endpoint returns the content record associated with a CID

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.PublicApi();
let cid = "cid_example"; // String | Cid

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

Parameters

Name	Type	Description	Notes
cid	String	Cid

Return type

'String'

Authorization

bearerAuth

HTTP request headers

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

publicInfoGet

'String' publicInfoGet()

Get public node info

This endpoint returns information about the node

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.PublicApi();
apiInstance.publicInfoGet((error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

This endpoint does not need any parameter.

Return type

'String'

Authorization

bearerAuth

HTTP request headers

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

publicMetricsDealsOnChainGet

'String' publicMetricsDealsOnChainGet()

Get deal metrics

This endpoint is used to get deal metrics

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.PublicApi();
apiInstance.publicMetricsDealsOnChainGet((error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

This endpoint does not need any parameter.

Return type

'String'

Authorization

bearerAuth

HTTP request headers

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

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

publicMinersFailuresMinerGet

'String' publicMinersFailuresMinerGet(miner)

Get all miners

This endpoint returns all miners

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.PublicApi();
let miner = "miner_example"; // String | Filter by miner

apiInstance.publicMinersFailuresMinerGet(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

publicMinersGet

'String' publicMinersGet()

Get all miners

This endpoint returns all miners

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.PublicApi();
apiInstance.publicMinersGet((error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

This endpoint does not need any parameter.

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

publicNetAddrsGet

['String'] publicNetAddrsGet()

Net Addrs

This endpoint is used to get net addrs

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.PublicApi();
apiInstance.publicNetAddrsGet((error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

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

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.PublicApi();
apiInstance.publicNetPeersGet((error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

This endpoint does not need any parameter.

Return type

['String']

Authorization

bearerAuth

HTTP request headers

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

publicStatsGet

'String' publicStatsGet()

Public stats

This endpoint is used to get public 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.PublicApi();
apiInstance.publicStatsGet((error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

This endpoint does not need any parameter.

Return type

'String'

Authorization

bearerAuth

HTTP request headers

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