Skip to main content

EstuaryClient.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 {EstuaryClient} from 'estuary-client';
let defaultClient = EstuaryClient.ApiClient.instance;

// Configure API key authorization: bearerAuth
let bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.apiKeyPrefix = 'Token';

let apiInstance = new EstuaryClient.DealsApi();
let body = new EstuaryClient.MainEstimateDealBody(); // MainEstimateDealBody | The size of the deal in bytes, the replication factor, and the duration of the deal in blocks

apiInstance.dealEstimatePost(body, (error, data, response) => {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
});

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 {EstuaryClient} from 'estuary-client';
let defaultClient = EstuaryClient.ApiClient.instance;

// Configure API key authorization: bearerAuth
let bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.apiKeyPrefix = 'Token';

let apiInstance = new EstuaryClient.DealsApi();
let dealid = 56; // Number | Deal ID

apiInstance.dealInfoDealidGet(dealid, (error, data, response) => {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
});

Parameters

NameTypeDescriptionNotes
dealidNumberDeal 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 {EstuaryClient} from 'estuary-client';
let defaultClient = EstuaryClient.ApiClient.instance;

// Configure API key authorization: bearerAuth
let bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.apiKeyPrefix = 'Token';

let apiInstance = new EstuaryClient.DealsApi();
let propcid = "propcid_example"; // String | Proposal CID

apiInstance.dealProposalPropcidGet(propcid, (error, data, response) => {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
});

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 {EstuaryClient} from 'estuary-client';
let defaultClient = EstuaryClient.ApiClient.instance;

// Configure API key authorization: bearerAuth
let bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.apiKeyPrefix = 'Token';

let apiInstance = new EstuaryClient.DealsApi();
let miner = "miner_example"; // String | CID

apiInstance.dealQueryMinerGet(miner, (error, data, response) => {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
});

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 {EstuaryClient} from 'estuary-client';
let defaultClient = EstuaryClient.ApiClient.instance;

// Configure API key authorization: bearerAuth
let bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.apiKeyPrefix = 'Token';

let apiInstance = new EstuaryClient.DealsApi();
let propcid = "propcid_example"; // String | PropCid

apiInstance.dealStatusByProposalPropcidGet(propcid, (error, data, response) => {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
});

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 {EstuaryClient} from 'estuary-client';
let defaultClient = EstuaryClient.ApiClient.instance;

// Configure API key authorization: bearerAuth
let bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.apiKeyPrefix = 'Token';

let apiInstance = new EstuaryClient.DealsApi();
let miner = "miner_example"; // String | Miner
let propcid = "propcid_example"; // String | Proposal CID

apiInstance.dealStatusMinerPropcidGet(miner, propcid, (error, data, response) => {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
});

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 {EstuaryClient} from 'estuary-client';
let defaultClient = EstuaryClient.ApiClient.instance;

// Configure API key authorization: bearerAuth
let bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.apiKeyPrefix = 'Token';

let apiInstance = new EstuaryClient.DealsApi();
apiInstance.dealTransferInProgressGet((error, data, response) => {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
});

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 {EstuaryClient} from 'estuary-client';
let defaultClient = EstuaryClient.ApiClient.instance;

// Configure API key authorization: bearerAuth
let bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.apiKeyPrefix = 'Token';

let apiInstance = new EstuaryClient.DealsApi();
let body = new EstuaryClient.MainChannelIDParam(); // MainChannelIDParam | Channel ID

apiInstance.dealTransferStatusPost(body, (error, data, response) => {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
});

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 {EstuaryClient} from 'estuary-client';
let defaultClient = EstuaryClient.ApiClient.instance;

// Configure API key authorization: bearerAuth
let bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.apiKeyPrefix = 'Token';

let apiInstance = new EstuaryClient.DealsApi();
apiInstance.dealsFailuresGet((error, data, response) => {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
});

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 {EstuaryClient} from 'estuary-client';
let defaultClient = EstuaryClient.ApiClient.instance;

// Configure API key authorization: bearerAuth
let bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.apiKeyPrefix = 'Token';

let apiInstance = new EstuaryClient.DealsApi();
let body = "body_example"; // String | Deal Request
let miner = "miner_example"; // String | Miner

apiInstance.dealsMakeMinerPost(body, miner, (error, data, response) => {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
});

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 {EstuaryClient} from 'estuary-client';
let defaultClient = EstuaryClient.ApiClient.instance;

// Configure API key authorization: bearerAuth
let bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.apiKeyPrefix = 'Token';

let apiInstance = new EstuaryClient.DealsApi();
let deal = 56; // Number | Deal ID

apiInstance.dealsStatusDealGet(deal, (error, data, response) => {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
});

Parameters

NameTypeDescriptionNotes
dealNumberDeal 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 {EstuaryClient} from 'estuary-client';
let defaultClient = EstuaryClient.ApiClient.instance;

// Configure API key authorization: bearerAuth
let bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.apiKeyPrefix = 'Token';

let apiInstance = new EstuaryClient.DealsApi();
apiInstance.publicDealsFailuresGet((error, data, response) => {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
});

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 {EstuaryClient} from 'estuary-client';
let defaultClient = EstuaryClient.ApiClient.instance;

// Configure API key authorization: bearerAuth
let bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.apiKeyPrefix = 'Token';

let apiInstance = new EstuaryClient.DealsApi();
let miner = "miner_example"; // String | CID

apiInstance.publicMinersStorageQueryMinerGet(miner, (error, data, response) => {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
});

Parameters

NameTypeDescriptionNotes
minerStringCID

Return type

'String'

Authorization

bearerAuth

HTTP request headers

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