Skip to content

Latest commit

 

History

History
304 lines (240 loc) · 7.97 KB

public-api_JP.md

File metadata and controls

304 lines (240 loc) · 7.97 KB
Raw

English

Table of Contents generated with DocToc

Public API一覧 (2021-12-03)

API 概要

  • エンドポイント URL: https://public.bitbank.cc
  • リクエストに不正がある場合、HTTPステータス 4XX を返します。
  • リクエストに不正がある場合、以下のようなエラーレスポンスを返します。
{
  "success": 0,
  "data": {
    "code": 10000
  }
}
  • GETエンドポイントの場合、パラメータをクエリーストリングとして送信してください。

エンドポイント一覧

Ticker

[Public API] ティッカー情報を取得。

GET /{pair}/ticker

Parameters:

Name Type Mandatory Description
pair string YES 通貨ペア: btc_jpy, xrp_jpy, xrp_btc, ltc_jpy, ltc_btc, eth_jpy, eth_btc, mona_jpy, mona_btc, bcc_jpy, bcc_btc, xlm_jpy, xlm_btc, qtum_jpy, qtum_btc, bat_jpy, bat_btc, omg_jpy, omg_btc, xym_jpy, xym_btc, link_jpy, link_btc

Response:

Name Type Description
sell string 現在の売り注文の最安値
buy string 現在の買い注文の最高値
high string 過去24時間の最高値取引価格
low string 過去24時間の最安値取引価格
open string 24時間前の始値
last string 最新取引価格
vol string 過去24時間の出来高
timestamp number 日時（UnixTimeのミリ秒）

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

{
  "success": 0,
  "data": {
    "sell": "string",
    "buy": "string",
    "high": "string",
    "low": "string",
    "open": "string",
    "last": "string",
    "vol": "string",
    "timestamp": 0
  }
}

Tickers

[Public API] 全ペアのティッカー情報を取得。

GET /tickers

Parameters:

なし

Response:

Name Type Description
pair string 通貨ペア: btc_jpy, xrp_jpy, xrp_btc, ltc_jpy, ltc_btc, eth_jpy, eth_btc, mona_jpy, mona_btc, bcc_jpy, bcc_btc, xlm_jpy, xlm_btc, qtum_jpy, qtum_btc, bat_jpy, bat_btc, omg_jpy, omg_btc, xym_jpy, xym_btc, link_jpy, link_btc
sell string 現在の売り注文の最安値
buy string 現在の買い注文の最高値
high string 過去24時間の最高値取引価格
low string 過去24時間の最安値取引価格
open string 24時間前の始値
last string 最新取引価格
vol string 過去24時間の出来高
timestamp number 日時（UnixTimeのミリ秒）

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

{
  "success": 0,
  "data": [{
    "pair": "string",
    "sell": "string",
    "buy": "string",
    "high": "string",
    "low": "string",
    "open": "string",
    "last": "string",
    "vol": "string",
    "timestamp": 0
  }]
}

TickersJPY

[Public API] JPYペアのティッカー情報を取得。

GET /tickers_jpy

Parameters:

なし

Response:

Name Type Description
pair string 通貨ペア(JPYペアのみ): btc_jpy, xrp_jpy, ltc_jpy, eth_jpy, mona_jpy, bcc_jpy, xlm_jpy, qtum_jpy, bat_jpy, omg_jpy, xym_jpy, xym_btc, link_jpy, link_btc
sell string 現在の売り注文の最安値
buy string 現在の買い注文の最高値
high string 過去24時間の最高値取引価格
low string 過去24時間の最安値取引価格
open string 24時間前の始値
last string 最新取引価格
vol string 過去24時間の出来高
timestamp number 日時（UnixTimeのミリ秒）

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

{
  "success": 0,
  "data": [{
    "pair": "string",
    "sell": "string",
    "buy": "string",
    "high": "string",
    "low": "string",
    "open": "string",
    "last": "string",
    "vol": "string",
    "timestamp": 0
  }]
}

Depth

[Public API] 板情報を取得。

GET /{pair}/depth

Parameters:

Name Type Mandatory Description
pair string YES 通貨ペア: btc_jpy, xrp_jpy, xrp_btc, ltc_jpy, ltc_btc, eth_jpy, eth_btc, mona_jpy, mona_btc, bcc_jpy, bcc_btc, xlm_jpy, xlm_btc, qtum_jpy, qtum_btc, bat_jpy, bat_btc, omg_jpy, omg_btc, xym_jpy, xym_btc, link_jpy, link_btc

Response:

Name Type Description
asks [string, string][] 売り板 [価格, 数量]
bids [string, string][] 買い板 [価格, 数量]

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

{
  "success": 0,
  "data": {
    "asks": [
      [
        "string",  "string"
      ]
    ],
    "bids": [
      [
        "string",  "string"
      ]
    ]
  }
}

Transactions

[Public API] 指定された日付の全約定履歴を取得。

GET /{pair}/transactions/{YYYYMMDD}

Parameters:

Name Type Mandatory Description
pair string YES 通貨ペア: btc_jpy, xrp_jpy, xrp_btc, ltc_jpy, ltc_btc, eth_jpy, eth_btc, mona_jpy, mona_btc, bcc_jpy, bcc_btc, xlm_jpy, xlm_btc, qtum_jpy, qtum_btc, bat_jpy, bat_btc, omg_jpy, omg_btc, xym_jpy, xym_btc, link_jpy, link_btc
YYYYMMDD string NO date formatted as YYYYMMDD

Response:

Name Type Description
transaction_id number 取引ID
side string buy または sell
price string 価格
amount string 数量
executed_at number 約定日時（UnixTimeのミリ秒）

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

{
  "success": 0,
  "data": {
    "transactions": [
      {
        "transaction_id": 0,
        "side": "string",
        "price": "string",
        "amount": "string",
        "executed_at": 0
      }
    ]
  }
}

Candlestick

[Public API] 指定された日付のロウソク足データを取得。

GET /{pair}/candlestick/{candle-type}/{YYYY}

Parameters:

Name Type Mandatory Description
pair string YES 通貨ペア: btc_jpy, xrp_jpy, xrp_btc, ltc_jpy, ltc_btc, eth_jpy, eth_btc, mona_jpy, mona_btc, bcc_jpy, bcc_btc, xlm_jpy, xlm_btc, qtum_jpy, qtum_btc, bat_jpy, bat_btc, omg_jpy, omg_btc, xym_jpy, xym_btc, link_jpy, link_btc
candle-type string YES 以下の期間から指定: 1min, 5min, 15min, 30min, 1hour, 4hour, 8hour, 12hour, 1day, 1week, 1month
YYYY string YES 日付 YYYYMMDD 形式または YYYY を指定
  • YYYY の指定は candle-type によって異なります:
    • YYYYMMDD: 1min, 5min, 15min, 30min, 1hour
    • YYYY: 4hour, 8hour, 12hour, 1day, 1week, 1month

Response:

Name Type Description
ohlcv string[] [始値, 高値, 安値, 終値, 出来高, UnixTimeのミリ秒]

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

{
  "success": 0,
  "data": {
    "candlestick": [
      {
        "type": "string",
        "ohlcv": [
          [
            "string"
          ]
        ]
      }
    ]
  }
}