python-liquid-api-tths 0.4.0

Use Liquid API with Python

python_liquid_api_tths

API概要

このライブラリはLiquid APIのPrivate APIとPublic APIをPythonで扱うものです。

PyPI https://pypi.org/project/python-liquid-api-tths/

インストール

インストールにはコンソールで次のコマンドを実行します。

pip install python-liquid-api-tths

目次

1. Public API
   1-1. ローソク足(OHLCV)の生データを取得
   1-2. ローソク足(OHLCV)を取得
   1-3. 板情報の生データを取得
   1-4. 板情報の取得
   1-5. 約定データの生データを取得
   1-6. 約定データの取得
2. Private API
   2-1. 注文
   2-2. 注文のキャンセル
   2-3. 資産残高の取得
   2-4. 日本円残高の取得（廃止予定メソッド）
   2-5. 暗号資産残高の取得（廃止予定メソッド）

1. Public API

Public APIを使うにはLiquidPublicをインスタンス化します。引数は必要ありません。

from python_liquid_api.public_api import LiquidPublic
pub = LiquidPublic()

1-1. ローソク足(OHLCV)の生データを取得

ローソク足（OHLCVデータ）の生データを取得するにはget_candlestick_rawを使用します。

from python_liquid_api.public_api import LiquidPublic
pub = LiquidPublic()
ohlc = pub.get_candlestick_raw(currency_name, candle_type)

引数

• currency_name: 取得対象の通貨名を指定します。指定できる値は次の通りです。
  • btc: ビットコイン
  • eth: イーサリアム
  • xrp: リップル
  • bch: ビットコインキャッシュ
  • qash: キャッシュ
  • ltc: ライトコイン
  • bat: ベーシックアテンショントークン
• candle_type: 取得するローソク足のタイプを指定します。指定できる値は次の文字列です。
  • 1min: 1分足を取得
  • 5min: 5分足を取得
  • 15min: 15分足を取得
  • 30min: 30分足を取得
  • 1hour: 1時間足を取得

1-2. ローソク足(OHLCV)を取得

ローソク足（OHLCVデータ）を取得するにはget_candlestickを使用します。

from python_liquid_api.public_api import LiquidPublic
pub = LiquidPublic()
ohlc = pub.get_candlestick(currency_name, date, candle_type)

引数

• currency_name: 取得対象の通貨名を指定します。指定できる値は次の通りです。
  • btc: ビットコイン
  • eth: イーサリアム
  • xrp: リップル
  • bch: ビットコインキャッシュ
  • qash: キャッシュ
  • ltc: ライトコイン
  • bat: ベーシックアテンショントークン
• date: 取得対象の日付を指定します。フォーマットはyyyymmddの文字列です。
• candle_type: 取得するローソク足のタイプを指定します。指定できる値は次の文字列です。
  • 1min: 1分足を取得
  • 5min: 5分足を取得
  • 15min: 15分足を取得
  • 30min: 30分足を取得
  • 1hour: 1時間足を取得
• is_index_datetime: indexにdatetimeを設定する

返り値

• output_df: pandas.DataFrame型のOHLCVが格納されたデータです。列は次の通りです。
  • datetime: datatime型の日時(yyyy-mm-dd hh:mm:ss)
  • open: 始値
  • high: 高値
  • low: 低値
  • close: 終値
  • volume: 出来高

例外

• 通貨名が不正です。: 引数のcurrency_nameに指定できる通貨名以外を指定した場合に発生します。
• ローソク足のタイプが不正です。: 引数のcandle_typeに指定できる値以外を指定した場合に発生します。

1-3. 板情報の生データを取得

板情報を取得するにはget_order_book_rawを使用します。

from python_liquid_api.public_api import LiquidPublic
pub = LiquidPublic()
raw_data = pub.get_order_book_raw(currency_name)

引数

• currency_name: 取得対象の通貨名を指定します。指定できる値は次の通りです。
  • btc: ビットコイン
  • eth: イーサリアム
  • xrp: リップル
  • bch: ビットコインキャッシュ
  • qash: キャッシュ
  • ltc: ライトコイン
  • bat: ベーシックアテンショントークン

返り値

• raw_data: 板情報

例外

• 通貨名が不正です。: 引数のcurrency_nameに指定できる通貨名以外を指定した場合に発生します。

1-4. 板情報を取得

板情報を取得するにはget_order_bookを使用します。

from python_liquid_api.public_api import LiquidPublic
pub = LiquidPublic()
bid_df, ask_df, datetime_data = pub.get_order_book(currency_name)

引数

• currency_name: 取得対象の通貨名を指定します。指定できる値は次の通りです。
  • btc: ビットコイン
  • eth: イーサリアム
  • xrp: リップル
  • bch: ビットコインキャッシュ
  • qash: キャッシュ
  • ltc: ライトコイン
  • bat: ベーシックアテンショントークン

返り値

• bid_df: pandas.DataFrame型の売値データ
• ask_df: pandas.DataFrame型の買値データ
• datetime_data: datetime型の板情報取得日時

例外

• 通貨名が不正です。: 引数のcurrency_nameに指定できる通貨名以外を指定した場合に発生します。

1-5. 約定情報の生データを取得

約定情報を取得するにはget_executions_rawを使用します。

from python_liquid_api.public_api import LiquidPublic
pub = LiquidPublic()
raw_data, url = pub.get_executions_raw(currency_name, timestamp, max_data_num=1000, base_url=None)

引数

• currency_name: 取得対象の通貨名。指定できる値は次の通りです。
  • btc: ビットコイン
  • eth: イーサリアム
  • xrp: リップル
  • bch: ビットコインキャッシュ
  • qash: キャッシュ
  • ltc: ライトコイン
  • bat: ベーシックアテンショントークン
• timestamp: 取得対象のtimestamp
• max_data_num: 最大取得データ数
• base_url: 約定履歴を取得するURLのからtimestampを指定する部分を除いたURL。指定すると処理をいくつかスキップできます。

返り値

• raw_data: 約定履歴の生データ
• url: 約定履歴を取得するURLのからtimestampを指定する部分を除いたURL

1-6. 約定情報を取得

約定情報を取得するにはget_executionsを使用します。

from python_liquid_api.public_api import LiquidPublic
pub = LiquidPublic()
execution_df = pub.get_executions(currency_name, date, hour)

引数

• currency_name: 取得対象の通貨名。指定できる値は次の通りです。
  • btc: ビットコイン
  • eth: イーサリアム
  • xrp: リップル
  • bch: ビットコインキャッシュ
  • qash: キャッシュ
  • ltc: ライトコイン
  • bat: ベーシックアテンショントークン
• date: 取得対象の日付。フォーマットはyyyymmddの文字列
• hour: 取得対象の時間。フォーマットはhhの文字列

返り値

• out_df: pandas.DataFrame型の約定データ
  • quantity: 取引量
  • price: 取引価格
  • taker_size: taker側のside(buy/sell)
  • timestamp: 取引された時刻

2. Private API

Private APIを使うにはLiquidPrivateをインスタンス化します。

from python_liquid_api.private_api import LiquidPrivate
pri = LiquidPrivate(token_id, secret_key)

引数

• token_id: トークンID
• secret_key: APIトークン秘密鍵

2-1. 注文

現物取引の注文を出すにはcreate_orderを使用します。

from python_liquid_api.private_api import LiquidPrivate
pri = LiquidPrivate(token_id, secret_key)
order_info = pri.create_order(currency_name, side, amount, price=0.0, order_type="limit")

引数

• currency_name: 取得対象の通貨名。指定できる値は次の通りです。
  • btc: ビットコイン
  • eth: イーサリアム
  • xrp: リップル
  • bch: ビットコインキャッシュ
  • qash: キャッシュ
  • ltc: ライトコイン
  • bat: ベーシックアテンショントークン
• side: 売買の指定。指定できる値は次の通りです。
  • sell: 売り注文
  • buy: 買い注文
• amount: 注文量
• price: 注文単価
• order_type: 注文方法。指定できる値は次の通りです。
  • limit: 指値注文
  • market: 成行注文
  • stop: 逆指値注文

返り値

• output: 辞書型の注文情報です。
  • transaction_id: 取引ID
  • order_type: 注文方法(limit/market)
  • quantity: 注文量
  • price: 取引単価
  • side: 売買(sell/buy)
  • created_at: 登録日時
  • updated_at: 更新日時
  • currency: 取引通貨名

例外

• 通貨名が不正です。: 引数のcurrency_nameに指定できる通貨名以外を指定した場合に発生します。
• 注文にはbuyもしくはsellを指定してください。: 引数のsideに指定できる値以外を指定した場合に発生します。

2-2. 注文のキャンセル

注文をキャンセルするにはcancel_orderを使用します。

from python_liquid_api.private_api import LiquidPrivate
pri = LiquidPrivate(token_id, secret_key)
pri.cancel_order(order_id)

引数

• order_id: キャンセル対象の取引ID

2-3. 資産残高の取得

資産残高の取得をするにはget_asset_infoを使用します。

from python_liquid_api.private_api import LiquidPrivate
pri = LiquidPrivate(token_id, secret_key)
pri.get_asset_info(asset)

引数

• asset: 取得対象資産
  • jpy: 日本円
  • btc: ビットコイン
  • eth: イーサリアム
  • xrp: リップル
  • bch: ビットコインキャッシュ
  • qash: キャッシュ
  • ltc: ライトコイン
  • bat: ベーシックアテンショントークン

例外

• 通貨名が不正です。: 引数のcurrency_nameに指定できる通貨名以外を指定した場合に発生します。

2-4. 日本円残高の取得

! 廃止予定のメソッド get_asset_infoを使ってください。

日本円残高を取得するにはget_fiat_infoを使用します。

from python_liquid_api.private_api import LiquidPrivate
pri = LiquidPrivate(token_id, secret_key)
pri.get_fiat_info()

返り値

• balance: 利用可能残高
• reserved: ロック中残高

返り値

• balance: 利用可能残高
• reserved: ロック中残高

2-5. 暗号資産残高の取得

! 廃止予定のメソッド get_asset_infoを使ってください。 暗号資産残高を取得するにはget_crypto_infoを使用します。

from python_liquid_api.private_api import LiquidPrivate
pri = LiquidPrivate(token_id, secret_key)
pri.get_crypto_info(currency="btc")

引数

• currency_name: 取得対象の通貨名
  • btc: ビットコイン
  • eth: イーサリアム
  • xrp: リップル
  • bch: ビットコインキャッシュ
  • qash: キャッシュ
  • ltc: ライトコイン
  • bat: ベーシックアテンショントークン

返り値

• balance: 利用可能残高
• reserved: ロック中残高