@bluefin-exchange/pro-sdk 0.1.61 → 0.2.0-pre-release.1

package/src/docs/TradeApi.md

@@ -1,589 +0,0 @@
-# TradeApi
-
-All URIs are relative to *https://api.sui-staging.bluefin.io*
-
-|Method | HTTP request | Description|
-|------------- | ------------- | -------------|
-|[**cancelOrders**](#cancelorders) | **PUT** /api/v1/trade/orders/cancel | /trade/orders/cancel|
-|[**cancelStandbyOrders**](#cancelstandbyorders) | **PUT** /api/v1/trade/orders/cancel/standby | /trade/orders/cancel/standby|
-|[**getOpenOrders**](#getopenorders) | **GET** /api/v1/trade/openOrders | /trade/openOrders|
-|[**getStandbyOrders**](#getstandbyorders) | **GET** /api/v1/trade/standbyOrders | /trade/standbyOrders|
-|[**postCreateOrder**](#postcreateorder) | **POST** /api/v1/trade/orders | /trade/orders|
-|[**postWithdraw**](#postwithdraw) | **POST** /api/v1/trade/withdraw | /trade/withdraw|
-|[**putAdjustIsolatedMargin**](#putadjustisolatedmargin) | **PUT** /api/v1/trade/adjustIsolatedMargin | /trade/adjustIsolatedMargin|
-|[**putAuthorizeAccount**](#putauthorizeaccount) | **PUT** /api/v1/trade/accounts/authorize | /trade/accounts/authorize|
-|[**putDeauthorizeAccount**](#putdeauthorizeaccount) | **PUT** /api/v1/trade/accounts/deauthorize | /trade/accounts/deauthorize|
-|[**putLeverageUpdate**](#putleverageupdate) | **PUT** /api/v1/trade/leverage | /trade/leverage|
-
-# **cancelOrders**
-> cancelOrders(cancelOrdersRequest)
-
-Cancel orders for a market using order hashes. - May be a single order hash or a list of order hashes. - All orders must belong to the same account. - If no order hashes are specified, then will cancel all orders for the given market  - All orders being cancelled by request will receive the same time priority. 
-
-### Example
-
-```typescript
-import {
-    TradeApi,
-    Configuration,
-    CancelOrdersRequest
-} from '@bluefin/api-client';
-
-const configuration = new Configuration();
-const apiInstance = new TradeApi(configuration);
-
-let cancelOrdersRequest: CancelOrdersRequest; //
-
-const { status, data } = await apiInstance.cancelOrders(
-    cancelOrdersRequest
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **cancelOrdersRequest** | **CancelOrdersRequest**|  | |
-
-
-### Return type
-
-void (empty response body)
-
-### Authorization
-
-[bearerAuth](../README.md#bearerAuth)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**202** | Order cancellation submitted successfully. |  -  |
-|**400** | Bad Request. Invalid body parameters. |  -  |
-|**401** | Unauthorized. Authentication is required or invalid. |  -  |
-|**403** | Forbidden. |  -  |
-|**429** | Too Many Requests. The request was rate limited. |  -  |
-|**500** | Internal Server Error. An unexpected error occurred on the server. |  -  |
-|**503** | Service Unavailable. The service is currently unavailable. |  -  |
-
-[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
-
-# **cancelStandbyOrders**
-> CancelOrdersResponse cancelStandbyOrders(cancelOrdersRequest)
-
-Cancel orders in standby for a market using order hashes. - May be a single order hash or a list of order hashes. - All orders must belong to the same account. - If no order hashes are specified, then will cancel all orders for the given market - All orders being cancelled by request will receive the same time priority. 
-
-### Example
-
-```typescript
-import {
-    TradeApi,
-    Configuration,
-    CancelOrdersRequest
-} from '@bluefin/api-client';
-
-const configuration = new Configuration();
-const apiInstance = new TradeApi(configuration);
-
-let cancelOrdersRequest: CancelOrdersRequest; //
-
-const { status, data } = await apiInstance.cancelStandbyOrders(
-    cancelOrdersRequest
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **cancelOrdersRequest** | **CancelOrdersRequest**|  | |
-
-
-### Return type
-
-**CancelOrdersResponse**
-
-### Authorization
-
-[bearerAuth](../README.md#bearerAuth)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Orders cancelled successfully. |  -  |
-|**400** | Bad Request. Invalid body parameters. |  -  |
-|**403** | Forbidden. |  -  |
-|**401** | Unauthorized. Authentication is required or invalid. |  -  |
-|**429** | Too Many Requests. The request was rate limited. |  -  |
-|**500** | Internal Server Error. An unexpected error occurred on the server. |  -  |
-|**503** | Service Unavailable. The service is currently unavailable. |  -  |
-
-[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
-
-# **getOpenOrders**
-> Array<OpenOrderResponse> getOpenOrders()
-
-Retrieve details of open orders for a specific account.
-
-### Example
-
-```typescript
-import {
-    TradeApi,
-    Configuration
-} from '@bluefin/api-client';
-
-const configuration = new Configuration();
-const apiInstance = new TradeApi(configuration);
-
-let symbol: string; //Filter by specific perpetual symbol (optional) (optional) (default to undefined)
-
-const { status, data } = await apiInstance.getOpenOrders(
-    symbol
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **symbol** | [**string**] | Filter by specific perpetual symbol (optional) | (optional) defaults to undefined|
-
-
-### Return type
-
-**Array<OpenOrderResponse>**
-
-### Authorization
-
-[bearerAuth](../README.md#bearerAuth)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Open orders retrieved successfully. |  -  |
-|**400** | Bad Request. The request was invalid or malformed. |  -  |
-|**401** | Unauthorized. Authentication is required or invalid. |  -  |
-|**404** | Not Found. The requested account address was not found. |  -  |
-|**500** | Internal Server Error. An unexpected error occurred on the server. |  -  |
-
-[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
-
-# **getStandbyOrders**
-> Array<OpenOrderResponse> getStandbyOrders()
-
-Retrieve details of orders in standby for a specific account.
-
-### Example
-
-```typescript
-import {
-    TradeApi,
-    Configuration
-} from '@bluefin/api-client';
-
-const configuration = new Configuration();
-const apiInstance = new TradeApi(configuration);
-
-let symbol: string; //Filter by specific perpetual symbol (optional) (optional) (default to undefined)
-
-const { status, data } = await apiInstance.getStandbyOrders(
-    symbol
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **symbol** | [**string**] | Filter by specific perpetual symbol (optional) | (optional) defaults to undefined|
-
-
-### Return type
-
-**Array<OpenOrderResponse>**
-
-### Authorization
-
-[bearerAuth](../README.md#bearerAuth)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Orders in standby retrieved successfully. |  -  |
-|**400** | Bad Request. The request was invalid or malformed. |  -  |
-|**401** | Unauthorized. Authentication is required or invalid. |  -  |
-|**500** | Internal Server Error. An unexpected error occurred on the server. |  -  |
-
-[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
-
-# **postCreateOrder**
-> CreateOrderResponse postCreateOrder(createOrderRequest)
-
-Submit a new order for execution.
-
-### Example
-
-```typescript
-import {
-    TradeApi,
-    Configuration,
-    CreateOrderRequest
-} from '@bluefin/api-client';
-
-const configuration = new Configuration();
-const apiInstance = new TradeApi(configuration);
-
-let createOrderRequest: CreateOrderRequest; //
-
-const { status, data } = await apiInstance.postCreateOrder(
-    createOrderRequest
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **createOrderRequest** | **CreateOrderRequest**|  | |
-
-
-### Return type
-
-**CreateOrderResponse**
-
-### Authorization
-
-[bearerAuth](../README.md#bearerAuth)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Order creation successful. |  -  |
-|**202** | Order creation submitted successfully. |  -  |
-|**400** | Bad Request. The request was invalid or malformed. |  -  |
-|**401** | Unauthorized. Authentication is required or invalid. Signature is invalid |  -  |
-|**403** | Forbidden. |  -  |
-|**404** | Not Found. The requested account was not found. |  -  |
-|**429** | Too Many Requests. The request was rate limited. |  -  |
-|**500** | Internal Server Error. An unexpected error occurred on the server. |  -  |
-|**503** | Service Unavailable. The service is currently unavailable. |  -  |
-
-[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
-
-# **postWithdraw**
-> postWithdraw(withdrawRequest)
-
-Initiates a withdraw action to remove some amount of funds from a user\'s account.
-
-### Example
-
-```typescript
-import {
-    TradeApi,
-    Configuration,
-    WithdrawRequest
-} from '@bluefin/api-client';
-
-const configuration = new Configuration();
-const apiInstance = new TradeApi(configuration);
-
-let withdrawRequest: WithdrawRequest; //
-
-const { status, data } = await apiInstance.postWithdraw(
-    withdrawRequest
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **withdrawRequest** | **WithdrawRequest**|  | |
-
-
-### Return type
-
-void (empty response body)
-
-### Authorization
-
-[bearerAuth](../README.md#bearerAuth)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**202** | Withdraw request submitted successfully. |  -  |
-|**400** | Bad Request. The request was invalid or malformed. |  -  |
-|**401** | Unauthorized. Authentication is required or invalid. Signature is invalid |  -  |
-|**403** | Forbidden. |  -  |
-|**404** | Not Found. The requested resource was not found. |  -  |
-|**429** | Too Many Requests. The request was rate limited. |  -  |
-|**500** | Internal Server Error. An unexpected error occurred on the server. |  -  |
-|**503** | Service Unavailable. The service is currently unavailable. |  -  |
-
-[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
-
-# **putAdjustIsolatedMargin**
-> putAdjustIsolatedMargin(adjustIsolatedMarginRequest)
-
-Adjust margin for an isolated position on a specific market.
-
-### Example
-
-```typescript
-import {
-    TradeApi,
-    Configuration,
-    AdjustIsolatedMarginRequest
-} from '@bluefin/api-client';
-
-const configuration = new Configuration();
-const apiInstance = new TradeApi(configuration);
-
-let adjustIsolatedMarginRequest: AdjustIsolatedMarginRequest; //
-
-const { status, data } = await apiInstance.putAdjustIsolatedMargin(
-    adjustIsolatedMarginRequest
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **adjustIsolatedMarginRequest** | **AdjustIsolatedMarginRequest**|  | |
-
-
-### Return type
-
-void (empty response body)
-
-### Authorization
-
-[bearerAuth](../README.md#bearerAuth)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**202** | Adjust margin request sent successfully. |  -  |
-|**400** | Bad Request. The request was invalid or malformed. |  -  |
-|**401** | Unauthorized. Authentication is required or invalid. Signature is invalid |  -  |
-|**403** | Forbidden. |  -  |
-|**404** | Not Found. The requested account was not found. |  -  |
-|**500** | Internal Server Error. An unexpected error occurred on the server. |  -  |
-|**503** | Service Unavailable. The service is currently unavailable. |  -  |
-
-[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
-
-# **putAuthorizeAccount**
-> putAuthorizeAccount(accountAuthorizationRequest)
-
-Authorizes an account to trade, perform liquidations and more, on behalf of another account.
-
-### Example
-
-```typescript
-import {
-    TradeApi,
-    Configuration,
-    AccountAuthorizationRequest
-} from '@bluefin/api-client';
-
-const configuration = new Configuration();
-const apiInstance = new TradeApi(configuration);
-
-let accountAuthorizationRequest: AccountAuthorizationRequest; //
-
-const { status, data } = await apiInstance.putAuthorizeAccount(
-    accountAuthorizationRequest
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **accountAuthorizationRequest** | **AccountAuthorizationRequest**|  | |
-
-
-### Return type
-
-void (empty response body)
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**202** | Authorize Account request submitted successfully |  -  |
-|**400** | Bad Request. The request was invalid or malformed. |  -  |
-|**401** | Unauthorized. Authentication is required or invalid. Signature is invalid |  -  |
-|**500** | Internal Server Error. An unexpected error occurred on the server. |  -  |
-|**503** | Service Unavailable. The service is currently unavailable. |  -  |
-
-[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
-
-# **putDeauthorizeAccount**
-> putDeauthorizeAccount(accountAuthorizationRequest)
-
-Deauthorizes an account to trade, perform liquidations and more, on behalf of another account.
-
-### Example
-
-```typescript
-import {
-    TradeApi,
-    Configuration,
-    AccountAuthorizationRequest
-} from '@bluefin/api-client';
-
-const configuration = new Configuration();
-const apiInstance = new TradeApi(configuration);
-
-let accountAuthorizationRequest: AccountAuthorizationRequest; //
-
-const { status, data } = await apiInstance.putDeauthorizeAccount(
-    accountAuthorizationRequest
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **accountAuthorizationRequest** | **AccountAuthorizationRequest**|  | |
-
-
-### Return type
-
-void (empty response body)
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**202** | Deauthorize Account request submitted successfully |  -  |
-|**400** | Bad Request. The request was invalid or malformed. |  -  |
-|**401** | Unauthorized. Authentication is required or invalid. Signature is invalid |  -  |
-|**500** | Internal Server Error. An unexpected error occurred on the server. |  -  |
-|**503** | Service Unavailable. The service is currently unavailable. |  -  |
-
-[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
-
-# **putLeverageUpdate**
-> putLeverageUpdate(accountPositionLeverageUpdateRequest)
-
-Updates leverage for positions of a given market and closes all open orders for that market.
-
-### Example
-
-```typescript
-import {
-    TradeApi,
-    Configuration,
-    AccountPositionLeverageUpdateRequest
-} from '@bluefin/api-client';
-
-const configuration = new Configuration();
-const apiInstance = new TradeApi(configuration);
-
-let accountPositionLeverageUpdateRequest: AccountPositionLeverageUpdateRequest; //
-
-const { status, data } = await apiInstance.putLeverageUpdate(
-    accountPositionLeverageUpdateRequest
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **accountPositionLeverageUpdateRequest** | **AccountPositionLeverageUpdateRequest**|  | |
-
-
-### Return type
-
-void (empty response body)
-
-### Authorization
-
-[bearerAuth](../README.md#bearerAuth)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**202** | Leverage update request sent successfully. |  -  |
-|**400** | Bad Request. The request was invalid or malformed. |  -  |
-|**401** | Unauthorized. Authentication is required or invalid. Signature is invalid |  -  |
-|**403** | Forbidden. |  -  |
-|**404** | Not Found. The requested account was not found. |  -  |
-|**500** | Internal Server Error. An unexpected error occurred on the server. |  -  |
-|**503** | Service Unavailable. The service is currently unavailable. |  -  |
-
-[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
-

package/src/docs/TradeSide.md

@@ -1,13 +0,0 @@
-# TradeSide
-
-Trade side based on the user order in this trade.
-
-## Enum
-
-* `Long` (value: `'LONG'`)
-
-* `Short` (value: `'SHORT'`)
-
-* `Unspecified` (value: `'UNSPECIFIED'`)
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/src/docs/TradeType.md

@@ -1,15 +0,0 @@
-# TradeType
-
-Type of trade.
-
-## Enum
-
-* `Order` (value: `'ORDER'`)
-
-* `Liquidation` (value: `'LIQUIDATION'`)
-
-* `Deleverage` (value: `'DELEVERAGE'`)
-
-* `Unspecified` (value: `'UNSPECIFIED'`)
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/src/docs/TradingFees.md

@@ -1,24 +0,0 @@
-# TradingFees
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**makerFeeE9** | **string** | The Account Maker Fee (e9 format). | [default to undefined]
-**takerFeeE9** | **string** | The Account Taker Fee (e9 format). | [default to undefined]
-**isApplied** | **boolean** | Are the fees applied on the account? | [default to undefined]
-
-## Example
-
-```typescript
-import { TradingFees } from '@bluefin/api-client';
-
-const instance: TradingFees = {
-    makerFeeE9,
-    takerFeeE9,
-    isApplied,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/src/docs/Transaction.md

@@ -1,34 +0,0 @@
-# Transaction
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **string** | Transaction ID. | [default to undefined]
-**symbol** | **string** | Market address. | [optional] [default to undefined]
-**type** | [**TransactionType**](TransactionType.md) |  | [default to undefined]
-**amountE9** | **string** | Amount in e9 format (positive or negative). | [default to undefined]
-**status** | **string** | Transaction status (SUCCESS, REJECTED). | [optional] [default to undefined]
-**assetSymbol** | **string** | Asset bank address. | [default to undefined]
-**tradeId** | **string** | Trade ID | [optional] [default to undefined]
-**executedAtMillis** | **number** | Transaction timestamp in milliseconds since Unix epoch. | [default to undefined]
-
-## Example
-
-```typescript
-import { Transaction } from '@bluefin/api-client';
-
-const instance: Transaction = {
-    id,
-    symbol,
-    type,
-    amountE9,
-    status,
-    assetSymbol,
-    tradeId,
-    executedAtMillis,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/src/docs/TransactionType.md

@@ -1,25 +0,0 @@
-# TransactionType
-
-Transaction type (what caused the change in the asset balance).
-
-## Enum
-
-* `Transfer` (value: `'TRANSFER'`)
-
-* `Deposit` (value: `'DEPOSIT'`)
-
-* `Withdraw` (value: `'WITHDRAW'`)
-
-* `RealizedPnl` (value: `'REALIZED_PNL'`)
-
-* `FundingFee` (value: `'FUNDING_FEE'`)
-
-* `TradingFee` (value: `'TRADING_FEE'`)
-
-* `TradingGasFee` (value: `'TRADING_GAS_FEE'`)
-
-* `Bonus` (value: `'BONUS'`)
-
-* `Unspecified` (value: `'UNSPECIFIED'`)
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)