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

rename option client. update docs

Browse Source
This commit is contained in:
tiagosiebler
2022-09-08 18:34:49 +01:00
parent 557ddc90f5
commit c100c4af6f
5 changed files with 21 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@@ -41,16 +41,19 @@ Most methods accept JS objects. These can be populated using parameters specifie
## 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)](https://bybit-exchange.github.io/docs/futuresV2/inverse/) |
| [LinearClient](src/linear-client.ts) | [USDT Perpetual Futures (v2)](https://bybit-exchange.github.io/docs/futuresV2/linear/#t-introduction) |
| [InverseFuturesClient](src/inverse-futures-client.ts) | [Inverse Futures (v2)](https://bybit-exchange.github.io/docs/futuresV2/inverse_futures/#t-introduction) |
| [SpotClient](src/spot-client.ts) | [Spot Markets](https://bybit-exchange.github.io/docs/spot/#t-introduction) |
| [AccountAssetClient](src/account-asset-client.ts) | [Account Asset API](https://bybit-exchange.github.io/docs/account_asset/#t-introduction) |
| USDC Options & Perpetual Contracts | Under Development |
| Derivatives V3 unified margin | Under Development |
| [WebsocketClient](src/websocket-client.ts) | All WebSocket Events (Public & Private for all API categories) |
| Class | Description |
|:-----------------------------------------------------: |:-----------------------------------------------------------------------------------------------------------: |
| [InverseClient](src/inverse-client.ts) | [Inverse Perpetual Futures (v2) APIs](https://bybit-exchange.github.io/docs/futuresV2/inverse/) |
| [LinearClient](src/linear-client.ts) | [USDT Perpetual Futures (v2) APIs](https://bybit-exchange.github.io/docs/futuresV2/linear/#t-introduction) |
| [InverseFuturesClient](src/inverse-futures-client.ts) | [Inverse Futures (v2) APIs](https://bybit-exchange.github.io/docs/futuresV2/inverse_futures/#t-introduction) |
| [SpotClient](src/spot-client.ts) | [Spot Market APIs](https://bybit-exchange.github.io/docs/spot/#t-introduction) |
| [AccountAssetClient](src/account-asset-client.ts) | [Account Asset APIs](https://bybit-exchange.github.io/docs/account_asset/#t-introduction) |
| [USDC Perpetual](src/usdc-perpetual-client.ts) | [USDC Perpetual APIs](https://bybit-exchange.github.io/docs/usdc/option/?console#t-querydeliverylog) |
| [USDC Option](src/usdc-options-client.ts) | [USDC Option APIs](https://bybit-exchange.github.io/docs/usdc/option/#t-introduction) |
| [AccountAssetClient](src/account-asset-client.ts) | [Account Asset APIs](https://bybit-exchange.github.io/docs/account_asset/#t-introduction) |
| Spot v3 | Under Development |
| Derivatives V3 unified margin | Under Development |
| [WebsocketClient](src/websocket-client.ts) | All WebSocket Events (Public & Private for all API categories) |
Examples for using each client can be found in the [examples](./examples) folder and the [awesome-crypto-examples](https://github.com/tiagosiebler/awesome-crypto-examples) repository.

4
src/usdc-options-client.ts
View File

@@ -23,9 +23,9 @@ import { REST_CLIENT_TYPE_ENUM } from './util';
import BaseRestClient from './util/BaseRestClient';
/**
* REST API client for USDC Options APIs
* REST API client for USDC Option APIs
*/
export class USDCOptionsClient extends BaseRestClient {
export class USDCOptionClient extends BaseRestClient {
getClientType() {
return REST_CLIENT_TYPE_ENUM.usdc;
}

4
test/usdc/options/private.read.test.ts
View File

@@ -1,4 +1,4 @@
import { USDCOptionsClient } from '../../../src';
import { USDCOptionClient } from '../../../src';
import {
successResponseObject,
successUSDCResponseObject,
@@ -15,7 +15,7 @@ describe('Private Account Asset REST API Endpoints', () => {
expect(API_SECRET).toStrictEqual(expect.any(String));
});
const api = new USDCOptionsClient(API_KEY, API_SECRET, useLivenet);
const api = new USDCOptionClient(API_KEY, API_SECRET, useLivenet);
const category = 'OPTION';
it('getActiveRealtimeOrders()', async () => {

4
test/usdc/options/private.write.test.ts
View File

@@ -1,4 +1,4 @@
import { API_ERROR_CODE, USDCOptionsClient } from '../../../src';
import { API_ERROR_CODE, USDCOptionClient } from '../../../src';
import { successUSDCResponseObject } from '../../response.util';
describe('Private Account Asset REST API Endpoints', () => {
@@ -11,7 +11,7 @@ describe('Private Account Asset REST API Endpoints', () => {
expect(API_SECRET).toStrictEqual(expect.any(String));
});
const api = new USDCOptionsClient(API_KEY, API_SECRET, useLivenet);
const api = new USDCOptionClient(API_KEY, API_SECRET, useLivenet);
const currency = 'USDC';
const symbol = 'BTC-30SEP22-400000-C';

4
test/usdc/options/public.read.test.ts
View File

@@ -1,4 +1,4 @@
import { USDCOptionsClient } from '../../../src';
import { USDCOptionClient } from '../../../src';
import {
successResponseObject,
successUSDCResponseObject,
@@ -9,7 +9,7 @@ describe('Public USDC Options REST API Endpoints', () => {
const API_KEY = undefined;
const API_SECRET = undefined;
const api = new USDCOptionsClient(API_KEY, API_SECRET, useLivenet);
const api = new USDCOptionClient(API_KEY, API_SECRET, useLivenet);
const symbol = 'BTC-30SEP22-400000-C';
it('getOrderBook()', async () => {