Deal

List all deals

post

List all deals

Body

preparationsstring[]Optional

preparation ID or name filter

providersstring[]Optional

provider filter

schedulesinteger[]Optional

schedule id filter

sourcesstring[]Optional

source ID or name filter

Responses

200

OK

application/json

clientIdstringOptional

createdAtstringOptional

ddoAllocationIdintegerOptional

DDO-specific fields (only populated for DealTypeDDO)

ddoPaymentTokenstringOptional

ddoRailIdintegerOptional

dealIdintegerOptional

dealTypestring · enumOptionalPossible values:

endEpochintegerOptional

errorMessagestringOptional

idintegerOptional

labelstringOptional

lastVerifiedAtstringOptional

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

nextChallengeEpochintegerOptional

NextChallengeEpoch is the next epoch when a challenge proof is due

pieceCidstringOptional

pieceSizeintegerOptional

pricestringOptional

proofSetIdintegerOptional

PDP-specific fields (only populated for DealTypePDP)

proofSetLivebooleanOptional

ProofSetLive indicates if the proof set is live (actively being challenged)

proposalIdstringOptional

providerstringOptional

scheduleIdintegerOptional

Associations

sectorStartEpochintegerOptional

startEpochintegerOptional

statestring · enumOptionalPossible values:

updatedAtstringOptional

verifiedbooleanOptional

walletIdintegerOptional

400

Bad Request

application/json

500

Internal Server Error

application/json

post/deal

POST /api/deal HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 126

{
  "dealTypes": [
    "market"
  ],
  "preparations": [
    "text"
  ],
  "providers": [
    "text"
  ],
  "schedules": [
    1
  ],
  "sources": [
    "text"
  ],
  "states": [
    "proposed"
  ]
}

[
  {
    "clientId": "text",
    "createdAt": "text",
    "ddoAllocationId": 1,
    "ddoPaymentToken": "text",
    "ddoRailId": 1,
    "dealId": 1,
    "dealType": "market",
    "endEpoch": 1,
    "errorMessage": "text",
    "id": 1,
    "label": "text",
    "lastVerifiedAt": "text",
    "nextChallengeEpoch": 1,
    "pieceCid": "text",
    "pieceSize": 1,
    "price": "text",
    "proofSetId": 1,
    "proofSetLive": true,
    "proposalId": "text",
    "provider": "text",
    "scheduleId": 1,
    "sectorStartEpoch": 1,
    "startEpoch": 1,
    "state": "proposed",
    "updatedAt": "text",
    "verified": true,
    "walletId": 1
  }
]

Send a manual deal proposal

post

Send a manual deal proposal

Body

clientAddressstringOptional

Client address

durationstringOptional

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

Default: 12840h

fileSizeintegerOptional

File size in bytes for boost to fetch the CAR file

httpHeadersstring[]Optional

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

ipnibooleanOptional

Whether the deal should be IPNI

Default: true

keepUnsealedbooleanOptional

Whether the deal should be kept unsealed

Default: true

pieceCidstringOptional

Piece CID

pieceSizestringOptional

Piece size

pricePerDealnumberOptional

Price in FIL per deal

Default: 0

pricePerGbnumberOptional

Price in FIL per GiB

Default: 0

pricePerGbEpochnumberOptional

Price in FIL per GiB per epoch

Default: 0

providerIdstringOptional

Provider ID

rootCidstringOptional

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

Default: bafkqaaa

startDelaystringOptional

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

Default: 72h

urlTemplatestringOptional

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

verifiedbooleanOptional

Whether the deal should be verified

Default: true

Responses

200

OK

application/json

clientIdstringOptional

createdAtstringOptional

ddoAllocationIdintegerOptional

DDO-specific fields (only populated for DealTypeDDO)

ddoPaymentTokenstringOptional

ddoRailIdintegerOptional

dealIdintegerOptional

dealTypestring · enumOptionalPossible values:

endEpochintegerOptional

errorMessagestringOptional

idintegerOptional

labelstringOptional

lastVerifiedAtstringOptional

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

nextChallengeEpochintegerOptional

NextChallengeEpoch is the next epoch when a challenge proof is due

pieceCidstringOptional

pieceSizeintegerOptional

pricestringOptional

proofSetIdintegerOptional

PDP-specific fields (only populated for DealTypePDP)

proofSetLivebooleanOptional

ProofSetLive indicates if the proof set is live (actively being challenged)

proposalIdstringOptional

providerstringOptional

scheduleIdintegerOptional

Associations

sectorStartEpochintegerOptional

startEpochintegerOptional

statestring · enumOptionalPossible values:

updatedAtstringOptional

verifiedbooleanOptional

walletIdintegerOptional

400

Bad Request

application/json

500

Internal Server Error

application/json

post/send_deal

POST /api/send_deal HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 298

{
  "clientAddress": "text",
  "duration": "12840h",
  "fileSize": 1,
  "httpHeaders": [
    "text"
  ],
  "ipni": true,
  "keepUnsealed": true,
  "pieceCid": "text",
  "pieceSize": "text",
  "pricePerDeal": 0,
  "pricePerGb": 0,
  "pricePerGbEpoch": 0,
  "providerId": "text",
  "rootCid": "bafkqaaa",
  "startDelay": "72h",
  "urlTemplate": "text",
  "verified": true
}

{
  "clientId": "text",
  "createdAt": "text",
  "ddoAllocationId": 1,
  "ddoPaymentToken": "text",
  "ddoRailId": 1,
  "dealId": 1,
  "dealType": "market",
  "endEpoch": 1,
  "errorMessage": "text",
  "id": 1,
  "label": "text",
  "lastVerifiedAt": "text",
  "nextChallengeEpoch": 1,
  "pieceCid": "text",
  "pieceSize": 1,
  "price": "text",
  "proofSetId": 1,
  "proofSetLive": true,
  "proposalId": "text",
  "provider": "text",
  "scheduleId": 1,
  "sectorStartEpoch": 1,
  "startEpoch": 1,
  "state": "proposed",
  "updatedAt": "text",
  "verified": true,
  "walletId": 1
}