評価項目
| ドキュメント | APIに指定するパラメータやレスポンスの内容が簡潔に記載されている。
エンドポイントが共通仕様でメソッドと分けられて表示されているため当てはめて使用する必要がある。 Private APIの呼び出しには認証が必要だが、Keyの取得方法もリンク付きで説明されている。ページ形式や2段階認証、制限等についての記述もあるため親切である。 パラメータの指定については1つはマーケット一覧のレスポンスから取得したものを入力するようことのみが記述されていて少々不親切に感じため、パラメータ一覧があると尚良い。また、概要説明の情報量を増やすと尚良いと考える。 |
|---|---|
| 使いやすさ | パラメータの種類は少ないため扱いやすい。データ量も板情報が長文化することをのぞいて多すぎず簡潔で見やすくまとまっている。しかし、パラメータに入力する情報の1つはマーケット一覧のレスポンスから取得しなければならないため少々手間がかかる。 また、Private APIの利用には認証が必要になるため多少手間がかかる。 |
| データの中身 | ドキュメントのレスポンスはJSONで記載されているがレスポンス形式に関しての記述は特になく、XMLやHTMLでも確認できた。 データの内容は充実していて、情報量についてはレスポンスに含まれる分で十分である。 |
| 価格 | 無料 |
| サポート体制 | 問い合わせに関してはドキュメント内には説明がなく、ページ下部のフッターにリンクが用意されている。サポートページではキーワード検索できるFAQや電話窓口、お問い合わせフォームの記述があり充実している。 API自体に不明な点が特にないため問題ない。 |
| 開始しやすさ | 別ページだが本番環境が用意されていて開始しやすい。 Public APIは利用にあたりアカウント登録が不要で、特に難しい項目や手順、審査などはないため、すぐに利用できる。 Private APIの利用にはbitFlyer Lightningが利用可能なアカウントクラスである必要があり、認証が必要になるため多少手間がかかる。 |
API概要
| API名 | bitFlyer Lightning HTTP API |
|---|---|
| APlbank ASID | 172 |
| テスト可否 | 否 |
| カテゴリ | 金融 |
| 概要 | HTTP API は、API キーによる認証が不要な HTTP Public API と、 認証が必要な HTTP Private API に分けられ、情報の取得やトレードを外部のプログラムから行えます。 |
| 公式URL | https://lightning.bitflyer.com |
| APIフォーマット | REST。URLパラメーターを指定するタイプ。 |
| レスポンス形式 | JSON(XML,HTML) |
| SDK/ライブラリ | 用意なし（そもそも不要） |
| テスト環境 | なし(本番環境あり) |
| APIbankのレスポンスタイム | － |
総合評価コメント
bitFlyer Lightningの取引所の公開情報の取得や、トレードを外部のプログラムから行うためのAPI。product_codeやページ形式を指定することで各種データを取得することが可能である。
APIの詳細についてのドキュメントは簡潔で分かりやすく、取得できるデータも充実していて使いやすいAPIとなっている。 レスポンスはドキュメントではJSON形式で表示されているがXMLやHTMLでも確認できた。
public APIを利用するにはアカウント登録は不要で、APIのテストページは本番環境が用意されているため、実際に使用することも可能である。Private APIの利用にはbitFlyer Lightningが利用可能なアカウントクラスである必要があり認証が必要になるが、ドキュメントにある説明で十分に感じる。サポート体制も充実していた。
しかし、パラメータに入力する情報の1つはマーケット一覧のレスポンスから取得しなければならない点が不便である。
また、APIについての概要説明等が不足しているように感じ、ドキュメントに改善の余地があると考え、総合評価は8点とした。