Skip to content
This repository was archived by the owner on Dec 4, 2020. It is now read-only.

Commit f4ef361

Browse files
committed
Update links to new bybit api docs
1 parent 6464f83 commit f4ef361

File tree

2 files changed

+58
-45
lines changed

2 files changed

+58
-45
lines changed

doc/rest-client.md

Lines changed: 32 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -14,106 +14,106 @@ If you only use the [public endpoints](#public-endpoints) you can ommit key and
1414
### Private enpoints
1515

1616
#### async placeActiveOrder(params)
17-
[See bybit documentation](https://github.com/bybit-exchange/bybit-official-api-docs/blob/master/en/rest_api.md#place-active-order-v2)
17+
[See bybit documentation](https://bybit-exchange.github.io/docs/inverse/#t-placev2active)
1818

1919
#### async getActiveOrder(params)
20-
[See bybit documentation](https://github.com/bybit-exchange/bybit-official-api-docs/blob/master/en/rest_api.md#get-active-order)
20+
[See bybit documentation](https://bybit-exchange.github.io/docs/inverse/#t-getactive)
2121

2222
#### async cancelActiveOrder(params)
23-
[See bybit documentation](https://github.com/bybit-exchange/bybit-official-api-docs/blob/master/en/rest_api.md#open-apiordercancelv2post)
23+
[See bybit documentation](https://bybit-exchange.github.io/docs/inverse/#t-cancelv2active)
2424

2525
#### async cancelAllActiveOrders(params)
26-
[See bybit documentation](https://github.com/bybit-exchange/bybit-official-api-docs/blob/master/en/rest_api.md#open-apiordercancelallpost)
26+
[See bybit documentation](https://bybit-exchange.github.io/docs/inverse/#t-cancelallactive)
2727

2828
#### async replaceActiveOrder(params)
29-
[See bybit documentation](https://github.com/bybit-exchange/bybit-official-api-docs/blob/master/en/rest_api.md#open-apiorderreplacepost)
29+
[See bybit documentation](https://bybit-exchange.github.io/docs/inverse/#t-replaceactive)
3030

3131
#### async queryActiveOrder(params)
32-
[See bybit documentation](https://github.com/bybit-exchange/bybit-official-api-docs/blob/master/en/rest_api.md#query-active-order-real-time)
32+
[See bybit documentation](https://bybit-exchange.github.io/docs/inverse/#t-queryactive)
3333

3434
#### async placeConditionalOrder(params)
35-
[See bybit documentation](https://github.com/bybit-exchange/bybit-official-api-docs/blob/master/en/rest_api.md#place-conditional-order)
35+
[See bybit documentation](https://bybit-exchange.github.io/docs/inverse/#t-placecond)
3636

3737
#### async getConditioanlOrder(params)
38-
[See bybit documentation](https://github.com/bybit-exchange/bybit-official-api-docs/blob/master/en/rest_api.md#get-conditional-order)
38+
[See bybit documentation](https://bybit-exchange.github.io/docs/inverse/#t-getcond)
3939

4040
#### async cancelConditionalOrder(params)
41-
[See bybit documentation](https://github.com/bybit-exchange/bybit-official-api-docs/blob/master/en/rest_api.md#cancel-conditional-order-)
41+
[See bybit documentation](https://bybit-exchange.github.io/docs/inverse/#t-cancelcond)
4242

4343
#### async cancelAllConditionalOrders(params)
44-
[See bybit documentation](https://github.com/bybit-exchange/bybit-official-api-docs/blob/master/en/rest_api.md#cancel-all-conditional-orders)
44+
[See bybit documentation](https://bybit-exchange.github.io/docs/inverse/#t-cancelallcond)
4545

4646
#### async queryConditionalOrder(params)
47-
[See bybit documentation](https://github.com/bybit-exchange/bybit-official-api-docs/blob/master/en/rest_api.md#query-stop-order-real-time)
47+
[See bybit documentation](https://bybit-exchange.github.io/docs/inverse/#t-querycond)
4848

4949
#### async getUserLeverage()
50-
[See bybit documentation](https://github.com/bybit-exchange/bybit-official-api-docs/blob/master/en/rest_api.md#user-leverage)
50+
[See bybit documentation](https://bybit-exchange.github.io/docs/inverse/#t-getleverage)
5151

5252
#### async changeUserLeverage(params)
53-
[See bybit documentation](https://github.com/bybit-exchange/bybit-official-api-docs/blob/master/en/rest_api.md#-change-user-leverage)
53+
[See bybit documentation](https://bybit-exchange.github.io/docs/inverse/#t-changeleverage)
5454

5555
#### async getPosition(params)
56-
[See bybit documentation](https://github.com/bybit-exchange/bybit-official-api-docs/blob/master/en/rest_api.md#-my-position-v2)
56+
[See bybit documentation](https://bybit-exchange.github.io/docs/inverse/#t-mypositionv2)
5757

5858
#### async getPositions()
5959
*Deprecated v1 method*
6060
[See bybit documentation](https://github.com/bybit-exchange/bybit-official-api-docs/blob/master/en/rest_api.md#positionlistget)
6161

6262
#### async changePositionMargin(params)
63-
[See bybit documentation](https://github.com/bybit-exchange/bybit-official-api-docs/blob/master/en/rest_api.md#-change-position-margin)
63+
[See bybit documentation](https://bybit-exchange.github.io/docs/inverse/#t-changemargin)
6464

6565
#### async setTradingStop(params)
66-
[See bybit documentation](https://github.com/bybit-exchange/bybit-official-api-docs/blob/master/en/rest_api.md#-set-trading-stop)
66+
[See bybit documentation](https://bybit-exchange.github.io/docs/inverse/#t-tradingstop)
6767

6868
#### async getWalletFundRecords(params)
69-
[See bybit documentation](https://github.com/bybit-exchange/bybit-official-api-docs/blob/master/en/rest_api.md#-get-wallet-fund-records)
69+
[See bybit documentation](https://bybit-exchange.github.io/docs/inverse/#t-walletrecords)
7070

7171
#### async getWithdrawRecords(params)
72-
[See bybit documentation](https://github.com/bybit-exchange/bybit-official-api-docs/blob/master/en/rest_api.md#-get-withdraw-records)
72+
[See bybit documentation](https://bybit-exchange.github.io/docs/inverse/#t-withdrawrecords)
7373

7474
#### async getWalletBalance(params)
75-
[See bybit documentation](https://github.com/bybit-exchange/bybit-official-api-docs/blob/master/en/rest_api.md#open-apiwalletbalanceget)
75+
[See bybit documentation](https://bybit-exchange.github.io/docs/inverse/#t-balance)
7676

7777
#### async setRiskLimit(params)
78-
[See bybit documentation](https://github.com/bybit-exchange/bybit-official-api-docs/blob/master/en/rest_api.md#set-risk-limit-)
78+
[See bybit documentation](https://bybit-exchange.github.io/docs/inverse/#t-setrisklimit)
7979

8080
#### async getRiskLimitList()
81-
[See bybit documentation](https://github.com/bybit-exchange/bybit-official-api-docs/blob/master/en/rest_api.md#get-risk-limit-list-)
81+
[See bybit documentation](https://bybit-exchange.github.io/docs/inverse/#t-getrisklimit)
8282

8383
#### async getLastFundingRate(params)
84-
[See bybit documentation](https://github.com/bybit-exchange/bybit-official-api-docs/blob/master/en/rest_api.md#-get-the-last-funding-rate)
84+
[See bybit documentation](https://bybit-exchange.github.io/docs/inverse/#t-fundingrate)
8585

8686
#### async getMyLastFundingFee(params)
87-
[See bybit documentation](https://github.com/bybit-exchange/bybit-official-api-docs/blob/master/en/rest_api.md#-get-my-last-funding-fee)
87+
[See bybit documentation](https://bybit-exchange.github.io/docs/inverse/#t-mylastfundingfee)
8888

8989
#### async getPredictedFunding(params)
90-
[See bybit documentation](https://github.com/bybit-exchange/bybit-official-api-docs/blob/master/en/rest_api.md#get-predicted-funding-rate-and-funding-fee)
90+
[See bybit documentation](https://bybit-exchange.github.io/docs/inverse/#t-predictedfunding)
9191

9292
#### async getTradeRecords(params)
93-
[See bybit documentation](https://github.com/bybit-exchange/bybit-official-api-docs/blob/master/en/rest_api.md#get-users-trade-records)
93+
[See bybit documentation](https://bybit-exchange.github.io/docs/inverse/#t-usertraderecords)
9494

9595
### Public enpoints
9696

9797
#### async getOrderBook(params)
98-
[See bybit documentation](https://github.com/bybit-exchange/bybit-official-api-docs/blob/master/en/rest_api.md#get-orderbook)
98+
[See bybit documentation](https://bybit-exchange.github.io/docs/inverse/#t-orderbook)
9999

100100
#### async getLatestInformation()
101-
[See bybit documentation](https://github.com/bybit-exchange/bybit-official-api-docs/blob/master/en/rest_api.md#latest-information-for-symbol)
101+
[See bybit documentation](https://bybit-exchange.github.io/docs/inverse/#t-latestsymbolinfo)
102102

103103
#### async getPublicTradingRecords(params)
104-
[See bybit documentation](https://github.com/bybit-exchange/bybit-official-api-docs/blob/master/en/rest_api.md#get-public-trading-records)
104+
[See bybit documentation](https://bybit-exchange.github.io/docs/inverse/#t-publictradingrecords)
105105

106106
#### async getServerTime()
107-
[See bybit documentation](https://github.com/bybit-exchange/bybit-official-api-docs/blob/master/en/rest_api.md#server-time)
107+
[See bybit documentation](https://bybit-exchange.github.io/docs/inverse/#t-servertime)
108108

109109
#### async getApiAnnouncements()
110-
[See bybit documentation](https://github.com/bybit-exchange/bybit-official-api-docs/blob/master/en/rest_api.md#open-apiannouncement)
110+
[See bybit documentation](https://bybit-exchange.github.io/docs/inverse/#t-announcement)
111111

112112
#### async getSymbols()
113113
Returns symbol information (such as tick size & min notional):
114-
[Meeting price restrictions](https://github.com/bybit-exchange/bybit-official-api-docs/blob/master/en/rest_api.md#price-price)
114+
[Meeting price restrictions](https://bybit-exchange.github.io/docs/inverse/#price-price)
115115

116-
[See bybit documentation](https://bybit-exchange.github.io/bybit-official-api-docs/en/index.html#operation/query_symbol)
116+
[See bybit documentation](https://bybit-exchange.github.io/docs/inverse/#t-querysymbol)
117117

118118
#### async getTimeOffset()
119119

doc/websocket-client.md

Lines changed: 26 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -100,9 +100,8 @@ Emitted when an error occurs.
100100

101101
## Available Topics
102102

103-
Generaly all topics as described in the
104-
[official bybit api documentation](https://github.com/bybit-exchange/bybit-official-api-docs/blob/master/en/websocket.md)
105-
are available.
103+
Generaly all [public](https://bybit-exchange.github.io/docs/inverse/#t-publictopics) and [private](https://bybit-exchange.github.io/docs/inverse/#t-privatetopics)
104+
topics are available.
106105

107106
### Private topics
108107

@@ -111,58 +110,72 @@ Generaly all topics as described in the
111110
All positions of your account.
112111
Topic: `position`
113112

114-
[See bybit documentation](https://github.com/bybit-exchange/bybit-official-api-docs/blob/master/en/websocket.md#positions-of-your-account)
113+
[See bybit documentation](https://bybit-exchange.github.io/docs/inverse/#t-websocketposition)
115114

116115
#### Execution message
117116

118117
Execution message, whenever an order has been (partially) filled.
119118
Topic: `execution`
120119

121-
[See bybit documentation](https://github.com/bybit-exchange/bybit-official-api-docs/blob/master/en/websocket.md#execution-message)
120+
[See bybit documentation](https://bybit-exchange.github.io/docs/inverse/#t-websocketexecution)
122121

123122
#### Update for your orders
124123

125124
Updates for your active orders
126125
Topic: `order`
127126

128-
[See bybit documentation](https://github.com/bybit-exchange/bybit-official-api-docs/blob/master/en/websocket.md#update-for-your-orders)
127+
[See bybit documentation](https://bybit-exchange.github.io/docs/inverse/#t-websocketorder)
128+
129+
#### Update for your conditional orders
130+
131+
Updates for your active conditional orders
132+
Topic: `stop_order`
133+
134+
[See bybit documentation](https://bybit-exchange.github.io/docs/inverse/#t-websocketstoporder)
129135

130136

131137
### Public topics
132138

133139
#### Candlestick chart
134140

135141
Candlestick OHLC "candles" for selected symbol and interval.
136-
Example topic: `kline.BTCUSD.1m`
142+
Example topic: `klineV2.BTCUSD.1m`
137143

138-
[See bybit documentation](https://github.com/bybit-exchange/bybit-official-api-docs/blob/master/en/websocket.md#kline)
144+
[See bybit documentation](https://bybit-exchange.github.io/docs/inverse/#t-websocketklinev2)
139145

140146
#### Real-time trading information
141147

142148
All trades as they occur.
143149
Topic: `trade`
144150

145-
[See bybit documentation](https://github.com/bybit-exchange/bybit-official-api-docs/blob/master/en/websocket.md#trade)
151+
[See bybit documentation](https://bybit-exchange.github.io/docs/inverse/#t-websockettrade)
146152

147153
#### Daily insurance fund update
148154

149155
Topic: `insurance`
150156

151-
[See bybit documentation](https://github.com/bybit-exchange/bybit-official-api-docs/blob/master/en/websocket.md#daily-insurance-fund-update)
157+
[See bybit documentation](https://bybit-exchange.github.io/docs/inverse/#t-websocketinsurance)
152158

153159
#### OrderBook of 25 depth per side
154160

155161
OrderBook for selected symbol
156162
Example topic: `orderBookL2_25.BTCUSD`
157163

158-
[See bybit documentation](https://github.com/bybit-exchange/bybit-official-api-docs/blob/master/en/websocket.md#orderBook25_v2)
164+
[See bybit documentation](https://bybit-exchange.github.io/docs/inverse/#t-websocketorderbook25)
165+
166+
#### OrderBook of 200 depth per side
167+
168+
OrderBook for selected symbol
169+
Example topic: `orderBook_200.100ms.BTCUS`
170+
171+
[See bybit documentation](https://bybit-exchange.github.io/docs/inverse/#t-websocketorderbook200)
159172

160173
#### Latest information for symbol
161174

162-
LAtest information for selected symbol
175+
Latest information for selected symbol
163176
Example topic: `instrument_info.100ms.BTCUSD`
164177

165-
[See bybit documentation](https://github.com/bybit-exchange/bybit-official-api-docs/blob/master/en/websocket.md#instrument_info)
178+
[See bybit documentation](https://bybit-exchange.github.io/docs/inverse/#t-websocketinstrumentinfo)
166179

167180

168181
## Example

0 commit comments

Comments
 (0)