Skip to main content

PublicApi

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

MethodHTTP requestDescription
publicByCidCidGetGET /public/by-cid/{cid}Get Content by Cid
publicInfoGetGET /public/infoGet public node info
publicMetricsDealsOnChainGetGET /public/metrics/deals-on-chainGet deal metrics
publicMinersDealsMinerGetGET /public/miners/deals/{miner}Get all miners deals
publicMinersFailuresMinerGetGET /public/miners/failures/{miner}Get all miners
publicMinersGetGET /public/minersGet all miners
publicMinersStatsMinerGetGET /public/miners/stats/{miner}Get miner stats
publicNetAddrsGetGET /public/net/addrsNet Addrs
publicNetPeersGetGET /public/net/peersNet Peers
publicStatsGetGET /public/statsPublic stats
# **publicByCidCidGet** > publicByCidCidGet(cid)

Get Content by Cid

This endpoint returns the content associated with a CID

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.PublicApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: bearerAuth
ApiKeyAuth bearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("bearerAuth");
bearerAuth.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.setApiKeyPrefix("Token");

PublicApi apiInstance = new PublicApi();
String cid = "cid_example"; // String | Cid
try {
apiInstance.publicByCidCidGet(cid);
} catch (ApiException e) {
System.err.println("Exception when calling PublicApi#publicByCidCidGet");
e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
cidStringCid

Return type

null (empty response body)

Authorization

bearerAuth

HTTP request headers

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

Get public node info

This endpoint returns information about the node

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.PublicApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: bearerAuth
ApiKeyAuth bearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("bearerAuth");
bearerAuth.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.setApiKeyPrefix("Token");

PublicApi apiInstance = new PublicApi();
try {
apiInstance.publicInfoGet();
} catch (ApiException e) {
System.err.println("Exception when calling PublicApi#publicInfoGet");
e.printStackTrace();
}

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
# **publicMetricsDealsOnChainGet** > publicMetricsDealsOnChainGet()

Get deal metrics

This endpoint is used to get deal metrics

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.PublicApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: bearerAuth
ApiKeyAuth bearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("bearerAuth");
bearerAuth.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.setApiKeyPrefix("Token");

PublicApi apiInstance = new PublicApi();
try {
apiInstance.publicMetricsDealsOnChainGet();
} catch (ApiException e) {
System.err.println("Exception when calling PublicApi#publicMetricsDealsOnChainGet");
e.printStackTrace();
}

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
# **publicMinersDealsMinerGet** > publicMinersDealsMinerGet(miner, ignoreFailed)

Get all miners deals

This endpoint returns all miners deals

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.PublicApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: bearerAuth
ApiKeyAuth bearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("bearerAuth");
bearerAuth.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.setApiKeyPrefix("Token");

PublicApi apiInstance = new PublicApi();
String miner = "miner_example"; // String | Filter by miner
String ignoreFailed = "ignoreFailed_example"; // String | Ignore Failed
try {
apiInstance.publicMinersDealsMinerGet(miner, ignoreFailed);
} catch (ApiException e) {
System.err.println("Exception when calling PublicApi#publicMinersDealsMinerGet");
e.printStackTrace();
}

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
# **publicMinersFailuresMinerGet** > publicMinersFailuresMinerGet(miner)

Get all miners

This endpoint returns all miners

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.PublicApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: bearerAuth
ApiKeyAuth bearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("bearerAuth");
bearerAuth.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.setApiKeyPrefix("Token");

PublicApi apiInstance = new PublicApi();
String miner = "miner_example"; // String | Filter by miner
try {
apiInstance.publicMinersFailuresMinerGet(miner);
} catch (ApiException e) {
System.err.println("Exception when calling PublicApi#publicMinersFailuresMinerGet");
e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
minerStringFilter 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

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.PublicApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: bearerAuth
ApiKeyAuth bearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("bearerAuth");
bearerAuth.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.setApiKeyPrefix("Token");

PublicApi apiInstance = new PublicApi();
try {
apiInstance.publicMinersGet();
} catch (ApiException e) {
System.err.println("Exception when calling PublicApi#publicMinersGet");
e.printStackTrace();
}

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
# **publicMinersStatsMinerGet** > publicMinersStatsMinerGet(miner)

Get miner stats

This endpoint returns miner stats

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.PublicApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: bearerAuth
ApiKeyAuth bearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("bearerAuth");
bearerAuth.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.setApiKeyPrefix("Token");

PublicApi apiInstance = new PublicApi();
String miner = "miner_example"; // String | Filter by miner
try {
apiInstance.publicMinersStatsMinerGet(miner);
} catch (ApiException e) {
System.err.println("Exception when calling PublicApi#publicMinersStatsMinerGet");
e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
minerStringFilter by miner

Return type

null (empty response body)

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json
# **publicNetAddrsGet** > List<String> publicNetAddrsGet()

Net Addrs

This endpoint is used to get net addrs

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.PublicApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: bearerAuth
ApiKeyAuth bearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("bearerAuth");
bearerAuth.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.setApiKeyPrefix("Token");

PublicApi apiInstance = new PublicApi();
try {
List<String> result = apiInstance.publicNetAddrsGet();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling PublicApi#publicNetAddrsGet");
e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

List<String>

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json
# **publicNetPeersGet** > List<String> publicNetPeersGet()

Net Peers

This endpoint is used to get net peers

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.PublicApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: bearerAuth
ApiKeyAuth bearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("bearerAuth");
bearerAuth.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.setApiKeyPrefix("Token");

PublicApi apiInstance = new PublicApi();
try {
List<String> result = apiInstance.publicNetPeersGet();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling PublicApi#publicNetPeersGet");
e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

List<String>

Authorization

bearerAuth

HTTP request headers

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

Public stats

This endpoint is used to get public stats.

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.PublicApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: bearerAuth
ApiKeyAuth bearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("bearerAuth");
bearerAuth.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.setApiKeyPrefix("Token");

PublicApi apiInstance = new PublicApi();
try {
apiInstance.publicStatsGet();
} catch (ApiException e) {
System.err.println("Exception when calling PublicApi#publicStatsGet");
e.printStackTrace();
}

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