Skip to main content

DealsApi

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

MethodHTTP requestDescription
dealEstimatePostPOST /deal/estimateEstimate the cost of a deal
dealInfoDealidGetGET /deal/info/{dealid}Get Deal Info
dealProposalPropcidGetGET /deal/proposal/{propcid}Get Proposal
dealQueryMinerGetGET /deal/query/{miner}Query Ask
dealStatusByProposalPropcidGetGET /deal/status-by-proposal/{propcid}Get Deal Status by PropCid
dealStatusMinerPropcidGetGET /deal/status/{miner}/{propcid}Deal Status
dealTransferInProgressGetGET /deal/transfer/in-progressTransfer In Progress
dealTransferStatusPostPOST /deal/transfer/statusTransfer Status
dealsFailuresGetGET /deals/failuresGet storage failures for user
dealsMakeMinerPostPOST /deals/make/{miner}Make Deal
dealsStatusDealGetGET /deals/status/{deal}Get Deal Status
publicDealsFailuresGetGET /public/deals/failuresGet storage failures
publicMinersStorageQueryMinerGetGET /public/miners/storage/query/{miner}Query Ask

dealEstimatePost

String dealEstimatePost(body)

Estimate the cost of a deal

This endpoint estimates the cost of a deal

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.DealsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: bearerAuth
ApiKeyAuth bearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("bearerAuth");
bearerAuth.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.setApiKeyPrefix("Token");

DealsApi apiInstance = new DealsApi();
MainEstimateDealBody body = new MainEstimateDealBody(); // MainEstimateDealBody | The size of the deal in bytes, the replication factor, and the duration of the deal in blocks
try {
String result = apiInstance.dealEstimatePost(body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DealsApi#dealEstimatePost");
e.printStackTrace();
}

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

dealInfoDealidGet

String dealInfoDealidGet(dealid)

Get Deal Info

This endpoint returns the deal info for a deal

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.DealsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: bearerAuth
ApiKeyAuth bearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("bearerAuth");
bearerAuth.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.setApiKeyPrefix("Token");

DealsApi apiInstance = new DealsApi();
Integer dealid = 56; // Integer | Deal ID
try {
String result = apiInstance.dealInfoDealidGet(dealid);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DealsApi#dealInfoDealidGet");
e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
dealidIntegerDeal ID

Return type

String

Authorization

bearerAuth

HTTP request headers

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

dealProposalPropcidGet

String dealProposalPropcidGet(propcid)

Get Proposal

This endpoint returns the proposal for a deal

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.DealsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: bearerAuth
ApiKeyAuth bearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("bearerAuth");
bearerAuth.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.setApiKeyPrefix("Token");

DealsApi apiInstance = new DealsApi();
String propcid = "propcid_example"; // String | Proposal CID
try {
String result = apiInstance.dealProposalPropcidGet(propcid);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DealsApi#dealProposalPropcidGet");
e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
propcidStringProposal CID

Return type

String

Authorization

bearerAuth

HTTP request headers

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

dealQueryMinerGet

String dealQueryMinerGet(miner)

Query Ask

This endpoint returns the ask for a given CID

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.DealsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: bearerAuth
ApiKeyAuth bearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("bearerAuth");
bearerAuth.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.setApiKeyPrefix("Token");

DealsApi apiInstance = new DealsApi();
String miner = "miner_example"; // String | CID
try {
String result = apiInstance.dealQueryMinerGet(miner);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DealsApi#dealQueryMinerGet");
e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
minerStringCID

Return type

String

Authorization

bearerAuth

HTTP request headers

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

dealStatusByProposalPropcidGet

String dealStatusByProposalPropcidGet(propcid)

Get Deal Status by PropCid

Get Deal Status by PropCid

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.DealsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: bearerAuth
ApiKeyAuth bearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("bearerAuth");
bearerAuth.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.setApiKeyPrefix("Token");

DealsApi apiInstance = new DealsApi();
String propcid = "propcid_example"; // String | PropCid
try {
String result = apiInstance.dealStatusByProposalPropcidGet(propcid);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DealsApi#dealStatusByProposalPropcidGet");
e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
propcidStringPropCid

Return type

String

Authorization

bearerAuth

HTTP request headers

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

dealStatusMinerPropcidGet

String dealStatusMinerPropcidGet(miner, propcid)

Deal Status

This endpoint returns the status of a deal

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.DealsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: bearerAuth
ApiKeyAuth bearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("bearerAuth");
bearerAuth.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.setApiKeyPrefix("Token");

DealsApi apiInstance = new DealsApi();
String miner = "miner_example"; // String | Miner
String propcid = "propcid_example"; // String | Proposal CID
try {
String result = apiInstance.dealStatusMinerPropcidGet(miner, propcid);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DealsApi#dealStatusMinerPropcidGet");
e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
minerStringMiner
propcidStringProposal CID

Return type

String

Authorization

bearerAuth

HTTP request headers

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

dealTransferInProgressGet

String dealTransferInProgressGet()

Transfer In Progress

This endpoint returns the in-progress transfers

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.DealsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: bearerAuth
ApiKeyAuth bearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("bearerAuth");
bearerAuth.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.setApiKeyPrefix("Token");

DealsApi apiInstance = new DealsApi();
try {
String result = apiInstance.dealTransferInProgressGet();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DealsApi#dealTransferInProgressGet");
e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

String

Authorization

bearerAuth

HTTP request headers

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

dealTransferStatusPost

String dealTransferStatusPost(body)

Transfer Status

This endpoint returns the status of a transfer

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.DealsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: bearerAuth
ApiKeyAuth bearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("bearerAuth");
bearerAuth.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.setApiKeyPrefix("Token");

DealsApi apiInstance = new DealsApi();
MainChannelIDParam body = new MainChannelIDParam(); // MainChannelIDParam | Channel ID
try {
String result = apiInstance.dealTransferStatusPost(body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DealsApi#dealTransferStatusPost");
e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
bodyMainChannelIDParamChannel ID

Return type

String

Authorization

bearerAuth

HTTP request headers

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

dealsFailuresGet

String dealsFailuresGet()

Get storage failures for user

This endpoint returns a list of storage failures for user

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.DealsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: bearerAuth
ApiKeyAuth bearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("bearerAuth");
bearerAuth.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.setApiKeyPrefix("Token");

DealsApi apiInstance = new DealsApi();
try {
String result = apiInstance.dealsFailuresGet();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DealsApi#dealsFailuresGet");
e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

String

Authorization

bearerAuth

HTTP request headers

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

dealsMakeMinerPost

String dealsMakeMinerPost(body, miner)

Make Deal

This endpoint makes a deal for a given content and miner

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.DealsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: bearerAuth
ApiKeyAuth bearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("bearerAuth");
bearerAuth.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.setApiKeyPrefix("Token");

DealsApi apiInstance = new DealsApi();
String body = "body_example"; // String | Deal Request
String miner = "miner_example"; // String | Miner
try {
String result = apiInstance.dealsMakeMinerPost(body, miner);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DealsApi#dealsMakeMinerPost");
e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
bodyStringDeal Request
minerStringMiner

Return type

String

Authorization

bearerAuth

HTTP request headers

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

dealsStatusDealGet

String dealsStatusDealGet(deal)

Get Deal Status

This endpoint returns the status of a deal

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.DealsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: bearerAuth
ApiKeyAuth bearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("bearerAuth");
bearerAuth.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.setApiKeyPrefix("Token");

DealsApi apiInstance = new DealsApi();
Integer deal = 56; // Integer | Deal ID
try {
String result = apiInstance.dealsStatusDealGet(deal);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DealsApi#dealsStatusDealGet");
e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
dealIntegerDeal ID

Return type

String

Authorization

bearerAuth

HTTP request headers

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

publicDealsFailuresGet

String publicDealsFailuresGet()

Get storage failures

This endpoint returns a list of storage failures

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.DealsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: bearerAuth
ApiKeyAuth bearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("bearerAuth");
bearerAuth.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.setApiKeyPrefix("Token");

DealsApi apiInstance = new DealsApi();
try {
String result = apiInstance.publicDealsFailuresGet();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DealsApi#publicDealsFailuresGet");
e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

String

Authorization

bearerAuth

HTTP request headers

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

publicMinersStorageQueryMinerGet

String publicMinersStorageQueryMinerGet(miner)

Query Ask

This endpoint returns the ask for a given CID

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.DealsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: bearerAuth
ApiKeyAuth bearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("bearerAuth");
bearerAuth.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.setApiKeyPrefix("Token");

DealsApi apiInstance = new DealsApi();
String miner = "miner_example"; // String | CID
try {
String result = apiInstance.publicMinersStorageQueryMinerGet(miner);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DealsApi#publicMinersStorageQueryMinerGet");
e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
minerStringCID

Return type

String

Authorization

bearerAuth

HTTP request headers

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