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

package/src/docs/CreateOrderRequest.md

@@ -1,36 +0,0 @@
-# CreateOrderRequest
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**signedFields** | [**CreateOrderRequestSignedFields**](CreateOrderRequestSignedFields.md) |  | [default to undefined]
-**signature** | **string** | The signature of the request, encoded from the signedFields | [default to undefined]
-**clientOrderId** | **string** | The client-defined unique identifier of this order used for lookup. This should always be unique; however, the server will not gurantee this or impose any checks. | [optional] [default to undefined]
-**type** | [**OrderType**](OrderType.md) |  | [default to undefined]
-**reduceOnly** | **boolean** | Is this order to only reduce a position? Default false | [default to undefined]
-**postOnly** | **boolean** | If set to TRUE, the order can only be a maker order | [optional] [default to false]
-**timeInForce** | [**OrderTimeInForce**](OrderTimeInForce.md) | Omit or set to null for market orders; otherwise, choose a valid time-in-force value. GTT: Good Til Time  IOC: Immediate Or Cancel  FOK: Fill Or Kill  | [optional] [default to undefined]
-**triggerPriceE9** | **string** | Trigger price in base e9 for stop orders. This should always be a number | [optional] [default to undefined]
-**selfTradePreventionType** | [**SelfTradePreventionType**](SelfTradePreventionType.md) |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { CreateOrderRequest } from '@bluefin/api-client';
-
-const instance: CreateOrderRequest = {
-    signedFields,
-    signature,
-    clientOrderId,
-    type,
-    reduceOnly,
-    postOnly,
-    timeInForce,
-    triggerPriceE9,
-    selfTradePreventionType,
-};
-```
-
-[[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/CreateOrderRequestSignedFields.md

@@ -1,40 +0,0 @@
-# CreateOrderRequestSignedFields
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**symbol** | **string** | The symbol of the perpetual for which to create the order | [default to undefined]
-**accountAddress** | **string** | The account address of the order. May be an account user is authorized for. | [default to undefined]
-**priceE9** | **string** | The price in base e9 of the asset to be traded. Should always be a number | [default to undefined]
-**quantityE9** | **string** | The quantity in base e9 of the asset to be traded. Should always be a number | [default to undefined]
-**side** | [**OrderSide**](OrderSide.md) |  | [default to undefined]
-**leverageE9** | **string** | The leverage in base e9 of the order to be traded. Should always be a number | [default to undefined]
-**isIsolated** | **boolean** | Is this order isolated or cross margin. Note market must be set to the same mode. | [default to false]
-**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]
-**expiresAtMillis** | **number** | timestamp in millis at which order will expire. Defaults to 1 month for LIMIT orders if not provided | [default to undefined]
-**signedAtMillis** | **number** | The timestamp in millis at which the request was signed | [default to undefined]
-
-## Example
-
-```typescript
-import { CreateOrderRequestSignedFields } from '@bluefin/api-client';
-
-const instance: CreateOrderRequestSignedFields = {
-    symbol,
-    accountAddress,
-    priceE9,
-    quantityE9,
-    side,
-    leverageE9,
-    isIsolated,
-    salt,
-    idsId,
-    expiresAtMillis,
-    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)

package/src/docs/CreateOrderResponse.md

@@ -1,20 +0,0 @@
-# CreateOrderResponse
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**orderHash** | **string** | The unique identifier of this order, to be used as a lookup key | [default to undefined]
-
-## Example
-
-```typescript
-import { CreateOrderResponse } from '@bluefin/api-client';
-
-const instance: CreateOrderResponse = {
-    orderHash,
-};
-```
-
-[[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/EpochConfigs.md

@@ -1,34 +0,0 @@
-# EpochConfigs
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**campaignName** | **string** | The name of the campaign. | [default to undefined]
-**epochDuration** | **number** | Duration of the epoch in seconds. | [default to undefined]
-**suiRewardsAllocationE9** | **string** | Allocation of Sui token rewards in the epoch (e9 format). | [default to undefined]
-**blueRewardsAllocationE9** | **string** | Allocation of Blue token rewards in the epoch (e9 format). | [default to undefined]
-**walRewardsAllocationE9** | **string** | Allocation of wal token rewards in the epoch (e9 format) | [default to undefined]
-**intervalNumber** | **number** | Interval number for the epoch. | [default to undefined]
-**epochNumber** | **number** | Epoch number for the epoch. | [default to undefined]
-**config** | **{ [key: string]: any | undefined; }** | Object to add custom configurations for campaigns. | [default to undefined]
-
-## Example
-
-```typescript
-import { EpochConfigs } from '@bluefin/api-client';
-
-const instance: EpochConfigs = {
-    campaignName,
-    epochDuration,
-    suiRewardsAllocationE9,
-    blueRewardsAllocationE9,
-    walRewardsAllocationE9,
-    intervalNumber,
-    epochNumber,
-    config,
-};
-```
-
-[[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/EpochConfigsResponse.md

@@ -1,24 +0,0 @@
-# EpochConfigsResponse
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**maxIntervalNumber** | **number** | The maximum interval number available. | [default to undefined]
-**intervalNumber** | **number** | The current interval number being queried. | [default to undefined]
-**data** | [**Array<EpochConfigs>**](EpochConfigs.md) | List of epoch configs for different campaigns. | [default to undefined]
-
-## Example
-
-```typescript
-import { EpochConfigsResponse } from '@bluefin/api-client';
-
-const instance: EpochConfigsResponse = {
-    maxIntervalNumber,
-    intervalNumber,
-    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/EpochMetadata.md

@@ -1,30 +0,0 @@
-# EpochMetadata
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**status** | **string** |  | [default to undefined]
-**campaignName** | **string** | Name of the campaign. | [default to undefined]
-**epochId** | **number** | Epoch Id of the epoch. | [default to undefined]
-**epochNumber** | **number** | Epoch number for the queried epoch. | [default to undefined]
-**startDate** | **number** | Time in seconds for campaign start date. | [default to undefined]
-**endDate** | **number** | Time in seconds for campaign end date. | [default to undefined]
-
-## Example
-
-```typescript
-import { EpochMetadata } from '@bluefin/api-client';
-
-const instance: EpochMetadata = {
-    status,
-    campaignName,
-    epochId,
-    epochNumber,
-    startDate,
-    endDate,
-};
-```
-
-[[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/Error.md

@@ -1,22 +0,0 @@
-# ModelError
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**errorCode** | **string** | A code representing the type of error. | [optional] [default to undefined]
-**message** | **string** | A human-readable message describing the error. | [default to undefined]
-
-## Example
-
-```typescript
-import { ModelError } from '@bluefin/api-client';
-
-const instance: ModelError = {
-    errorCode,
-    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/ExchangeApi.md

@@ -1,473 +0,0 @@
-# ExchangeApi
-
-All URIs are relative to *https://api.sui-staging.bluefin.io*
-
-|Method | HTTP request | Description|
-|------------- | ------------- | -------------|
-|[**getAllMarketTicker**](#getallmarketticker) | **GET** /v1/exchange/tickers | /exchange/tickers|
-|[**getCandlestickData**](#getcandlestickdata) | **GET** /v1/exchange/candlesticks | /exchange/candlesticks|
-|[**getExchangeInfo**](#getexchangeinfo) | **GET** /v1/exchange/info | /exchange/info|
-|[**getExchangeStats**](#getexchangestats) | **GET** /v1/exchange/stats | /exchange/stats|
-|[**getFundingRateHistory**](#getfundingratehistory) | **GET** /v1/exchange/fundingRateHistory | /exchange/fundingRateHistory|
-|[**getMarketTicker**](#getmarketticker) | **GET** /v1/exchange/ticker | /exchange/ticker|
-|[**getOrderbookDepth**](#getorderbookdepth) | **GET** /v1/exchange/depth | /exchange/depth|
-|[**getRecentTrades**](#getrecenttrades) | **GET** /v1/exchange/trades | /exchange/trades|
-
-# **getAllMarketTicker**
-> Array<TickerResponse> getAllMarketTicker()
-
-Retrieves all market ticker information.
-
-### Example
-
-```typescript
-import {
-    ExchangeApi,
-    Configuration
-} from '@bluefin/api-client';
-
-const configuration = new Configuration();
-const apiInstance = new ExchangeApi(configuration);
-
-const { status, data } = await apiInstance.getAllMarketTicker();
-```
-
-### Parameters
-This endpoint does not have any parameters.
-
-
-### Return type
-
-**Array<TickerResponse>**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | OK |  -  |
-
-[[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)
-
-# **getCandlestickData**
-> Array<Array<string>> getCandlestickData()
-
-Retrieves candle stick data for a market.
-
-### Example
-
-```typescript
-import {
-    ExchangeApi,
-    Configuration
-} from '@bluefin/api-client';
-
-const configuration = new Configuration();
-const apiInstance = new ExchangeApi(configuration);
-
-let symbol: string; //The market symbol to get the klines for. (default to undefined)
-let interval: KlineInterval; //The interval to get the klines for. (default to undefined)
-let type: CandlePriceType; //Candle price type (last price, market price or oracle). (default to undefined)
-let startTimeAtMillis: number; //Timestamp in milliseconds in ms to get klines from. (optional) (default to undefined)
-let endTimeAtMillis: number; //Timestamp in milliseconds in ms to get klines until. (optional) (default to undefined)
-let limit: number; //Default 50; max 1000. (optional) (default to 50)
-let page: number; //The page number to retrieve in a paginated response. (optional) (default to undefined)
-
-const { status, data } = await apiInstance.getCandlestickData(
-    symbol,
-    interval,
-    type,
-    startTimeAtMillis,
-    endTimeAtMillis,
-    limit,
-    page
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **symbol** | [**string**] | The market symbol to get the klines for. | defaults to undefined|
-| **interval** | **KlineInterval** | The interval to get the klines for. | defaults to undefined|
-| **type** | **CandlePriceType** | Candle price type (last price, market price or oracle). | defaults to undefined|
-| **startTimeAtMillis** | [**number**] | Timestamp in milliseconds in ms to get klines from. | (optional) defaults to undefined|
-| **endTimeAtMillis** | [**number**] | Timestamp in milliseconds in ms to get klines until. | (optional) defaults to undefined|
-| **limit** | [**number**] | Default 50; max 1000. | (optional) defaults to 50|
-| **page** | [**number**] | The page number to retrieve in a paginated response. | (optional) defaults to undefined|
-
-
-### Return type
-
-**Array<Array<string>>**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Kline/candlestick data |  -  |
-
-[[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)
-
-# **getExchangeInfo**
-> ExchangeInfoResponse getExchangeInfo()
-
-Returns the current exchange information including available margin assets, markets, and rules.
-
-### Example
-
-```typescript
-import {
-    ExchangeApi,
-    Configuration
-} from '@bluefin/api-client';
-
-const configuration = new Configuration();
-const apiInstance = new ExchangeApi(configuration);
-
-const { status, data } = await apiInstance.getExchangeInfo();
-```
-
-### Parameters
-This endpoint does not have any parameters.
-
-
-### Return type
-
-**ExchangeInfoResponse**
-
-### 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 |  -  |
-
-[[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)
-
-# **getExchangeStats**
-> StatsResponse getExchangeStats()
-
-Retrieves exchange statistics.
-
-### Example
-
-```typescript
-import {
-    ExchangeApi,
-    Configuration
-} from '@bluefin/api-client';
-
-const configuration = new Configuration();
-const apiInstance = new ExchangeApi(configuration);
-
-let interval: StatsInterval; // (optional) (default to undefined)
-let startTimeAtMillis: number; //Timestamp in milliseconds. (optional) (default to undefined)
-let endTimeAtMillis: number; //Timestamp in milliseconds. (optional) (default to undefined)
-let limit: number; //Number of records to return. Default is 30; max is 200. (optional) (default to 30)
-let page: number; //The page number to retrieve in a paginated response. (optional) (default to undefined)
-
-const { status, data } = await apiInstance.getExchangeStats(
-    interval,
-    startTimeAtMillis,
-    endTimeAtMillis,
-    limit,
-    page
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **interval** | **StatsInterval** |  | (optional) defaults to undefined|
-| **startTimeAtMillis** | [**number**] | Timestamp in milliseconds. | (optional) defaults to undefined|
-| **endTimeAtMillis** | [**number**] | Timestamp in milliseconds. | (optional) defaults to undefined|
-| **limit** | [**number**] | Number of records to return. Default is 30; max is 200. | (optional) defaults to 30|
-| **page** | [**number**] | The page number to retrieve in a paginated response. | (optional) defaults to undefined|
-
-
-### Return type
-
-**StatsResponse**
-
-### 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 exchange statistics. |  -  |
-|**400** | Invalid parameters provided. |  -  |
-|**422** | Unprocessable parameters provided. |  -  |
-|**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)
-
-# **getFundingRateHistory**
-> Array<FundingRateEntry> getFundingRateHistory()
-
-Retrieve the funding rate history for a specific market address.
-
-### Example
-
-```typescript
-import {
-    ExchangeApi,
-    Configuration
-} from '@bluefin/api-client';
-
-const configuration = new Configuration();
-const apiInstance = new ExchangeApi(configuration);
-
-let symbol: string; //The market symbol to get funding rate history for (default to undefined)
-let limit: number; //Number of records to return. Default is 100; max is 1000. (optional) (default to 100)
-let startTimeAtMillis: number; //The timestamp specifies the earliest point in time for which data should be returned. The value is not included. (optional) (default to undefined)
-let endTimeAtMillis: number; //The timestamp specifies the latest point in time for which data should be returned. The value is included. (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.getFundingRateHistory(
-    symbol,
-    limit,
-    startTimeAtMillis,
-    endTimeAtMillis,
-    page
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **symbol** | [**string**] | The market symbol to get funding rate history for | defaults to undefined|
-| **limit** | [**number**] | Number of records to return. Default is 100; max is 1000. | (optional) defaults to 100|
-| **startTimeAtMillis** | [**number**] | The timestamp specifies the earliest point in time for which data should be returned. The value is not included. | (optional) defaults to undefined|
-| **endTimeAtMillis** | [**number**] | The timestamp specifies the latest point in time for which data should be returned. The value is included. | (optional) defaults to undefined|
-| **page** | [**number**] | The page number to retrieve in a paginated response. | (optional) defaults to undefined|
-
-
-### Return type
-
-**Array<FundingRateEntry>**
-
-### 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 funding rate history. |  -  |
-
-[[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)
-
-# **getMarketTicker**
-> TickerResponse getMarketTicker()
-
-Retrieves aggregated ticker data for a market.
-
-### Example
-
-```typescript
-import {
-    ExchangeApi,
-    Configuration
-} from '@bluefin/api-client';
-
-const configuration = new Configuration();
-const apiInstance = new ExchangeApi(configuration);
-
-let symbol: string; //Market symbol. (default to undefined)
-
-const { status, data } = await apiInstance.getMarketTicker(
-    symbol
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **symbol** | [**string**] | Market symbol. | defaults to undefined|
-
-
-### Return type
-
-**TickerResponse**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | OK |  -  |
-|**404** | Market not found. |  -  |
-
-[[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)
-
-# **getOrderbookDepth**
-> OrderbookDepthResponse getOrderbookDepth()
-
-Returns the current state of the orderbook.
-
-### Example
-
-```typescript
-import {
-    ExchangeApi,
-    Configuration
-} from '@bluefin/api-client';
-
-const configuration = new Configuration();
-const apiInstance = new ExchangeApi(configuration);
-
-let symbol: string; //Market symbol to get the orderbook depth for. (default to undefined)
-let limit: number; //Maximum number of bids and asks to return. Default 500; max 1000. (optional) (default to 500)
-
-const { status, data } = await apiInstance.getOrderbookDepth(
-    symbol,
-    limit
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **symbol** | [**string**] | Market symbol to get the orderbook depth for. | defaults to undefined|
-| **limit** | [**number**] | Maximum number of bids and asks to return. Default 500; max 1000. | (optional) defaults to 500|
-
-
-### Return type
-
-**OrderbookDepthResponse**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Orderbook depth |  -  |
-
-[[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)
-
-# **getRecentTrades**
-> Array<Trade> getRecentTrades()
-
-Retrieves recent trades executed on a market.
-
-### Example
-
-```typescript
-import {
-    ExchangeApi,
-    Configuration
-} from '@bluefin/api-client';
-
-const configuration = new Configuration();
-const apiInstance = new ExchangeApi(configuration);
-
-let symbol: string; //The market symbol to get the trades for. (default to undefined)
-let tradeType: TradeType; //Type of trade. (optional) (default to undefined)
-let limit: number; //Default 500; max 1000. (optional) (default to 500)
-let startTimeAtMillis: number; //The timestamp specifies the earliest point in time for which data should be returned. The value is not included. (optional) (default to undefined)
-let endTimeAtMillis: number; //The timestamp specifies the latest point in time for which data should be returned. The value is included. (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.getRecentTrades(
-    symbol,
-    tradeType,
-    limit,
-    startTimeAtMillis,
-    endTimeAtMillis,
-    page
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **symbol** | [**string**] | The market symbol to get the trades for. | defaults to undefined|
-| **tradeType** | **TradeType** | Type of trade. | (optional) defaults to undefined|
-| **limit** | [**number**] | Default 500; max 1000. | (optional) defaults to 500|
-| **startTimeAtMillis** | [**number**] | The timestamp specifies the earliest point in time for which data should be returned. The value is not included. | (optional) defaults to undefined|
-| **endTimeAtMillis** | [**number**] | The timestamp specifies the latest point in time for which data should be returned. The value is included. | (optional) defaults to undefined|
-| **page** | [**number**] | The page number to retrieve in a paginated response. | (optional) defaults to undefined|
-
-
-### Return type
-
-**Array<Trade>**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Recent trades |  -  |
-
-[[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)
-