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(ctx, body) Estimate the cost of a deal

This endpoint estimates the cost of a deal

Required Parameters

NameTypeDescriptionNotes
ctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.
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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DealInfoDealidGet

string DealInfoDealidGet(ctx, dealid) Get Deal Info

This endpoint returns the deal info for a deal

Required Parameters

NameTypeDescriptionNotes
ctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.
dealidint32Deal ID

Return type

string

Authorization

bearerAuth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DealProposalPropcidGet

string DealProposalPropcidGet(ctx, propcid) Get Proposal

This endpoint returns the proposal for a deal

Required Parameters

NameTypeDescriptionNotes
ctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.
propcidstringProposal CID

Return type

string

Authorization

bearerAuth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DealQueryMinerGet

string DealQueryMinerGet(ctx, miner) Query Ask

This endpoint returns the ask for a given CID

Required Parameters

NameTypeDescriptionNotes
ctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.
minerstringCID

Return type

string

Authorization

bearerAuth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DealStatusByProposalPropcidGet

string DealStatusByProposalPropcidGet(ctx, propcid) Get Deal Status by PropCid

Get Deal Status by PropCid

Required Parameters

NameTypeDescriptionNotes
ctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.
propcidstringPropCid

Return type

string

Authorization

bearerAuth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DealStatusMinerPropcidGet

string DealStatusMinerPropcidGet(ctx, miner, propcid) Deal Status

This endpoint returns the status of a deal

Required Parameters

NameTypeDescriptionNotes
ctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.
minerstringMiner
propcidstringProposal CID

Return type

string

Authorization

bearerAuth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DealTransferInProgressGet

string DealTransferInProgressGet(ctx, ) Transfer In Progress

This endpoint returns the in-progress transfers

Required Parameters

This endpoint does not need any parameter.

Return type

string

Authorization

bearerAuth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DealTransferStatusPost

string DealTransferStatusPost(ctx, body) Transfer Status

This endpoint returns the status of a transfer

Required Parameters

NameTypeDescriptionNotes
ctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.
bodyMainChannelIdParamChannel ID

Return type

string

Authorization

bearerAuth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DealsFailuresGet

string DealsFailuresGet(ctx, ) Get storage failures for user

This endpoint returns a list of storage failures for user

Required Parameters

This endpoint does not need any parameter.

Return type

string

Authorization

bearerAuth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DealsMakeMinerPost

string DealsMakeMinerPost(ctx, body, miner) Make Deal

This endpoint makes a deal for a given content and miner

Required Parameters

NameTypeDescriptionNotes
ctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.
bodystringDeal Request
minerstringMiner

Return type

string

Authorization

bearerAuth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DealsStatusDealGet

string DealsStatusDealGet(ctx, deal) Get Deal Status

This endpoint returns the status of a deal

Required Parameters

NameTypeDescriptionNotes
ctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.
dealint32Deal ID

Return type

string

Authorization

bearerAuth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PublicDealsFailuresGet

string PublicDealsFailuresGet(ctx, ) Get storage failures

This endpoint returns a list of storage failures

Required Parameters

This endpoint does not need any parameter.

Return type

string

Authorization

bearerAuth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PublicMinersStorageQueryMinerGet

string PublicMinersStorageQueryMinerGet(ctx, miner) Query Ask

This endpoint returns the ask for a given CID

Required Parameters

NameTypeDescriptionNotes
ctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.
minerstringCID

Return type

string

Authorization

bearerAuth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]