Skip to content

Commit 33fc8ee

Browse files
soichirokodamasoichirokodama
authored
Merge pull request #101 from bitbankinc/feature/multichain
feat: multi-chain（2023-11-08）
2 parents c9f901c + f3bf6d6 commit 33fc8ee

File tree

4 files changed

+96
-15
lines changed

4 files changed

+96
-15
lines changed

‎CHANGELOG.md‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,11 @@
1-
# CHANGELOG for Bitbank's API (2023-10-23)
1+
# CHANGELOG for Bitbank's API (2023-11-08)
2+
3+
## 2023-11-08
4+
* Added new docs
5+
* `networks.md`
6+
* Added network fields to
7+
* `rest-api.md`.
8+
* `rest-api_JP.md`.
29

310
## 2023-10-23
411
* Added new pairs to

‎networks.md‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
2+
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
3+
**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)*
4+
5+
- [networks (2023-11-08)](#networks-2023-11-08)
6+
7+
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
8+
9+
# networks (2023-11-08)
10+
11+
The following is the list of network.
12+
13+
Network | Network name
14+
------------ | ------------
15+
bitcoin | Bitcoin
16+
litecoin | Litecoin
17+
ripple | XRP
18+
ethereum | Ethereum
19+
monacoin | Monacoin
20+
bitcoincash | Bitcoin Cash
21+
stellar | Stellar
22+
qtum | Qtum
23+
symbol | Symbol
24+
polkadot | Polkadot
25+
dogecoin | Dogecoin
26+
astar | Astar
27+
cardano | Cardano
28+
avalanche | Avalanche C-Chain
29+
flare | Flare
30+
oasys | Oasys
31+
bsc | BNB Smart Chain
32+
arbitrum | Arbitrum
33+
op | OP Mainnet
34+
polygon | Polygon

‎rest-api.md‎

Lines changed: 26 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
55
**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)*
66

7-
- [Private REST API for Bitbank (2023-06-20)](#private-rest-api-for-bitbank-2023-06-20)
7+
- [Private REST API for Bitbank (2023-11-08)](#private-rest-api-for-bitbank-2023-11-08)
88
- [General API Information](#general-api-information)
99
- [Authorization](#authorization)
1010
- [Rate limit](#rate-limit)
@@ -32,7 +32,7 @@
3232

3333
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
3434

35-
# Private REST API for Bitbank (2023-06-20)
35+
# Private REST API for Bitbank (2023-11-08)
3636

3737
## General API Information
3838

@@ -96,9 +96,10 @@ free_amount | string | free amount
9696
amount_precision | number | amount precision
9797
onhand_amount | string | onhand amount
9898
locked_amount | string | locked amount
99-
withdrawal_fee | string | withdrawal fee
100-
stop_deposit | boolean | deposit status
101-
stop_withdrawal | boolean | withdrawal status
99+
withdrawal_fee | { min: string, max: string } or { under: string, over: string, threshold:string } for `jpy` | withdrawal fee
100+
stop_deposit | boolean | deposit status（All networks: stop_deposit = `true`）
101+
stop_withdrawal | boolean | withdrawal status（All networks: stop_withdrawal = `true`）
102+
network_list | { asset: string, network: string, stop_deposit: boolean, stop_withdrawal: boolean, withdrawal_fee: string } or undefined for `jpy` | network list
102103

103104
**Sample code:**
104105

@@ -132,9 +133,21 @@ curl -H 'ACCESS-KEY:'"$API_KEY"'' -H 'ACCESS-NONCE:'"$ACCESS_NONCE"'' -H 'ACCESS
132133
"amount_precision": 0,
133134
"onhand_amount": "string",
134135
"locked_amount": "string",
135-
"withdrawal_fee": "string",
136+
"withdrawal_fee": {
137+
"min": "string",
138+
"max": "string"
139+
},
136140
"stop_deposit": false,
137141
"stop_withdrawal": false,
142+
"network_list": [
143+
{
144+
"asset": "string",
145+
"network": "string",
146+
"stop_deposit": false,
147+
"stop_withdrawal": false,
148+
"withdrawal_fee": "string"
149+
}
150+
]
138151
},
139152
{
140153
"asset": "jpy",
@@ -233,7 +246,7 @@ curl -H 'ACCESS-KEY:'"$API_KEY"'' -H 'ACCESS-NONCE:'"$ACCESS_NONCE"'' -H 'ACCESS
233246
"ordered_at": 0,
234247
"expire_at": 0,
235248
"triggered_at": 0,
236-
"triger_price": "string",
249+
"trigger_price": "string",
237250
"status": "string"
238251
}
239252
}
@@ -703,6 +716,7 @@ Name | Type | Description
703716
uuid | string | uuid for each deposit
704717
address | string | deposit address
705718
asset | string | enum: [asset list](assets.md)
719+
network | string | enum: [network list](networks.md)
706720
amount | number | deposit amount
707721
txid | string or null | deposit transaction id (only for crypto assets)
708722
status | string | deposit status enum: `FOUND`, `CONFIRMED`, `DONE`
@@ -743,6 +757,7 @@ curl -H 'ACCESS-KEY:'"$API_KEY"'' -H 'ACCESS-NONCE:'"$ACCESS_NONCE"'' -H 'ACCESS
743757
{
744758
"uuid": "string",
745759
"asset": "string",
760+
"network": "string",
746761
"amount": "string",
747762
"txid": "string",
748763
"status": "string",
@@ -839,6 +854,7 @@ amount | string | withdrawal amount
839854
fee | string | withdrawal fee
840855
label | string | withdrawal account label (only for crypto assets)
841856
address | string | withdrawal destination address (only for crypto assets)
857+
network | string | enum (only for crypto assets): [network list](networks.md)
842858
destination_tag | number or string | withdrawal destination tag or memo (only for crypto that have it)
843859
txid | string or null | withdrawal transaction id (only for crypto assets)
844860
bank_name | string | bank of withdrawal account (only for fiat assets)
@@ -884,6 +900,7 @@ curl -H 'ACCESS-KEY:'"$API_KEY"'' -H 'ACCESS-NONCE:'"$ACCESS_NONCE"'' -H 'ACCESS
884900

885901
"label": "string",
886902
"address": "string",
903+
"network": "string",
887904
"txid": "string",
888905
"destination_tag": 0,
889906

@@ -925,6 +942,7 @@ amount | number | withdrawal amount
925942
fee | number | withdrawal fee
926943
label | string | withdrawal account label (only for crypto assets)
927944
address | string | withdrawal destination address (only for crypto assets)
945+
network | string | enum (only for crypto assets): [network list](networks.md)
928946
destination_tag | number or string | withdrawal destination tag or memo (only for crypto that have it)
929947
txid | string or null | withdrawal transaction id (only for crypto assets)
930948
bank_name | string | bank of withdrawal account (only for fiat assets)
@@ -971,6 +989,7 @@ curl -H 'ACCESS-KEY:'"$API_KEY"'' -H 'ACCESS-NONCE:'"$ACCESS_NONCE"'' -H 'ACCESS
971989

972990
"label": "string",
973991
"address": "string",
992+
"network": "string",
974993
"txid": "string",
975994
"destination_tag": 0,
976995

‎rest-api_JP.md‎

Lines changed: 28 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
55
**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)*
66

7-
- [Private REST API一覧 (2023-06-20)](#private-rest-api%E4%B8%80%E8%A6%A7-2023-06-20)
7+
- [Private REST API一覧 (2023-11-08)](#private-rest-api%E4%B8%80%E8%A6%A7-2023-11-08)
88
- [API 概要](#api-%E6%A6%82%E8%A6%81)
99
- [認証](#%E8%AA%8D%E8%A8%BC)
1010
- [レートリミット](#%E3%83%AC%E3%83%BC%E3%83%88%E3%83%AA%E3%83%9F%E3%83%83%E3%83%88)
@@ -33,7 +33,7 @@
3333

3434
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
3535

36-
# Private REST API一覧 (2023-06-20)
36+
# Private REST API一覧 (2023-11-08)
3737

3838
## API 概要
3939

@@ -103,9 +103,10 @@ free_amount | string | 利用可能な量
103103
amount_precision | number | 精度
104104
onhand_amount | string | 保有量
105105
locked_amount | string | ロックされている量
106-
withdrawal_fee | string or { under: string, over: string, threshold:string } for `jpy` | 出金手数料
107-
stop_deposit | boolean | 入金ステータス
108-
stop_withdrawal | boolean | 出金ステータス
106+
withdrawal_fee | { min: string, max: string } or { under: string, over: string, threshold:string } for `jpy` | 出金手数料
107+
stop_deposit | boolean | 入金ステータス（全ネットワークが入金停止 = `true`）
108+
stop_withdrawal | boolean | 出金ステータス（全ネットワークが出金停止 = `true`）
109+
network_list | { asset: string, network: string, stop_deposit: boolean, stop_withdrawal: boolean, withdrawal_fee: string } or undefined for `jpy` | ネットワーク一覧
109110

110111
**サンプルコード:**
111112

@@ -139,9 +140,21 @@ curl -H 'ACCESS-KEY:'"$API_KEY"'' -H 'ACCESS-NONCE:'"$ACCESS_NONCE"'' -H 'ACCESS
139140
"amount_precision": 0,
140141
"onhand_amount": "string",
141142
"locked_amount": "string",
142-
"withdrawal_fee": "string",
143+
"withdrawal_fee": {
144+
"min": "string",
145+
"max": "string"
146+
},
143147
"stop_deposit": false,
144148
"stop_withdrawal": false,
149+
"network_list": [
150+
{
151+
"asset": "string",
152+
"network": "string",
153+
"stop_deposit": false,
154+
"stop_withdrawal": false,
155+
"withdrawal_fee": "string"
156+
}
157+
]
145158
},
146159
{
147160
"asset": "jpy",
@@ -240,7 +253,7 @@ curl -H 'ACCESS-KEY:'"$API_KEY"'' -H 'ACCESS-NONCE:'"$ACCESS_NONCE"'' -H 'ACCESS
240253
"ordered_at": 0,
241254
"expire_at": 0,
242255
"triggered_at": 0,
243-
"triger_price": "string",
256+
"trigger_price": "string",
244257
"status": "string"
245258
}
246259
}
@@ -709,6 +722,7 @@ Name | Type | Description
709722
uuid | string | 入金識別uuid
710723
address | string | 入金address
711724
asset | string | アセット名: [アセット一覧](assets.md)
725+
network | string | ネットワーク名: [ネットワーク一覧](networks.md)
712726
amount | number | 入金数量
713727
txid | string or null | 入金トランザクションID(暗号資産の時のみ)
714728
status | string | 入金状態: `FOUND`, `CONFIRMED`, `DONE`
@@ -749,6 +763,7 @@ curl -H 'ACCESS-KEY:'"$API_KEY"'' -H 'ACCESS-NONCE:'"$ACCESS_NONCE"'' -H 'ACCESS
749763
{
750764
"uuid": "string",
751765
"asset": "string",
766+
"network": "string",
752767
"amount": "string",
753768
"txid": "string",
754769
"status": "string",
@@ -780,6 +795,7 @@ Name | Type | Description
780795
------------ | ------------ | ------------
781796
uuid | string | 出金アカウントのID
782797
label | string | ラベル
798+
network | string | ネットワーク名: [ネットワーク一覧](networks.md)
783799
address | string | 出金先アドレス
784800

785801
**サンプルコード:**
@@ -811,6 +827,7 @@ curl -H 'ACCESS-KEY:'"$API_KEY"'' -H 'ACCESS-NONCE:'"$ACCESS_NONCE"'' -H 'ACCESS
811827
{
812828
"uuid": "string",
813829
"label": "string",
830+
"network": "string",
814831
"address": "string"
815832
}
816833
]
@@ -845,6 +862,7 @@ amount | string | 出金数量
845862
fee | string | 出金手数料
846863
label | string | 出金先アドレスにつけたラベル(暗号資産の時のみ)
847864
address | string | 出金先アドレス(暗号資産の時のみ)
865+
network | string | ネットワーク名(暗号資産の時のみ): [ネットワーク一覧](networks.md)
848866
destination_tag | number or string | 出金先宛先タグまたはメモ(タグまたはメモを指定した暗号資産の出金時のみ)
849867
txid | string or null | 出金トランザクションID(暗号資産の時のみ)
850868
bank_name | string | 出金先銀行(法定通貨の時のみ)
@@ -891,6 +909,7 @@ curl -H 'ACCESS-KEY:'"$API_KEY"'' -H 'ACCESS-NONCE:'"$ACCESS_NONCE"'' -H 'ACCESS
891909

892910
"label": "string",
893911
"address": "string",
912+
"network": "string",
894913
"txid": "string",
895914
"destination_tag": 0,
896915

@@ -932,6 +951,7 @@ amount | number | 出金数量
932951
fee | number | 出金手数料
933952
label | string | 出金先アドレスにつけたラベル(暗号資産の時のみ)
934953
address | string | 出金先アドレス(暗号資産の時のみ)
954+
network | string | ネットワーク名(暗号資産の時のみ): [ネットワーク一覧](networks.md)
935955
destination_tag | number or string | 出金先宛先タグまたはメモ(タグまたはメモを指定した暗号資産の出金時のみ)
936956
txid | string or null | 出金トランザクションID(暗号資産の時のみ)
937957
bank_name | string | 出金先銀行(法定通貨の時のみ)
@@ -978,6 +998,7 @@ curl -H 'ACCESS-KEY:'"$API_KEY"'' -H 'ACCESS-NONCE:'"$ACCESS_NONCE"'' -H 'ACCESS
978998

979999
"label": "string",
9801000
"address": "string",
1001+
"network": "string",
9811002
"txid": "string",
9821003
"destination_tag": 0,
9831004

0 commit comments

Comments
 (0)