Home

Websocket

Order Object

定数値

フレームワーク内で定義されている定数値です。

Order Type

注文形式。create_order()のtypeに指定する値です。

• LIMIT (limit)
  指値注文。priceで価格を指定してください。
• MARKET (market)
  成行注文。priceは不要です。

Order Side

注文の売り又は買い。create_order()のsideに指定する値です。

• BUY (buy)
  買い注文
• SELL (sell)
  売り注文

Order State

• OPEN (open)
• CLOSED (closed)
• CANCELED (canceled)
• WAIT_OPEN (wait_open)
• WAIT_CANCEL (wait_cancel)

Order Event

• EVENT_EXECUTION (execution)
• EVENT_OPEN (open)
• EVENT_OPEN_FAILED (open_failed)
• EVENT_CANCEL_FAILED (cancel_failed)
• EVENT_CLOSE (close)
• EVENT_ERROR (error)

プロジェクト構成

• bin – 実行ファイル
• botfw – フレームワーク本体: 取引所共通部分のディレクトリ(base)、取引所毎のディレクトリ(bitflyer, bitmex, ...)、etc
• samples – 実行可能なサンプルプログラム
• test – TODO

コーディングのスタイルとポリシー

• 多少コードが冗長になる場合でも、基本的には設計上の正しさを優先します。

• フレームワーク部分（botfw）については以下の規則を適用します。

  • pep8に準拠。ただし__init__.pyは例外
  • コメントを含めて英語(askiiコードのみ)で記述。それ以外のsampleやgitログ等は自由。

• メソッド名や引数の変数名とその順序、また定数変数（全部大文字の変数）の内部値は可能な限りccxtと揃えます。

  • 'FX_BTC_JPY'(bitflyer) -> 'FX_BTC_JPY'(ccxt)
  • 'BTC_JPY(bitflyer) -> 'BTC/JPY'(ccxt)
  • 'BUY'(bitflyer), 'Buy'(bitmex), 'BUY'(binance) -> 'buy'(ccxt)
  • 'LIMIT'(bitflyer), 'Limit'(bitmex), 'LIMIT'(binance) -> 'limit'(ccxt)

• メソッド名の英単語は省略しませんが、変数名、及び引数名は意味の分かる範囲内で自由に省略します。

• 日本語部分（サンプルコード、README）を含め、全角スペース全面禁止