Skip to main content

estuary-client

This is the API for the Estuary application.

This Python package is automatically generated by the Swagger Codegen project:

  • API version: 0.0.0
  • Package version: 1.0.3
  • Build package: io.swagger.codegen.v3.generators.python.PythonClientCodegen For more information, please visit https://docs.estuary.tech/feedback

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

If the python package is hosted on Github, you can install directly from Github

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import estuary_client 

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import estuary_client

Getting Started

Please follow the installation procedure and then run the following:

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.UserApi(estuary_client.ApiClient(configuration))

try:
# Get API keys for a user
api_response = api_instance.user_api_keys_get()
pprint(api_response)
except ApiException as e:
print("Exception when calling UserApi->user_api_keys_get: %s\n" % e)

# 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.UserApi(estuary_client.ApiClient(configuration))
key_or_hash = 'key_or_hash_example' # str | Key or Hash

try:
# Revoke a User API Key.
api_response = api_instance.user_api_keys_key_or_hash_delete(key_or_hash)
pprint(api_response)
except ApiException as e:
print("Exception when calling UserApi->user_api_keys_key_or_hash_delete: %s\n" % e)

# 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.UserApi(estuary_client.ApiClient(configuration))
expiry = 'expiry_example' # str | Expiration - Expiration - Valid time units are ns, us (or µs), ms, s, m, h. for example 300h (optional)
perms = 'perms_example' # str | Permissions -- currently unused (optional)

try:
# Create API keys for a user
api_response = api_instance.user_api_keys_post(expiry=expiry, perms=perms)
pprint(api_response)
except ApiException as e:
print("Exception when calling UserApi->user_api_keys_post: %s\n" % e)

# 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.UserApi(estuary_client.ApiClient(configuration))

try:
# Export user data
api_response = api_instance.user_export_get()
pprint(api_response)
except ApiException as e:
print("Exception when calling UserApi->user_export_get: %s\n" % e)

# 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.UserApi(estuary_client.ApiClient(configuration))

try:
# Get stats for the current user
api_response = api_instance.user_stats_get()
pprint(api_response)
except ApiException as e:
print("Exception when calling UserApi->user_stats_get: %s\n" % e)

Documentation for API Endpoints

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

ClassMethodHTTP requestDescription
UserApiuser_api_keys_getGET /user/api-keysGet API keys for a user
UserApiuser_api_keys_key_or_hash_deleteDELETE /user/api-keys/{key_or_hash}Revoke a User API Key.
UserApiuser_api_keys_postPOST /user/api-keysCreate API keys for a user
UserApiuser_export_getGET /user/exportExport user data
UserApiuser_stats_getGET /user/statsGet stats for the current user
AdminApiadmin_peering_peers_deleteDELETE /admin/peering/peersRemove peers on Peering Service
AdminApiadmin_peering_peers_getGET /admin/peering/peersList all Peering peers
AdminApiadmin_peering_peers_postPOST /admin/peering/peersAdd peers on Peering Service
AdminApiadmin_peering_start_postPOST /admin/peering/startStart Peering
AdminApiadmin_peering_status_getGET /admin/peering/statusCheck Peering Status
AdminApiadmin_peering_stop_postPOST /admin/peering/stopStop Peering
AdminApiadmin_system_config_getGET /admin/system/configGet systems(estuary/shuttle) config
AdminApiadmin_users_getGET /admin/usersGet all users
AutoretrieveApiadmin_autoretrieve_init_postPOST /admin/autoretrieve/initRegister autoretrieve server
AutoretrieveApiadmin_autoretrieve_list_getGET /admin/autoretrieve/listList autoretrieve servers
AutoretrieveApiautoretrieve_heartbeat_postPOST /autoretrieve/heartbeatMarks autoretrieve server as up
CollectionsApicollections_coluuid_commit_postPOST /collections/{coluuid}/commitProduce a CID of the collection contents
CollectionsApicollections_coluuid_contents_deleteDELETE /collections/{coluuid}/contentsDeletes a content from a collection
CollectionsApicollections_coluuid_deleteDELETE /collections/{coluuid}Deletes a collection
CollectionsApicollections_coluuid_getGET /collections/{coluuid}Get contents in a collection
CollectionsApicollections_coluuid_postPOST /collections/{coluuid}Add contents to a collection
CollectionsApicollections_fs_add_postPOST /collections/fs/addAdd a file to a collection
CollectionsApicollections_getGET /collections/List all collections
CollectionsApicollections_postPOST /collections/Create a new collection
ContentApiadmin_invites_getGET /admin/invitesGet Estuary invites
ContentApiadmin_invites_postPOST /admin/invitesCreate an Estuary invite
ContentApicontent_add_car_postPOST /content/add-carAdd Car object
ContentApicontent_add_ipfs_postPOST /content/add-ipfsAdd IPFS object
ContentApicontent_add_postPOST /content/addAdd new content
ContentApicontent_aggregated_content_getGET /content/aggregated/{content}Get aggregated content stats
ContentApicontent_all_deals_getGET /content/all-dealsGet all deals for a user
ContentApicontent_bw_usage_content_getGET /content/bw-usage/{content}Get content bandwidth
ContentApicontent_create_postPOST /content/createAdd a new content
ContentApicontent_deals_getGET /content/dealsContent with deals
ContentApicontent_ensure_replication_datacid_getGET /content/ensure-replication/{datacid}Ensure Replication
ContentApicontent_failures_content_getGET /content/failures/{content}List all failures for a content
ContentApicontent_id_getGET /content/{id}Content
ContentApicontent_importdeal_postPOST /content/importdealImport a deal
ContentApicontent_list_getGET /content/listList all pinned content
ContentApicontent_read_cont_getGET /content/read/{cont}Read content
ContentApicontent_staging_zones_getGET /content/staging-zonesGet staging zone for user
ContentApicontent_stats_getGET /content/statsGet content statistics
ContentApicontent_status_id_getGET /content/status/{id}Content Status
DealsApideal_estimate_postPOST /deal/estimateEstimate the cost of a deal
DealsApideal_info_dealid_getGET /deal/info/{dealid}Get Deal Info
DealsApideal_proposal_propcid_getGET /deal/proposal/{propcid}Get Proposal
DealsApideal_query_miner_getGET /deal/query/{miner}Query Ask
DealsApideal_status_by_proposal_propcid_getGET /deal/status-by-proposal/{propcid}Get Deal Status by PropCid
DealsApideal_status_miner_propcid_getGET /deal/status/{miner}/{propcid}Deal Status
DealsApideal_transfer_in_progress_getGET /deal/transfer/in-progressTransfer In Progress
DealsApideal_transfer_status_postPOST /deal/transfer/statusTransfer Status
DealsApideals_failures_getGET /deals/failuresGet storage failures for user
DealsApideals_make_miner_postPOST /deals/make/{miner}Make Deal
DealsApideals_status_deal_getGET /deals/status/{deal}Get Deal Status
DealsApipublic_deals_failures_getGET /public/deals/failuresGet storage failures
DealsApipublic_miners_storage_query_miner_getGET /public/miners/storage/query/{miner}Query Ask
MetricsApipublic_metrics_deals_on_chain_getGET /public/metrics/deals-on-chainGet deal metrics
MinerApipublic_miners_deals_miner_getGET /public/miners/deals/{miner}Get all miners deals
MinerApipublic_miners_stats_miner_getGET /public/miners/stats/{miner}Get miner stats
NetApinet_addrs_getGET /net/addrsNet Addrs
NetApipublic_miners_failures_miner_getGET /public/miners/failures/{miner}Get all miners
NetApipublic_miners_getGET /public/minersGet all miners
NetApipublic_net_addrs_getGET /public/net/addrsNet Addrs
NetApipublic_net_peers_getGET /public/net/peersNet Peers
PeeringApiadmin_peering_peers_deleteDELETE /admin/peering/peersRemove peers on Peering Service
PeeringApiadmin_peering_peers_getGET /admin/peering/peersList all Peering peers
PeeringApiadmin_peering_peers_postPOST /admin/peering/peersAdd peers on Peering Service
PeeringApiadmin_peering_start_postPOST /admin/peering/startStart Peering
PeeringApiadmin_peering_status_getGET /admin/peering/statusCheck Peering Status
PeeringApiadmin_peering_stop_postPOST /admin/peering/stopStop Peering
PeersApiadmin_peering_peers_deleteDELETE /admin/peering/peersRemove peers on Peering Service
PeersApiadmin_peering_peers_getGET /admin/peering/peersList all Peering peers
PeersApiadmin_peering_peers_postPOST /admin/peering/peersAdd peers on Peering Service
PeersApiadmin_peering_start_postPOST /admin/peering/startStart Peering
PeersApiadmin_peering_status_getGET /admin/peering/statusCheck Peering Status
PeersApiadmin_peering_stop_postPOST /admin/peering/stopStop Peering
PinningApipinning_pins_getGET /pinning/pinsList all pin status objects
PinningApipinning_pins_pinid_deleteDELETE /pinning/pins/{pinid}Delete a pinned object
PinningApipinning_pins_pinid_getGET /pinning/pins/{pinid}Get a pin status object
PinningApipinning_pins_pinid_postPOST /pinning/pins/{pinid}Replace a pinned object
PinningApipinning_pins_postPOST /pinning/pinsAdd and pin object
PublicApiget_cid_getGET /get/{cid}Get Full Content by Cid
PublicApipublic_by_cid_cid_getGET /public/by-cid/{cid}Get Content by Cid
PublicApipublic_info_getGET /public/infoGet public node info
PublicApipublic_metrics_deals_on_chain_getGET /public/metrics/deals-on-chainGet deal metrics
PublicApipublic_miners_deals_miner_getGET /public/miners/deals/{miner}Get all miners deals
PublicApipublic_miners_failures_miner_getGET /public/miners/failures/{miner}Get all miners
PublicApipublic_miners_getGET /public/minersGet all miners
PublicApipublic_miners_stats_miner_getGET /public/miners/stats/{miner}Get miner stats
PublicApipublic_net_addrs_getGET /public/net/addrsNet Addrs
PublicApipublic_net_peers_getGET /public/net/peersNet Peers
PublicApipublic_stats_getGET /public/statsPublic stats

Documentation For Models

Documentation For Authorization

bearerAuth

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header

Author