Package: python-liquid-api-tths
python_liquid_api_tthsAPI概要このライブラリはLiquid APIのPrivate APIとPublic APIをPythonで扱うものです。PyPIhttps://pypi.org/project/python-liquid-api-tths/インストールインストールにはコンソールで次のコマンドを実行します。pipinstallpython-liquid-api-tths目次Public API1-1.ローソク足(OHLCV)の生データを取得1-2.ローソク足(OHLCV)を取得1-3.板情報の生データを取得1-4.板情報の取得1-5.約定データの生データを取得1-6.約定データの取得Private API2-1.注文2-2.注文のキャンセル2-3.資産残高の取得2-4.日本円残高の取得（廃止予定メソッド）2-5.暗号資産残高の取得（廃止予定メソッド）1.Public APIPublic APIを使うにはLiquidPublicをインスタンス化します。引数は必要ありません。frompython_liquid_api.public_apiimportLiquidPublicpub=LiquidPublic()1-1.ローソク足(OHLCV)の生データを取得ローソク足（OHLCVデータ）の生データを取得するにはget_candlestick_rawを使用します。frompython_liquid_api.public_apiimportLiquidPublicpub=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を使用します。frompython_liquid_api.public_apiimportLiquidPublicpub=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を使用します。frompython_liquid_api.public_apiimportLiquidPublicpub=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を使用します。frompython_liquid_api.public_apiimportLiquidPublicpub=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を使用します。frompython_liquid_api.public_apiimportLiquidPublicpub=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: 取得対象のtimestampmax_data_num: 最大取得データ数base_url: 約定履歴を取得するURLのからtimestampを指定する部分を除いたURL。指定すると処理をいくつかスキップできます。返り値raw_data: 約定履歴の生データurl: 約定履歴を取得するURLのからtimestampを指定する部分を除いたURL1-6.約定情報を取得約定情報を取得するにはget_executionsを使用します。frompython_liquid_api.public_apiimportLiquidPublicpub=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 APIPrivate APIを使うにはLiquidPrivateをインスタンス化します。frompython_liquid_api.private_apiimportLiquidPrivatepri=LiquidPrivate(token_id,secret_key)引数token_id: トークンIDsecret_key: APIトークン秘密鍵2-1.注文現物取引の注文を出すにはcreate_orderを使用します。frompython_liquid_api.private_apiimportLiquidPrivatepri=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: 取引IDorder_type: 注文方法(limit/market)quantity: 注文量price: 取引単価side: 売買(sell/buy)created_at: 登録日時updated_at: 更新日時currency: 取引通貨名例外通貨名が不正です。: 引数のcurrency_nameに指定できる通貨名以外を指定した場合に発生します。注文にはbuyもしくはsellを指定してください。: 引数のsideに指定できる値以外を指定した場合に発生します。2-2.注文のキャンセル注文をキャンセルするにはcancel_orderを使用します。frompython_liquid_api.private_apiimportLiquidPrivatepri=LiquidPrivate(token_id,secret_key)pri.cancel_order(order_id)引数order_id: キャンセル対象の取引ID2-3.資産残高の取得資産残高の取得をするにはget_asset_infoを使用します。frompython_liquid_api.private_apiimportLiquidPrivatepri=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を使用します。frompython_liquid_api.private_apiimportLiquidPrivatepri=LiquidPrivate(token_id,secret_key)pri.get_fiat_info()返り値balance: 利用可能残高reserved: ロック中残高返り値balance: 利用可能残高reserved: ロック中残高2-5.暗号資産残高の取得! 廃止予定のメソッド get_asset_infoを使ってください。暗号資産残高を取得するにはget_crypto_infoを使用します。frompython_liquid_api.private_apiimportLiquidPrivatepri=LiquidPrivate(token_id,secret_key)pri.get_crypto_info(currency="btc")引数currency_name: 取得対象の通貨名btc: ビットコインeth: イーサリアムxrp: リップルbch: ビットコインキャッシュqash: キャッシュltc: ライトコインbat: ベーシックアテンショントークン返り値balance: 利用可能残高reserved: ロック中残高