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

statesstring · enum[]optional

state filter

Responses

application/json

object[]optional

application/json

application/json

post

HTTPcURLJavaScriptPython

POST /api/deal HTTP/1.1
Host: localhost:9090
Content-Type: application/json
Accept: */*
Content-Length: 103

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

[
  {
    "clientId": "text",
    "createdAt": "text",
    "dealId": 1,
    "endEpoch": 1,
    "errorMessage": "text",
    "id": 1,
    "label": "text",
    "lastVerifiedAt": "text",
    "pieceCid": "text",
    "pieceSize": 1,
    "price": "text",
    "proposalId": "text",
    "provider": "text",
    "scheduleId": 1,
    "sectorStartEpoch": 1,
    "startEpoch": 1,
    "state": "proposed",
    "updatedAt": "text",
    "verified": true
  }
]

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: 12740h

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

application/json

objectoptional

application/json

application/json

post

HTTPcURLJavaScriptPython

POST /api/send_deal HTTP/1.1
Host: localhost:9090
Content-Type: application/json
Accept: */*
Content-Length: 293

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

{
  "clientId": "text",
  "createdAt": "text",
  "dealId": 1,
  "endEpoch": 1,
  "errorMessage": "text",
  "id": 1,
  "label": "text",
  "lastVerifiedAt": "text",
  "pieceCid": "text",
  "pieceSize": 1,
  "price": "text",
  "proposalId": "text",
  "provider": "text",
  "scheduleId": 1,
  "sectorStartEpoch": 1,
  "startEpoch": 1,
  "state": "proposed",
  "updatedAt": "text",
  "verified": true
}