code/bybit-api
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update links to new bybit api docs

Browse Source
This commit is contained in:
Stefan Aebischer
2020-02-17 21:59:06 -05:00
parent 6464f83608
commit f4ef361816
2 changed files with 58 additions and 45 deletions
Download Patch File Download Diff File Expand all files Collapse all files

64
doc/rest-client.md
View File

@@ -14,106 +14,106 @@ If you only use the [public endpoints](#public-endpoints) you can ommit key and
### Private enpoints
#### async placeActiveOrder(params)
[See bybit documentation](https://github.com/bybit-exchange/bybit-official-api-docs/blob/master/en/rest_api.md#place-active-order-v2)
[See bybit documentation](https://bybit-exchange.github.io/docs/inverse/#t-placev2active)
#### async getActiveOrder(params)
[See bybit documentation](https://github.com/bybit-exchange/bybit-official-api-docs/blob/master/en/rest_api.md#get-active-order)
[See bybit documentation](https://bybit-exchange.github.io/docs/inverse/#t-getactive)
#### async cancelActiveOrder(params)
[See bybit documentation](https://github.com/bybit-exchange/bybit-official-api-docs/blob/master/en/rest_api.md#open-apiordercancelv2post)
[See bybit documentation](https://bybit-exchange.github.io/docs/inverse/#t-cancelv2active)
#### async cancelAllActiveOrders(params)
[See bybit documentation](https://github.com/bybit-exchange/bybit-official-api-docs/blob/master/en/rest_api.md#open-apiordercancelallpost)
[See bybit documentation](https://bybit-exchange.github.io/docs/inverse/#t-cancelallactive)
#### async replaceActiveOrder(params)
[See bybit documentation](https://github.com/bybit-exchange/bybit-official-api-docs/blob/master/en/rest_api.md#open-apiorderreplacepost)
[See bybit documentation](https://bybit-exchange.github.io/docs/inverse/#t-replaceactive)
#### async queryActiveOrder(params)
[See bybit documentation](https://github.com/bybit-exchange/bybit-official-api-docs/blob/master/en/rest_api.md#query-active-order-real-time)
[See bybit documentation](https://bybit-exchange.github.io/docs/inverse/#t-queryactive)
#### async placeConditionalOrder(params)
[See bybit documentation](https://github.com/bybit-exchange/bybit-official-api-docs/blob/master/en/rest_api.md#place-conditional-order)
[See bybit documentation](https://bybit-exchange.github.io/docs/inverse/#t-placecond)
#### async getConditioanlOrder(params)
[See bybit documentation](https://github.com/bybit-exchange/bybit-official-api-docs/blob/master/en/rest_api.md#get-conditional-order)
[See bybit documentation](https://bybit-exchange.github.io/docs/inverse/#t-getcond)
#### async cancelConditionalOrder(params)
[See bybit documentation](https://github.com/bybit-exchange/bybit-official-api-docs/blob/master/en/rest_api.md#cancel-conditional-order-)
[See bybit documentation](https://bybit-exchange.github.io/docs/inverse/#t-cancelcond)
#### async cancelAllConditionalOrders(params)
[See bybit documentation](https://github.com/bybit-exchange/bybit-official-api-docs/blob/master/en/rest_api.md#cancel-all-conditional-orders)
[See bybit documentation](https://bybit-exchange.github.io/docs/inverse/#t-cancelallcond)
#### async queryConditionalOrder(params)
[See bybit documentation](https://github.com/bybit-exchange/bybit-official-api-docs/blob/master/en/rest_api.md#query-stop-order-real-time)
[See bybit documentation](https://bybit-exchange.github.io/docs/inverse/#t-querycond)
#### async getUserLeverage()
[See bybit documentation](https://github.com/bybit-exchange/bybit-official-api-docs/blob/master/en/rest_api.md#user-leverage)
[See bybit documentation](https://bybit-exchange.github.io/docs/inverse/#t-getleverage)
#### async changeUserLeverage(params)
[See bybit documentation](https://github.com/bybit-exchange/bybit-official-api-docs/blob/master/en/rest_api.md#-change-user-leverage)
[See bybit documentation](https://bybit-exchange.github.io/docs/inverse/#t-changeleverage)
#### async getPosition(params)
[See bybit documentation](https://github.com/bybit-exchange/bybit-official-api-docs/blob/master/en/rest_api.md#-my-position-v2)
[See bybit documentation](https://bybit-exchange.github.io/docs/inverse/#t-mypositionv2)
#### async getPositions()
*Deprecated v1 method*
[See bybit documentation](https://github.com/bybit-exchange/bybit-official-api-docs/blob/master/en/rest_api.md#positionlistget)
#### async changePositionMargin(params)
[See bybit documentation](https://github.com/bybit-exchange/bybit-official-api-docs/blob/master/en/rest_api.md#-change-position-margin)
[See bybit documentation](https://bybit-exchange.github.io/docs/inverse/#t-changemargin)
#### async setTradingStop(params)
[See bybit documentation](https://github.com/bybit-exchange/bybit-official-api-docs/blob/master/en/rest_api.md#-set-trading-stop)
[See bybit documentation](https://bybit-exchange.github.io/docs/inverse/#t-tradingstop)
#### async getWalletFundRecords(params)
[See bybit documentation](https://github.com/bybit-exchange/bybit-official-api-docs/blob/master/en/rest_api.md#-get-wallet-fund-records)
[See bybit documentation](https://bybit-exchange.github.io/docs/inverse/#t-walletrecords)
#### async getWithdrawRecords(params)
[See bybit documentation](https://github.com/bybit-exchange/bybit-official-api-docs/blob/master/en/rest_api.md#-get-withdraw-records)
[See bybit documentation](https://bybit-exchange.github.io/docs/inverse/#t-withdrawrecords)
#### async getWalletBalance(params)
[See bybit documentation](https://github.com/bybit-exchange/bybit-official-api-docs/blob/master/en/rest_api.md#open-apiwalletbalanceget)
[See bybit documentation](https://bybit-exchange.github.io/docs/inverse/#t-balance)
#### async setRiskLimit(params)
[See bybit documentation](https://github.com/bybit-exchange/bybit-official-api-docs/blob/master/en/rest_api.md#set-risk-limit-)
[See bybit documentation](https://bybit-exchange.github.io/docs/inverse/#t-setrisklimit)
#### async getRiskLimitList()
[See bybit documentation](https://github.com/bybit-exchange/bybit-official-api-docs/blob/master/en/rest_api.md#get-risk-limit-list-)
[See bybit documentation](https://bybit-exchange.github.io/docs/inverse/#t-getrisklimit)
#### async getLastFundingRate(params)
[See bybit documentation](https://github.com/bybit-exchange/bybit-official-api-docs/blob/master/en/rest_api.md#-get-the-last-funding-rate)
[See bybit documentation](https://bybit-exchange.github.io/docs/inverse/#t-fundingrate)
#### async getMyLastFundingFee(params)
[See bybit documentation](https://github.com/bybit-exchange/bybit-official-api-docs/blob/master/en/rest_api.md#-get-my-last-funding-fee)
[See bybit documentation](https://bybit-exchange.github.io/docs/inverse/#t-mylastfundingfee)
#### async getPredictedFunding(params)
[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)
[See bybit documentation](https://bybit-exchange.github.io/docs/inverse/#t-predictedfunding)
#### async getTradeRecords(params)
[See bybit documentation](https://github.com/bybit-exchange/bybit-official-api-docs/blob/master/en/rest_api.md#get-users-trade-records)
[See bybit documentation](https://bybit-exchange.github.io/docs/inverse/#t-usertraderecords)
### Public enpoints
#### async getOrderBook(params)
[See bybit documentation](https://github.com/bybit-exchange/bybit-official-api-docs/blob/master/en/rest_api.md#get-orderbook)
[See bybit documentation](https://bybit-exchange.github.io/docs/inverse/#t-orderbook)
#### async getLatestInformation()
[See bybit documentation](https://github.com/bybit-exchange/bybit-official-api-docs/blob/master/en/rest_api.md#latest-information-for-symbol)
[See bybit documentation](https://bybit-exchange.github.io/docs/inverse/#t-latestsymbolinfo)
#### async getPublicTradingRecords(params)
[See bybit documentation](https://github.com/bybit-exchange/bybit-official-api-docs/blob/master/en/rest_api.md#get-public-trading-records)
[See bybit documentation](https://bybit-exchange.github.io/docs/inverse/#t-publictradingrecords)
#### async getServerTime()
[See bybit documentation](https://github.com/bybit-exchange/bybit-official-api-docs/blob/master/en/rest_api.md#server-time)
[See bybit documentation](https://bybit-exchange.github.io/docs/inverse/#t-servertime)
#### async getApiAnnouncements()
[See bybit documentation](https://github.com/bybit-exchange/bybit-official-api-docs/blob/master/en/rest_api.md#open-apiannouncement)
[See bybit documentation](https://bybit-exchange.github.io/docs/inverse/#t-announcement)
#### async getSymbols()
Returns symbol information (such as tick size & min notional):
[Meeting price restrictions](https://github.com/bybit-exchange/bybit-official-api-docs/blob/master/en/rest_api.md#price-price)
[Meeting price restrictions](https://bybit-exchange.github.io/docs/inverse/#price-price)
[See bybit documentation](https://bybit-exchange.github.io/bybit-official-api-docs/en/index.html#operation/query_symbol)
[See bybit documentation](https://bybit-exchange.github.io/docs/inverse/#t-querysymbol)
#### async getTimeOffset()

39
doc/websocket-client.md
View File

@@ -100,9 +100,8 @@ Emitted when an error occurs.
## Available Topics
Generaly all topics as described in the
[official bybit api documentation](https://github.com/bybit-exchange/bybit-official-api-docs/blob/master/en/websocket.md)
are available.
Generaly all [public](https://bybit-exchange.github.io/docs/inverse/#t-publictopics) and [private](https://bybit-exchange.github.io/docs/inverse/#t-privatetopics)
topics are available.
### Private topics
@@ -111,21 +110,28 @@ Generaly all topics as described in the
All positions of your account.
Topic: `position`
[See bybit documentation](https://github.com/bybit-exchange/bybit-official-api-docs/blob/master/en/websocket.md#positions-of-your-account)
[See bybit documentation](https://bybit-exchange.github.io/docs/inverse/#t-websocketposition)
#### Execution message
Execution message, whenever an order has been (partially) filled.
Topic: `execution`
[See bybit documentation](https://github.com/bybit-exchange/bybit-official-api-docs/blob/master/en/websocket.md#execution-message)
[See bybit documentation](https://bybit-exchange.github.io/docs/inverse/#t-websocketexecution)
#### Update for your orders
Updates for your active orders
Topic: `order`
[See bybit documentation](https://github.com/bybit-exchange/bybit-official-api-docs/blob/master/en/websocket.md#update-for-your-orders)
[See bybit documentation](https://bybit-exchange.github.io/docs/inverse/#t-websocketorder)
#### Update for your conditional orders
Updates for your active conditional orders
Topic: `stop_order`
[See bybit documentation](https://bybit-exchange.github.io/docs/inverse/#t-websocketstoporder)
### Public topics
@@ -133,36 +139,43 @@ Topic: `order`
#### Candlestick chart
Candlestick OHLC "candles" for selected symbol and interval.
Example topic: `kline.BTCUSD.1m`
Example topic: `klineV2.BTCUSD.1m`
[See bybit documentation](https://github.com/bybit-exchange/bybit-official-api-docs/blob/master/en/websocket.md#kline)
[See bybit documentation](https://bybit-exchange.github.io/docs/inverse/#t-websocketklinev2)
#### Real-time trading information
All trades as they occur.
Topic: `trade`
[See bybit documentation](https://github.com/bybit-exchange/bybit-official-api-docs/blob/master/en/websocket.md#trade)
[See bybit documentation](https://bybit-exchange.github.io/docs/inverse/#t-websockettrade)
#### Daily insurance fund update
Topic: `insurance`
[See bybit documentation](https://github.com/bybit-exchange/bybit-official-api-docs/blob/master/en/websocket.md#daily-insurance-fund-update)
[See bybit documentation](https://bybit-exchange.github.io/docs/inverse/#t-websocketinsurance)
#### OrderBook of 25 depth per side
OrderBook for selected symbol
Example topic: `orderBookL2_25.BTCUSD`
[See bybit documentation](https://github.com/bybit-exchange/bybit-official-api-docs/blob/master/en/websocket.md#orderBook25_v2)
[See bybit documentation](https://bybit-exchange.github.io/docs/inverse/#t-websocketorderbook25)
#### OrderBook of 200 depth per side
OrderBook for selected symbol
Example topic: `orderBook_200.100ms.BTCUS`
[See bybit documentation](https://bybit-exchange.github.io/docs/inverse/#t-websocketorderbook200)
#### Latest information for symbol
LAtest information for selected symbol
Latest information for selected symbol
Example topic: `instrument_info.100ms.BTCUSD`
[See bybit documentation](https://github.com/bybit-exchange/bybit-official-api-docs/blob/master/en/websocket.md#instrument_info)
[See bybit documentation](https://bybit-exchange.github.io/docs/inverse/#t-websocketinstrumentinfo)
## Example