【API連携】bitFlyer Lightningの利用方法|Python編

【API連携】bitFlyer Lightningの利用方法|Python編

bitFlyerにはAPIという他のアプリケーションでも市場価格や自身の資産を閲覧したり取引を行うことが出来る機能があります。本記事ではbitFlyer APIを使った連携の方法について解説しています。


APIとは?

APIとは「Application Programming Interface(アプリケーション・プログラミング・インターフェイス)」の略語であり、「ある1つの機能に特化したプログラムで共有可能なもの」や「ソフトウェアの機能を共有する仕組み」のことです。

このAPIはしばしばWeb上に公開され、外部(Web)から呼び出して利用します。様々な分野・用途でAPIが公開されていますが、ほとんどが無料で利用することが可能です。

APIで出来ること

外部からWeb APIを利用する際は、一般的にそのAPIを提供する企業のWebサイトから利用登録を行った上でAPIキーを取得できるようになります。そしてURLにリクエストを送信すると、その企業側が提供する情報を取得できます。

bitFlyerで使える4つのAPI

bitFlyerからは以下の4つのAPIが公開されています。

  • bitFlyer Lightning
  • chainFlyer API
  • bitFlyer Lightning API Playground
  • Echo API

bitFlyer Lightning

bitFlyer LightningではHTTP APIとRealtime APIの2種類を提供しています。 

HTTP APIではbitFlyerが用意する様々なライブラリを用いて様々な情報を読み出せるAPIになります。Realtime APIとはWebSocketを使ったリアルタイムデータのAPIになっています。

chainFlyer API

ビットコインの動きをリアルタイムで視覚化したサービスになります。この視覚化はビットコインの取引の様子やマイニング状況を分かるようになっています。またビットコインの監査ツールというのもこちらで用意されています。

こちらのツールはマイナーの方向けのツールとしての色合いが強いでしょう。

bitFlyer Lightning API Playground

API PlaygroundではWebで自由にプログラムを記入することで、その場で結果を確認することが出来るAPI機能になります。

通常のAPIを使って開発を行う前に、テストやデバッグ機能として使うことが可能です。

Echo API

こちらは法人向けのサービスになります。このサービスの利用にあたっての導入手数料・売買手数料・API手数料の全てが無料となっています。

サービスの内容としては複数人へむけて少額のビットコインを送付できるというものになります。

API | 仮想通貨ビットコイン(Bitcoin)の購入/販売所/取引所 【bitFlyer(ビットフライヤー)】

https://bitflyer.com/ja-jp/api

bitFlyer(ビットフライヤー)では仮想通貨ビットコインを透明な価格で簡単に取引することができます。チャートで相場確認も可能。bitFlyerは皆様のビットコインに関するあらゆる取引をサポートし、ビットコインの普及に貢献します。

bitFlyer Lightningとは

bitFlyer Lightningで使えるAPI機能にはHTTP APIとRealtime APIの2種類が存在します。


この2つのAPIの違いは通信方式の違いによるものになります。HTTP APIはHTTPプロトコルを用いてクライアント(つまりここで言うと私達API利用者)がサーバ(ここで言う情報提供者:bitFlyer)に対して情報を提供するという仕組みになります。


また異なる手法としてWebSocketというプロトコルを用いたリアルタイムデータの取得もありますが、今回はHTTP APIについての説明をします。

HTTP APIの種類

bitFlyerが提供するHTTP APIはAPIキーによる認証が不要であるHTTP Public APIと認証が必要なHTTP Private APIに二分されます。

主に機能としては以下のように分類されます。

Public API
関数名 機能
marketsマーケットの一覧
board板情報を取得
tickertickerを取得
executions約定履歴の取得
getboardstate板の状態
gethealth取引所の状態
getchatsチャットの発言一覧
Private API
カテゴリ 関数名 機能
API getpermissionsAPIキーの権限を取得
資産 getbalance資産残高を取得
getcollateral証拠金の状態を取得
入出金 getaddresses預け入れ用アドレス取得
getcoinins仮想通貨預入履歴
getcoinouts仮想通貨送付履歴
getbankaccounts銀行口座一覧取得
getdeposits入金履歴
withdraw出金
getwithdrawals出金履歴
トレード sendchildorder新規注文を出す
cancelchildorder注文をキャンセルする
sendparentorder新規の親注文を出す(特殊注文)
cancelparentorder親注文をキャンセルする
cancelallchildorders全ての注文をキャンセルする
getchildorders注文の一覧を取得
getparentorders親注文の一覧を取得
getexecutions約定の一覧を取得
getbalancehistory残高履歴を取得
getcollateralhistory証拠金の変動履歴を取得
gettradingcommission取引手数料を取得

bitFlyer Lightningの利用方法

APIキーとシークレットキーを取得

それではここからは実際のbitFlyerのインターフェースを参考にAPIキー取得の流れを確認していきましょう。

まずはbitFlyerのホームページにジャンプし、インターフェース左にある「bitFlyer Lightning」をクリックしましょう。

通常のbitFlyerのホームページとは一転、bitFlyer Lightningでは下のような黒いインターフェースになります。

それでは画面左上の三本線のアイコンをクリックしましょう。

そうすると左側に様々なタブが表示されます。

そのタブの中から「API」をクリックして下さい。

そうするとbitFlyer LightningのAPI設定画面に推移します。

ここからAPI設定が可能になります。

では、画面下部の「新しいAPIキーを追加」をクリックします。

ここでAPI利用に関する注意事項が表示されます。

これを全て理解した上でチェックボックスを入れて下さい。しっかりとAPIを利用する上でのリスクは把握しておきましょう。

その後に「同意します」をクリックしましょう。

APIキーのラベルやこの発行するAPIキーの所有権限を付与します。


ご自身が取得したい情報にチェックを入れましょう。非常に多く入れすぎるとハッキングリスクが高くなることも考慮しましょう。

付与する権限を決めた後に「OK」をクリックしましょう。

そうするとbitFlyer LightningのAPI画面に設定したAPIキーが表示されます。

このAPIキーとAPIシークレットキーは厳重に保管しておくことをおすすめします。
特にシークレットキーは流出すると、ご自身のbitFlyer内の資産が流出する恐れがあります。


オンライン上やPCに保管するのではなく、紙に書き留めるなど少し工夫をした保管の方法をされることをオススメします。

APIキーの確認

先程のAPIの画面でAPIキーのシークレットキーの横にある「表示」をクリックするとシークレットキーが表示されます。

こちらからAPIキーとシークレットキーをメモなどにコピーしておきましょう。(ハッキングリスクに注意しましょう)

ライブラリのインストール

APIキーの取得が完了したら、次は公式のライブラリをインストールする必要があります。ターミナルウインドウ(Windowsではコマンドプロンプト)を起動して下のコマンドを入力しましょう。

$pip3 install bitflyer

これでライブラリインストールは完了です。

実際の情報の取得(ソースコード解説)

取引板の取得

ここからは実際のPythonの実行環境で記述したソースコードを書いておきます。下に記述しているコードをご自身の開発環境にコピーして下さい。

#bitFlyerのライブラリをインポート
import pybitflyer 

#APIキーの設定
api = pybitflyer.API(api_key="-----取得したAPIキー-----",
api_secret = "-----取得したシークレットキー------")

#取引板情報の取得
board = api.board(product_code="BTC_JPY")


print(board)

非常にシンプルなソースコードであるので説明はそこまで不要かと思います。アウトプットとして以下のように情報が出てきたら成功です。

価格情報の取得

#bitFlyerのライブラリをインポート
import pybitflyer 

#APIキーの設定
api = pybitflyer.API(api_key="-----取得したAPIキー-----",
api_secret = "-----取得したシークレットキー------") 

#ticker情報の取得
ticker = api.ticker(product_code="BTC_JPY")


print(ticker)
{"mid_price": 33320,
    "bids": [
    {
     "price": 30000,
    "size": 0.1
    },
    {
    "price": 25570,
    "size": 3
    }
  ],
  "asks": [
   {
   "price": 36640,
   "size": 5
   },
   {
   "price": 36700,
   "size": 1.2
  }
  ]
}

こちらもシンプルなソースコードなので説明は省略します。
アウトプットとして以下のような結果が得られると思います。

{
  "product_code": "BTC_JPY",
  "timestamp": "2015-07-08T02:50:59.97",
  "tick_id": 3579,
  "best_bid": 30000,
  "best_ask": 36640,
  "best_bid_size": 0.1,
  "best_ask_size": 5,
  "total_bid_depth": 15.13,
  "total_ask_depth": 20,
  "ltp": 31690,
  "volume": 16819.26,
  "volume_by_product": 6819.26
}

その他API連携解説記事

bitFlyer Lightning

BITPoint(ビットポイント)を使ったAPI連携方法を解説

https://ohmycrypto.news/articles/175

BITPoint(ビットポイント)にはAPIという他のアプリケーションでも市場価格や自身の資産を閲覧したり取引を行うことが出来る機能があります。本記事ではBITPoint上でのAPI連携の方法について解説しています。

bitbankで取得できる「API」とは? pythonを使った利用方法を解説!

https://ohmycrypto.news/articles/147

bitbankにはAPIという他のアプリケーションでも市場価格や自身の資産を閲覧したりbot取引を行うことが出来ます。本記事ではbitbank(ビットバンク)を使ったAPIの使い方について解説しています。

おわりに

今回はbitFlyerのAPI連携についての解説をしました。

bitFlyerでは比較的簡単にAPIのライブラリを使うことが可能なのでAPI入門の方には非常にオススメな取引所であると言えます。今回解説しきれなかった部分はbitFlyerのホームページに記載されていますので是非ご確認下さい。

ビットコイン取引所【bitFlyer Lightning】

https://lightning.bitflyer.com/docs

bitFlyer Lightning は、ビットコインの取引所です。お客様同士の需要と供給から価格が決定されます。円を売ってビットコインを買う、反対にビットコインを売って円に替えることもできます。FX(外国為替証拠金取引)での取引と似ています。

bitFlyer Playground

https://lightning.bitflyer.com/docs/playground#GETv1%2Fgetmarkets/javascript

bitFlyer Lightning は、ビットコインの取引所です。お客様同士の需要と供給から価格が決定されます。円を売ってビットコインを買う、反対にビットコインを売って円に替えることもできます。FX(外国為替証拠金取引)での取引と似ています。

おすすめ記事


この投稿のライター

OhMyCryptoNews編集部です。読者の皆様にとって価値ある情報を届けられるよう日々邁進致します。分散型取引所(DEX)に関する情報や海外取引所関連情報にアンテナを立てております。

関連する投稿


【API連携】CoincheckのAPI取得方法から機能まで徹底解説!

【API連携】CoincheckのAPI取得方法から機能まで徹底解説!

CoincheckはAPIを発行している仮想通貨取引所です。 仮想通貨の自動売買に興味がある方は知っておいて損はない情報ですので、是非ともこちらの記事を参考にAPIを利用してみてはいかがでしょうか。


GMOコインがAPIをリリース!?GMOコインで自動売買が可能に!

GMOコインがAPIをリリース!?GMOコインで自動売買が可能に!

GMOコインがAPIをリリースすることを発表しました。 APIが発行されたことによってGMOコインで自動売買が可能になります。


【セキュリティ】QUOREAは安全?|Liquidの取引APIの設定に注意

【セキュリティ】QUOREAは安全?|Liquidの取引APIの設定に注意

この記事では、今話題になっている仮想通貨自動売買ツール提供会社QUOREAのセキュリティやリスクについて解説します。


【手数料】BitFlyerの手数料と特徴3つ|マーケットメイクロジックを利用している人におすすめの理由

【手数料】BitFlyerの手数料と特徴3つ|マーケットメイクロジックを利用している人におすすめの理由

この記事では最近何かと話題になっているBitFlyerの手数料に関してご説明いたします。 BitFlyerの手数料は他の仮想通貨取引所に比べて高いのか安いのか詳しくご説明します。


【評判・口コミ】bitFlyerの特徴・メリット/デメリット・評判|注文が通りにくいはホント?

【評判・口コミ】bitFlyerの特徴・メリット/デメリット・評判|注文が通りにくいはホント?

bitFlyerは、2017年にはZaif・coincheckと並び日本三大取引所と呼ばれていました。現在でも資本金の大きさやユーザー数の多さから、日本最大の仮想通貨取引所となっています。この記事では bitFlyer はどういった取引所であるのか、取引所としてのメリットとデメリットどこにあるのかなどについて見ていきましょう。


最新の投稿


FXにおけるEAとは?【メリット・デメリットを含め徹底解説!】

FXにおけるEAとは?【メリット・デメリットを含め徹底解説!】

今回はFXにおけるEAについてご説明していきます。 EAとはどのようなことを指しているのか。 また、EAを用いることで出てくるメリットとデメリットを併せて解説していきます。


【口コミ・評判】TAOTAOの評判|Yahoo!がPayPayとTAOTAOに投資!

【口コミ・評判】TAOTAOの評判|Yahoo!がPayPayとTAOTAOに投資!

今回は新規仮想通貨取引所であるTAOTAOの評判についてご紹介いたします。 TAOTAOはYahoo!が出資している取引所ですが、利用者からはどのような評判を得ているのでしょうか。


30代で投資を始めるメリットや気をつけるポイントとは?

30代で投資を始めるメリットや気をつけるポイントとは?

30代は、20代よりも仕事を任されることも増え少しずつ収入が増えていく年代です。貯蓄も少しずつ増える反面、住宅ローンや子供の養育費など、大きな出費が控えているのもこの年代の特徴です。そんな30代から投資を始めるメリットや気をつけるポイントについて解説します。


【審査落ち多数!?】FUNDINNOの実績はどうなっているの?

【審査落ち多数!?】FUNDINNOの実績はどうなっているの?

こちらの記事では、投資型クラウドファンディングサービスを提供しているFUNDINNOの実績に関してご説明していきます。 クラウドファンディングや資産運用に興味がある方はぜひ参考にしてみてください。


COOLは怪しい?運営会社や実績から徹底解説!

COOLは怪しい?運営会社や実績から徹底解説!

こちらの記事では、ソーシャルレンディングサービスであるCOOLは怪しいのかということに関して、会社概要や実績からご説明していきます。 資産運用やクラウドファンディングに興味がある方は参考にしてみてください。


アイネットFX

仮想通貨自動売買ツール3選

  • 1. QUOREA

    【自動売買初心者にオススメ】料金は取引した分だけ。オリジナルのbotを作成して稼ぐこともできる。Liquidの取引所に対応

    関連記事を読む 公式サイト

  • 2. マネコ

    【トレーダーのランキング有り】レバレッジ取引でのアルトコイン取り扱い通貨種類国内No.1。気になる優秀なトレーダーの取引をそのままコピーできる。

    関連記事を読む 公式サイト

  • 3. CoinTrader

    【アプリから始められる】25種類のbot戦略を選べて、国内19の取引所で利用可能。対応取引所・通貨ペアの数が国内最大

    関連記事を読む 公式サイト

自動売買|bot取引|シストレの記事一覧