✨
Singularity
日本語
日本語
  • 概要
    • Singularityとは何ですか
    • V1またはV2
  • インストール
    • バイナリのダウンロード
    • Dockerを使用してインストールする
    • ソースからビルドする
    • 本番環境への展開
  • データの準備
    • はじめに
    • パフォーマンスのチューニング
  • コンテンツの配布
    • CARファイルの配布
  • 取引の実施
    • 取引スケジュールの作成
  • トピック
    • インライン準備
    • ベンチマーク
  • 💻CLIリファレンス
    • メニュー
    • Ez Prep
    • バージョン
    • 管理者
      • 初期化
      • リセット
      • データセットの移行
      • スケジュールの移行
    • ダウンロード
    • CARの抽出
    • 取引
      • スケジュール
        • 作成
        • リスト
        • 更新
        • 一時停止
        • 再開
      • 手動送信
      • リスト
    • 実行
      • API
      • データセットワーカー
      • コンテンツプロバイダー
      • 取引トラッカー
      • 取引プッシャー
      • ダウンロードサーバー
    • ウォレット
      • インポート
      • リスト
      • 削除
    • ストレージ
      • 作成
        • Acd
        • Azureblob
        • B2
        • Box
        • Drive
        • Dropbox
        • Fichier
        • Filefabric
        • Ftp
        • Google Cloud Storage
        • Gphotos
        • Hdfs
        • Hidrive
        • Http
        • Internetarchive
        • Jottacloud
        • Koofr / Digi Storage
          • Digistorage
          • Koofr / Digi Storage
          • Other
        • ローカル
        • Mailru
        • Mega
        • Netstorage
        • Onedrive
        • Opendrive
        • Oos
          • Env_auth
          • Instance_principal_auth
          • No_auth
          • Resource_principal_auth
          • User_principal_auth
        • Pcloud
        • Premiumizeme
        • Putio
        • Qingstor
        • AWS S3 and compliant
          • Aws
          • Alibaba
          • Arvancloud
          • Ceph
          • Chinamobile
          • Cloudflare
          • Digitalocean
          • Dreamhost
          • Huaweiobs
          • Ibmcos
          • Idrive
          • Ionos
          • Liara
          • Lyvecloud
          • Minio
          • Netease
          • Other
          • Qiniu
          • Rackcorp
          • Scaleway
          • Seaweedfs
          • Stackpath
          • Storj
          • Tencentcos
          • Wasabi
        • Seafile
        • Sftp
        • Sharefile
        • Sia
        • Smb
        • Storj
          • 既存
          • 新規
        • Sugarsync
        • Swift
        • Uptobox
        • Webdav
        • Yandex
        • Zoho
      • エクスプローラー
      • リスト
      • 削除
      • アップデート
        • Acd
        • Azureblob
        • B2
        • Box
        • Drive
        • Dropbox
        • Fichier
        • Filefabric
        • Ftp
        • Google Cloud Storage
        • Gphotos
        • Hdfs
        • Hidrive
        • Http
        • Internetarchive
        • Jottacloud
        • Koofr / Digi Storage
          • Digistorage
          • Koofr / Digi Storage
          • Other
        • ローカル
        • Mailru
        • Mega
        • Netstorage
        • Onedrive
        • Opendrive
        • Oos
          • Env_auth
          • Instance_principal_auth
          • No_auth
          • Resource_principal_auth
          • User_principal_auth
        • Pcloud
        • Premiumizeme
        • Putio
        • Qingstor
        • AWS S3 and compliant
          • Aws
          • Alibaba
          • Arvancloud
          • Ceph
          • Chinamobile
          • Cloudflare
          • Digitalocean
          • Dreamhost
          • Huaweiobs
          • Ibmcos
          • Idrive
          • Ionos
          • Liara
          • Lyvecloud
          • Minio
          • Netease
          • Other
          • Qiniu
          • Rackcorp
          • Scaleway
          • Seaweedfs
          • Stackpath
          • Storj
          • Tencentcos
          • Wasabi
        • Seafile
        • Sftp
        • Sharefile
        • Sia
        • Smb
        • Storj
          • 既存
          • 新規
        • Sugarsync
        • Swift
        • Uptobox
        • Webdav
        • Yandex
        • Zoho
      • 名前変更
    • Prep
      • 作成
      • リスト
      • 状態
      • 名前変更
      • ソースの添付
      • 出力の添付
      • 出力の解除
      • スキャンの開始
      • スキャンの一時停止
      • パックの開始
      • パックの一時停止
      • Daggenの開始
      • Daggenの一時停止
      • ピースのリスト
      • ピースの追加
      • エクスプローラー
      • ウォレットの添付
      • ウォレットのリスト
      • ウォレットの解除
  • 🌐Web APIリファレンス
    • 取引スケジュール
    • 取引
    • ファイル
    • ジョブ
    • ピース
    • 準備
    • ストレージ
    • ウォレット関連
    • ウォレット
    • 仕様
  • ❓FAQ
    • データベースがロックされています
Powered by GitBook
On this page

Was this helpful?

Edit on GitHub
  1. Web APIリファレンス

取引

Previous取引スケジュールNextファイル

Last updated 1 year ago

Was this helpful?

🌐
  • POSTList all deals
  • POSTSend a manual deal proposal

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
400
Bad Request
application/json
500
Internal Server Error
application/json
post
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
200
OK
application/json
400
Bad Request
application/json
500
Internal Server Error
application/json
post
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
}