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

package/src/docs/OrderbookDiffDepthUpdate.md

@@ -1,30 +0,0 @@
-# OrderbookDiffDepthUpdate
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**updatedAtMillis** | **number** | The timestamp of the orderbook update. | [default to undefined]
-**symbol** | **string** | The symbol of the market for the orderbook update. | [default to undefined]
-**bidsE9** | **Array<Array<string>>** |  | [default to undefined]
-**asksE9** | **Array<Array<string>>** |  | [default to undefined]
-**firstUpdateId** | **number** | The ID of the first update in this batch. | [default to undefined]
-**lastUpdateId** | **number** | The ID of the last update in this batch. | [default to undefined]
-
-## Example
-
-```typescript
-import { OrderbookDiffDepthUpdate } from '@bluefin/api-client';
-
-const instance: OrderbookDiffDepthUpdate = {
-    updatedAtMillis,
-    symbol,
-    bidsE9,
-    asksE9,
-    firstUpdateId,
-    lastUpdateId,
-};
-```
-
-[[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/OrderbookPartialDepthUpdate.md

@@ -1,30 +0,0 @@
-# OrderbookPartialDepthUpdate
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**updatedAtMillis** | **number** | The timestamp of the partial depth update. | [default to undefined]
-**symbol** | **string** | The symbol of the market for the partial depth update. | [default to undefined]
-**bidsE9** | **Array<Array<string>>** |  | [default to undefined]
-**asksE9** | **Array<Array<string>>** |  | [default to undefined]
-**orderbookUpdateId** | **number** | The unique identifier for the orderbook update. | [default to undefined]
-**depthLevel** | **string** | The depth level of the orderbook snapshot. | [default to undefined]
-
-## Example
-
-```typescript
-import { OrderbookPartialDepthUpdate } from '@bluefin/api-client';
-
-const instance: OrderbookPartialDepthUpdate = {
-    updatedAtMillis,
-    symbol,
-    bidsE9,
-    asksE9,
-    orderbookUpdateId,
-    depthLevel,
-};
-```
-
-[[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/Position.md

@@ -1,52 +0,0 @@
-# Position
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**symbol** | **string** | Market address. | [default to undefined]
-**avgEntryPriceE9** | **string** | Average entry price determined by a simple average of all entry prices resulting in this position size (e9 format). | [default to undefined]
-**clientSetLeverageE9** | **string** | Isolated position leverage (e9 format). | [default to undefined]
-**liquidationPriceE9** | **string** | Liquidation price (e9 format). | [default to undefined]
-**markPriceE9** | **string** | Mark price (e9 format). | [default to undefined]
-**notionalValueE9** | **string** | Notional value (e9 format). | [default to undefined]
-**sizeE9** | **string** | Position size (e9 format). | [default to undefined]
-**unrealizedPnlE9** | **string** | Unrealized profit (e9 format). | [default to undefined]
-**side** | [**PositionSide**](PositionSide.md) |  | [default to undefined]
-**marginRequiredE9** | **string** | Initial margin required with current mark price (e9 format). | [default to undefined]
-**maintenanceMarginE9** | **string** | Maintenance margin required with current mark price (e9 format). | [default to undefined]
-**isIsolated** | **boolean** | If the position is isolated. | [default to undefined]
-**isolatedMarginE9** | **string** | Margin value present if margin type is isolated (e9 format). | [default to undefined]
-**updatedAtMillis** | **number** | Last update time. | [default to undefined]
-**fundingRatePaymentAllTimeE9** | **string** | Total funding rate payment (e9 format). | [default to undefined]
-**fundingRatePaymentSinceChangeE9** | **string** | Funding rate payment since last position change (e9 format). | [default to undefined]
-**fundingRatePaymentSinceOpenedE9** | **string** | Funding rate payment since position opened (e9 format). | [default to undefined]
-
-## Example
-
-```typescript
-import { Position } from '@bluefin/api-client';
-
-const instance: Position = {
-    symbol,
-    avgEntryPriceE9,
-    clientSetLeverageE9,
-    liquidationPriceE9,
-    markPriceE9,
-    notionalValueE9,
-    sizeE9,
-    unrealizedPnlE9,
-    side,
-    marginRequiredE9,
-    maintenanceMarginE9,
-    isIsolated,
-    isolatedMarginE9,
-    updatedAtMillis,
-    fundingRatePaymentAllTimeE9,
-    fundingRatePaymentSinceChangeE9,
-    fundingRatePaymentSinceOpenedE9,
-};
-```
-
-[[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/PositionSide.md

@@ -1,13 +0,0 @@
-# PositionSide
-
-The side of the position, either long or short
-
-## 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/RecentTradesUpdates.md

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

@@ -1,20 +0,0 @@
-# RefereeOnboardResponse
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**message** | **string** | Response message indicating if the referral code exists | [default to undefined]
-
-## Example
-
-```typescript
-import { RefereeOnboardResponse } from '@bluefin/api-client';
-
-const instance: RefereeOnboardResponse = {
-    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/RefreshTokenRequest.md

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

@@ -1,26 +0,0 @@
-# RefreshTokenResponse
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**accessToken** | **string** |  | [default to undefined]
-**accessTokenValidForSeconds** | **number** |  | [default to undefined]
-**refreshToken** | **string** |  | [default to undefined]
-**refreshTokenValidForSeconds** | **number** |  | [default to undefined]
-
-## Example
-
-```typescript
-import { RefreshTokenResponse } from '@bluefin/api-client';
-
-const instance: RefreshTokenResponse = {
-    accessToken,
-    accessTokenValidForSeconds,
-    refreshToken,
-    refreshTokenValidForSeconds,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)