Deal

List all deals

List all deals

POST//localhost:9090/api/deal

Body

application/json

ListDealRequest

preparationsarray of string

preparation ID or name filter

providersarray of string

provider filter

schedulesarray of integer

schedule id filter

sourcesarray of string

source ID or name filter

statesarray of model.DealState (enum)

state filter

Response

200400500

OK

Body

application/json

clientIdstring

createdAtstring

dealIdinteger

endEpochinteger

errorMessagestring

idinteger

labelstring

lastVerifiedAtstring

LastVerifiedAt is the last time the deal was verified as active by the tracker

pieceCidstring

pieceSizeinteger

pricestring

proposalIdstring

providerstring

scheduleIdinteger

Associations

sectorStartEpochinteger

startEpochinteger

statemodel.DealState (enum)

proposedpublishedactiveexpiredproposal_expiredrejectedslashederror

updatedAtstring

verifiedboolean

Request

JavaScriptCurl

const response = await fetch('//localhost:9090/api/deal', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

[
  {
    "clientId": "text",
    "createdAt": "text",
    "errorMessage": "text",
    "label": "text",
    "lastVerifiedAt": "text",
    "pieceCid": "text",
    "price": "text",
    "proposalId": "text",
    "provider": "text",
    "state": "proposed",
    "updatedAt": "text",
    "verified": false
  }
]

Send a manual deal proposal

Send a manual deal proposal

POST//localhost:9090/api/send_deal

Body

application/json

Proposal

clientAddressstring

Client address

durationstring

Duration in epoch or in duration format, i.e. 1500000, 2400h

fileSizeinteger

File size in bytes for boost to fetch the CAR file

httpHeadersarray of string

http headers to be passed with the request (i.e. key=value)

ipniboolean

Whether the deal should be IPNI

keepUnsealedboolean

Whether the deal should be kept unsealed

pieceCidstring

Piece CID

pieceSizestring

Piece size

pricePerDealnumber

Price in FIL per deal

pricePerGbnumber

Price in FIL per GiB

pricePerGbEpochnumber

Price in FIL per GiB per epoch

providerIdstring

Provider ID

rootCidstring

Root CID that is required as part of the deal proposal, if empty, will be set to empty CID

startDelaystring

Deal start delay in epoch or in duration format, i.e. 1000, 72h

urlTemplatestring

URL template with PIECE_CID placeholder for boost to fetch the CAR file, i.e. http://127.0.0.1/piece/{PIECE_CID}.car

verifiedboolean

Whether the deal should be verified

Response

200400500

OK

Body

application/json

clientIdstring

createdAtstring

dealIdinteger

endEpochinteger

errorMessagestring

idinteger

labelstring

lastVerifiedAtstring

LastVerifiedAt is the last time the deal was verified as active by the tracker

pieceCidstring

pieceSizeinteger

pricestring

proposalIdstring

providerstring

scheduleIdinteger

Associations

sectorStartEpochinteger

startEpochinteger

statemodel.DealState (enum)

proposedpublishedactiveexpiredproposal_expiredrejectedslashederror

updatedAtstring

verifiedboolean

Request

JavaScriptCurl

const response = await fetch('//localhost:9090/api/send_deal', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "clientId": "text",
  "createdAt": "text",
  "errorMessage": "text",
  "label": "text",
  "lastVerifiedAt": "text",
  "pieceCid": "text",
  "price": "text",
  "proposalId": "text",
  "provider": "text",
  "state": "proposed",
  "updatedAt": "text",
  "verified": false
}