The ByBit Client API has been upgraded to V5 version. The following Protocols are supported:
- WebSocket API: connect to a websocket server and provides real-time market data updates, account changes and more.
- REST API: send HTTP requests to get market data, place orders, account data...
Properties
You can configure the following properties in the Bybit property.
- ApiKey: you can request a new api key in your Bybit account, just copy the value to this property. If the APIKey is set, the client will connect to the websocket private server. If it's empty, will connect to the WebSocket public server.
- ApiSecret: it's the secret value of the api.
- SignatureExpires: number of seconds after the signature expires (by default 10 seconds).
- TestNet: if enabled, will connect to the Bybit TestNet Demo account (disabled by default).
Connection
When the client successfully connects to Bybit servers, the event OnConnect is fired. After the event OnConnect is fired, then you can start to send and receive messages to/from Bybit servers. If you are connecting to the private websocket channel, you must wait till OnBybitAuthentication event is fired and check if the success parameter is true, before subscribe to any channel.
The client supports several APIs, so use the property BybitClient to set which API you want to use:
- bybSpot
- bybPerpetual
- bybLinear
- bybFutures
Find below an example of connecting to WebSocket Spot Private API.
After a successful connection to the Spot WebSocket Server, you can start to subscribe to WebSocket channels, just access the REST_API property and then call any of the subscribe/unsubscribe methods available
Subscribe to WebSocket Channels
Find below an example of subscribing to the Private Spot Websocket Channels after a successful authentication.
Placing Orders
Find below an example of Placing a Market Order