始めに
Public APIおよびTrade APIとは、 他社ソフトウェアの取引所とのコミュニケーションをするための便利なツールです。
- Public APIは、アカウントの個人データへのアクセスを必要としない情報を入手するために適用されます。
- Trade APIは、オーダーの作成及びキャンセル、実際残高に関するリクエスト、アカウントの個人データへのアクセスを必要とする情報を入手するために必要です。
Public API
現在、Public APIの複数のバージョンが存在します。開発者には、ソフトウェア開発のために最新バージョンをおすすめします。
v2
第2版のPublic APIでは次のを入手できます：depth, fee, ticker, trades (メソッド)。
リンクの形：https://yobit.net/api/2/ペア/メソッド名
リンクでは1つのペアのみ指定できます。
ペアの例 ltc_btc:
v3
第2版に比べて、Public APIの第3版では、サーバーへの1つのリクエストで複数のペアに関する情報を入手できるようになりました。情報を入手したいペアの間に「ー」をつけます。
サーバーの応答が2秒ごとにキャッシュ化されるので、それ以上リクエストの頻度を上げる必要がありません。
利用可能なメソッド：depth, ticker, trades, info.
リンクの形：https://yobit.net/api/3/メソッド名/ペアの並べ
複数のペア（繰り返しなし）または一つのペアだけ指定することができます。
メソッドinfoは、ペアを並べるパラメーターを有しません。このメソッドは、利用可能なペアのリストを取得するために適用できます。
ペアのリストの一例ltc_btc-nmc_btc:
ご注意！ リストに記載されているいずれかのペアが無効にされた場合、APIはエラーを返します。このようなエラーを無視する設定を有効にするために、GETパラメーターを使用することができます。ignore_invalid.
使用例：https://yobit.net/api/3/depth/ltc_btc-error_pair?ignore_invalid=1
info
リクエストの例：https://yobit.net/api/3/info
返答の例：
{
"server_time":1418654531,
"pairs":{
"ltc_btc":{
"decimal_places":8,
"min_price":0.00000001,
"max_price":10000,
"min_amount":0.0001,
"hidden":0,
"fee":0.2
}
...
}
}
- decimal_places: 少数部の桁数
- min_price: 最低制限価格
- max_price: 最大制限価格
- min_amount: 購入または販売用の最低制限数
- hidden: ペアは表示されません（0または1）
- fee: ペアの手数料
表示されないペアは取引所のメインページの一覧に掲載されませんが、交換が行われつづけます。
いずれかのペアを無効化すると、一覧で表示されなくなります。
ticker
メソッドはこの前の24時間の統計情報を返します。
リクエストの例：https://yobit.net/api/3/ticker/ltc_btc
返答の例：
{
"ltc_btc":{
"high":105.41,
"low":104.67,
"avg":105.04,
"vol":43398.22251455,
"vol_cur":4546.26962359,
"last":105.11,
"buy":104.2,
"sell":105.11,
"updated":1418654531
}
...
}
- high: 最大価格
- low: 最低価格
- avg: 平均価格
- vol: 取引高
- vol_cur: 通貨取引高
- last: 最終取引の価格
- buy: 購入価格
- sell: 販売価格
- updated: 最後のキャッシュアップデート
depth
メソッドは指定されているペアの有効なオーダーのリストに関する情報を返します。
GETパラメーターはlimit 情報を取得する階層の深さを指定します（デフォルト値は150、最大値は2000）。
リクエストの例：https://yobit.net/api/3/depth/ltc_btc
返答の例：
{
"ltc_btc":{
"asks":[
[104.67,0.01],
[104.75,11],
[104.80,0.523],
...
],
"bids":[
[104.3,5.368783],
[104.212,2.57357],
[103.62,0.43663336],
[103.61,0.7255672],
...
]
}
...
}
- asks: 販売用オーダー
- bids: 購入用オーダー
trades
メソッドは指定されているペアの最終の取引に関する情報を返します。
GETパラメーターはlimit情報を取得する階層の深さを指定します（デフォルト値は150、最大値は2000）。
リクエストの例：https://yobit.net/api/3/trades/ltc_btc
返答の例：
{
"ltc_btc":[
{
"type":"ask",
"price":104.2,
"amount":0.101,
"tid":41234426,
"timestamp":1418654531
},
{
"type":"bid",
"price":103.53,
"amount":1.51414,
"tid":41234422,
"timestamp":1418654530
},
...
]
...
}
- type: ask - 販売、bid - 購入
- price: 購入/販売価格
- amount: 件数
- tid: 取引のID
- timestamp: 取引のunix time
Trade API
Trade APIは、オーダーの作成及びキャンセル、実際残高に関するリクエスト、アカウントの個人データへのアクセスを必要とする情報を入手するために必要です。
Trade APIを使うために、 このセクションでキーを作成しなければなりません。
キーの秘密は作成後に1時間以内に閲覧できるので、キーを生成した後すぐに保存しておくことをおすすめします。キーおよびその秘密はユーザー認証にために使われます。
Trade APIにリクエストを送信するアドレス：https://yobit.net/tapi/
リクエストするたびに、認証が必要です。
サーバーはすべての返答をJSON形式で返します。
サーバーの返答が成功な例：
{"success":1,"return":{返答}}
エラーを報告する返答の例：
{"success":0,"error":"エラー"}
認証
Trade APIの各リクエストは認証を受けなければなりません。
認証は次のHTTPヘッダーを送信する方法で行われます：
Key - APIキー、例： FAF816D16FFDFBD1D46EEF5D5B10D8A2
Sign - デジタル署名、HMAC-SHA512を使って秘密鍵で署名されたPOSTパラメーター(?param0=val0 & ...& nonce=1)
パラメーターnonce (最低値は1、最大値は2147483646)は、新しいリクエストごとに、前のリクエストのパラメーターより大きくならなければなりません。
Nonce値をゼロにするために新しいキーを作成しなければなりません。
getInfo
<
メソッドはユーザーの残高とAPIキーの優遇およびサーバー時間に関する情報を返します。
要件: キーの優遇info
パラメーター: なし
返答の例：
{
"success":1,
"return":{
"funds":{
"ltc":22,
"nvc":423.998,
"ppc":10,
...
},
"funds_incl_orders":{
"ltc":32,
"nvc":523.998,
"ppc":20,
...
},
"rights":{
"info":1,
"trade":0,
"withdraw":0
},
"transaction_count":0,
"open_orders":1,
"server_time":1418654530
}
}
- funds: 利用可能なアカウント残高（オープンオーダーにあるお金を除く）
- funds_incl_orders: 利用可能なアカウント残高（オープンオーダーにあるお金を含む）
- rights: キーの優遇。withdrawは使用されません（予約済み）
- transaction_count: いつも0（古い）
- open_orders: いつも0（古い）
- server_time: サーバー時間
Trade
取引所で販売する新しいオーダーを作成するためのメソッド：
要件: キーの優遇info&trade
パラメーター:
- pair: ペア（例：ltc_btc)
- type: トランザクションの種類（例：buyまたはsell)
- rate: 購入または販売しなければならないレート：（数値： 数)
- amount: 購入または販売しなければならない数量（数値：数)
返答の例：
{
"success":1,
"return":{
"received":0.1,
"remains":0,
"order_id":12345,
"funds":{
"btc":15,
"ltc":51.82,
"nvc":0,
...
}
}
}
- received: 購入/販売された通貨の金額
- remains: 後で購入/販売する通貨の金額
- order_id: 作成されたオーダーのID
- funds: リクエスト後の実際残高
ActiveOrders
メソッドはユーザーの有効なオーダーのリストを返します。
要件: キーの優遇info
パラメーター:
返答の例：
{
"success":1,
"return":{
"100025362":{
"pair":"ltc_btc",
"type":"sell",
"amount":21.615,
"rate":0.258,
"timestamp_created":1418654530,
"status":0
},
...
}
}
- 配列のキー: オーダーのID（例：100025362）
- pair: ペア（例：ltc_btc)
- type: トランザクションの種類（例：buyまたは sell)
- amount: 残りの購入または販売
- rate: 購入または販売価格
- timestamp_created: オーダーの作成時間
- status: いつも0（古い）
OrderInfo
メソッドは指定されたオーダーに関する情報を返します
要件: キーの優遇info
パラメーター:
返答の例：
{
"success":1,
"return":{
"100025362":{
"pair":ltc_btc,
"type":sell,
"start_amount":13.345,
"amount":12.345,
"rate":485,
"timestamp_created":1418654530,
"status":0
}
}
}
- 配列のキー: オーダーID（例：100025362)
- pair: オーダーのペア（例： ltc_btc)
- type: オーダーの種類（例：buyまたはsell)
- start_amount: 作成する際のオーダーの当初価格
- amount: オーダーの残りの購入または販売の金額
- rate: 購入または販売価格
- timestamp_created: オーダーの作成時間
- status: 0 - 有効、1 -実行済み、完了、2 - キャンセル、3 - 一部実行後にキャンセル。
CancelOrder
メソッドは指定されたオーダーをキャンセルします。
要件: キーの優遇info&trade
パラメーター:
返答の例：
{
"success":1,
"return":{
"order_id":100025362,
"funds":{
"btc":15,
"ltc":51.82,
"nvc":0,
...
}
}
}
- order_id: オーダーID
- funds: リクエスト後の実際残高
TradeHistory
メソッドは取引の履歴を返します。
要件: キーの優遇info
パラメーター:
- from: 表示される最初の取引の番号（数値： 数, デフォルト値：0)
- count: 表示される取引数（数値：数, デフォルト値：1000)
- from_id: 表示される最初の取引のID（数値：数, デフォルト値： 0)
- end_id: 表示される最後の取引のID（数値：数, デフォルト値：∞)
- order: リストの並べ替え（値：ASCまたはDESC, デフォルト値：DESC)
- since: 表示する最初の時間（値：unix time, デフォルト値：0)
- end: 表示する最後の時間（値：unix time, デフォルト値：∞)
- pair: ペア（例：ltc_btc)
パラメーターsinceまたはendを使う場合、パラメーターorder は自動的にASCの値になります。
パラメーターsinceを使う場合、履歴が取得できる最も古い日付は1週間前です。
返答の例：
{
"success":1,
"return":{
"24523":{
"pair":"ltc_btc",
"type":"sell",
"amount":11.4,
"rate":0.145,
"order_id":100025362,
"is_your_order":1,
"timestamp":1418654530
}
...
}
}
- 配列のキー: 取引ID （例：24523)
- pair: ペア（例：ltc_btc)
- type: 取引の種類（例：buy またはsell)
- amount: 購入または販売された数量
- rate: 購入または販売価格
- order_id: オーダーID
- is_your_order: オーダーはあなたのものですか（１または0）
- timestamp: 取引の時間
GetDepositAddress
メソッドは入金用のアドレスを返します。
要件: キーの優遇deposits
パラメーター:
- coinName: 通貨のティッカー（例：BTC)
- need_new: value: 0または1, デフォルト値：0
返答の例：
{
"success":1,
"return":{
"address": 1UHAnAWvxDB9XXETsi7z483zRRBmcUZxb3,
"processed_amount": 1.00000000,
"server_time": 1437146228
}
}
WithdrawCoinsToAddress
メソッドは出金のリクエストを作成します。
要件: キーの優遇withdrawals
パラメーター:
- coinName: 通貨のティッカー（例：BTC)
- amount: 出金の金額
- address: 目的のアドレス
返答の例：
{
"success":1,
"return":{
"server_time": 1437146228
}
}
CreateYobicode
メソッドはYobicodes（クーポン）を作成するためのものです。
メソッドの別の書き方: CreateCoupon
要件: キーの優遇withdrawals
パラメーター:
- currency: 通貨のティッカー（例：BTC)
- amount: yobicode金額
返答の例：
{
"success":1,
"return":{
"coupon": "YOBITUZ0HHSTBCOH5F6EAOENCRD8RGOQX3H01BTC",
"transID": 1,
"funds":{
"btc":15,
"ltc":51.82,
"nvc":0,
...
}
}
}
- coupon: Yobicode
- transID: 他の取引所のAPIとの適合性のためにいつも1
- funds: リクエスト後の実際残高
RedeemYobicode
メソッドはYobicodes（クーポン）を取り消すためのものです。
メソッドの別の書き方: RedeemCoupon
要件: キーの優遇deposits
パラメーター:
- coupon: 入金用のyobicode（例：YOBITUZ0HHSTB...OQX3H01BTC)
返答の例：
{
"success":1,
"return":{
"couponAmount": "1.2345",
"couponCurrency": "BTC",
"transID": 1,
"funds":{
"btc":15,
"ltc":51.82,
"nvc":0,
...
}
}
}
- couponAmount: 入金された金額。
- couponCurrency: 入金されたyobicode通貨。
- transID: 他の取引所のAPIとの適合性のためにいつも1
- funds: リクエスト後の実際残高
Defi Public API
すべとのプールに関する情報のリクエストの例：
https://yobit.net/api/defi/info
指定プールに関する情報のリクエストの例：
https://yobit.net/api/defi/info/btc_usdt-yo_btc
返答の例：
{
"server_time":1418654531,
"pools":{
"usdt_spitz":{
"liq1":"45540230.71160736",
"liq2":"230.12172671",
"price1":"0.00000505",
"price2":"197896.26717427",
"fee":"0.003",
"price24high1":"0.00000512",
"price24low1":"0.00000505",
"price24high2":"197898.16740049",
"price24low2":"195199.11794729",
"vol1":"47.57434935",
"vol2":"2.61017416",
"algo1":"erc20",
"tokenid1":"0xdac17f958d2ee523a2206206994597c13d831ec7",
"algo2":"bep20",
"tokenid2":"0x9d1d63501e3490aeedf0dba24f60c29918caf965",
}
...
}
}
- liq1: リクイディティ・プロバイダーは通貨1をプールに預け入れました
- liq2: リクイディティ・プロバイダーは通貨2をプールに預け入れました
- price1: 現在のprice 1
- price2: 現在のprice 2
- fee: 手数料、％（0.003は0.3%を意味します）
- price24high1: この前の24時間の最大price 1
- price24low1: この前の24時間の最低price 1
- price24high2: この前の24時間の最大price 2
- price24low2: この前の24時間の最低price 2
- vol1: この前の24時間の通貨1のスワップ
- vol2: この前の24時間の通貨2のスワップ
- algo1: erc20、trc20、bep20またはSHA256/Scrypt/X11
- tokenid1: 通貨1のため、erc20、trc20、bep20アルゴリズムの場合はtokenアドレス、その他の場合は空白
- algo2: erc20, trc20, bep20 or SHA256/Scrypt/X11
- tokenid2: 通貨2のため、erc20、trc20、bep20アルゴリズムの場合はtokenアドレス、その他の場合は空白
表示されないプールは取引所のメインページの一覧に掲載されません。
いずれかのプールを無効化すると、一覧で表示されなくなります。
DefiSwapInfo
メソッドは、DefiSwap機能でスワップを引き起こす前に可能なスワップに関する情報を取得するためのものです。
要件: キーの優遇info&trade
パラメーター:
- pool: cur1_cur2形式のプール名（例：btc_usdt)
- PayCurrency:スワップの際に引き渡す通貨。それはcur1またはcur2でなければなりません（例：usdt)
- PayAmount: スワップの際に引き渡す金額（例：1.123)
返答の例：
{
"success":1,
"swap_made":0,
"info":{
"desc": "SWAP 1.12300000 USDT to 0.00002567 BTC with price 43732.86034952",
"pay_amount": "1.12300000",
"pay_currency": "USDT",
"get_amount": "0.00002567",
"get_currency": "BTC",
"price_of_swap": "43732.86034952",
"fee_total": "0.00000007",
"fee_total_currency": "BTC",
"price1_before": "43601.61783433",
"price1_after": "43601.70585432",
"price2_before": "0.00002293",
"price2_after": "0.00002294",
}
}
- swap_made: いつも0。スワップは事実上行われなかったことを示します。
- pay_amount: スワップの際に引き渡す金額
- pay_currency: スワップの際に引き渡す通貨
- get_amount: スワップの際に取得する金額
- get_currency: スワップの際に取得する通貨
- price_of_swap: スワップ価格 (
- fee_total: 手数料の金額
- fee_total_currency: 手数料の通貨
- price1_before: スワップ前のプール1の実際価格
- price1_after: スワップ前のプール2の実際価格
- price2_before: スワップが行われたらスワップ後のプール1の価格を示します
- price2_after: スワップが行われたらスワップ後のプール2の価格を示します
DefiSwap
メソッドはDefiスワップ (Swaps)を行うためのものです。.
要件: キーの優遇 info&trade
パラメーター:
- pool: cur1_cur2形式のプール名（例：btc_usdt)
- PayCurrency: スワップの際に引き渡す通貨。それはcur1またはcur2でなければなりません（例： usdt)
- PayAmount: スワップの際に引き渡す金額（例：1.123)
返答の例：
{
"success":1,
"swap_made":0,
"info":{
"desc": "SWAP 1.12300000 USDT to 0.00002567 BTC with price 43732.86034952",
"pay_amount": "1.12300000",
"pay_currency": "USDT",
"get_amount": "0.00002567",
"get_currency": "BTC",
"price_of_swap": "43732.86034952",
"fee_total": "0.00000007",
"fee_total_currency": "BTC",
"price1_before": "43601.61783433",
"price1_after": "43601.70585432",
"price2_before": "0.00002293",
"price2_after": "0.00002294",
},
"user":{
"new_balance1": "12.07789855",
"new_balance1_currency": "BTC",
"new_balance2": "497908.66928976",
"new_balance2_currency": "USDT",
"pooled1": "1.07518709",
"pooled2": "46729.28782075",
"pooled_est": "$93,233.91955017",
"pooled_pr": "2.1456",
"comfee1": "4.1894",
"comfee2": "625.3309128",
"comfee_est": "$1,207.09775086",
}
}
- pay_amount: スワップの際に引き渡す金額
- pay_currency: スワップの際に引き渡す通貨
- get_amount: スワップの際に取得する金額
- get_currency: スワップの際に取得する通貨
- price_of_swap: スワップ価格 (
- fee_total: 手数料の金額
- fee_total_currency: 手数料の通貨
- price1_before: スワップ前のプール1の価格
- price1_after: スワップ前のプール1の価格
- price2_before: スワップ後のプール1の価格
- price2_after: スワップ後のプール2の価格
- new_balance1: スワップ後の通貨1の新しい残高
- new_balance1_currency: 通貨名1の名
- new_balance2: スワップ後の通貨2の新しい残高
- new_balance2_currency: 通貨2の名
- pooled1: 流動性のプールにおける通貨1のあなたの分
- pooled2: 流動性のプールにおける通貨2のあなたの分
- pooled_est: USD建て凡その数量pooled1+pooled2
- pooled_pr: 流動性のプールのあなたの％（例： 2.1456は流動性のプールの2.1456%を意味します)
- comfee1: 稼いだ手数料（通貨1の合計）
- comfee2: 稼いだ手数料（通貨2の合計）
- comfee_est: USD建て凡その数量comfee1+comfee2