Skip to main content

SwaggerClient::PublicApi

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

MethodHTTP requestDescription
get_cid_getGET /get/{cid}Get Full Content by Cid
public_by_cid_cid_getGET /public/by-cid/{cid}Get Content by Cid
public_info_getGET /public/infoGet public node info
public_metrics_deals_on_chain_getGET /public/metrics/deals-on-chainGet deal metrics
public_miners_deals_miner_getGET /public/miners/deals/{miner}Get all miners deals
public_miners_failures_miner_getGET /public/miners/failures/{miner}Get all miners
public_miners_getGET /public/minersGet all miners
public_miners_stats_miner_getGET /public/miners/stats/{miner}Get miner stats
public_net_addrs_getGET /public/net/addrsNet Addrs
public_net_peers_getGET /public/net/peersNet Peers
public_stats_getGET /public/statsPublic stats

get_cid_get

get_cid_get(cid)

Get Full Content by Cid

This endpoint returns the content associated with a CID

Example

# load the gem
require 'swagger_client'
# setup authorization
SwaggerClient.configure do |config|
# Configure API key authorization: bearerAuth
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::PublicApi.new
cid = 'cid_example' # String | Cid


begin
#Get Full Content by Cid
api_instance.get_cid_get(cid)
rescue SwaggerClient::ApiError => e
puts "Exception when calling PublicApi->get_cid_get: #{e}"
end

Parameters

NameTypeDescriptionNotes
cidStringCid

Return type

nil (empty response body)

Authorization

bearerAuth

HTTP request headers

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

public_by_cid_cid_get

String public_by_cid_cid_get(cid)

Get Content by Cid

This endpoint returns the content record associated with a CID

Example

# load the gem
require 'swagger_client'
# setup authorization
SwaggerClient.configure do |config|
# Configure API key authorization: bearerAuth
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::PublicApi.new
cid = 'cid_example' # String | Cid


begin
#Get Content by Cid
result = api_instance.public_by_cid_cid_get(cid)
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling PublicApi->public_by_cid_cid_get: #{e}"
end

Parameters

NameTypeDescriptionNotes
cidStringCid

Return type

String

Authorization

bearerAuth

HTTP request headers

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

public_info_get

String public_info_get

Get public node info

This endpoint returns information about the node

Example

# load the gem
require 'swagger_client'
# setup authorization
SwaggerClient.configure do |config|
# Configure API key authorization: bearerAuth
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::PublicApi.new

begin
#Get public node info
result = api_instance.public_info_get
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling PublicApi->public_info_get: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return type

String

Authorization

bearerAuth

HTTP request headers

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

public_metrics_deals_on_chain_get

String public_metrics_deals_on_chain_get

Get deal metrics

This endpoint is used to get deal metrics

Example

# load the gem
require 'swagger_client'
# setup authorization
SwaggerClient.configure do |config|
# Configure API key authorization: bearerAuth
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::PublicApi.new

begin
#Get deal metrics
result = api_instance.public_metrics_deals_on_chain_get
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling PublicApi->public_metrics_deals_on_chain_get: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return type

String

Authorization

bearerAuth

HTTP request headers

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

public_miners_deals_miner_get

String public_miners_deals_miner_get(miner, opts)

Get all miners deals

This endpoint returns all miners deals

Example

# load the gem
require 'swagger_client'
# setup authorization
SwaggerClient.configure do |config|
# Configure API key authorization: bearerAuth
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::PublicApi.new
miner = 'miner_example' # String | Filter by miner
opts = {
ignore_failed: 'ignore_failed_example' # String | Ignore Failed
}

begin
#Get all miners deals
result = api_instance.public_miners_deals_miner_get(miner, opts)
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling PublicApi->public_miners_deals_miner_get: #{e}"
end

Parameters

NameTypeDescriptionNotes
minerStringFilter by miner
ignore_failedStringIgnore Failed[optional]

Return type

String

Authorization

bearerAuth

HTTP request headers

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

public_miners_failures_miner_get

String public_miners_failures_miner_get(miner)

Get all miners

This endpoint returns all miners

Example

# load the gem
require 'swagger_client'
# setup authorization
SwaggerClient.configure do |config|
# Configure API key authorization: bearerAuth
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::PublicApi.new
miner = 'miner_example' # String | Filter by miner


begin
#Get all miners
result = api_instance.public_miners_failures_miner_get(miner)
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling PublicApi->public_miners_failures_miner_get: #{e}"
end

Parameters

NameTypeDescriptionNotes
minerStringFilter by miner

Return type

String

Authorization

bearerAuth

HTTP request headers

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

public_miners_get

String public_miners_get

Get all miners

This endpoint returns all miners

Example

# load the gem
require 'swagger_client'
# setup authorization
SwaggerClient.configure do |config|
# Configure API key authorization: bearerAuth
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::PublicApi.new

begin
#Get all miners
result = api_instance.public_miners_get
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling PublicApi->public_miners_get: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return type

String

Authorization

bearerAuth

HTTP request headers

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

public_miners_stats_miner_get

String public_miners_stats_miner_get(miner)

Get miner stats

This endpoint returns miner stats

Example

# load the gem
require 'swagger_client'
# setup authorization
SwaggerClient.configure do |config|
# Configure API key authorization: bearerAuth
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::PublicApi.new
miner = 'miner_example' # String | Filter by miner


begin
#Get miner stats
result = api_instance.public_miners_stats_miner_get(miner)
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling PublicApi->public_miners_stats_miner_get: #{e}"
end

Parameters

NameTypeDescriptionNotes
minerStringFilter by miner

Return type

String

Authorization

bearerAuth

HTTP request headers

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

public_net_addrs_get

Array<String> public_net_addrs_get

Net Addrs

This endpoint is used to get net addrs

Example

# load the gem
require 'swagger_client'
# setup authorization
SwaggerClient.configure do |config|
# Configure API key authorization: bearerAuth
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::PublicApi.new

begin
#Net Addrs
result = api_instance.public_net_addrs_get
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling PublicApi->public_net_addrs_get: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return type

Array<String>

Authorization

bearerAuth

HTTP request headers

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

public_net_peers_get

Array<String> public_net_peers_get

Net Peers

This endpoint is used to get net peers

Example

# load the gem
require 'swagger_client'
# setup authorization
SwaggerClient.configure do |config|
# Configure API key authorization: bearerAuth
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::PublicApi.new

begin
#Net Peers
result = api_instance.public_net_peers_get
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling PublicApi->public_net_peers_get: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return type

Array<String>

Authorization

bearerAuth

HTTP request headers

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

public_stats_get

String public_stats_get

Public stats

This endpoint is used to get public stats.

Example

# load the gem
require 'swagger_client'
# setup authorization
SwaggerClient.configure do |config|
# Configure API key authorization: bearerAuth
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::PublicApi.new

begin
#Public stats
result = api_instance.public_stats_get
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling PublicApi->public_stats_get: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return type

String

Authorization

bearerAuth

HTTP request headers

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