Estuary

Python API for interacting with Estuary

---

source

est_get_viewer

 est_get_viewer (api_key:str)

View your Estuary account details

	Type	Details
api_key	str	Your Estuary API key

Standard IPFS Pinning API

Pinning to/interacting with IPFS through Estuary

---

source

list_pins

 list_pins (api_key:str)

List all your pins

	Type	Details
api_key	str	Your Estuary API key

---

source

add_pin

 add_pin (api_key:str, file_name:str, cid:str)

Add a new pin object for the current access token.

	Type	Details
api_key	str	Your Estuary API key
file_name	str	File name to pin
cid	str	CID to attach

---

source

get_pin

 get_pin (api_key:str, pin_id:str)

Get a pinned object by ID

	Type	Details
api_key	str	Your Estuary API key
pin_id	str	Unique pin ID

---

source

replace_pin

 replace_pin (api_key:str, pin_id:str)

Replace a pinned object by ID

	Type	Details
api_key	str	Your Estuary API key
pin_id	str	Unique pin ID

---

source

remove_pin

 remove_pin (api_key:str, pin_id:str)

Remove a pinned object by ID

	Type	Details
api_key	str	Your Estuary API key
pin_id	str	Unique pin ID

Collections

---

source

create_coll

 create_coll (api_key:str, name:str, description:str)

Create new collection

	Type	Details
api_key	str	Your Estuary API key
name	str	Collection name
description	str	Collection description

---

source

add_content

 add_content (api_key:str, collection_id:str, data:list, cids:list)

Add data to Collection

	Type	Details
api_key	str	Your Estuary API key
collection_id	str	Collection ID
data	list	List of paths to data to be added
cids	list	List of respective CIDs

---

source

list_colls

 list_colls (api_key:str)

List your collections

	Type	Details
api_key	str	Your Estuary API key

---

source

list_coll_content

 list_coll_content (api_key:str, collection_id:str)

List contents of a collection from ID

	Type	Details
api_key	str	Your Estuary API key
collection_id	str	Collection ID

---

source

list_content_path

 list_content_path (api_key:str, collection_id:str, path:str)

List content of a path in collection

	Type	Details
api_key	str	Your Estuary API key
collection_id	str	Collection ID
path	str	Path in collection to list files from

---

source

add_content_path

 add_content_path (api_key:str, collection_id:str, path:str)

Add content to a specific file system path in an IPFS collection

	Type	Details
api_key	str	Your Estuary API key
collection_id	str	Collection ID
path	str	Path in collection to add files to

Estuary base API

---

source

add_key

 add_key (api_key, expiry='24h')

Add client safe upload key

	Type	Default	Details
api_key			Your Estuary API key
expiry	str	24h	Expiry of upload key

---

source

add_data

 add_data (api_key:str, path_to_file:str)

Upload file to Estuary

	Type	Details
api_key	str	Your Estuary API key
path_to_file	str	Path to file you want to upload

---

source

add_cid

 add_cid (api_key:str, file_name:str, cid:str)

Use an existing IPFS CID to make storage deals.

	Type	Details
api_key	str	Your Estuary API key
file_name	str	File name to add to CID
cid	str	CID for file

---

source

add_car

 add_car (api_key:str, path_to_file:str)

Write a Content-Addressable Archive (CAR) file, and make storage deals for its contents.

	Type	Details
api_key	str	Your Estuary API key
path_to_file	str	Path to file to store

---

source

make_deal

 make_deal (api_key:str, content_id:str, provider_id:str)

Make a deal with a storage provider and a file you have already uploaded to Estuary

	Type	Details
api_key	str	Your Estuary API key
content_id	str	Content ID on Estuary
provider_id	str	Provider ID

---

source

view_data_cid

 view_data_cid (api_key:str, cid:str)

View CID information

	Type	Details
api_key	str	Your Estuary API key
cid	str	CID

---

source

list_data

 list_data (api_key:str)

	Type	Details
api_key	str	Your Estuary API key

---

source

list_deals

 list_deals (api_key:str)

	Type	Details
api_key	str	Your Estuary API key

---

source

get_deal_status

 get_deal_status (api_key:str, deal_id:str)

Get deal status by id

	Type	Details
api_key	str	Your Estuary API key
deal_id	str	Deal ID

---

source

get_node_stats

 get_node_stats ()

Get Estuary node stats

---

source

get_deal_data

 get_deal_data ()

Get on-chain deal data

---

source

get_miner_ask

 get_miner_ask (miner_id:str)

Get the query ask and verified ask for any miner

	Type	Details
miner_id	str	Miner ID

---

source

get_failure_logs

 get_failure_logs (miner_id:str)

Get all of the failure logs for a specific miner

	Type	Details
miner_id	str	Miner ID

---

source

get_deal_logs

 get_deal_logs (provider_id:str)

Get deal logs by provider

	Type	Details
provider_id	str	Provider ID

---

source

get_provider_stats

 get_provider_stats (provider_id:str)

Get provider stats

	Type	Details
provider_id	str	Provider ID

---

source

list_providers

 list_providers ()

List Estuary providers

Downloading data

---

source

get_data

 get_data (cid:str, path_name:str)

Download data from Estuary CID

	Type	Details
cid	str	Data CID
path_name	str	Path and filename to store the file at