From 20d60da75a6770a1e31cab684f8859d15d4b39b5 Mon Sep 17 00:00:00 2001 From: tiagosiebler Date: Wed, 31 Aug 2022 18:00:09 +0100 Subject: [PATCH] update readme --- README.md | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c451745..98bb8f3 100644 --- a/README.md +++ b/README.md @@ -4,9 +4,15 @@ [![last commit](https://img.shields.io/github/last-commit/tiagosiebler/bybit-api)][1] [![CodeFactor](https://www.codefactor.io/repository/github/tiagosiebler/bybit-api/badge)](https://www.codefactor.io/repository/github/tiagosiebler/bybit-api) +[![connector logo](https://cdn.builder.io/api/v1/image/assets%2Ffddee401a9284ab792b271538c28932d%2F5190c99403ac474699a1959fdee1ab6c?format=webp&width=2000)][1] + [1]: https://www.npmjs.com/package/bybit-api -Node.js connector for the Bybit APIs and WebSockets, with TypeScript & browser support. +Node.js connector for the Bybit APIs and WebSockets: +- TypeScript support (with type declarations for most API requests & responses). +- Integration tests with real API calls validating any changes before they reach npm. +- Robust WebSocket integration with connection heartbeats & automatic reconnection. +- Browser support (via webpack bundle - see "Browser Usage" below). ## Installation `npm install --save bybit-api` @@ -32,6 +38,17 @@ Most methods accept JS objects. These can be populated using parameters specifie - [Bybit API Inverse Futures Documentation](https://bybit-exchange.github.io/docs/inverse_futures/#t-introduction). - [Bybit API Linear Documentation](https://bybit-exchange.github.io/docs/linear/#t-introduction) +## REST Clients +Each REST API category has a dedicated REST client. Here are the REST clients and their API group: +| Class | Description | +|:-----------------------------------------------------: |:------------------------------: | +| [InverseClient](src/inverse-client.ts) | Inverse Perpetual Futures (v2) | +| [LinearClient](src/linear-client.ts) | USDT Perpetual Futures (v2) | +| [InverseFuturesClient](src/inverse-futures-client.ts) | Inverse Futures (v2) | +| [SpotClient](src/spot-client.ts) | Spot Markets | +| USDC Options & Perpetual Contracts | Under Development | +| Derivatives V3 unified margin | Under Development | + ## Structure This project uses typescript. Resources are stored in 3 key structures: - [src](./src) - the whole connector written in typescript