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

package/src/docs/AccountDataApi.md

@@ -1,374 +0,0 @@
-# AccountDataApi
-
-All URIs are relative to *https://api.sui-staging.bluefin.io*
-
-|Method | HTTP request | Description|
-|------------- | ------------- | -------------|
-|[**getAccountDetails**](#getaccountdetails) | **GET** /api/v1/account | /account|
-|[**getAccountFundingRateHistory**](#getaccountfundingratehistory) | **GET** /api/v1/account/fundingRateHistory | /account/fundingRateHistory|
-|[**getAccountPreferences**](#getaccountpreferences) | **GET** /api/v1/account/preferences | /account/preferences|
-|[**getAccountTrades**](#getaccounttrades) | **GET** /api/v1/account/trades | /account/trades|
-|[**getAccountTransactionHistory**](#getaccounttransactionhistory) | **GET** /api/v1/account/transactions | /account/transactions|
-|[**putAccountPreferences**](#putaccountpreferences) | **PUT** /api/v1/account/preferences | /account/preferences|
-
-# **getAccountDetails**
-> Account getAccountDetails()
-
-Retrieves the user\'s account details.
-
-### Example
-
-```typescript
-import {
-    AccountDataApi,
-    Configuration
-} from '@bluefin/api-client';
-
-const configuration = new Configuration();
-const apiInstance = new AccountDataApi(configuration);
-
-let accountAddress: string; //Account address to fetch account details by. (optional) (default to undefined)
-
-const { status, data } = await apiInstance.getAccountDetails(
-    accountAddress
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **accountAddress** | [**string**] | Account address to fetch account details by. | (optional) defaults to undefined|
-
-
-### Return type
-
-**Account**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Successful response with account details. |  -  |
-|**400** | request missing required parameters |  -  |
-|**401** | unauthorized access |  -  |
-|**404** | account not found |  -  |
-|**500** | internal server error |  -  |
-
-[[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)
-
-# **getAccountFundingRateHistory**
-> AccountFundingRateHistory getAccountFundingRateHistory()
-
-Retrieves the funding rate history for a specific account.
-
-### Example
-
-```typescript
-import {
-    AccountDataApi,
-    Configuration
-} from '@bluefin/api-client';
-
-const configuration = new Configuration();
-const apiInstance = new AccountDataApi(configuration);
-
-let accountAddress: string; //Account address to filter funding rate history by. (optional) (default to undefined)
-let limit: number; //Default 500; max 1000. (optional) (default to 500)
-let page: number; //The page number to retrieve in a paginated response. (optional) (default to 1)
-
-const { status, data } = await apiInstance.getAccountFundingRateHistory(
-    accountAddress,
-    limit,
-    page
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **accountAddress** | [**string**] | Account address to filter funding rate history by. | (optional) defaults to undefined|
-| **limit** | [**number**] | Default 500; max 1000. | (optional) defaults to 500|
-| **page** | [**number**] | The page number to retrieve in a paginated response. | (optional) defaults to 1|
-
-
-### Return type
-
-**AccountFundingRateHistory**
-
-### Authorization
-
-[bearerAuth](../README.md#bearerAuth)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Successful response with funding rate history. |  -  |
-|**400** | request missing required parameters |  -  |
-|**401** | unauthorized access |  -  |
-|**404** | account not found |  -  |
-|**500** | internal server error |  -  |
-
-[[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)
-
-# **getAccountPreferences**
-> AccountPreference getAccountPreferences()
-
-Retrieves the user\'s account preferences.
-
-### Example
-
-```typescript
-import {
-    AccountDataApi,
-    Configuration
-} from '@bluefin/api-client';
-
-const configuration = new Configuration();
-const apiInstance = new AccountDataApi(configuration);
-
-const { status, data } = await apiInstance.getAccountPreferences();
-```
-
-### Parameters
-This endpoint does not have any parameters.
-
-
-### Return type
-
-**AccountPreference**
-
-### Authorization
-
-[bearerAuth](../README.md#bearerAuth)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Successful response with account preferences. |  -  |
-|**400** | request missing required parameters |  -  |
-|**401** | unauthorized access |  -  |
-|**404** | account not found |  -  |
-|**500** | internal server error |  -  |
-
-[[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)
-
-# **getAccountTrades**
-> Array<Trade> getAccountTrades()
-
-Retrieves the user\'s trade history.
-
-### Example
-
-```typescript
-import {
-    AccountDataApi,
-    Configuration
-} from '@bluefin/api-client';
-
-const configuration = new Configuration();
-const apiInstance = new AccountDataApi(configuration);
-
-let symbol: string; //Market address to filter trades by. If not specified, returns trades for all markets. (optional) (default to undefined)
-let startTimeAtMillis: number; //Start time in milliseconds. Defaults to 7 days ago if not specified. (optional) (default to undefined)
-let endTimeAtMillis: number; //End time in milliseconds. Defaults to now if not specified. Must be greater than start time and must be less than 7 days apart. (optional) (default to undefined)
-let limit: number; //Default 500; max 1000. (optional) (default to 500)
-let tradeType: TradeType; //Type of trade. By default returns all. UNSPECIFIED returns all. (optional) (default to undefined)
-let page: number; //The page number to retrieve in a paginated response. (optional) (default to undefined)
-
-const { status, data } = await apiInstance.getAccountTrades(
-    symbol,
-    startTimeAtMillis,
-    endTimeAtMillis,
-    limit,
-    tradeType,
-    page
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **symbol** | [**string**] | Market address to filter trades by. If not specified, returns trades for all markets. | (optional) defaults to undefined|
-| **startTimeAtMillis** | [**number**] | Start time in milliseconds. Defaults to 7 days ago if not specified. | (optional) defaults to undefined|
-| **endTimeAtMillis** | [**number**] | End time in milliseconds. Defaults to now if not specified. Must be greater than start time and must be less than 7 days apart. | (optional) defaults to undefined|
-| **limit** | [**number**] | Default 500; max 1000. | (optional) defaults to 500|
-| **tradeType** | **TradeType** | Type of trade. By default returns all. UNSPECIFIED returns all. | (optional) defaults to undefined|
-| **page** | [**number**] | The page number to retrieve in a paginated response. | (optional) defaults to undefined|
-
-
-### Return type
-
-**Array<Trade>**
-
-### Authorization
-
-[bearerAuth](../README.md#bearerAuth)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Successful response with trade details. |  -  |
-|**400** | request missing required parameters |  -  |
-|**401** | unauthorized access |  -  |
-|**404** | account not found |  -  |
-|**500** | internal server error |  -  |
-
-[[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)
-
-# **getAccountTransactionHistory**
-> Array<Transaction> getAccountTransactionHistory()
-
-Retrieves the user\'s transaction history (any change in balance).
-
-### Example
-
-```typescript
-import {
-    AccountDataApi,
-    Configuration
-} from '@bluefin/api-client';
-
-const configuration = new Configuration();
-const apiInstance = new AccountDataApi(configuration);
-
-let types: Array<TransactionType>; //Optional query parameter to filter transactions by type. (optional) (default to undefined)
-let assetSymbol: string; //Optional query parameter to filter transactions by asset bank address. (optional) (default to undefined)
-let startTimeAtMillis: number; //Start time in milliseconds. Defaults to 7 days ago if not specified. (optional) (default to undefined)
-let endTimeAtMillis: number; //End time in milliseconds. Defaults to now if not specified. Must be greater than start time and must be less than 7 days apart. (optional) (default to undefined)
-let limit: number; //Default 500; max 1000. (optional) (default to 500)
-let page: number; //The page number to retrieve in a paginated response. (optional) (default to undefined)
-
-const { status, data } = await apiInstance.getAccountTransactionHistory(
-    types,
-    assetSymbol,
-    startTimeAtMillis,
-    endTimeAtMillis,
-    limit,
-    page
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **types** | **Array&lt;TransactionType&gt;** | Optional query parameter to filter transactions by type. | (optional) defaults to undefined|
-| **assetSymbol** | [**string**] | Optional query parameter to filter transactions by asset bank address. | (optional) defaults to undefined|
-| **startTimeAtMillis** | [**number**] | Start time in milliseconds. Defaults to 7 days ago if not specified. | (optional) defaults to undefined|
-| **endTimeAtMillis** | [**number**] | End time in milliseconds. Defaults to now if not specified. Must be greater than start time and must be less than 7 days apart. | (optional) defaults to undefined|
-| **limit** | [**number**] | Default 500; max 1000. | (optional) defaults to 500|
-| **page** | [**number**] | The page number to retrieve in a paginated response. | (optional) defaults to undefined|
-
-
-### Return type
-
-**Array<Transaction>**
-
-### Authorization
-
-[bearerAuth](../README.md#bearerAuth)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Successful response with transaction history details. |  -  |
-|**400** | request missing required parameters |  -  |
-|**401** | unauthorized access |  -  |
-|**404** | account not found |  -  |
-|**500** | internal server error |  -  |
-
-[[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)
-
-# **putAccountPreferences**
-> putAccountPreferences(updateAccountPreferenceRequest)
-
-Update user\'s account preferences. This will overwrite the preferences, so always send the full object.
-
-### Example
-
-```typescript
-import {
-    AccountDataApi,
-    Configuration,
-    UpdateAccountPreferenceRequest
-} from '@bluefin/api-client';
-
-const configuration = new Configuration();
-const apiInstance = new AccountDataApi(configuration);
-
-let updateAccountPreferenceRequest: UpdateAccountPreferenceRequest; //
-
-const { status, data } = await apiInstance.putAccountPreferences(
-    updateAccountPreferenceRequest
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **updateAccountPreferenceRequest** | **UpdateAccountPreferenceRequest**|  | |
-
-
-### 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 |
-|-------------|-------------|------------------|
-|**204** | Success. |  -  |
-|**400** | request missing request body |  -  |
-|**401** | unauthorized access |  -  |
-|**404** | account not found |  -  |
-|**413** | request entity too large |  -  |
-|**500** | internal server error |  -  |
-
-[[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/AccountDataStream.md

@@ -1,21 +0,0 @@
-# AccountDataStream
-
-Represents the type of account data stream.
-
-## Enum
-
-* `AccountOrderUpdate` (value: `'AccountOrderUpdate'`)
-
-* `AccountTradeUpdate` (value: `'AccountTradeUpdate'`)
-
-* `AccountAggregatedTradeUpdate` (value: `'AccountAggregatedTradeUpdate'`)
-
-* `AccountPositionUpdate` (value: `'AccountPositionUpdate'`)
-
-* `AccountUpdate` (value: `'AccountUpdate'`)
-
-* `AccountTransactionUpdate` (value: `'AccountTransactionUpdate'`)
-
-* `AccountCommandFailureUpdate` (value: `'AccountCommandFailureUpdate'`)
-
-[[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/AccountEventReason.md

@@ -1,25 +0,0 @@
-# AccountEventReason
-
-The reason for the account-related event.
-
-## Enum
-
-* `Deposit` (value: `'Deposit'`)
-
-* `Withdraw` (value: `'Withdraw'`)
-
-* `OrderCreated` (value: `'OrderCreated'`)
-
-* `OrderMatched` (value: `'OrderMatched'`)
-
-* `OrderCancelled` (value: `'OrderCancelled'`)
-
-* `OrdersForMarketCancelled` (value: `'OrdersForMarketCancelled'`)
-
-* `LeverageUpdated` (value: `'LeverageUpdated'`)
-
-* `IsolatedMarginUpdated` (value: `'IsolatedMarginUpdated'`)
-
-* `FundingRatePayment` (value: `'FundingRatePayment'`)
-
-[[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/AccountEventType.md

@@ -1,21 +0,0 @@
-# AccountEventType
-
-The type of account-related event.
-
-## Enum
-
-* `AccountUpdate` (value: `'AccountUpdate'`)
-
-* `AccountTradeUpdate` (value: `'AccountTradeUpdate'`)
-
-* `AccountAggregatedTradeUpdate` (value: `'AccountAggregatedTradeUpdate'`)
-
-* `AccountOrderUpdate` (value: `'AccountOrderUpdate'`)
-
-* `AccountPositionUpdate` (value: `'AccountPositionUpdate'`)
-
-* `AccountTransactionUpdate` (value: `'AccountTransactionUpdate'`)
-
-* `AccountCommandFailureUpdate` (value: `'AccountCommandFailureUpdate'`)
-
-[[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/AccountFundingRateHistory.md

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

@@ -1,30 +0,0 @@
-# AccountFundingRateHistoryData
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**paymentAmountE9** | **string** | Payment amount in e9 format. | [default to undefined]
-**positionSide** | [**PositionSide**](PositionSide.md) |  | [default to undefined]
-**rateE9** | **string** | Funding rate value (e9 format). | [default to undefined]
-**symbol** | **string** | Market address. | [default to undefined]
-**executedAtMillis** | **number** | Execution timestamp in milliseconds since Unix epoch. | [default to undefined]
-**computedAtMillis** | **number** | Computed timestamp in milliseconds since Unix epoch. | [default to undefined]
-
-## Example
-
-```typescript
-import { AccountFundingRateHistoryData } from '@bluefin/api-client';
-
-const instance: AccountFundingRateHistoryData = {
-    paymentAmountE9,
-    positionSide,
-    rateE9,
-    symbol,
-    executedAtMillis,
-    computedAtMillis,
-};
-```
-
-[[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/AccountMarketPreference.md

@@ -1,22 +0,0 @@
-# AccountMarketPreference
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**marginType** | [**MarginType**](MarginType.md) |  | [optional] [default to undefined]
-**setLeverage** | **number** | User set leverage (e.g., 10x). | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { AccountMarketPreference } from '@bluefin/api-client';
-
-const instance: AccountMarketPreference = {
-    marginType,
-    setLeverage,
-};
-```
-
-[[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/AccountOrderUpdate.md

@@ -1,71 +0,0 @@
-# AccountOrderUpdate
-
-A message containing order update information.
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**orderHash** | **string** | The unique hash of the order. | [default to undefined]
-**clientOrderId** | **string** | The client-provided order ID. | [optional] [default to undefined]
-**symbol** | **string** | The symbol of the market. | [default to undefined]
-**accountAddress** | **string** | The address of the account. | [default to undefined]
-**priceE9** | **string** | The price of the order in scientific notation with 9 decimal places. | [default to undefined]
-**quantityE9** | **string** | The quantity of the order in scientific notation with 9 decimal places. | [default to undefined]
-**filledQuantityE9** | **string** | The filled quantity of the order in scientific notation with 9 decimal places. | [default to undefined]
-**side** | [**TradeSide**](TradeSide.md) |  | [default to undefined]
-**leverageE9** | **string** | The leverage of the order in scientific notation with 9 decimal places. | [default to undefined]
-**isIsolated** | **boolean** | Indicates if the order is isolated. | [default to undefined]
-**salt** | **string** | A unique salt for the order. | [default to undefined]
-**expiresAtMillis** | **number** | The expiration timestamp of the order in milliseconds. | [default to undefined]
-**signedAtMillis** | **number** | The signing timestamp of the order in milliseconds. | [default to undefined]
-**signerAddress** | **string** | The address of the signer of the order request. | [default to undefined]
-**type** | [**OrderType**](OrderType.md) |  | [default to undefined]
-**reduceOnly** | **boolean** | Indicates if the order is reduce-only. | [default to undefined]
-**postOnly** | **boolean** | Indicates if the order is post-only. | [default to undefined]
-**timeInForce** | [**OrderTimeInForce**](OrderTimeInForce.md) |  | [default to undefined]
-**triggerPriceE9** | **string** | The trigger price for stop-limit or stop-market orders. | [optional] [default to undefined]
-**status** | [**OrderStatus**](OrderStatus.md) |  | [default to undefined]
-**selfTradePreventionType** | [**SelfTradePreventionType**](SelfTradePreventionType.md) |  | [default to undefined]
-**createdAtMillis** | **number** | The timestamp of the order creation in milliseconds. | [default to undefined]
-**updatedAtMillis** | **number** | The timestamp of the last update of the order in milliseconds. | [default to undefined]
-**cancellationReason** | [**OrderCancelReason**](OrderCancelReason.md) |  | [default to undefined]
-**failureToCancelReason** | [**OrderCancellationFailureReason**](OrderCancellationFailureReason.md) |  | [optional] [default to undefined]
-**remainingQuantityE9** | **string** | The remaining quantity of the order. | [default to undefined]
-
-## Example
-
-```typescript
-import { AccountOrderUpdate } from '@bluefin/api-client';
-
-const instance: AccountOrderUpdate = {
-    orderHash,
-    clientOrderId,
-    symbol,
-    accountAddress,
-    priceE9,
-    quantityE9,
-    filledQuantityE9,
-    side,
-    leverageE9,
-    isIsolated,
-    salt,
-    expiresAtMillis,
-    signedAtMillis,
-    signerAddress,
-    type,
-    reduceOnly,
-    postOnly,
-    timeInForce,
-    triggerPriceE9,
-    status,
-    selfTradePreventionType,
-    createdAtMillis,
-    updatedAtMillis,
-    cancellationReason,
-    failureToCancelReason,
-    remainingQuantityE9,
-};
-```
-
-[[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/AccountPositionLeverageUpdateRequest.md

@@ -1,22 +0,0 @@
-# AccountPositionLeverageUpdateRequest
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**signedFields** | [**AccountPositionLeverageUpdateRequestSignedFields**](AccountPositionLeverageUpdateRequestSignedFields.md) |  | [default to undefined]
-**signature** | **string** | The signature of the request, encoded from the signedFields | [default to undefined]
-
-## Example
-
-```typescript
-import { AccountPositionLeverageUpdateRequest } from '@bluefin/api-client';
-
-const instance: AccountPositionLeverageUpdateRequest = {
-    signedFields,
-    signature,
-};
-```
-
-[[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/AccountPositionLeverageUpdateRequestSignedFields.md

@@ -1,30 +0,0 @@
-# AccountPositionLeverageUpdateRequestSignedFields
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**accountAddress** | **string** | The Account Address from which to update leverage | [default to undefined]
-**symbol** | **string** | Symbol of the perpetual of the positions for which to update the leverage | [default to undefined]
-**leverageE9** | **string** | The leverage to set for the account positions (Must be a number in base e9) | [default to undefined]
-**salt** | **string** | The random generated SALT. Should always be a number | [default to undefined]
-**idsId** | **string** | the ID of the internal datastore for the target network | [default to undefined]
-**signedAtMillis** | **number** | The timestamp in millis at which the request was signed | [default to undefined]
-
-## Example
-
-```typescript
-import { AccountPositionLeverageUpdateRequestSignedFields } from '@bluefin/api-client';
-
-const instance: AccountPositionLeverageUpdateRequestSignedFields = {
-    accountAddress,
-    symbol,
-    leverageE9,
-    salt,
-    idsId,
-    signedAtMillis,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)