Skip to main content

SwaggerClient::DealsApi

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

MethodHTTP requestDescription
deal_estimate_postPOST /deal/estimateEstimate the cost of a deal
deal_info_dealid_getGET /deal/info/{dealid}Get Deal Info
deal_proposal_propcid_getGET /deal/proposal/{propcid}Get Proposal
deal_query_miner_getGET /deal/query/{miner}Query Ask
deal_status_by_proposal_propcid_getGET /deal/status-by-proposal/{propcid}Get Deal Status by PropCid
deal_status_miner_propcid_getGET /deal/status/{miner}/{propcid}Deal Status
deal_transfer_in_progress_getGET /deal/transfer/in-progressTransfer In Progress
deal_transfer_status_postPOST /deal/transfer/statusTransfer Status
deals_failures_getGET /deals/failuresGet storage failures for user
deals_make_miner_postPOST /deals/make/{miner}Make Deal
deals_status_deal_getGET /deals/status/{deal}Get Deal Status
public_deals_failures_getGET /public/deals/failuresGet storage failures
public_miners_storage_query_miner_getGET /public/miners/storage/query/{miner}Query Ask

deal_estimate_post

String deal_estimate_post(body)

Estimate the cost of a deal

This endpoint estimates the cost of a deal

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::DealsApi.new
body = SwaggerClient::MainEstimateDealBody.new # MainEstimateDealBody | The size of the deal in bytes, the replication factor, and the duration of the deal in blocks


begin
#Estimate the cost of a deal
result = api_instance.deal_estimate_post(body)
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling DealsApi->deal_estimate_post: #{e}"
end

Parameters

NameTypeDescriptionNotes
bodyMainEstimateDealBodyThe size of the deal in bytes, the replication factor, and the duration of the deal in blocks

Return type

String

Authorization

bearerAuth

HTTP request headers

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

deal_info_dealid_get

String deal_info_dealid_get(dealid)

Get Deal Info

This endpoint returns the deal info for a deal

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::DealsApi.new
dealid = 56 # Integer | Deal ID


begin
#Get Deal Info
result = api_instance.deal_info_dealid_get(dealid)
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling DealsApi->deal_info_dealid_get: #{e}"
end

Parameters

NameTypeDescriptionNotes
dealidIntegerDeal ID

Return type

String

Authorization

bearerAuth

HTTP request headers

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

deal_proposal_propcid_get

String deal_proposal_propcid_get(propcid)

Get Proposal

This endpoint returns the proposal for a deal

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::DealsApi.new
propcid = 'propcid_example' # String | Proposal CID


begin
#Get Proposal
result = api_instance.deal_proposal_propcid_get(propcid)
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling DealsApi->deal_proposal_propcid_get: #{e}"
end

Parameters

NameTypeDescriptionNotes
propcidStringProposal CID

Return type

String

Authorization

bearerAuth

HTTP request headers

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

deal_query_miner_get

String deal_query_miner_get(miner)

Query Ask

This endpoint returns the ask for a given 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::DealsApi.new
miner = 'miner_example' # String | CID


begin
#Query Ask
result = api_instance.deal_query_miner_get(miner)
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling DealsApi->deal_query_miner_get: #{e}"
end

Parameters

NameTypeDescriptionNotes
minerStringCID

Return type

String

Authorization

bearerAuth

HTTP request headers

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

deal_status_by_proposal_propcid_get

String deal_status_by_proposal_propcid_get(propcid)

Get Deal Status by PropCid

Get Deal Status by PropCid

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::DealsApi.new
propcid = 'propcid_example' # String | PropCid


begin
#Get Deal Status by PropCid
result = api_instance.deal_status_by_proposal_propcid_get(propcid)
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling DealsApi->deal_status_by_proposal_propcid_get: #{e}"
end

Parameters

NameTypeDescriptionNotes
propcidStringPropCid

Return type

String

Authorization

bearerAuth

HTTP request headers

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

deal_status_miner_propcid_get

String deal_status_miner_propcid_get(miner, propcid)

Deal Status

This endpoint returns the status of a deal

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::DealsApi.new
miner = 'miner_example' # String | Miner
propcid = 'propcid_example' # String | Proposal CID


begin
#Deal Status
result = api_instance.deal_status_miner_propcid_get(miner, propcid)
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling DealsApi->deal_status_miner_propcid_get: #{e}"
end

Parameters

NameTypeDescriptionNotes
minerStringMiner
propcidStringProposal CID

Return type

String

Authorization

bearerAuth

HTTP request headers

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

deal_transfer_in_progress_get

String deal_transfer_in_progress_get

Transfer In Progress

This endpoint returns the in-progress transfers

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::DealsApi.new

begin
#Transfer In Progress
result = api_instance.deal_transfer_in_progress_get
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling DealsApi->deal_transfer_in_progress_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

deal_transfer_status_post

String deal_transfer_status_post(body)

Transfer Status

This endpoint returns the status of a transfer

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::DealsApi.new
body = SwaggerClient::MainChannelIDParam.new # MainChannelIDParam | Channel ID


begin
#Transfer Status
result = api_instance.deal_transfer_status_post(body)
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling DealsApi->deal_transfer_status_post: #{e}"
end

Parameters

NameTypeDescriptionNotes
bodyMainChannelIDParamChannel ID

Return type

String

Authorization

bearerAuth

HTTP request headers

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

deals_failures_get

String deals_failures_get

Get storage failures for user

This endpoint returns a list of storage failures for user

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::DealsApi.new

begin
#Get storage failures for user
result = api_instance.deals_failures_get
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling DealsApi->deals_failures_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

deals_make_miner_post

String deals_make_miner_post(bodyminer)

Make Deal

This endpoint makes a deal for a given content and miner

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::DealsApi.new
body = 'body_example' # String | Deal Request
miner = 'miner_example' # String | Miner


begin
#Make Deal
result = api_instance.deals_make_miner_post(bodyminer)
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling DealsApi->deals_make_miner_post: #{e}"
end

Parameters

NameTypeDescriptionNotes
bodyStringDeal Request
minerStringMiner

Return type

String

Authorization

bearerAuth

HTTP request headers

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

deals_status_deal_get

String deals_status_deal_get(deal)

Get Deal Status

This endpoint returns the status of a deal

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::DealsApi.new
deal = 56 # Integer | Deal ID


begin
#Get Deal Status
result = api_instance.deals_status_deal_get(deal)
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling DealsApi->deals_status_deal_get: #{e}"
end

Parameters

NameTypeDescriptionNotes
dealIntegerDeal ID

Return type

String

Authorization

bearerAuth

HTTP request headers

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

public_deals_failures_get

String public_deals_failures_get

Get storage failures

This endpoint returns a list of storage failures

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::DealsApi.new

begin
#Get storage failures
result = api_instance.public_deals_failures_get
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling DealsApi->public_deals_failures_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_storage_query_miner_get

String public_miners_storage_query_miner_get(miner)

Query Ask

This endpoint returns the ask for a given 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::DealsApi.new
miner = 'miner_example' # String | CID


begin
#Query Ask
result = api_instance.public_miners_storage_query_miner_get(miner)
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling DealsApi->public_miners_storage_query_miner_get: #{e}"
end

Parameters

NameTypeDescriptionNotes
minerStringCID

Return type

String

Authorization

bearerAuth

HTTP request headers

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