目次
・API連携機能とは?
・API連携機能の使い方
STEP① 取引所からAPIキーを取得する
STEP② GtaxにAPIキーを入力してデータ連携
STEP③ 自動でデータを連携
・API連携とファイルアップロードの共存について
・API連携の解除方法
取引所API連携機能とは?
API連携とは、取引所から取得できるAPIキーをGtax側に入力することで、取引のデータを自動で同期することができるようになる機能です。
API連携を行うことで、仮想通貨取引所で行った取引のデータをGtaxが自動で読み取ることができるようになり、取引履歴を取得してアップロードするといった作業が必要なくなります。また、履歴のアップロード漏れも防ぐことができる点も大きなメリットです。
Gtaxは取引データの”参照”のみを行い、お預かりした取引所のAPIキーは暗号化をした上で、厳しいセキュリティ基準を設けて厳密に管理しております。
取引所API連携機能の使い方
API連携の手順は以下の3つのステップで完了します。
STEP① 取引所からAPIキーを取得する
記事を参考に、データ連携をしたい取引所からAPIキーを取得します。
APIキーは接続の際には必ずGtaxが指定するAPIキーを使用する、必ず参照のみの権限設定にする、APIキーを第三者へ共有しない等管理にご注意ください。
STEP② GtaxにAPIキーを入力してデータ連携
1.メニューより「データ取り込み」にカーソルを合わせ、「API連携-β版」をクリック
2.「新規登録」をクリックします。
3.API接続を希望する取引所を選択します。
※各取引所のAPIキーの取得方法は下記をご確認ください。
▶BitbankのAPIキー取得方法
4.取引所より取得したAPIキーを入力して送信。
※この際に取得したい履歴の取引種類を選択することが可能です。API送信後にこちらの設定を変更することはできず、再度設定し直していただくことになる点ご留意ください。
※ファイル経由でアップ済みの取引履歴がある場合は、最新の取引日時以降の履歴のみを取得し、二重計上を防止します。
5.ステータスが「同期成功」になっていることを確認できたらAPI連携完了です!
【重要】APIで取り込むことが可能な取引期間
API連携を行うと、連携を行った年の「前年の1月1日」から現在までの履歴が自動で同期されます。
例えば2022年12月1日にbitbankのAPI連携を行った場合、2021年1月1日以降の取引履歴がGtaxに自動で同期されます。このケースにおいて、2021年1月1日以前の取引履歴がある場合は、別途取引履歴ファイルをbitbankから取得し、Gtaxにアップロードする必要がありますのでご注意ください。
また、取引履歴ファイルをすでにアップロード済みの場合は、それ以降の取引履歴データをAPIで自動で取得します。
例えば、2022年3月31日までのbitbankの取引履歴をアップロード済みの状態で、2022年12月1日にAPI連携を行った場合は、3月31日以降の取引履歴データをAPIで自動で取得します。
STEP③ 自動でデータを連携
一度API連携の設定が完了してしまえば、あとはGtaxが自動で取引のデータを取得するので、履歴のアップロードなどの作業は必要ありません。
ただし同じ取引所でも、API対応していない履歴に関しては取引履歴をアップロードしていただく必要がありますのでご注意ください。
例えばbitbankでは、APIでのデータ連携は「現物売買履歴」にのみ対応しております。その他の「入出金履歴」「販売所履歴」に関しては、該当する取引を行なっている場合は履歴をアップロードしていただく必要があります。
■手動同期について
API連携機能では、定期的に自動で取引データの同期を行いますが、取引所ごとの「同期する」ボタンを押すことで手動で更新することもできます。API連携したすべての取引所を同期するときは「すべてを同期」で更新することができます。
API連携とファイルアップロードとの共存について
■API接続中
API連携している場合、取引履歴ファイルをアップロードすることができるのは、APIで同期した取引期間以前の取引のみになります。APIで同期済みの期間と重複する取引履歴をアップロードした場合、重複する部分は取り込まれません。
■API接続解除後
API連携を解除した場合、APIで取得した取引は削除されずそのまま残ります。API連携を解除後に取引履歴ファイルをアップロードすると、APIで同期していた期間以降の取引を取り込むことが可能です(重複する期間の履歴は取り込まれません)。
なお、APIで取得した取引を削除したい場合は、取引一覧の削除機能で削除してください。
API連携の解除方法
API連携ページにて、接続解除から「解除する」をクリックすれば完了です。