Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
870 lines (691 sloc) 25.3 KB

English

Table of Contents generated with DocToc

Private REST API一覧 (2019-09-27)

API 概要

  • エンドポイント URL: https://api.bitbank.cc/v1
  • リクエストに不正がある場合、以下のようなエラーレスポンスを返します。
{
  "success": 0,
  "data": {
    "code": 20003
  }
}
  • エラーコードの一覧は errors_JP.md を確認してください。
  • GETエンドポイントの場合、パラメータをクエリー文字列として送信してください。
  • POSTエンドポイントの場合、リクエストヘッダContent-Typeapplication/jsonで、リクエストボディにデータを記述してください。

認証

  • パブリックAPIは認証情報無しでアクセスできます。プライベートAPIでは以下の情報をHTTPリクエストヘッダーに付与してリクエストを行う必要があります。

    • ACCESS-KEY : APIキーページで取得したAPIキー。
    • ACCESS-NONCE : 整数値。リクエスト毎に数を増加させる必要があります。通常はUNIXタイムスタンプを使用してください。
    • ACCESS-SIGNATURE : 以下に記述する署名を指定します。
  • 署名作成は、以下の文字列を HMAC-SHA256 形式でAPIシークレットキーを使って署名した結果となります。

    • GETの場合: 「ACCESS-NONCE、リクエストのパス、クエリパラメータ」 を連結させたもの
    • POSTの場合: 「ACCESS-NONCE、リクエストボディのJson文字列」 を連結させたもの

※ GETのACCESS-SIGNATUREで使用する「リクエストのパス」には"/v1"も含める必要があります。

※ POSTではパラメータをJson文字列にしてリクエストボディに含める必要があります。

エンドポイント一覧

アセット

アセット一覧を返す

GET /user/assets

Parameters: None

Response:

Name Type Description
asset string アセット名: jpy,btc, xrp, ltc, eth, mona, bcc
free_amount string 利用可能な量
amount_precision number 精度
onhand_amount string 保有量
locked_amount string ロックされている量
withdrawal_fee string or { under: string, over: string, threshold:string } for jpy 引き出し手数料
stop_deposit boolean 入金ステータス
stop_withdrawal boolean 出金ステータス

サンプルコード:

Curl

export API_KEY=___your api key___
export API_SECRET=___your api secret___
export ACCESS_NONCE="$(date +%s)"
export ACCESS_SIGNATURE="$(echo -n "$ACCESS_NONCE/v1/user/assets" | openssl dgst -sha256 -hmac "$API_SECRET")"

curl -H 'ACCESS-KEY:'"$API_KEY"'' -H 'ACCESS-NONCE:'"$ACCESS_NONCE"'' -H 'ACCESS-SIGNATURE:'"$ACCESS_SIGNATURE"'' https://api.bitbank.cc/v1/user/assets

レスポンスのフォーマット:

{
  "success": 1,
  "data": {
    "assets": [
      {
        "asset": "string",
        "free_amount": "string",
        "amount_precision": 0,
        "onhand_amount": "string",
        "locked_amount": "string",
        "withdrawal_fee": "string",
        "stop_deposit": false,
        "stop_withdrawal": false,
      },
      {
        "asset": "jpy",
        "free_amount": "string",
        "amount_precision": 0,
        "onhand_amount": "string",
        "locked_amount": "string",
        "withdrawal_fee": {
            "under": "string",
            "over": "string",
            "threshold": "string"
        },
        "stop_deposit": false,
        "stop_withdrawal": false,
    },
    ]
  }
}

注文情報

注文情報を取得する

GET /user/spot/order

Parameters:

Name Type Mandatory Description
pair string YES 通貨ペア: btc_jpy, xrp_jpy, ltc_btc, eth_btc, mona_jpy, mona_btc, bcc_jpy, bcc_btc
order_id number YES 取引ID

Response:

Name Type Description
order_id number 取引ID
pair string 通貨ペア: btc_jpy, xrp_jpy, ltc_btc, eth_btc, mona_jpy, mona_btc, bcc_jpy, bcc_btc
side string buy または sell
type string limit または market
start_amount string 注文時の数量
remaining_amount string 未約定の数量
executed_amount string 約定済み数量
price string 注文価格
average_price string 平均約定価格
ordered_at number 注文日時(UnixTimeのミリ秒)
status string 注文ステータス: UNFILLED 注文中, PARTIALLY_FILLED 注文中(一部約定), FULLY_FILLED 約定済み, CANCELED_UNFILLED 取消済, CANCELED_PARTIALLY_FILLED 取消済(一部約定)

レスポンスのフォーマット:

{
  "success": 1,
  "data": {
    "order_id": 0,
    "pair": "string",
    "side": "string",
    "type": "string",
    "start_amount": "string",
    "remaining_amount": "string",
    "executed_amount": "string",
    "price": "string",
    "average_price": "string",
    "ordered_at": 0,
    "status": "string"
  }
}

新規注文を行う

POST /user/spot/order

Parameters(requestBody):

Name Type Mandatory Description
pair string YES 通貨ペア: btc_jpy, xrp_jpy, ltc_btc, eth_btc, mona_jpy, mona_btc, bcc_jpy, bcc_btc
amount string YES 注文量
price string NO 価格
side string YES buy または sell
type string YES limit または market

Response:

Name Type Description
order_id number 取引ID
pair string 通貨ペア: btc_jpy, xrp_jpy, ltc_btc, eth_btc, mona_jpy, mona_btc, bcc_jpy, bcc_btc
side string buy または sell
type string limit または market
start_amount string 注文時の数量
remaining_amount string 未約定の数量
executed_amount string 約定済み数量
price string 注文価格
average_price string 平均約定価格
ordered_at number 注文日時(UnixTimeのミリ秒)
status string 注文ステータス: UNFILLED 注文中, PARTIALLY_FILLED 注文中(一部約定), FULLY_FILLED 約定済み, CANCELED_UNFILLED 取消済, CANCELED_PARTIALLY_FILLED 取消済(一部約定)

サンプルコード:

Curl

export API_KEY=___your api key___
export API_SECRET=___your api secret___
export ACCESS_NONCE="$(date +%s)"
export REQUEST_BODY='{"pair": "xrp_jpy", "price": "20", "amount": "1","side": "buy", "type": "limit"}'
export ACCESS_SIGNATURE="$(echo -n "$ACCESS_NONCE$REQUEST_BODY" | openssl dgst -sha256 -hmac "$API_SECRET")"

curl -H 'ACCESS-KEY:'"$API_KEY"'' -H 'ACCESS-NONCE:'"$ACCESS_NONCE"'' -H 'ACCESS-SIGNATURE:'"$ACCESS_SIGNATURE"'' -H "Content-Type: application/json" -d ''"$REQUEST_BODY"'' https://api.bitbank.cc/v1/user/spot/order

レスポンスのフォーマット:

{
  "success": 1,
  "data": {
    "order_id": 0,
    "pair": "string",
    "side": "string",
    "type": "string",
    "start_amount": "string",
    "remaining_amount": "string",
    "executed_amount": "string",
    "price": "string",
    "average_price": "string",
    "ordered_at": 0,
    "status": "string"
  }
}

注文をキャンセルする

POST /user/spot/cancel_order

Parameters(requestBody):

Name Type Mandatory Description
pair string YES 通貨ペア: btc_jpy, xrp_jpy, ltc_btc, eth_btc, mona_jpy, mona_btc, bcc_jpy, bcc_btc
order_id number YES 注文ID

Response:

Name Type Description
order_id number 注文ID
pair string 通貨ペア: btc_jpy, xrp_jpy, ltc_btc, eth_btc, mona_jpy, mona_btc, bcc_jpy, bcc_btc
side string buy または sell
type string limit または market
start_amount string 注文時の数量
remaining_amount string 未約定の数量
executed_amount string 約定済み数量
price string 注文価格
average_price string 平均約定価格
ordered_at number 注文日時(UnixTimeのミリ秒)
canceled_at number キャンセル日時(UnixTimeのミリ秒)
status string 注文ステータス: UNFILLED 注文中, PARTIALLY_FILLED 注文中(一部約定), FULLY_FILLED 約定済み, CANCELED_UNFILLED 取消済, CANCELED_PARTIALLY_FILLED 取消済(一部約定)

サンプルコード:

Curl

export API_KEY=___your api key___
export API_SECRET=___your api secret___
export ACCESS_NONCE="$(date +%s)"
export REQUEST_BODY='{"pair": "xrp_jpy", "order_id": 1}'
export ACCESS_SIGNATURE="$(echo -n "$ACCESS_NONCE$REQUEST_BODY" | openssl dgst -sha256 -hmac "$API_SECRET")"

curl -H 'ACCESS-KEY:'"$API_KEY"'' -H 'ACCESS-NONCE:'"$ACCESS_NONCE"'' -H 'ACCESS-SIGNATURE:'"$ACCESS_SIGNATURE"'' -H "Content-Type: application/json" -d ''"$REQUEST_BODY"'' https://api.bitbank.cc/v1/user/spot/cancel_order

レスポンスのフォーマット:

{
  "success": 1,
  "data": {
    "order_id": 0,
    "pair": "string",
    "side": "string",
    "type": "string",
    "start_amount": "string",
    "remaining_amount": "string",
    "executed_amount": "string",
    "price": "string",
    "average_price": "string",
    "ordered_at": 0,
    "canceled_at": 0,
    "status": "string"
  }
}

注文をキャンセルする(複数)

POST /user/spot/cancel_orders

Parameters(requestBody):

Name Type Mandatory Description
pair string YES 通貨ペア: btc_jpy, xrp_jpy, ltc_btc, eth_btc, mona_jpy, mona_btc, bcc_jpy, bcc_btc
order_ids number[] YES 注文ID

Response:

{
  "success": 1,
  "data": {
    "orders": [
      {
        "order_id": 0,
        "pair": "string",
        "side": "string",
        "type": "string",
        "start_amount": "string",
        "remaining_amount": "string",
        "executed_amount": "string",
        "price": "string",
        "average_price": "string",
        "ordered_at": 0,
        "canceled_at": 0,
        "status": "string"
      }
    ]
  }
}

注文情報を取得する(複数)

POST /user/spot/orders_info

POSTメソッド注意

Parameters (requestBody):

Name Type Mandatory Description
pair string YES 通貨ペア: btc_jpy, xrp_jpy, ltc_btc, eth_btc, mona_jpy, mona_btc, bcc_jpy, bcc_btc
order_ids number[] YES 注文ID

サンプルコード:

Curl

export API_KEY=___your api key___
export API_SECRET=___your api secret___
export ACCESS_NONCE="$(date +%s)"
export REQUEST_BODY='{"pair": "xrp_jpy", "order_ids": [1]}'
export ACCESS_SIGNATURE="$(echo -n "$ACCESS_NONCE$REQUEST_BODY" | openssl dgst -sha256 -hmac "$API_SECRET")"

curl -H 'ACCESS-KEY:'"$API_KEY"'' -H 'ACCESS-NONCE:'"$ACCESS_NONCE"'' -H 'ACCESS-SIGNATURE:'"$ACCESS_SIGNATURE"'' -H "Content-Type: application/json" -d ''"$REQUEST_BODY"'' https://api.bitbank.cc/v1/user/spot/orders_info

レスポンスのフォーマット:

{
  "success": 1,
  "data": {
    "orders": [
      {
        "order_id": 0,
        "pair": "string",
        "side": "string",
        "type": "string",
        "start_amount": "string",
        "remaining_amount": "string",
        "executed_amount": "string",
        "price": "string",
        "average_price": "string",
        "ordered_at": 0,
        "status": "string"
      }
    ]
  }
}

アクティブな注文を取得する

GET /user/spot/active_orders

Parameters:

Name Type Mandatory Description
pair string YES 通貨ペア: btc_jpy, xrp_jpy, ltc_btc, eth_btc, mona_jpy, mona_btc, bcc_jpy, bcc_btc
count number NO 取得する注文数
from_id number NO 取得開始注文ID
end_id number NO 取得終了注文ID
since number NO 開始UNIXタイムスタンプ
end number NO 終了UNIXタイムスタンプ

Response:

Name Type Description
pair string 通貨ペア: btc_jpy, xrp_jpy, ltc_btc, eth_btc, mona_jpy, mona_btc, bcc_jpy, bcc_btc
side string buy または sell
type string limit または market
start_amount string 注文時の数量
remaining_amount string 未約定の数量
executed_amount string 約定済み数量
price string 注文価格
average_price string 平均約定価格
ordered_at number 注文日時(UnixTimeのミリ秒)
status string 注文ステータス: UNFILLED 注文中, PARTIALLY_FILLED 注文中(一部約定), FULLY_FILLED 約定済み, CANCELED_UNFILLED 取消済, CANCELED_PARTIALLY_FILLED 取消済(一部約定)

サンプルコード:

Curl

export API_KEY=___your api key___
export API_SECRET=___your api secret___
export ACCESS_NONCE="$(date +%s)"
export ACCESS_SIGNATURE="$(echo -n "$ACCESS_NONCE/v1/user/spot/active_orders?pair=btc_jpy" | openssl dgst -sha256 -hmac "$API_SECRET")"

curl -H 'ACCESS-KEY:'"$API_KEY"'' -H 'ACCESS-NONCE:'"$ACCESS_NONCE"'' -H 'ACCESS-SIGNATURE:'"$ACCESS_SIGNATURE"'' https://api.bitbank.cc/v1/user/spot/active_orders?pair=btc_jpy

レスポンスのフォーマット:

{
  "success": 1,
  "data": {
    "orders": [
      {
        "order_id": 0,
        "pair": "string",
        "side": "string",
        "type": "string",
        "start_amount": "string",
        "remaining_amount": "string",
        "executed_amount": "string",
        "price": "string",
        "average_price": "string",
        "ordered_at": 0,
        "status": "string"
      }
    ]
  }
}

約定履歴

約定履歴を取得する

GET /user/spot/trade_history

Parameters:

Name Type Mandatory Description
pair string YES 通貨ペア: btc_jpy, xrp_jpy, ltc_btc, eth_btc, mona_jpy, mona_btc, bcc_jpy, bcc_btc
count number NO 取得する約定数
order_id number NO 注文ID
since number NO 開始UNIXタイムスタンプ
end number NO 終了UNIXタイムスタンプ
order string NO 約定時刻順序(asc: 昇順、desc: 降順、デフォルトdesc)

Response:

Name Type Description
trade_id number trade id
pair string 通貨ペア: btc_jpy, xrp_jpy, ltc_btc, eth_btc, mona_jpy, mona_btc, bcc_jpy, bcc_btc
order_id number 注文ID
side string buy または sell
type string limit または market
amount string 注文量
price string 価格
maker_taker string maker または taker
fee_amount_base string base手数料
fee_amount_quote string quote手数料
executed_at number 約定日時(UnixTimeのミリ秒)

サンプルコード:

Curl

export API_KEY=___your api key___
export API_SECRET=___your api secret___
export ACCESS_NONCE="$(date +%s)"
export ACCESS_SIGNATURE="$(echo -n "$ACCESS_NONCE/v1/user/spot/trade_history?pair=btc_jpy" | openssl dgst -sha256 -hmac "$API_SECRET")"

curl -H 'ACCESS-KEY:'"$API_KEY"'' -H 'ACCESS-NONCE:'"$ACCESS_NONCE"'' -H 'ACCESS-SIGNATURE:'"$ACCESS_SIGNATURE"'' https://api.bitbank.cc/v1/user/spot/trade_history?pair=btc_jpy

レスポンスのフォーマット:

{
  "success": 1,
  "data": {
    "trades": [
      {
        "trade_id": 0,
        "pair": "string",
        "order_id": 0,
        "side": "string",
        "type": "string",
        "amount": "string",
        "price": "string",
        "maker_taker": "string",
        "fee_amount_base": "string",
        "fee_amount_quote": "string",
        "executed_at": 0
      }
    ]
  }
}

出金

出金アカウントを取得する

GET /user/withdrawal_account

Parameters:

Name Type Mandatory Description
asset string YES アセット名: btc, xrp, ltc, eth, mona, bcc

Response:

Name Type Description
uuid string 出金アカウントのID
label string ラベル
address string 出金先アドレス

サンプルコード:

Curl

export API_KEY=___your api key___
export API_SECRET=___your api secret___
export ACCESS_NONCE="$(date +%s)"
export ACCESS_SIGNATURE="$(echo -n "$ACCESS_NONCE/v1/user/withdrawal_account?asset=btc" | openssl dgst -sha256 -hmac "$API_SECRET")"

curl -H 'ACCESS-KEY:'"$API_KEY"'' -H 'ACCESS-NONCE:'"$ACCESS_NONCE"'' -H 'ACCESS-SIGNATURE:'"$ACCESS_SIGNATURE"'' https://api.bitbank.cc/v1/user/withdrawal_account?asset=btc

レスポンスのフォーマット:

{
  "success": 1,
  "data": {
    "accounts": [
      {
        "uuid": "string",
        "label": "string",
        "address": "string"
      }
    ]
  }
}

出金リクエストを行う

POST /user/request_withdrawal

Parameters (requestBody):

Name Type Mandatory Description
asset string YES アセット名: btc, xrp, ltc, eth, mona, bcc
uuid string YES 出金アカウントのuuid
amount string YES 引き出し量
otp_token string NO 二段階認証トークン(設定している場合、otp_tokenかsms_tokenのどちらか一方を指定)
sms_token string NO SMS認証トークン

Response:

Name Type Description
uuid string 出金アカウントのID
asset string アセット名: btc, xrp, ltc, eth, mona, bcc
account_uuid string アカウントのID
amount number 引き出し量
fee number 引き出し手数料
label string ラベル
address string 引き出し先アドレス
txid string 引き出し送金トランザクションID
status string ステータス: CONFIRMING, EXAMINING, SENDING, DONE, REJECTED, CANCELED, CONFIRM_TIMEOUT
requested_at number リクエスト日時(UnixTimeのミリ秒)

サンプルコード:

Curl

export API_KEY=___your api key___
export API_SECRET=___your api secret___
export ACCESS_NONCE="$(date +%s)"
export REQUEST_BODY='{"asset": "xrp", "uuid": "___your uuid___", amount: "1"}'
export ACCESS_SIGNATURE="$(echo -n "$ACCESS_NONCE$REQUEST_BODY" | openssl dgst -sha256 -hmac "$API_SECRET")"

curl -H 'ACCESS-KEY:'"$API_KEY"'' -H 'ACCESS-NONCE:'"$ACCESS_NONCE"'' -H 'ACCESS-SIGNATURE:'"$ACCESS_SIGNATURE"'' -H "Content-Type: application/json" -d ''"$REQUEST_BODY"'' https://api.bitbank.cc/v1/user/request_withdrawal

レスポンスのフォーマット:

{
  "success": 1,
  "data": {
    "uuid": "string",
    "asset": "string",
    "amount": 0,
    "account_uuid": "string",
    "fee": 0,
    "status": "string",
    "label": "string",
    "txid": "string",
    "address": "string",
    "requested_at": 0
  }
}

取引所ステータス

取引所ステータスを取得する

当該APIは認証不要となります。

GET /spot/status

Parameters: None

Response:

Name Type Description
pair string 通貨ペア
status string 取引所ステータス: NORMAL, BUSY, VERY_BUSY
min_amount string 取引所ステータスに応じた最小注文数量(負荷が高いほど大きくなります)

サンプルコード:

Curl

export API_KEY=___your api key___
export API_SECRET=___your api secret___
export ACCESS_NONCE="$(date +%s)"
export ACCESS_SIGNATURE="$(echo -n "$ACCESS_NONCE/v1/spot/status" | openssl dgst -sha256 -hmac "$API_SECRET")"

curl -H 'ACCESS-KEY:'"$API_KEY"'' -H 'ACCESS-NONCE:'"$ACCESS_NONCE"'' -H 'ACCESS-SIGNATURE:'"$ACCESS_SIGNATURE"'' https://api.bitbank.cc/v1/spot/status

レスポンスのフォーマット:

{
  "success": 1,
  "data": {
    "statuses": [
      {
        "pair": "string",
        "status": "string",
        "min_amount": "string"
      }
    ]
  }
}

銘柄詳細

銘柄詳細一覧を取得する

当該APIは認証不要となります。

GET /spot/pairs

Parameters: None

Response:

Name Type Description
name string 銘柄名
base_asset string 原資産
quote_asset string クオート資産
maker_fee_rate_base string メイカー手数料率(原資産)
taker_fee_rate_base string テイカー手数料率(原資産)
maker_fee_rate_quote string メイカー手数料率(クオート資産)
taker_fee_rate_quote string テイカー手数料率(クオート資産)
unit_amount string 最小注文数量
limit_max_amount string 最大注文数量
market_max_amount string 成行注文時の最大数量
market_allowance_rate string 成行買注文時の余裕率
price_digits number 価格切り捨て対象桁数(0起点)
amount_digits number 数量切り捨て対象桁数(0起点)
is_stop_buy boolean 買注文停止ステータス
is_stop_sell boolean 売注文停止ステータス

サンプルコード:

Curl

export API_KEY=___your api key___
export API_SECRET=___your api secret___
export ACCESS_NONCE="$(date +%s)"
export ACCESS_SIGNATURE="$(echo -n "$ACCESS_NONCE/v1/spot/pairs" | openssl dgst -sha256 -hmac "$API_SECRET")"

curl -H 'ACCESS-KEY:'"$API_KEY"'' -H 'ACCESS-NONCE:'"$ACCESS_NONCE"'' -H 'ACCESS-SIGNATURE:'"$ACCESS_SIGNATURE"'' https://api.bitbank.cc/v1/spot/pairs

レスポンスのフォーマット:

{
  "success": 1,
  "data": {
    "paris": [
      {
        "name": "string",
        "base_asset": "string",
        "maker_fee_rate_base": "string",
        "taker_fee_rate_base": "string",
        "maker_fee_rate_quote": "string",
        "taker_fee_rate_quote": "string",
        "unit_amount": "string",
        "limit_max_amount": "string",
        "market_max_amount": "string",
        "market_allowance_rate": "string",
        "price_digits": 0,
        "amount_digits": 0,
        "is_stop_buy": true,
        "is_stop_sell": true
      }
    ]
  }
}
You can’t perform that action at this time.