APIエンドポイント

全てのAPIリクエストは、以下のAPIエンドポイントに送信してください:

https://api.cryptohopper.com/v1/

サポートされているリクエストメソッド

リクエストパラメータ

APIでは、パス、クエリ文字列、ヘッダー、リクエストボディの4種類の パラメーターを使ってるよ。リクエストボディ パラメーターは、POSTとPATCHリクエストのJSONリクエストボディに投稿されたデータさ。ヘッダー パラメーターは、ヘッダーに投稿する必要があるパラメーターだね。ヘッダー、パス、クエリ文字列パラメーターの詳細については、下に書いてあるから見てちょうだい。

ヘッダーパラメータ

APIへのリクエストはすべて、ヘッダーに以下の値をPOSTで認証する必要があるゾ。

• access-token - OAuth2認証にて、アクセストークンを受け取りました。

パスパラメータ

これらのパラメータは、エンドポイントの URI に指定されたものです。例えば、GET Hopper エンドポイントの場合：

https://api.cryptohopper.com/v1/hopper/{hopper_id}

トラディングボットをその固有IDで取得するには、{hopper_id} プレースホルダーのID値を置き換える必要があります。 例えば、IDが37のトラディングボットを取得するには、以下のURLをリクエストする必要があります。

https://api.cryptohopper.com/v1/hopper/37

一部のエンドポイントは複数のパラメータが必要です。 例えば、前回のホッパーから特定の注文を取得したい場合は、以下のURLを呼び出す必要があります。

https://api.cryptohopper.com/v1//hopper/{hopperId}/order/{orderId}

そして、ホッパーとオーダーIDをパラメーターに置き換えることで、以下のようになります。

https://api.cryptohopper.com/v1//hopper/37/order/231

APIエンドポイントに必要とされるパラメータの詳細なリストについては、APIリファレンスガイドを参照してください。

クエリ文字列パラメータ

データの絞り込みやページネーションのために、GETリクエストでこの種の引数を用いています。これらの引数はパスには指定されていませんが、URL文字列内で「&」記号で区切られた一連の値として指定されています。

例えば、取引ボットのビットコイン買い注文を取得するには、Hopper Orderエンドポイントをこう呼び出すことができる:

https://api.cryptohopper.com/v1/hopper/37/order/?order_type=buy&coin=btc
        

APIリファレンスを見れば分かるんだけど、この場合、order_typeパラメータは「buy」か「sell」のいずれか、そしてcoinパラメータは、小文字の仮想通貨コインコードなら何でもOKだってんだ。

応答形式

全てのレスポンスはJSONオブジェクト形式です。従って、我々のレスポンスで見られるMIMEタイプはapplication/jsonです。各リクエストとレスポンス本文の具体的なJSONレスポンス形式については、APIリファレンスドキュメントを参照してください。

HTTPレスポンスコード

我々 は、RFC 2616 と RFC 6585 規格で定義されたレスポンス ステータス コードを利用しているぞ。.

HTTPエラーコード

エラーメッセージ

APIがエラーコードを返した場合、エラーの説明を含むJSONオブジェクトをボディに添付します。エラーメッセージはこんな風になります。

{
            "status": 400,
            "error": 1,
            "message": "Missing required request parameters: [access_token]"
        }
        

レート制限

当社のAPIは、すべてのユーザーに帯域幅リソースを均等に割り当てるため、リクエストレート制限を設けています。現在のレート制限は、1秒あたりユーザー2リクエストです。ただし、買い注文の場合は、8秒ごとに1件の注文までとなります。

1秒あたりのリクエスト制限を超えると、429エラーレスポンスコードが返されます。レスポンスに添付されたRetry-Afterヘッダーを確認し、次のリクエストを実行できるまでの待機時間を確認してください。