安心・安全な仮想通貨取引所BTCBOX
ホーム > ヘルプ > API
REST API

入門

ステップ1:APIの公開鍵と秘密鍵を取得

トランザクションAPIを要求し、公開鍵と秘密鍵を取得する必要があり、アプリケーションをクリックします。

注:あなたのアカウントのセキュリティに関連する鍵は、誰にも言わないで下さい。APIキーの取得はこちら。

ステップ2:署名

1、次のようにシグネチャに必要なパラメータを収集します(殘高のサンプルを取得:シグネチャ自体を除いてリクエストパラメータをチェックします)

リクエストパラメータ:以下の例の様に殘高を取得します。

key signature coin nonce
Public API Key Signature Currency Self-incrementing

2、上記のパラメータを以下のような文字列にします:key = xxxxxx&coin = btc&nonce = 1508482053

3、 署名を作成するには、HMacSHA256関数を使用して上記の文字列を暗号化します。暗号化キーは、MD5アルゴリズムでダイジェストされたプライベートAPIキーです。

4、署名とその他のパラメータをAPIへ送信する。

注意:1. MD5ダイジェストの結果がすべて小文字になっていることを確認してください(そうでない場合、手動で転送する必要があります)。

2. 署名生成時のパラメータの順序は、送信時と同じでなければなりません。

API Reference

Ticker

URI: /api/v1/ticker

Request Method: GET

Parameters Description

Parameter Description
coin btc , ltc , eth , bch. Default: btc

Sample Response

  {
    "high":39700,
    "low":36300,
    "buy":1.879,
    "sell":0,
    "last":38800,
    "vol":283.954
  }

Response Description

Parameter Description
high The highest price in the past 24 hours.
low The lowest price in the past 24 hours.
buy The current highest bid price.
sell The current lowest ask price.
last The price of the latest deal.
vol The total deal amount in the past 24 hours.

Account Balance

URI: /api/v1/balance/

Request Method: POST

Parameters Description

Parameter Description
coin btc , ltc , eth , bch. Default: btc
key API key
signature signature
nonce nonce

Sample Response

{
	"uid":8,
	"nameauth":0,
	"moflag":0,
	"btc_balance":4234234,
	"btc_lock":0,
	"ltc_balance":32429.6,
	"ltc_lock":2.4,
	"eth_balance":0,
	"eth_lock":0,
	"jpy_balance":2344581.519,
	"jpy_lock":868862.481
}

Response Description

Parameter Description
jpy_balance Total JPY.
btc_balance Total BTC.
jpy_lock Lock JPY.
btc_lock Lock BTC.
nameauth Real-name authentication status, 0 -> no, 1 -> wait, 2 -> success.
moflag Cellphone status, 0 -> no ,1 -> yes.

Wallet

URI: /api/v1/wallet/

Request Method: POST

Parameters Description

Parameter Description
coin btc , ltc , eth , bch. Default: btc
key API key
signature signature
nonce nonce

Sample Response

{
	"result":true,
	"address":"1xxxxxxxxxxxxxxxxxxxxxxxx"
}

Response Description

Parameter Description
result true(success), false(fail).
address Bitcoin address.

Trade_list

URI: /api/v1/trade_list/

Request Method: POST

Parameters Description

Parameter Description
coin btc , ltc , eth , bch. Default: btc
key API key
signature signature
nonce nonce
since unix timestamp(utc timezone) default == 0
type [open or all]

Sample Response


[
	{
		"id":"11",
		"datetime":"2014-10-21 10:47:20",
		"type":"sell",
		"price":42000,
		"amount_original":1.2,
		"amount_outstanding":1.2
	},
	{
		"id":"10",
		"datetime":"2014-10-20 13:29:39",
		"type":"sell",
		"price":42000,
		"amount_original":1.2,
		"amount_outstanding":1.2
	},
	.....
]
				

Response Description

Parameter Description
id ID.
datetime date and time.
type "buy" or "sell".
price price.
amount_original total number.
amount_outstanding The number of remaining.

Trade_view

URI: /api/v1/trade_view/

Request Method: POST

Parameters Description

Parameter Description
coin btc , ltc , eth , bch. Default: btc
key API key
signature signature
nonce nonce
id ID

Sample Response

{
	"id":11,
	"datetime":"2014-10-21 10:47:20",
	"type":"sell",
	"price":42000,
	"amount_original":1.2,
	"amount_outstanding":1.2,
	"status":"cancelled",
}

Response Description

Parameter Description
id ID.
datetime format:YYYY-mm-dd HH:ii:ss.
type "buy" or "sell".
price price.
amount_original total number.
amount_outstanding The number of remaining.
status Order status:no, part, cancelled, all.

Trade_cancel

URI: /api/v1/trade_cancel/

Request Method: POST

Parameters Description

Parameter Description
coin btc , ltc , eth , bch. Default: btc
key API key
signature signature
nonce nonce
id ID

Sample Response

{
	"result":true,
	"id":"11"
}

Response Description

Parameter Description
result true(success), false(fail).
id ID.

Trade_add

URI: /api/v1/trade_add/

Request Method: POST

Parameters Description

Parameter Description
coin btc , ltc , eth , bch. Default: btc
key API key
signature signature
nonce nonce
amount Total number
price price
type buy or sell

Sample Response

{
	"result":true,
	"id":"11"
}

Response Description

Parameter Description
id ID.
result true(success), false(fail).

Sample Code

PHP PYTHON

Error Code

success

{ "result":true, "code":"101" }

Response Description

Error Code 解決策
100 必須パラメーターを空にすることはできません。
101 無効なパラメータです。
102 コインが存在しません。
103 キーが存在しません。
104 署名が一致しません。
105 権限が不十分です。
106 要求が期限切れになりました(nonce error)。
107 価格は整数にして下さい。
200 殘高がありません。
201 取引数が少なすぎます。
202 価格は0〜1000000である必要があります。
203 オーダーが存在しません。
301 確認されていません。
401 システムエラーです。
402 リクエスト過多です。
403 非オープンAPIです。
404 IP制限はリソースを要求していません。