Skip to content

Commit

Permalink
ZAIF-9664 呼び出し制限に関する注釈追加
Browse files Browse the repository at this point in the history
  • Loading branch information
@zaifdotjp
zaifdotjp committed Mar 31, 2022
1 parent 5ffd7db commit 75e4d35
Show file tree
Hide file tree
Showing 2 changed files with 65 additions and 13 deletions.
36 changes: 30 additions & 6 deletions docs/MarginTradingAPI.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -196,10 +196,14 @@ guard_fee 追証ガード手数料 float
```

#### 補足
* 呼び出しは60秒間に10回以下におさまるようにしてください。呼び出しが多すぎるとアクセス拒否されることがあります。
* 呼び出しは60秒間に10回以下におさまるようにしてください。呼び出しが多すぎるとアクセス拒否されることがあります。（※）
* “since”もしくは”end”をセットした場合、”order”は強制的に”ASC”となります。
* “from_id”もしくは”end_id”をセットした場合、”order”は強制的に”ASC”となります。

``` note::
※ 呼び出しの回数制限を解除するためには、当社の定めた条件(一定基準以上の取引高など)に基づく審査が必要になります。
```

------------------------------------------------------------------------------------------------------------------------

### ユーザー自身の取引履歴明細を取得
Expand Down Expand Up @@ -273,9 +277,13 @@ order not found 注文が見つかりません
```

#### 補足
* 呼び出しは60秒間に10回以下におさまるようにしてください。呼び出しが多すぎるとアクセス拒否されることがあります。
* 呼び出しは60秒間に10回以下におさまるようにしてください。呼び出しが多すぎるとアクセス拒否されることがあります。（※）
* leverage_idは[ユーザー自身の取引履歴](#id10)または[未約定注文一覧](#id19)で取得できます。

``` note::
※ 呼び出しの回数制限を解除するためには、当社の定めた条件(一定基準以上の取引高など)に基づく審査が必要になります。
```

------------------------------------------------------------------------------------------------------------------------

### 未約定注文一覧の取得
Expand Down Expand Up @@ -341,7 +349,11 @@ deposit_price_xxx デポジット時計算レート(xxxは通貨コード）
```

#### 補足
* 呼び出しは10秒間に20回以下におさまるようにしてください。呼び出しが多すぎるとアクセス拒否されることがあります。
* 呼び出しは10秒間に20回以下におさまるようにしてください。呼び出しが多すぎるとアクセス拒否されることがあります。（※）

``` note::
※ 呼び出しの回数制限を解除するためには、当社の定めた条件(一定基準以上の取引高など)に基づく審査が必要になります。
```

------------------------------------------------------------------------------------------------------------------------

Expand Down Expand Up @@ -412,7 +424,7 @@ insufficient funds 取引に必要な残高が存
```

#### 補足
* 呼び出しは10秒間に3回以下におさまるようにしてください。呼び出しが多すぎるとアクセス拒否されることがあります。
* 呼び出しは10秒間に3回以下におさまるようにしてください。呼び出しが多すぎるとアクセス拒否されることがあります。（※）

* パラメータ limitについて

Expand All @@ -436,6 +448,10 @@ insufficient funds 取引に必要な残高が存

btc_jpy : 0.0001BTC単位

``` note::
※ 呼び出しの回数制限を解除するためには、当社の定めた条件(一定基準以上の取引高など)に基づく審査が必要になります。
```

------------------------------------------------------------------------------------------------------------------------


Expand Down Expand Up @@ -497,7 +513,7 @@ trade temporarily unavailable 取引が一時的に停止さ
```

#### 補足
* 呼び出しは10秒間に3回以下におさまるようにしてください。呼び出しが多すぎるとアクセス拒否されることがあります。
* 呼び出しは10秒間に3回以下におさまるようにしてください。呼び出しが多すぎるとアクセス拒否されることがあります。（※）


* パラメータ limitについて
Expand Down Expand Up @@ -528,6 +544,10 @@ trade temporarily unavailable 取引が一時的に停止さ

* leverage_idは[ユーザー自身の取引履歴](#id10)または[未約定注文一覧](#id19)で取得できます。

``` note::
※ 呼び出しの回数制限を解除するためには、当社の定めた条件(一定基準以上の取引高など)に基づく審査が必要になります。
```

------------------------------------------------------------------------------------------------------------------------

### 注文の取消し
Expand Down Expand Up @@ -594,5 +614,9 @@ order is too new 注文から一定時間の経
```

#### 補足
* 呼び出しは10秒間に3回以下におさまるようにしてください。呼び出しが多すぎるとアクセス拒否されることがあります。
* 呼び出しは10秒間に3回以下におさまるようにしてください。呼び出しが多すぎるとアクセス拒否されることがあります。（※）
* leverage_idは[ユーザー自身の取引履歴](#id10)または[未約定注文一覧](#id19)で取得できます。

``` note::
※ 呼び出しの回数制限を解除するためには、当社の定めた条件(一定基準以上の取引高など)に基づく審査が必要になります。
```
42 changes: 35 additions & 7 deletions docs/TradingAPI.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -183,7 +183,7 @@ server_time UNIX時間で換算された日本時間 int
```

#### 補足
* 呼び出しは10秒間に10回以下におさまるようにしてください。呼び出しが多すぎるとアクセス拒否されることがあります。
* 呼び出しは10秒間に10回以下におさまるようにしてください。呼び出しが多すぎるとアクセス拒否されることがあります。（※）

* deposit算出方法

Expand All @@ -193,6 +193,11 @@ server_time UNIX時間で換算された日本時間 int

* 取得できる情報は、APIを実行した時点のものになります。

``` note::
※ 呼び出しの回数制限を解除するためには、当社の定めた条件(一定基準以上の取引高など)に基づく審査が必要になります。
```


------------------------------------------------------------------------------------------------------------------------

### 残高情報(軽量)の取得
Expand Down Expand Up @@ -252,7 +257,7 @@ server_time UNIX時間で換算された日本時間 int
```

#### 補足
* 呼び出しは10秒間に20回以下におさまるようにしてください。呼び出しが多すぎるとアクセス拒否されることがあります。
* 呼び出しは10秒間に20回以下におさまるようにしてください。呼び出しが多すぎるとアクセス拒否されることがあります。（※）

* deposit算出方法

Expand All @@ -262,6 +267,10 @@ server_time UNIX時間で換算された日本時間 int

* 取得できる情報は、APIを実行した時点のものになります。

``` note::
※ 呼び出しの回数制限を解除するためには、当社の定めた条件(一定基準以上の取引高など)に基づく審査が必要になります。
```

------------------------------------------------------------------------------------------------------------------------

### チャット情報の取得
Expand Down Expand Up @@ -405,14 +414,18 @@ is_token No カウンターパーティトークンかどうか b


#### 補足
* 呼び出しは60秒間に12回以下におさまるようにしてください。呼び出しが多すぎるとアクセス拒否されることがあります。
* 呼び出しは60秒間に12回以下におさまるようにしてください。呼び出しが多すぎるとアクセス拒否されることがあります。（※）

* “since”もしくは”end”をセットした場合、”order”は強制的に”ASC”となります。

* “from_id”もしくは”end_id”をセットした場合、”order”は強制的に”ASC”となります。

* “currency_pair”と”is_token”の両方を指定した場合は”currency_pair”が優先されます。両方指定しない場合はカウンターパーティトークン以外の情報を取得します。

``` note::
※ 呼び出しの回数制限を解除するためには、当社の定めた条件(一定基準以上の取引高など)に基づく審査が必要になります。
```

------------------------------------------------------------------------------------------------------------------------
```eval_rst
.. active_orders:
Expand Down Expand Up @@ -497,8 +510,11 @@ is_token_bothがtrueの時は下記
```

#### 補足
* 呼び出しは5秒間に10回以下におさまるようにしてください。呼び出しが多すぎるとアクセス拒否されることがあります。
* 呼び出しは5秒間に10回以下におさまるようにしてください。呼び出しが多すぎるとアクセス拒否されることがあります。（※）

``` note::
※ 呼び出しの回数制限を解除するためには、当社の定めた条件(一定基準以上の取引高など)に基づく審査が必要になります。
```

------------------------------------------------------------------------------------------------------------------------
```eval_rst
Expand Down Expand Up @@ -567,7 +583,7 @@ insuffcient funds 取引に必要な残高が存
```

#### 補足
* 呼び出しは10秒間に9回以下におさまるようにしてください。呼び出しが多すぎるとアクセス拒否されることがあります。
* 呼び出しは10秒間に9回以下におさまるようにしてください。呼び出しが多すぎるとアクセス拒否されることがあります。（※）

* パラメータ limitについて

Expand All @@ -587,6 +603,10 @@ insuffcient funds 取引に必要な残高が存
適切な価格や数量は現物公開APIの[通貨ペア情報](PublicAPI.html#id12)で取得できます。
通貨ペアごとに適切な価格や数量の最低量や単位は変わりますので、ご注意ください

``` note::
※ 呼び出しの回数制限を解除するためには、当社の定めた条件(一定基準以上の取引高など)に基づく審査が必要になります。
```

------------------------------------------------------------------------------------------------------------------------

### 注文の取消し
Expand Down Expand Up @@ -790,12 +810,16 @@ txid トランザクションID str
```

#### 補足
* 呼び出しは60秒間に10回以下におさまるようにしてください。呼び出しが多すぎるとアクセス拒否されることがあります。
* 呼び出しは60秒間に10回以下におさまるようにしてください。呼び出しが多すぎるとアクセス拒否されることがあります。（※）

* “since”もしくは”end”をセットした場合、”order”は強制的に”ASC”となります。

* “from_id”もしくは”end_id”をセットした場合、”order”は強制的に”ASC”となります。

``` note::
※ 呼び出しの回数制限を解除するためには、当社の定めた条件(一定基準以上の取引高など)に基づく審査が必要になります。
```

------------------------------------------------------------------------------------------------------------------------

### 出金履歴の取得
Expand Down Expand Up @@ -865,10 +889,14 @@ vasp_timestamp VASP情報登録日時 UNIX_TIMESTAMP
```

#### 補足
* 呼び出しは60秒間に10回以下におさまるようにしてください。呼び出しが多すぎるとアクセス拒否されることがあります。
* 呼び出しは60秒間に10回以下におさまるようにしてください。呼び出しが多すぎるとアクセス拒否されることがあります。（※）

* “since”もしくは”end”をセットした場合、”order”は強制的に”ASC”となります。

* “from_id”もしくは”end_id”をセットした場合、”order”は強制的に”ASC”となります。

* “kind“、“beneficiary_name“、“vasp_name“、“vasp_timestamp“は2022年4月1日より取得可能となります。

``` note::
※ 呼び出しの回数制限を解除するためには、当社の定めた条件(一定基準以上の取引高など)に基づく審査が必要になります。
```

0 comments on commit 75e4d35

Please sign in to comment.