package bitflyer

  1. Overview
  2. Docs
OCaml client for the bitFlyer cryptocurrency exchange API

Install

dune-project
 Dependency

Authors

Maintainers

Sources

v1.0.0.tar.gz
md5=1602aa488bf83ec24f8ff173cc5afbd3
sha512=c0d5cd489b07a16ae693ee8e6454470d63eeae1ce89cf44711b28adc3a96caef81b8669adba47b78d0a2f04313fccb47db5d910cfa1e6020e6a8c5840d94ad15

doc/README.html

Bitflyer API from OCaml

Builds, tests & co

Example of use

demo.gif

API実装状況

公式APIドキュメントに基づく実装状況一覧です。

HTTP Public API

API

エンドポイント

状態

実装

マーケットの一覧

GET /v1/getmarkets, /v1/markets

PublicApi.getmarkets, PublicApi.markets

板情報

GET /v1/getboard, /v1/board

PublicApi.getboard, PublicApi.board

Ticker

GET /v1/getticker, /v1/ticker

PublicApi.getticker, PublicApi.ticker

約定履歴

GET /v1/getexecutions, /v1/executions

PublicApi.getexecutions, PublicApi.executions

板の状態

GET /v1/getboardstate

PublicApi.getboardstate

取引所の状態

GET /v1/gethealth

PublicApi.gethealth

ファンディングレート

GET /v1/getfundingrate

PublicApi.getfundingrate

ファンディングレート履歴

GET /v1/getfundingratehistory

PublicApi.getfundingratehistory

法人アカウント最大レバレッジ

GET /v1/getcorporateleverage

PublicApi.getcorporateleverage

チャット

GET /v1/getchats

PublicApi.getchats

HTTP Private API — API

API

エンドポイント

状態

実装

APIキーの権限を取得

GET /v1/me/getpermissions

PrivateApi.getpermissions

HTTP Private API — 資産

API

エンドポイント

状態

実装

資産残高を取得

GET /v1/me/getbalance

PrivateApi.getbalance

証拠金の状態を取得

GET /v1/me/getcollateral

PrivateApi.getcollateral

証拠金の数量(通貨別)を取得

GET /v1/me/getcollateralaccounts

PrivateApi.getcollateralaccount

HTTP Private API — 入出金

API

エンドポイント

状態

実装

預入用アドレス取得

GET /v1/me/getaddresses

PrivateApi.getaddresses

仮想通貨預入履歴

GET /v1/me/getcoinins

PrivateApi.getcoinins

仮想通貨送付履歴

GET /v1/me/getcoinouts

PrivateApi.getcoinouts

銀行口座一覧取得

GET /v1/me/getbankaccounts

PrivateApi.getbankaccounts

入金履歴

GET /v1/me/getdeposits

PrivateApi.getdeposits

出金

POST /v1/me/withdraw

⚠️

PrivateApi.withdraw(実弾での動作確認は未実施)

出金履歴

GET /v1/me/getwithdrawals

PrivateApi.getwithdrawals

HTTP Private API — トレード

API

エンドポイント

状態

実装

新規注文を出す

POST /v1/me/sendchildorder

PrivateApi.sendchildorder

注文をキャンセルする

POST /v1/me/cancelchildorder

PrivateApi.cancelchildorder

新規の親注文を出す(特殊注文)

POST /v1/me/sendparentorder

PrivateApi.sendparentorder

親注文をキャンセルする

POST /v1/me/cancelparentorder

PrivateApi.cancelparentorder

すべての注文をキャンセルする

POST /v1/me/cancelallchildorders

PrivateApi.cancelallchildorders

注文の一覧を取得

GET /v1/me/getchildorders

PrivateApi.getchildorders

親注文の一覧を取得

GET /v1/me/getparentorders

PrivateApi.getparentorders

親注文の詳細を取得

GET /v1/me/getparentorder

PrivateApi.getparentorder

約定の一覧を取得

GET /v1/me/getexecutions

PrivateApi.getexecutions

残高履歴を取得

GET /v1/me/getbalancehistory

PrivateApi.getbalancehistory

建玉の一覧を取得

GET /v1/me/getpositions

PrivateApi.getpositions(信用(FX_BTC_JPY)取引のポジション確認に使用)

証拠金の変動履歴を取得

GET /v1/me/getcollateralhistory

PrivateApi.getcollateralhistory

取引手数料を取得

GET /v1/me/gettradingcommission

PrivateApi.gettradingcommissioncommision誤記を修正済み)

Realtime API (WebSocket)

チャンネル

状態

実装

Ticker (lightning_ticker_<product_code>)

Realtime.updatesTicker of PublicApi.ticker

板情報 (lightning_board_snapshot_<product_code>, lightning_board_<product_code>)

Realtime.updatesBoard of Realtime.orderbook。差分を内部で積算し常に最新の板状態を返す)

約定 (lightning_executions_<product_code>)

Realtime.execution_updates

チャイルドオーダー・親注文イベント (child_order_events, parent_order_events)

⚠️

Realtime.child_order_events, Realtime.parent_order_events(WS認証を含め実際のAPIキーでの動作確認は未実施)

既知の制約:

  • 接続を明示的に閉じる手段は未実装(ストリームの消費をやめても裏の接続は残る)
  • 発注条件を満たす間は毎回発注する仕様(連続発注の抑制なし)

レートリミッター

API制限に基づき、ApiCommonが全てのHTTPリクエストに自動で流量制限をかけます(RateLimiterモジュール、スライディングウィンドウ方式)。上限に達した場合は例外を投げずに、枠が空くまで自動的に待機してから送信します。

対象

上限

適用範囲

全リクエスト共通

500回 / 5分

ApiCommon.get_public, get, post すべて

注文系エンドポイント

300回 / 5分

sendchildorder, sendparentorder, cancelallchildorders

「数量0.1以下の注文は1分間で100回まで」という注文内容に依存する制限は、注文サイズを解釈する必要があるため未対応です。