1. 共通情報

トレードAPIに共通する情報です。 パラメータなど、API個別の情報はそれぞれのページを参照してください。

1.1. 事前準備

取引APIを利用するには、アカウント情報のページ のページからAPI Keyの発行をおこなってください。

1.2. リクエスト方法

1.2.1. エンドポイント

https://api.zaif.jp/tapi

1.2.2. リクエスト種別

POST

1.2.3. 認証

取得したAPI Keysを利用して、下記のようにHTTPヘッダを設定し、認証情報を送信します。

キー 詳細 具体例
key APIキー 490f983a-5fab-49b2-b789-9d1f130874d3
sign 署名 詳細は下記

注釈

signはPOSTする全てのパラメータ(nonceとmethodおよびメソッド毎のパラメータ)を URLエンコードしたクエリ形式(param1=val1&param2=val2)のメッセージとして、Secret Keyを用いてHMAC-SHA512で署名します。

1.2.4. パラメータ

キー 詳細 具体例
nonce 1以上の数を実行都度増分して送信します 23123
method APIメソッド名 get_info

その他のメソッド毎の固有のパラメータも全てPOSTパラメータにて送信してください。

1.3. 戻り値

{
    "success": 1,
    "return": {
        ...
    }
}
キー 詳細
success 成功フラグ int
return 実行結果 dict or string

1.4. 補足

1.4.1. 戻り値

処理に成功した場合、successには1が、returnには実行結果が設定されます。
処理に失敗した場合、successには0が、returnにはエラーメッセージが設定されます。