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

package/src/docs/RewardsSummary.md

@@ -1,26 +0,0 @@
-# RewardsSummary
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**userAddress** | **string** | User address for the rewards earned data. | [default to undefined]
-**blueRewardsE9** | **string** | Total Blue token rewards earned by the user (e9 format). | [default to undefined]
-**suiRewardsE9** | **string** | Total Sui token rewards earned by the user (e9 format). | [default to undefined]
-**walRewardsE9** | **string** | Total wal rewards earned by the user (e9 format). | [default to undefined]
-
-## Example
-
-```typescript
-import { RewardsSummary } from '@bluefin/api-client';
-
-const instance: RewardsSummary = {
-    userAddress,
-    blueRewardsE9,
-    suiRewardsE9,
-    walRewardsE9,
-};
-```
-
-[[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/SelfTradePreventionType.md

@@ -1,15 +0,0 @@
-# SelfTradePreventionType
-
-The strategy used to resolve self trades.   TAKER: On a self trade, the taker order will be cancelled  MAKER: On a self trade, the maker order will be cancelled  BOTH: On a self trade, both the taker and the maker order will be cancelled  UNSPECIFIED: set to default value 
-
-## Enum
-
-* `Taker` (value: `'TAKER'`)
-
-* `Maker` (value: `'MAKER'`)
-
-* `Both` (value: `'BOTH'`)
-
-* `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/StatsEntry.md

@@ -1,26 +0,0 @@
-# StatsEntry
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**startTimeAtMillis** | **number** | Timestamp in milliseconds when the statistics period starts. | [default to undefined]
-**tvlE9** | **string** | Total value locked in the exchange in e9 format. | [default to undefined]
-**totalQuoteAssetVolumeE9** | **string** | Total quote asset volume in the exchange in e9 format. | [default to undefined]
-**endTimeAtMillis** | **number** | Timestamp in milliseconds when the statistics period ends. | [default to undefined]
-
-## Example
-
-```typescript
-import { StatsEntry } from '@bluefin/api-client';
-
-const instance: StatsEntry = {
-    startTimeAtMillis,
-    tvlE9,
-    totalQuoteAssetVolumeE9,
-    endTimeAtMillis,
-};
-```
-
-[[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/StatsInterval.md

@@ -1,14 +0,0 @@
-# StatsInterval
-
-
-## Enum
-
-* `_1d` (value: `'1d'`)
-
-* `_1w` (value: `'1w'`)
-
-* `_1Mo` (value: `'1Mo'`)
-
-* `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/StatsResponse.md

@@ -1,20 +0,0 @@
-# StatsResponse
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**Array<StatsEntry>**](StatsEntry.md) |  | [default to undefined]
-
-## Example
-
-```typescript
-import { StatsResponse } from '@bluefin/api-client';
-
-const instance: StatsResponse = {
-    data,
-};
-```
-
-[[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/StreamsApi.md

@@ -1,126 +0,0 @@
-# StreamsApi
-
-All URIs are relative to *https://api.sui-staging.bluefin.io*
-
-|Method | HTTP request | Description|
-|------------- | ------------- | -------------|
-|[**webSocketAccountData**](#websocketaccountdata) | **GET** /ws/account | |
-|[**webSocketMarketData**](#websocketmarketdata) | **GET** /ws/market | |
-
-# **webSocketAccountData**
-> webSocketAccountData()
-
-WebSocket Account Streams URL.
-
-### Example
-
-```typescript
-import {
-    StreamsApi,
-    Configuration
-} from '@bluefin/api-client';
-
-const configuration = new Configuration();
-const apiInstance = new StreamsApi(configuration);
-
-let authorization: string; // (default to undefined)
-let upgrade: 'websocket'; // (default to undefined)
-let secWebSocketKey: string; //WebSocket key used during the handshake. (default to undefined)
-let secWebSocketVersion: '13'; //WebSocket protocol version. (default to undefined)
-
-const { status, data } = await apiInstance.webSocketAccountData(
-    authorization,
-    upgrade,
-    secWebSocketKey,
-    secWebSocketVersion
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **authorization** | [**string**] |  | defaults to undefined|
-| **upgrade** | [**&#39;websocket&#39;**]**Array<&#39;websocket&#39;>** |  | defaults to undefined|
-| **secWebSocketKey** | [**string**] | WebSocket key used during the handshake. | defaults to undefined|
-| **secWebSocketVersion** | [**&#39;13&#39;**]**Array<&#39;13&#39;>** | WebSocket protocol version. | defaults to undefined|
-
-
-### Return type
-
-void (empty response body)
-
-### Authorization
-
-[bearerAuth](../README.md#bearerAuth)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: Not defined
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**101** | Switching Protocols - The client is switching protocols as requested by the server. |  * Upgrade - Recognized WebSocket protocol <br>  |
-
-[[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)
-
-# **webSocketMarketData**
-> webSocketMarketData()
-
-WebSocket Market Streams URL.
-
-### Example
-
-```typescript
-import {
-    StreamsApi,
-    Configuration
-} from '@bluefin/api-client';
-
-const configuration = new Configuration();
-const apiInstance = new StreamsApi(configuration);
-
-let upgrade: 'websocket'; // (default to undefined)
-let secWebSocketKey: string; //WebSocket key used during the handshake. (default to undefined)
-let secWebSocketVersion: '13'; //WebSocket protocol version. (default to undefined)
-
-const { status, data } = await apiInstance.webSocketMarketData(
-    upgrade,
-    secWebSocketKey,
-    secWebSocketVersion
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **upgrade** | [**&#39;websocket&#39;**]**Array<&#39;websocket&#39;>** |  | defaults to undefined|
-| **secWebSocketKey** | [**string**] | WebSocket key used during the handshake. | defaults to undefined|
-| **secWebSocketVersion** | [**&#39;13&#39;**]**Array<&#39;13&#39;>** | WebSocket protocol version. | defaults to undefined|
-
-
-### Return type
-
-void (empty response body)
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: Not defined
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**101** | Switching Protocols - The client is switching protocols as requested by the server. |  * Upgrade - Recognized WebSocket protocol <br>  |
-
-[[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/SubscriptionResponseMessage.md

@@ -1,23 +0,0 @@
-# SubscriptionResponseMessage
-
-Response message indicating the success or failure of a subscription operation.
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**success** | **boolean** | Indicates if the subscription operation was successful. | [default to undefined]
-**message** | **string** | Additional information about the subscription operation. | [default to undefined]
-
-## Example
-
-```typescript
-import { SubscriptionResponseMessage } from '@bluefin/api-client';
-
-const instance: SubscriptionResponseMessage = {
-    success,
-    message,
-};
-```
-
-[[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/SubscriptionType.md

@@ -1,11 +0,0 @@
-# SubscriptionType
-
-Indicates the type of subscription action.
-
-## Enum
-
-* `Subscribe` (value: `'Subscribe'`)
-
-* `Unsubscribe` (value: `'Unsubscribe'`)
-
-[[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/TickerAllUpdate.md

@@ -1,20 +0,0 @@
-# TickerAllUpdate
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**tickerAll** | [**Array<TickerUpdate>**](TickerUpdate.md) | Array of detailed market ticker information for all markets. | [default to undefined]
-
-## Example
-
-```typescript
-import { TickerAllUpdate } from '@bluefin/api-client';
-
-const instance: TickerAllUpdate = {
-    tickerAll,
-};
-```
-
-[[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/TickerResponse.md

@@ -1,82 +0,0 @@
-# TickerResponse
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**symbol** | **string** | Market symbol. | [default to undefined]
-**lastQuantityE9** | **string** | Last trade quantity (e9 format). | [default to undefined]
-**lastTimeAtMillis** | **number** | Last trade time in milliseconds. | [default to undefined]
-**lastPriceE9** | **string** | Last trade price (e9 format). | [default to undefined]
-**lastFundingRateE9** | **string** | Funding rate value (e9 format). | [default to undefined]
-**nextFundingTimeAtMillis** | **number** | Time in milliseconds of next funding rate update. | [default to undefined]
-**avgFundingRate8hrE9** | **string** | 8 hr average funding rate (e9 format). | [default to undefined]
-**oraclePriceE9** | **string** | Oracle price of the asset (e9 format). | [default to undefined]
-**oraclePriceDirection** | **number** | Direction of oracle price computed by comparing current oracle price to last oracle price. 0 = no change, -1 = negative trend (current < last), 1 positive trend (current > last). | [default to undefined]
-**markPriceE9** | **string** | Mark price on the exchange (e9 format). | [default to undefined]
-**markPriceDirection** | **number** | Direction of mark price computed by comparing current mark price to last mark price. 0 = no change, -1 = negative trend (current < last), 1 positive trend (current > last). | [default to undefined]
-**marketPriceE9** | **string** | Simple average of bestBid and bestAsk. lastPrice if either is not present (e9 format). | [default to undefined]
-**marketPriceDirection** | **number** | Direction of market price computed by comparing current market price to last market price. 0 = no change, -1 = negative trend (current < last), 1 positive trend (current > last). | [default to undefined]
-**bestBidPriceE9** | **string** | Best bid price (e9 format). | [default to undefined]
-**bestBidQuantityE9** | **string** | Best bid quantity (e9 format). | [default to undefined]
-**bestAskPriceE9** | **string** | Best ask price (e9 format). | [default to undefined]
-**bestAskQuantityE9** | **string** | Best ask quantity (e9 format). | [default to undefined]
-**openInterestE9** | **string** | Open interest value (e9 format). | [default to undefined]
-**highPrice24hrE9** | **string** | Highest Price in the last 24hrs (e9 format). | [default to undefined]
-**lowPrice24hrE9** | **string** | Lowest Price in the last 24hrs (e9 format). | [default to undefined]
-**volume24hrE9** | **string** | Total market volume in last 24hrs of asset (e9 format). | [default to undefined]
-**quoteVolume24hrE9** | **string** | Total market volume in last 24hrs in USDC (e9 format). | [default to undefined]
-**closePrice24hrE9** | **string** | Close price 24hrs ago (e9 format). | [default to undefined]
-**openPrice24hrE9** | **string** | Open price in the last 24hrs (e9 format). | [default to undefined]
-**closeTime24hrAtMillis** | **number** | 24 hour close time in milliseconds. | [default to undefined]
-**openTime24hrAtMillis** | **number** | 24 hour open time in milliseconds. | [default to undefined]
-**firstId24hr** | **number** | First trade id in 24hr. | [default to undefined]
-**lastId24hr** | **number** | Last trade id in 24hr. | [default to undefined]
-**count24hr** | **string** | Total number of trades in 24hr. | [default to undefined]
-**priceChange24hrE9** | **string** | 24hr Market price change (e9 format). | [default to undefined]
-**priceChangePercent24hrE9** | **string** | 24hr Market price change in percentage (e9 format). | [default to undefined]
-**updatedAtMillis** | **number** | Last update time in milliseconds. | [default to undefined]
-
-## Example
-
-```typescript
-import { TickerResponse } from '@bluefin/api-client';
-
-const instance: TickerResponse = {
-    symbol,
-    lastQuantityE9,
-    lastTimeAtMillis,
-    lastPriceE9,
-    lastFundingRateE9,
-    nextFundingTimeAtMillis,
-    avgFundingRate8hrE9,
-    oraclePriceE9,
-    oraclePriceDirection,
-    markPriceE9,
-    markPriceDirection,
-    marketPriceE9,
-    marketPriceDirection,
-    bestBidPriceE9,
-    bestBidQuantityE9,
-    bestAskPriceE9,
-    bestAskQuantityE9,
-    openInterestE9,
-    highPrice24hrE9,
-    lowPrice24hrE9,
-    volume24hrE9,
-    quoteVolume24hrE9,
-    closePrice24hrE9,
-    openPrice24hrE9,
-    closeTime24hrAtMillis,
-    openTime24hrAtMillis,
-    firstId24hr,
-    lastId24hr,
-    count24hr,
-    priceChange24hrE9,
-    priceChangePercent24hrE9,
-    updatedAtMillis,
-};
-```
-
-[[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/TickerUpdate.md

@@ -1,83 +0,0 @@
-# TickerUpdate
-
-Represents detailed market ticker information.
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**symbol** | **string** | Market symbol. | [default to undefined]
-**lastQuantityE9** | **string** | Last trade quantity (e9 format). | [default to undefined]
-**lastTimeAtMillis** | **number** | Last trade time in milliseconds. | [default to undefined]
-**lastPriceE9** | **string** | Last trade price (e9 format). | [default to undefined]
-**lastFundingRateE9** | **string** | Funding rate value (e9 format). | [default to undefined]
-**nextFundingTimeAtMillis** | **number** | Time in milliseconds of next funding rate update. | [default to undefined]
-**avgFundingRate8hrE9** | **string** | 8 hr average funding rate (e9 format). | [default to undefined]
-**oraclePriceE9** | **string** | Oracle price of the asset (e9 format). | [default to undefined]
-**oraclePriceDirection** | **number** | Direction of oracle price computed by comparing current oracle price to last oracle price. 0 = no change, -1 = negative trend (current < last), 1 = positive trend (current > last). | [default to undefined]
-**markPriceE9** | **string** | Mark price on the exchange (e9 format). | [default to undefined]
-**markPriceDirection** | **number** | Direction of mark price computed by comparing current mark price to last mark price. 0 = no change, -1 = negative trend (current < last), 1 = positive trend (current > last). | [default to undefined]
-**marketPriceE9** | **string** | Simple average of bestBid and bestAsk, or lastPrice if either is not present (e9 format). | [default to undefined]
-**marketPriceDirection** | **number** | Direction of market price computed by comparing current market price to last market price. 0 = no change, -1 = negative trend (current < last), 1 = positive trend (current > last). | [default to undefined]
-**bestBidPriceE9** | **string** | Best bid price (e9 format). | [default to undefined]
-**bestBidQuantityE9** | **string** | Best bid quantity (e9 format). | [default to undefined]
-**bestAskPriceE9** | **string** | Best ask price (e9 format). | [default to undefined]
-**bestAskQuantityE9** | **string** | Best ask quantity (e9 format). | [default to undefined]
-**openInterestE9** | **string** | Open interest value (e9 format). | [default to undefined]
-**highPrice24hrE9** | **string** | Highest Price in the last 24 hours (e9 format). | [default to undefined]
-**lowPrice24hrE9** | **string** | Lowest Price in the last 24 hours (e9 format). | [default to undefined]
-**volume24hrE9** | **string** | Total market volume in last 24 hours of asset (e9 format). | [default to undefined]
-**quoteVolume24hrE9** | **string** | Total market volume in last 24 hours in USDC (e9 format). | [default to undefined]
-**closePrice24hrE9** | **string** | Close price 24 hours ago (e9 format). | [default to undefined]
-**openPrice24hrE9** | **string** | Open price in the last 24 hours (e9 format). | [default to undefined]
-**closeTime24hrAtMillis** | **number** | 24 hour close timestamp in milliseconds. | [default to undefined]
-**openTime24hrAtMillis** | **number** | 24 hour open timetamp in milliseconds. | [default to undefined]
-**firstId24hr** | **number** | First trade ID in the last 24 hours. | [default to undefined]
-**lastId24hr** | **number** | Last trade ID in the last 24 hours. | [default to undefined]
-**count24hr** | **string** | Total number of trades in the last 24 hours. | [default to undefined]
-**priceChange24hrE9** | **string** | 24 hour Market price change (e9 format). | [default to undefined]
-**priceChangePercent24hrE9** | **string** | 24 hour Market price change as a percentage (e9 format). | [default to undefined]
-**updatedAtMillis** | **number** | Last update timestamp in milliseconds. | [default to undefined]
-
-## Example
-
-```typescript
-import { TickerUpdate } from '@bluefin/api-client';
-
-const instance: TickerUpdate = {
-    symbol,
-    lastQuantityE9,
-    lastTimeAtMillis,
-    lastPriceE9,
-    lastFundingRateE9,
-    nextFundingTimeAtMillis,
-    avgFundingRate8hrE9,
-    oraclePriceE9,
-    oraclePriceDirection,
-    markPriceE9,
-    markPriceDirection,
-    marketPriceE9,
-    marketPriceDirection,
-    bestBidPriceE9,
-    bestBidQuantityE9,
-    bestAskPriceE9,
-    bestAskQuantityE9,
-    openInterestE9,
-    highPrice24hrE9,
-    lowPrice24hrE9,
-    volume24hrE9,
-    quoteVolume24hrE9,
-    closePrice24hrE9,
-    openPrice24hrE9,
-    closeTime24hrAtMillis,
-    openTime24hrAtMillis,
-    firstId24hr,
-    lastId24hr,
-    count24hr,
-    priceChange24hrE9,
-    priceChangePercent24hrE9,
-    updatedAtMillis,
-};
-```
-
-[[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/Trade.md

@@ -1,54 +0,0 @@
-# Trade
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **string** | Trade ID | [default to undefined]
-**clientOrderId** | **string** | Client order ID. | [optional] [default to undefined]
-**symbol** | **string** | Market address. | [optional] [default to undefined]
-**orderHash** | **string** | Order hash. | [optional] [default to undefined]
-**orderType** | [**OrderType**](OrderType.md) |  | [optional] [default to undefined]
-**tradeType** | [**TradeType**](TradeType.md) |  | [optional] [default to undefined]
-**side** | [**TradeSide**](TradeSide.md) |  | [default to undefined]
-**isMaker** | **boolean** | Indicates if the user was a maker to the trade. | [optional] [default to undefined]
-**priceE9** | **string** | Trade price (e9 format). | [default to undefined]
-**quantityE9** | **string** | Trade quantity (e9 format). | [default to undefined]
-**quoteQuantityE9** | **string** | Quote quantity (e9 format). | [default to undefined]
-**realizedPnlE9** | **string** | Realized profit and loss (e9 format). | [optional] [default to undefined]
-**positionSide** | [**PositionSide**](PositionSide.md) |  | [optional] [default to undefined]
-**tradingFeeE9** | **string** | Trading fee (e9 format). | [optional] [default to undefined]
-**tradingFeeAsset** | **string** | Asset used for trading fee. | [optional] [default to undefined]
-**gasFeeE9** | **string** | Gas fee. | [optional] [default to undefined]
-**gasFeeAsset** | **string** | Asset used for gas fee. | [optional] [default to undefined]
-**executedAtMillis** | **number** | Trade timestamp in milliseconds since Unix epoch. | [default to undefined]
-
-## Example
-
-```typescript
-import { Trade } from '@bluefin/api-client';
-
-const instance: Trade = {
-    id,
-    clientOrderId,
-    symbol,
-    orderHash,
-    orderType,
-    tradeType,
-    side,
-    isMaker,
-    priceE9,
-    quantityE9,
-    quoteQuantityE9,
-    realizedPnlE9,
-    positionSide,
-    tradingFeeE9,
-    tradingFeeAsset,
-    gasFeeE9,
-    gasFeeAsset,
-    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)