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(ctx, cid) Get Content by Cid

This endpoint returns the content associated with a CID

Required Parameters

NameTypeDescriptionNotes
ctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.
cidstringCid

Return type

(empty response body)

Authorization

bearerAuth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PublicInfoGet

PublicInfoGet(ctx, ) Get public node info

This endpoint returns information about the node

Required Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

bearerAuth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PublicMetricsDealsOnChainGet

PublicMetricsDealsOnChainGet(ctx, ) Get deal metrics

This endpoint is used to get deal metrics

Required Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

bearerAuth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PublicMinersDealsMinerGet

PublicMinersDealsMinerGet(ctx, miner, optional) Get all miners deals

This endpoint returns all miners deals

Required Parameters

NameTypeDescriptionNotes
ctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.
minerstringFilter by miner
optional*PublicApiPublicMinersDealsMinerGetOptsoptional parametersnil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a PublicApiPublicMinersDealsMinerGetOpts struct

NameTypeDescriptionNotes

ignoreFailed | optional.String| Ignore Failed |

Return type

(empty response body)

Authorization

bearerAuth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PublicMinersFailuresMinerGet

PublicMinersFailuresMinerGet(ctx, miner) Get all miners

This endpoint returns all miners

Required Parameters

NameTypeDescriptionNotes
ctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.
minerstringFilter by miner

Return type

(empty response body)

Authorization

bearerAuth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PublicMinersGet

PublicMinersGet(ctx, ) Get all miners

This endpoint returns all miners

Required Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

bearerAuth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PublicMinersStatsMinerGet

PublicMinersStatsMinerGet(ctx, miner) Get miner stats

This endpoint returns miner stats

Required Parameters

NameTypeDescriptionNotes
ctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.
minerstringFilter by miner

Return type

(empty response body)

Authorization

bearerAuth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PublicNetAddrsGet

[]string PublicNetAddrsGet(ctx, ) Net Addrs

This endpoint is used to get net addrs

Required Parameters

This endpoint does not need any parameter.

Return type

[]string

Authorization

bearerAuth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PublicNetPeersGet

[]string PublicNetPeersGet(ctx, ) Net Peers

This endpoint is used to get net peers

Required Parameters

This endpoint does not need any parameter.

Return type

[]string

Authorization

bearerAuth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PublicStatsGet

PublicStatsGet(ctx, ) Public stats

This endpoint is used to get public stats.

Required Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

bearerAuth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]