estuary_client.NetApi

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

Method	HTTP request	Description
admin_miners_get	GET /admin/miners/	Get all miners
public_miners_failures_miner_get	GET /public/miners/failures/{miner}	Get all miners
public_net_addrs_get	GET /public/net/addrs	Net Addrs
public_net_peers_get	GET /public/net/peers	Net Peers

admin_miners_get

ApiMinerResp admin_miners_get()

Get all miners

This endpoint returns all miners. Note: value may be cached

Example

from __future__ import print_function
import time
import estuary_client
from estuary_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: bearerAuth
configuration = estuary_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = estuary_client.NetApi(estuary_client.ApiClient(configuration))

try:
    # Get all miners
    api_response = api_instance.admin_miners_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling NetApi->admin_miners_get: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

ApiMinerResp

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]

public_miners_failures_miner_get

str public_miners_failures_miner_get(miner)

Get all miners

This endpoint returns all miners

Example

from __future__ import print_function
import time
import estuary_client
from estuary_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: bearerAuth
configuration = estuary_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = estuary_client.NetApi(estuary_client.ApiClient(configuration))
miner = 'miner_example' # str | Filter by miner

try:
    # Get all miners
    api_response = api_instance.public_miners_failures_miner_get(miner)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling NetApi->public_miners_failures_miner_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
miner	str	Filter by miner

Return type

str

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]

public_net_addrs_get

list[str] public_net_addrs_get()

Net Addrs

This endpoint is used to get net addrs

Example

from __future__ import print_function
import time
import estuary_client
from estuary_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: bearerAuth
configuration = estuary_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = estuary_client.NetApi(estuary_client.ApiClient(configuration))

try:
    # Net Addrs
    api_response = api_instance.public_net_addrs_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling NetApi->public_net_addrs_get: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

list[str]

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]

public_net_peers_get

list[str] public_net_peers_get()

Net Peers

This endpoint is used to get net peers

Example

from __future__ import print_function
import time
import estuary_client
from estuary_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: bearerAuth
configuration = estuary_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = estuary_client.NetApi(estuary_client.ApiClient(configuration))

try:
    # Net Peers
    api_response = api_instance.public_net_peers_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling NetApi->public_net_peers_get: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

list[str]

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]