@bluefin-exchange/pro-sdk 0.1.61 → 0.2.0-pre-release.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/{example.js → cjs/example.js} +3 -0
- package/dist/cjs/example.js.map +1 -0
- package/dist/{index.js → cjs/index.js} +1 -0
- package/dist/cjs/index.js.map +1 -0
- package/dist/{src → cjs/src}/api.js +75 -1
- package/dist/cjs/src/api.js.map +1 -0
- package/dist/{src → cjs/src}/base.js +5 -1
- package/dist/cjs/src/base.js.map +1 -0
- package/dist/{src → cjs/src}/common.js +1 -0
- package/dist/cjs/src/common.js.map +1 -0
- package/dist/{src → cjs/src}/configuration.js +1 -0
- package/dist/cjs/src/configuration.js.map +1 -0
- package/dist/{src → cjs/src}/index.js +1 -0
- package/dist/cjs/src/index.js.map +1 -0
- package/dist/{src → cjs/src}/request-signer.js +11 -0
- package/dist/cjs/src/request-signer.js.map +1 -0
- package/dist/{src → cjs/src}/sdk.js +47 -4
- package/dist/cjs/src/sdk.js.map +1 -0
- package/dist/{src → cjs/src}/utils.js +1 -0
- package/dist/cjs/src/utils.js.map +1 -0
- package/dist/{src → cjs/src}/websocket.js +1 -0
- package/dist/cjs/src/websocket.js.map +1 -0
- package/dist/esm/example.js +218 -0
- package/dist/esm/example.js.map +1 -0
- package/dist/esm/index.js +18 -0
- package/dist/esm/index.js.map +1 -0
- package/dist/esm/src/api.js +4318 -0
- package/dist/esm/src/api.js.map +1 -0
- package/dist/esm/src/base.js +69 -0
- package/dist/esm/src/base.js.map +1 -0
- package/dist/esm/src/common.js +162 -0
- package/dist/esm/src/common.js.map +1 -0
- package/dist/esm/src/configuration.js +45 -0
- package/dist/esm/src/configuration.js.map +1 -0
- package/dist/esm/src/index.js +23 -0
- package/dist/esm/src/index.js.map +1 -0
- package/dist/esm/src/request-signer.js +231 -0
- package/dist/esm/src/request-signer.js.map +1 -0
- package/dist/esm/src/sdk.js +786 -0
- package/dist/esm/src/sdk.js.map +1 -0
- package/dist/esm/src/utils.js +10 -0
- package/dist/esm/src/utils.js.map +1 -0
- package/dist/esm/src/websocket.js +159 -0
- package/dist/esm/src/websocket.js.map +1 -0
- package/dist/types/example.d.ts +2 -0
- package/dist/types/example.d.ts.map +1 -0
- package/dist/types/index.d.ts +2 -0
- package/dist/types/index.d.ts.map +1 -0
- package/dist/{src → types/src}/api.d.ts +126 -47
- package/dist/types/src/api.d.ts.map +1 -0
- package/dist/{src → types/src}/base.d.ts +1 -0
- package/dist/types/src/base.d.ts.map +1 -0
- package/dist/{src → types/src}/common.d.ts +1 -0
- package/dist/types/src/common.d.ts.map +1 -0
- package/dist/{src → types/src}/configuration.d.ts +1 -0
- package/dist/types/src/configuration.d.ts.map +1 -0
- package/dist/{src → types/src}/index.d.ts +1 -0
- package/dist/types/src/index.d.ts.map +1 -0
- package/dist/{src → types/src}/request-signer.d.ts +6 -1
- package/dist/types/src/request-signer.d.ts.map +1 -0
- package/dist/{src → types/src}/sdk.d.ts +12 -1
- package/dist/types/src/sdk.d.ts.map +1 -0
- package/dist/{src → types/src}/utils.d.ts +1 -0
- package/dist/types/src/utils.d.ts.map +1 -0
- package/dist/{src → types/src}/websocket.d.ts +1 -0
- package/dist/types/src/websocket.d.ts.map +1 -0
- package/package.json +21 -7
- package/dist/example.d.ts +0 -1
- package/dist/index.d.ts +0 -1
- package/example.ts +0 -323
- package/index.ts +0 -1
- package/openapitools.json +0 -24
- package/src/.openapi-generator/FILES +0 -128
- package/src/.openapi-generator/VERSION +0 -1
- package/src/.openapi-generator-ignore +0 -28
- package/src/README.md +0 -46
- package/src/api.ts +0 -8918
- package/src/base.ts +0 -86
- package/src/common.ts +0 -150
- package/src/configuration.ts +0 -115
- package/src/docs/Account.md +0 -64
- package/src/docs/AccountAggregatedTradeUpdate.md +0 -21
- package/src/docs/AccountAuthorizationRequest.md +0 -24
- package/src/docs/AccountAuthorizationRequestSignedFields.md +0 -28
- package/src/docs/AccountCommandFailureUpdate.md +0 -29
- package/src/docs/AccountDataApi.md +0 -374
- package/src/docs/AccountDataStream.md +0 -21
- package/src/docs/AccountEventReason.md +0 -25
- package/src/docs/AccountEventType.md +0 -21
- package/src/docs/AccountFundingRateHistory.md +0 -20
- package/src/docs/AccountFundingRateHistoryData.md +0 -30
- package/src/docs/AccountMarketPreference.md +0 -22
- package/src/docs/AccountOrderUpdate.md +0 -71
- package/src/docs/AccountPositionLeverageUpdateRequest.md +0 -22
- package/src/docs/AccountPositionLeverageUpdateRequestSignedFields.md +0 -30
- package/src/docs/AccountPositionUpdate.md +0 -47
- package/src/docs/AccountPreference.md +0 -24
- package/src/docs/AccountStreamMessage.md +0 -25
- package/src/docs/AccountStreamMessagePayload.md +0 -153
- package/src/docs/AccountSubscriptionMessage.md +0 -25
- package/src/docs/AccountTradeUpdate.md +0 -21
- package/src/docs/AccountTransactionUpdate.md +0 -31
- package/src/docs/AccountUpdate.md +0 -61
- package/src/docs/ActiveOrderUpdate.md +0 -65
- package/src/docs/AdjustIsolatedMarginRequest.md +0 -22
- package/src/docs/AdjustIsolatedMarginRequestSignedFields.md +0 -32
- package/src/docs/AdjustMarginOperation.md +0 -11
- package/src/docs/AffiliateIntervalOverview.md +0 -56
- package/src/docs/AffiliateLeaderDashboard.md +0 -38
- package/src/docs/AffiliateMetadata.md +0 -36
- package/src/docs/AffiliateMetadataFees.md +0 -31
- package/src/docs/AffiliateOnboardResponse.md +0 -22
- package/src/docs/AffiliateOverview.md +0 -46
- package/src/docs/AffiliateSummary.md +0 -30
- package/src/docs/Asset.md +0 -29
- package/src/docs/AssetConfig.md +0 -28
- package/src/docs/AuthApi.md +0 -243
- package/src/docs/AuthorizedWallet.md +0 -24
- package/src/docs/CampaignMetadata.md +0 -28
- package/src/docs/CampaignRewards.md +0 -18
- package/src/docs/CancelOrdersRequest.md +0 -23
- package/src/docs/CancelOrdersResponse.md +0 -21
- package/src/docs/CandlePriceType.md +0 -14
- package/src/docs/CandlestickUpdate.md +0 -41
- package/src/docs/CommandFailureReasonCode.md +0 -24
- package/src/docs/ContractsConfig.md +0 -31
- package/src/docs/CreateOrderRequest.md +0 -36
- package/src/docs/CreateOrderRequestSignedFields.md +0 -40
- package/src/docs/CreateOrderResponse.md +0 -20
- package/src/docs/EpochConfigs.md +0 -34
- package/src/docs/EpochConfigsResponse.md +0 -24
- package/src/docs/EpochMetadata.md +0 -30
- package/src/docs/Error.md +0 -22
- package/src/docs/ExchangeApi.md +0 -473
- package/src/docs/ExchangeInfoResponse.md +0 -30
- package/src/docs/FailedCommandType.md +0 -12
- package/src/docs/FeeConfigs.md +0 -33
- package/src/docs/FundingRateEntry.md +0 -24
- package/src/docs/GetAffiliateIntervalOverview200Response.md +0 -26
- package/src/docs/GetAffiliateLeaderDashboard200Response.md +0 -26
- package/src/docs/GetAffiliateOverview200Response.md +0 -26
- package/src/docs/IntervalMetadata.md +0 -28
- package/src/docs/IntervalRewards.md +0 -30
- package/src/docs/KlineInterval.md +0 -36
- package/src/docs/LoginRequest.md +0 -25
- package/src/docs/LoginResponse.md +0 -26
- package/src/docs/MarginType.md +0 -13
- package/src/docs/MarkPriceUpdate.md +0 -26
- package/src/docs/Market.md +0 -82
- package/src/docs/MarketDataStreamName.md +0 -142
- package/src/docs/MarketEventType.md +0 -25
- package/src/docs/MarketPriceUpdate.md +0 -26
- package/src/docs/MarketStatus.md +0 -16
- package/src/docs/MarketStreamMessage.md +0 -23
- package/src/docs/MarketStreamMessagePayload.md +0 -123
- package/src/docs/MarketSubscriptionMessage.md +0 -23
- package/src/docs/MarketSubscriptionStreams.md +0 -23
- package/src/docs/OnboardAffiliateRequest.md +0 -26
- package/src/docs/OnboardAffiliateRequestSocialUserNames.md +0 -27
- package/src/docs/OnboardRefereeRequest.md +0 -20
- package/src/docs/OpenOrderResponse.md +0 -64
- package/src/docs/Operators.md +0 -28
- package/src/docs/OraclePriceUpdate.md +0 -26
- package/src/docs/OrderCancelReason.md +0 -65
- package/src/docs/OrderCancellationFailureReason.md +0 -19
- package/src/docs/OrderCancellationUpdate.md +0 -35
- package/src/docs/OrderSide.md +0 -13
- package/src/docs/OrderStatus.md +0 -25
- package/src/docs/OrderTimeInForce.md +0 -15
- package/src/docs/OrderType.md +0 -29
- package/src/docs/OrderbookDepthResponse.md +0 -38
- package/src/docs/OrderbookDiffDepthUpdate.md +0 -30
- package/src/docs/OrderbookPartialDepthUpdate.md +0 -30
- package/src/docs/Position.md +0 -52
- package/src/docs/PositionSide.md +0 -13
- package/src/docs/RecentTradesUpdates.md +0 -20
- package/src/docs/RefereeOnboardResponse.md +0 -20
- package/src/docs/RefreshTokenRequest.md +0 -20
- package/src/docs/RefreshTokenResponse.md +0 -26
- package/src/docs/RewardsApi.md +0 -859
- package/src/docs/RewardsSummary.md +0 -26
- package/src/docs/SelfTradePreventionType.md +0 -15
- package/src/docs/StatsEntry.md +0 -26
- package/src/docs/StatsInterval.md +0 -14
- package/src/docs/StatsResponse.md +0 -20
- package/src/docs/StreamsApi.md +0 -126
- package/src/docs/SubscriptionResponseMessage.md +0 -23
- package/src/docs/SubscriptionType.md +0 -11
- package/src/docs/TickerAllUpdate.md +0 -20
- package/src/docs/TickerResponse.md +0 -82
- package/src/docs/TickerUpdate.md +0 -83
- package/src/docs/Trade.md +0 -54
- package/src/docs/TradeApi.md +0 -589
- package/src/docs/TradeSide.md +0 -13
- package/src/docs/TradeType.md +0 -15
- package/src/docs/TradingFees.md +0 -24
- package/src/docs/Transaction.md +0 -34
- package/src/docs/TransactionType.md +0 -25
- package/src/docs/UpdateAccountPreferenceRequest.md +0 -24
- package/src/docs/UpdateAffiliateFeeConfigRequest.md +0 -20
- package/src/docs/UserCampaignRewards.md +0 -48
- package/src/docs/WithdrawRequest.md +0 -22
- package/src/docs/WithdrawRequestSignedFields.md +0 -30
- package/src/git_push.sh +0 -57
- package/src/index.ts +0 -6
- package/src/request-signer.ts +0 -405
- package/src/sdk.ts +0 -982
- package/src/utils.ts +0 -6
- package/src/websocket.ts +0 -165
- package/tsconfig.json +0 -23
|
@@ -1,30 +0,0 @@
|
|
|
1
|
-
# ExchangeInfoResponse
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
## Properties
|
|
5
|
-
|
|
6
|
-
Name | Type | Description | Notes
|
|
7
|
-
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**assets** | [**Array<AssetConfig>**](AssetConfig.md) | List of assets available on the exchange. | [default to undefined]
|
|
9
|
-
**contractsConfig** | [**ContractsConfig**](ContractsConfig.md) | | [optional] [default to undefined]
|
|
10
|
-
**markets** | [**Array<Market>**](Market.md) | List of markets available on the exchange. | [default to undefined]
|
|
11
|
-
**tradingGasFeeE9** | **string** | Current gas fee set for subsidized trades (e9 format) | [default to undefined]
|
|
12
|
-
**serverTimeAtMillis** | **number** | Server time in milliseconds. | [default to undefined]
|
|
13
|
-
**timezone** | **string** | Timezone of the exchange. | [default to undefined]
|
|
14
|
-
|
|
15
|
-
## Example
|
|
16
|
-
|
|
17
|
-
```typescript
|
|
18
|
-
import { ExchangeInfoResponse } from '@bluefin/api-client';
|
|
19
|
-
|
|
20
|
-
const instance: ExchangeInfoResponse = {
|
|
21
|
-
assets,
|
|
22
|
-
contractsConfig,
|
|
23
|
-
markets,
|
|
24
|
-
tradingGasFeeE9,
|
|
25
|
-
serverTimeAtMillis,
|
|
26
|
-
timezone,
|
|
27
|
-
};
|
|
28
|
-
```
|
|
29
|
-
|
|
30
|
-
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -1,12 +0,0 @@
|
|
|
1
|
-
# FailedCommandType
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
## Enum
|
|
5
|
-
|
|
6
|
-
* `PositionIsolatedMarginUpdate` (value: `'POSITION_ISOLATED_MARGIN_UPDATE'`)
|
|
7
|
-
|
|
8
|
-
* `PositionLeverageUpdate` (value: `'POSITION_LEVERAGE_UPDATE'`)
|
|
9
|
-
|
|
10
|
-
* `Withdraw` (value: `'WITHDRAW'`)
|
|
11
|
-
|
|
12
|
-
[[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/FeeConfigs.md
DELETED
|
@@ -1,33 +0,0 @@
|
|
|
1
|
-
# FeeConfigs
|
|
2
|
-
|
|
3
|
-
Map of various fee-related configurations
|
|
4
|
-
|
|
5
|
-
## Properties
|
|
6
|
-
|
|
7
|
-
Name | Type | Description | Notes
|
|
8
|
-
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**referralPerpsFee** | **string** | Earnings from referral perps fees | [optional] [default to undefined]
|
|
10
|
-
**subaffiliatePerpsEarnings** | **string** | Earnings from subaffiliate perps | [optional] [default to undefined]
|
|
11
|
-
**spotLPFee** | **string** | Earnings from spot LP fees | [optional] [default to undefined]
|
|
12
|
-
**referralSpotLPFee** | **string** | Earnings from referral spot LP fees | [optional] [default to undefined]
|
|
13
|
-
**referralLendingRewards** | **string** | Earnings from referral lending rewards | [optional] [default to undefined]
|
|
14
|
-
**perpsFeeCashback** | **string** | Cashback from perps fees | [optional] [default to undefined]
|
|
15
|
-
**perpsRevShare** | **string** | Revenue share percentage for perps | [optional] [default to undefined]
|
|
16
|
-
|
|
17
|
-
## Example
|
|
18
|
-
|
|
19
|
-
```typescript
|
|
20
|
-
import { FeeConfigs } from '@bluefin/api-client';
|
|
21
|
-
|
|
22
|
-
const instance: FeeConfigs = {
|
|
23
|
-
referralPerpsFee,
|
|
24
|
-
subaffiliatePerpsEarnings,
|
|
25
|
-
spotLPFee,
|
|
26
|
-
referralSpotLPFee,
|
|
27
|
-
referralLendingRewards,
|
|
28
|
-
perpsFeeCashback,
|
|
29
|
-
perpsRevShare,
|
|
30
|
-
};
|
|
31
|
-
```
|
|
32
|
-
|
|
33
|
-
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -1,24 +0,0 @@
|
|
|
1
|
-
# FundingRateEntry
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
## Properties
|
|
5
|
-
|
|
6
|
-
Name | Type | Description | Notes
|
|
7
|
-
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**symbol** | **string** | The market symbol. | [default to undefined]
|
|
9
|
-
**fundingTimeAtMillis** | **number** | Timestamp of the funding time in milliseconds. | [default to undefined]
|
|
10
|
-
**fundingRateE9** | **string** | Funding rate for the market address. | [default to undefined]
|
|
11
|
-
|
|
12
|
-
## Example
|
|
13
|
-
|
|
14
|
-
```typescript
|
|
15
|
-
import { FundingRateEntry } from '@bluefin/api-client';
|
|
16
|
-
|
|
17
|
-
const instance: FundingRateEntry = {
|
|
18
|
-
symbol,
|
|
19
|
-
fundingTimeAtMillis,
|
|
20
|
-
fundingRateE9,
|
|
21
|
-
};
|
|
22
|
-
```
|
|
23
|
-
|
|
24
|
-
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -1,26 +0,0 @@
|
|
|
1
|
-
# GetAffiliateIntervalOverview200Response
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
## Properties
|
|
5
|
-
|
|
6
|
-
Name | Type | Description | Notes
|
|
7
|
-
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**data** | [**Array<AffiliateIntervalOverview>**](AffiliateIntervalOverview.md) | | [optional] [default to undefined]
|
|
9
|
-
**total** | **number** | Total number of records | [optional] [default to undefined]
|
|
10
|
-
**limit** | **number** | The page size for pagination | [optional] [default to undefined]
|
|
11
|
-
**page** | **number** | The page number for pagination | [optional] [default to undefined]
|
|
12
|
-
|
|
13
|
-
## Example
|
|
14
|
-
|
|
15
|
-
```typescript
|
|
16
|
-
import { GetAffiliateIntervalOverview200Response } from '@bluefin/api-client';
|
|
17
|
-
|
|
18
|
-
const instance: GetAffiliateIntervalOverview200Response = {
|
|
19
|
-
data,
|
|
20
|
-
total,
|
|
21
|
-
limit,
|
|
22
|
-
page,
|
|
23
|
-
};
|
|
24
|
-
```
|
|
25
|
-
|
|
26
|
-
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -1,26 +0,0 @@
|
|
|
1
|
-
# GetAffiliateLeaderDashboard200Response
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
## Properties
|
|
5
|
-
|
|
6
|
-
Name | Type | Description | Notes
|
|
7
|
-
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**data** | [**Array<AffiliateLeaderDashboard>**](AffiliateLeaderDashboard.md) | | [optional] [default to undefined]
|
|
9
|
-
**total** | **number** | Total number of records | [optional] [default to undefined]
|
|
10
|
-
**limit** | **number** | The page size for pagination | [optional] [default to undefined]
|
|
11
|
-
**page** | **number** | The page number for pagination | [optional] [default to undefined]
|
|
12
|
-
|
|
13
|
-
## Example
|
|
14
|
-
|
|
15
|
-
```typescript
|
|
16
|
-
import { GetAffiliateLeaderDashboard200Response } from '@bluefin/api-client';
|
|
17
|
-
|
|
18
|
-
const instance: GetAffiliateLeaderDashboard200Response = {
|
|
19
|
-
data,
|
|
20
|
-
total,
|
|
21
|
-
limit,
|
|
22
|
-
page,
|
|
23
|
-
};
|
|
24
|
-
```
|
|
25
|
-
|
|
26
|
-
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -1,26 +0,0 @@
|
|
|
1
|
-
# GetAffiliateOverview200Response
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
## Properties
|
|
5
|
-
|
|
6
|
-
Name | Type | Description | Notes
|
|
7
|
-
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**data** | [**Array<AffiliateOverview>**](AffiliateOverview.md) | | [optional] [default to undefined]
|
|
9
|
-
**total** | **number** | Total number of records | [optional] [default to undefined]
|
|
10
|
-
**limit** | **number** | The page size for pagination | [optional] [default to undefined]
|
|
11
|
-
**page** | **number** | The page number for pagination | [optional] [default to undefined]
|
|
12
|
-
|
|
13
|
-
## Example
|
|
14
|
-
|
|
15
|
-
```typescript
|
|
16
|
-
import { GetAffiliateOverview200Response } from '@bluefin/api-client';
|
|
17
|
-
|
|
18
|
-
const instance: GetAffiliateOverview200Response = {
|
|
19
|
-
data,
|
|
20
|
-
total,
|
|
21
|
-
limit,
|
|
22
|
-
page,
|
|
23
|
-
};
|
|
24
|
-
```
|
|
25
|
-
|
|
26
|
-
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -1,28 +0,0 @@
|
|
|
1
|
-
# IntervalMetadata
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
## Properties
|
|
5
|
-
|
|
6
|
-
Name | Type | Description | Notes
|
|
7
|
-
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**status** | **string** | | [default to undefined]
|
|
9
|
-
**startDate** | **number** | Time in seconds for interval start date. | [default to undefined]
|
|
10
|
-
**endDate** | **number** | Time in seconds for interval end date. | [default to undefined]
|
|
11
|
-
**intervalId** | **number** | Interval Id of the interval. | [default to undefined]
|
|
12
|
-
**intervalType** | **string** | Type of the interval. | [default to undefined]
|
|
13
|
-
|
|
14
|
-
## Example
|
|
15
|
-
|
|
16
|
-
```typescript
|
|
17
|
-
import { IntervalMetadata } from '@bluefin/api-client';
|
|
18
|
-
|
|
19
|
-
const instance: IntervalMetadata = {
|
|
20
|
-
status,
|
|
21
|
-
startDate,
|
|
22
|
-
endDate,
|
|
23
|
-
intervalId,
|
|
24
|
-
intervalType,
|
|
25
|
-
};
|
|
26
|
-
```
|
|
27
|
-
|
|
28
|
-
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -1,30 +0,0 @@
|
|
|
1
|
-
# IntervalRewards
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
## Properties
|
|
5
|
-
|
|
6
|
-
Name | Type | Description | Notes
|
|
7
|
-
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**userAddress** | **string** | User address for the rewards earned data. | [default to undefined]
|
|
9
|
-
**status** | **string** | | [default to undefined]
|
|
10
|
-
**blueRewardsE9** | **string** | Total Blue token rewards earned in the interval (e9 format). | [default to undefined]
|
|
11
|
-
**suiRewardsE9** | **string** | Total Sui token rewards earned in the interval (e9 format). | [default to undefined]
|
|
12
|
-
**walRewardsE9** | **string** | Total wal rewards earned in the interval (e9 format). | [default to undefined]
|
|
13
|
-
**intervalNumber** | **number** | Interval Id of the interval for the rewards earned data. | [default to undefined]
|
|
14
|
-
|
|
15
|
-
## Example
|
|
16
|
-
|
|
17
|
-
```typescript
|
|
18
|
-
import { IntervalRewards } from '@bluefin/api-client';
|
|
19
|
-
|
|
20
|
-
const instance: IntervalRewards = {
|
|
21
|
-
userAddress,
|
|
22
|
-
status,
|
|
23
|
-
blueRewardsE9,
|
|
24
|
-
suiRewardsE9,
|
|
25
|
-
walRewardsE9,
|
|
26
|
-
intervalNumber,
|
|
27
|
-
};
|
|
28
|
-
```
|
|
29
|
-
|
|
30
|
-
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -1,36 +0,0 @@
|
|
|
1
|
-
# KlineInterval
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
## Enum
|
|
5
|
-
|
|
6
|
-
* `_1m` (value: `'1m'`)
|
|
7
|
-
|
|
8
|
-
* `_3m` (value: `'3m'`)
|
|
9
|
-
|
|
10
|
-
* `_5m` (value: `'5m'`)
|
|
11
|
-
|
|
12
|
-
* `_15m` (value: `'15m'`)
|
|
13
|
-
|
|
14
|
-
* `_30m` (value: `'30m'`)
|
|
15
|
-
|
|
16
|
-
* `_1h` (value: `'1h'`)
|
|
17
|
-
|
|
18
|
-
* `_2h` (value: `'2h'`)
|
|
19
|
-
|
|
20
|
-
* `_4h` (value: `'4h'`)
|
|
21
|
-
|
|
22
|
-
* `_6h` (value: `'6h'`)
|
|
23
|
-
|
|
24
|
-
* `_8h` (value: `'8h'`)
|
|
25
|
-
|
|
26
|
-
* `_12h` (value: `'12h'`)
|
|
27
|
-
|
|
28
|
-
* `_1d` (value: `'1d'`)
|
|
29
|
-
|
|
30
|
-
* `_1w` (value: `'1w'`)
|
|
31
|
-
|
|
32
|
-
* `_1Mo` (value: `'1Mo'`)
|
|
33
|
-
|
|
34
|
-
* `Unspecified` (value: `'UNSPECIFIED'`)
|
|
35
|
-
|
|
36
|
-
[[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/LoginRequest.md
DELETED
|
@@ -1,25 +0,0 @@
|
|
|
1
|
-
# LoginRequest
|
|
2
|
-
|
|
3
|
-
User is expected to sign this payload and sends is signature in login api as header and payload itself in request body
|
|
4
|
-
|
|
5
|
-
## Properties
|
|
6
|
-
|
|
7
|
-
Name | Type | Description | Notes
|
|
8
|
-
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**accountAddress** | **string** | The address of the account. | [default to undefined]
|
|
10
|
-
**signedAtMillis** | **number** | The timestamp in millis when the login was signed. | [default to undefined]
|
|
11
|
-
**audience** | **string** | The intended audience of the login request. | [default to undefined]
|
|
12
|
-
|
|
13
|
-
## Example
|
|
14
|
-
|
|
15
|
-
```typescript
|
|
16
|
-
import { LoginRequest } from '@bluefin/api-client';
|
|
17
|
-
|
|
18
|
-
const instance: LoginRequest = {
|
|
19
|
-
accountAddress,
|
|
20
|
-
signedAtMillis,
|
|
21
|
-
audience,
|
|
22
|
-
};
|
|
23
|
-
```
|
|
24
|
-
|
|
25
|
-
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -1,26 +0,0 @@
|
|
|
1
|
-
# LoginResponse
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
## Properties
|
|
5
|
-
|
|
6
|
-
Name | Type | Description | Notes
|
|
7
|
-
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**accessToken** | **string** | | [default to undefined]
|
|
9
|
-
**accessTokenValidForSeconds** | **number** | | [default to undefined]
|
|
10
|
-
**refreshToken** | **string** | | [default to undefined]
|
|
11
|
-
**refreshTokenValidForSeconds** | **number** | | [default to undefined]
|
|
12
|
-
|
|
13
|
-
## Example
|
|
14
|
-
|
|
15
|
-
```typescript
|
|
16
|
-
import { LoginResponse } from '@bluefin/api-client';
|
|
17
|
-
|
|
18
|
-
const instance: LoginResponse = {
|
|
19
|
-
accessToken,
|
|
20
|
-
accessTokenValidForSeconds,
|
|
21
|
-
refreshToken,
|
|
22
|
-
refreshTokenValidForSeconds,
|
|
23
|
-
};
|
|
24
|
-
```
|
|
25
|
-
|
|
26
|
-
[[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/MarginType.md
DELETED
|
@@ -1,13 +0,0 @@
|
|
|
1
|
-
# MarginType
|
|
2
|
-
|
|
3
|
-
Margin type.
|
|
4
|
-
|
|
5
|
-
## Enum
|
|
6
|
-
|
|
7
|
-
* `Cross` (value: `'CROSS'`)
|
|
8
|
-
|
|
9
|
-
* `Isolated` (value: `'ISOLATED'`)
|
|
10
|
-
|
|
11
|
-
* `Unspecified` (value: `'UNSPECIFIED'`)
|
|
12
|
-
|
|
13
|
-
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -1,26 +0,0 @@
|
|
|
1
|
-
# MarkPriceUpdate
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
## Properties
|
|
5
|
-
|
|
6
|
-
Name | Type | Description | Notes
|
|
7
|
-
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**symbol** | **string** | The symbol of the market. | [default to undefined]
|
|
9
|
-
**priceE9** | **string** | The price in scientific notation with 9 decimal places of precision. | [default to undefined]
|
|
10
|
-
**source** | **string** | | [default to undefined]
|
|
11
|
-
**updatedAtMillis** | **number** | The timestamp of the price update. | [default to undefined]
|
|
12
|
-
|
|
13
|
-
## Example
|
|
14
|
-
|
|
15
|
-
```typescript
|
|
16
|
-
import { MarkPriceUpdate } from '@bluefin/api-client';
|
|
17
|
-
|
|
18
|
-
const instance: MarkPriceUpdate = {
|
|
19
|
-
symbol,
|
|
20
|
-
priceE9,
|
|
21
|
-
source,
|
|
22
|
-
updatedAtMillis,
|
|
23
|
-
};
|
|
24
|
-
```
|
|
25
|
-
|
|
26
|
-
[[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/Market.md
DELETED
|
@@ -1,82 +0,0 @@
|
|
|
1
|
-
# Market
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
## Properties
|
|
5
|
-
|
|
6
|
-
Name | Type | Description | Notes
|
|
7
|
-
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**symbol** | **string** | Symbol of the market. | [default to undefined]
|
|
9
|
-
**marketAddress** | **string** | Market address. | [default to undefined]
|
|
10
|
-
**status** | [**MarketStatus**](MarketStatus.md) | | [default to undefined]
|
|
11
|
-
**baseAssetSymbol** | **string** | Base asset symbol. | [default to undefined]
|
|
12
|
-
**baseAssetName** | **string** | Base asset name. | [default to undefined]
|
|
13
|
-
**baseAssetDecimals** | **number** | Precision of the base asset. | [default to undefined]
|
|
14
|
-
**stepSizeE9** | **string** | Step size for the quantity (e9 format). | [default to undefined]
|
|
15
|
-
**tickSizeE9** | **string** | Price increment size (e9 format). | [default to undefined]
|
|
16
|
-
**minOrderQuantityE9** | **string** | Minimum order size (e9 format). | [default to undefined]
|
|
17
|
-
**maxLimitOrderQuantityE9** | **string** | Maximum limit order size (e9 format). | [default to undefined]
|
|
18
|
-
**maxMarketOrderQuantityE9** | **string** | Maximum market order size (e9 format). | [default to undefined]
|
|
19
|
-
**minOrderPriceE9** | **string** | Minimum order price (e9 format). | [default to undefined]
|
|
20
|
-
**maxOrderPriceE9** | **string** | Maximum order price (e9 format). | [default to undefined]
|
|
21
|
-
**maintenanceMarginRatioE9** | **string** | Maintenance margin ratio (MMR, e9 format). | [default to undefined]
|
|
22
|
-
**initialMarginRatioE9** | **string** | Initial margin ratio (IMR), e9 format). | [default to undefined]
|
|
23
|
-
**insurancePoolRatioE9** | **string** | Insurance pool ratio (e9 format). | [default to undefined]
|
|
24
|
-
**defaultLeverageE9** | **string** | Default leverage (e9 format). | [default to undefined]
|
|
25
|
-
**maxNotionalAtOpenE9** | **Array<string>** | Maximum notional value at current leverage. Index 0 is max notional value for leverage set to 1x, index 1 is for leverage 2x, etc... | [default to undefined]
|
|
26
|
-
**minTradeQuantityE9** | **string** | Minimum trade quantity allowed (e9 format). | [default to undefined]
|
|
27
|
-
**maxTradeQuantityE9** | **string** | Max trade quantity allowed (e9 format). | [default to undefined]
|
|
28
|
-
**minTradePriceE9** | **string** | Minimum trade price allowed (e9 format). | [default to undefined]
|
|
29
|
-
**maxTradePriceE9** | **string** | Maximum trade price allowed (e9 format). | [default to undefined]
|
|
30
|
-
**maxFundingRateE9** | **string** | Maximum allowed funding rate (e9 format). | [default to undefined]
|
|
31
|
-
**defaultMakerFeeE9** | **string** | Default maker fee (e9 format). | [default to undefined]
|
|
32
|
-
**defaultTakerFeeE9** | **string** | Default taker fee (e9 format). | [default to undefined]
|
|
33
|
-
**insurancePoolAddress** | **string** | Insurance pool address. | [default to undefined]
|
|
34
|
-
**feePoolAddress** | **string** | Fee pool address. | [default to undefined]
|
|
35
|
-
**tradingStartTimeAtMillis** | **string** | The time when trading will start/have started on the market. | [default to undefined]
|
|
36
|
-
**mtbLongE9** | **string** | Maximum take bound for long positions (e9 format). | [default to undefined]
|
|
37
|
-
**mtbShortE9** | **string** | Maximum take bound for short positions (e9 format). | [default to undefined]
|
|
38
|
-
**delistingPriceE9** | **string** | Delisting price (e9 format). | [default to undefined]
|
|
39
|
-
**isolatedOnly** | **boolean** | Indicates whether the market only allows isolated margin. | [default to undefined]
|
|
40
|
-
|
|
41
|
-
## Example
|
|
42
|
-
|
|
43
|
-
```typescript
|
|
44
|
-
import { Market } from '@bluefin/api-client';
|
|
45
|
-
|
|
46
|
-
const instance: Market = {
|
|
47
|
-
symbol,
|
|
48
|
-
marketAddress,
|
|
49
|
-
status,
|
|
50
|
-
baseAssetSymbol,
|
|
51
|
-
baseAssetName,
|
|
52
|
-
baseAssetDecimals,
|
|
53
|
-
stepSizeE9,
|
|
54
|
-
tickSizeE9,
|
|
55
|
-
minOrderQuantityE9,
|
|
56
|
-
maxLimitOrderQuantityE9,
|
|
57
|
-
maxMarketOrderQuantityE9,
|
|
58
|
-
minOrderPriceE9,
|
|
59
|
-
maxOrderPriceE9,
|
|
60
|
-
maintenanceMarginRatioE9,
|
|
61
|
-
initialMarginRatioE9,
|
|
62
|
-
insurancePoolRatioE9,
|
|
63
|
-
defaultLeverageE9,
|
|
64
|
-
maxNotionalAtOpenE9,
|
|
65
|
-
minTradeQuantityE9,
|
|
66
|
-
maxTradeQuantityE9,
|
|
67
|
-
minTradePriceE9,
|
|
68
|
-
maxTradePriceE9,
|
|
69
|
-
maxFundingRateE9,
|
|
70
|
-
defaultMakerFeeE9,
|
|
71
|
-
defaultTakerFeeE9,
|
|
72
|
-
insurancePoolAddress,
|
|
73
|
-
feePoolAddress,
|
|
74
|
-
tradingStartTimeAtMillis,
|
|
75
|
-
mtbLongE9,
|
|
76
|
-
mtbShortE9,
|
|
77
|
-
delistingPriceE9,
|
|
78
|
-
isolatedOnly,
|
|
79
|
-
};
|
|
80
|
-
```
|
|
81
|
-
|
|
82
|
-
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -1,142 +0,0 @@
|
|
|
1
|
-
# MarketDataStreamName
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
## Enum
|
|
5
|
-
|
|
6
|
-
* `RecentTrade` (value: `'Recent_Trade'`)
|
|
7
|
-
|
|
8
|
-
* `Ticker` (value: `'Ticker'`)
|
|
9
|
-
|
|
10
|
-
* `TickerAll` (value: `'Ticker_All'`)
|
|
11
|
-
|
|
12
|
-
* `DiffDepth10Ms` (value: `'Diff_Depth_10_ms'`)
|
|
13
|
-
|
|
14
|
-
* `DiffDepth200Ms` (value: `'Diff_Depth_200_ms'`)
|
|
15
|
-
|
|
16
|
-
* `DiffDepth500Ms` (value: `'Diff_Depth_500_ms'`)
|
|
17
|
-
|
|
18
|
-
* `PartialDepth5` (value: `'Partial_Depth_5'`)
|
|
19
|
-
|
|
20
|
-
* `PartialDepth10` (value: `'Partial_Depth_10'`)
|
|
21
|
-
|
|
22
|
-
* `PartialDepth20` (value: `'Partial_Depth_20'`)
|
|
23
|
-
|
|
24
|
-
* `OraclePrice` (value: `'Oracle_Price'`)
|
|
25
|
-
|
|
26
|
-
* `MarkPrice` (value: `'Mark_Price'`)
|
|
27
|
-
|
|
28
|
-
* `MarketPrice` (value: `'Market_Price'`)
|
|
29
|
-
|
|
30
|
-
* `Candlestick1mLast` (value: `'Candlestick_1m_Last'`)
|
|
31
|
-
|
|
32
|
-
* `Candlestick3mLast` (value: `'Candlestick_3m_Last'`)
|
|
33
|
-
|
|
34
|
-
* `Candlestick5mLast` (value: `'Candlestick_5m_Last'`)
|
|
35
|
-
|
|
36
|
-
* `Candlestick15mLast` (value: `'Candlestick_15m_Last'`)
|
|
37
|
-
|
|
38
|
-
* `Candlestick30mLast` (value: `'Candlestick_30m_Last'`)
|
|
39
|
-
|
|
40
|
-
* `Candlestick1hLast` (value: `'Candlestick_1h_Last'`)
|
|
41
|
-
|
|
42
|
-
* `Candlestick2hLast` (value: `'Candlestick_2h_Last'`)
|
|
43
|
-
|
|
44
|
-
* `Candlestick4hLast` (value: `'Candlestick_4h_Last'`)
|
|
45
|
-
|
|
46
|
-
* `Candlestick6hLast` (value: `'Candlestick_6h_Last'`)
|
|
47
|
-
|
|
48
|
-
* `Candlestick8hLast` (value: `'Candlestick_8h_Last'`)
|
|
49
|
-
|
|
50
|
-
* `Candlestick12hLast` (value: `'Candlestick_12h_Last'`)
|
|
51
|
-
|
|
52
|
-
* `Candlestick1dLast` (value: `'Candlestick_1d_Last'`)
|
|
53
|
-
|
|
54
|
-
* `Candlestick1wLast` (value: `'Candlestick_1w_Last'`)
|
|
55
|
-
|
|
56
|
-
* `Candlestick1MoLast` (value: `'Candlestick_1Mo_Last'`)
|
|
57
|
-
|
|
58
|
-
* `Candlestick1mOracle` (value: `'Candlestick_1m_Oracle'`)
|
|
59
|
-
|
|
60
|
-
* `Candlestick3mOracle` (value: `'Candlestick_3m_Oracle'`)
|
|
61
|
-
|
|
62
|
-
* `Candlestick5mOracle` (value: `'Candlestick_5m_Oracle'`)
|
|
63
|
-
|
|
64
|
-
* `Candlestick15mOracle` (value: `'Candlestick_15m_Oracle'`)
|
|
65
|
-
|
|
66
|
-
* `Candlestick30mOracle` (value: `'Candlestick_30m_Oracle'`)
|
|
67
|
-
|
|
68
|
-
* `Candlestick1hOracle` (value: `'Candlestick_1h_Oracle'`)
|
|
69
|
-
|
|
70
|
-
* `Candlestick2hOracle` (value: `'Candlestick_2h_Oracle'`)
|
|
71
|
-
|
|
72
|
-
* `Candlestick4hOracle` (value: `'Candlestick_4h_Oracle'`)
|
|
73
|
-
|
|
74
|
-
* `Candlestick6hOracle` (value: `'Candlestick_6h_Oracle'`)
|
|
75
|
-
|
|
76
|
-
* `Candlestick8hOracle` (value: `'Candlestick_8h_Oracle'`)
|
|
77
|
-
|
|
78
|
-
* `Candlestick12hOracle` (value: `'Candlestick_12h_Oracle'`)
|
|
79
|
-
|
|
80
|
-
* `Candlestick1dOracle` (value: `'Candlestick_1d_Oracle'`)
|
|
81
|
-
|
|
82
|
-
* `Candlestick1wOracle` (value: `'Candlestick_1w_Oracle'`)
|
|
83
|
-
|
|
84
|
-
* `Candlestick1MoOracle` (value: `'Candlestick_1Mo_Oracle'`)
|
|
85
|
-
|
|
86
|
-
* `Candlestick1mMark` (value: `'Candlestick_1m_Mark'`)
|
|
87
|
-
|
|
88
|
-
* `Candlestick3mMark` (value: `'Candlestick_3m_Mark'`)
|
|
89
|
-
|
|
90
|
-
* `Candlestick5mMark` (value: `'Candlestick_5m_Mark'`)
|
|
91
|
-
|
|
92
|
-
* `Candlestick15mMark` (value: `'Candlestick_15m_Mark'`)
|
|
93
|
-
|
|
94
|
-
* `Candlestick30mMark` (value: `'Candlestick_30m_Mark'`)
|
|
95
|
-
|
|
96
|
-
* `Candlestick1hMark` (value: `'Candlestick_1h_Mark'`)
|
|
97
|
-
|
|
98
|
-
* `Candlestick2hMark` (value: `'Candlestick_2h_Mark'`)
|
|
99
|
-
|
|
100
|
-
* `Candlestick4hMark` (value: `'Candlestick_4h_Mark'`)
|
|
101
|
-
|
|
102
|
-
* `Candlestick6hMark` (value: `'Candlestick_6h_Mark'`)
|
|
103
|
-
|
|
104
|
-
* `Candlestick8hMark` (value: `'Candlestick_8h_Mark'`)
|
|
105
|
-
|
|
106
|
-
* `Candlestick12hMark` (value: `'Candlestick_12h_Mark'`)
|
|
107
|
-
|
|
108
|
-
* `Candlestick1dMark` (value: `'Candlestick_1d_Mark'`)
|
|
109
|
-
|
|
110
|
-
* `Candlestick1wMark` (value: `'Candlestick_1w_Mark'`)
|
|
111
|
-
|
|
112
|
-
* `Candlestick1MoMark` (value: `'Candlestick_1Mo_Mark'`)
|
|
113
|
-
|
|
114
|
-
* `Candlestick1mMarket` (value: `'Candlestick_1m_Market'`)
|
|
115
|
-
|
|
116
|
-
* `Candlestick3mMarket` (value: `'Candlestick_3m_Market'`)
|
|
117
|
-
|
|
118
|
-
* `Candlestick5mMarket` (value: `'Candlestick_5m_Market'`)
|
|
119
|
-
|
|
120
|
-
* `Candlestick15mMarket` (value: `'Candlestick_15m_Market'`)
|
|
121
|
-
|
|
122
|
-
* `Candlestick30mMarket` (value: `'Candlestick_30m_Market'`)
|
|
123
|
-
|
|
124
|
-
* `Candlestick1hMarket` (value: `'Candlestick_1h_Market'`)
|
|
125
|
-
|
|
126
|
-
* `Candlestick2hMarket` (value: `'Candlestick_2h_Market'`)
|
|
127
|
-
|
|
128
|
-
* `Candlestick4hMarket` (value: `'Candlestick_4h_Market'`)
|
|
129
|
-
|
|
130
|
-
* `Candlestick6hMarket` (value: `'Candlestick_6h_Market'`)
|
|
131
|
-
|
|
132
|
-
* `Candlestick8hMarket` (value: `'Candlestick_8h_Market'`)
|
|
133
|
-
|
|
134
|
-
* `Candlestick12hMarket` (value: `'Candlestick_12h_Market'`)
|
|
135
|
-
|
|
136
|
-
* `Candlestick1dMarket` (value: `'Candlestick_1d_Market'`)
|
|
137
|
-
|
|
138
|
-
* `Candlestick1wMarket` (value: `'Candlestick_1w_Market'`)
|
|
139
|
-
|
|
140
|
-
* `Candlestick1MoMarket` (value: `'Candlestick_1Mo_Market'`)
|
|
141
|
-
|
|
142
|
-
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -1,25 +0,0 @@
|
|
|
1
|
-
# MarketEventType
|
|
2
|
-
|
|
3
|
-
The type of event communicated in the WebSocket message.
|
|
4
|
-
|
|
5
|
-
## Enum
|
|
6
|
-
|
|
7
|
-
* `RecentTradesUpdates` (value: `'RecentTradesUpdates'`)
|
|
8
|
-
|
|
9
|
-
* `TickerUpdate` (value: `'TickerUpdate'`)
|
|
10
|
-
|
|
11
|
-
* `TickerAllUpdate` (value: `'TickerAllUpdate'`)
|
|
12
|
-
|
|
13
|
-
* `OraclePriceUpdate` (value: `'OraclePriceUpdate'`)
|
|
14
|
-
|
|
15
|
-
* `MarkPriceUpdate` (value: `'MarkPriceUpdate'`)
|
|
16
|
-
|
|
17
|
-
* `MarketPriceUpdate` (value: `'MarketPriceUpdate'`)
|
|
18
|
-
|
|
19
|
-
* `CandlestickUpdate` (value: `'CandlestickUpdate'`)
|
|
20
|
-
|
|
21
|
-
* `OrderbookDiffDepthUpdate` (value: `'OrderbookDiffDepthUpdate'`)
|
|
22
|
-
|
|
23
|
-
* `OrderbookPartialDepthUpdate` (value: `'OrderbookPartialDepthUpdate'`)
|
|
24
|
-
|
|
25
|
-
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -1,26 +0,0 @@
|
|
|
1
|
-
# MarketPriceUpdate
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
## Properties
|
|
5
|
-
|
|
6
|
-
Name | Type | Description | Notes
|
|
7
|
-
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**symbol** | **string** | The symbol of the market. | [default to undefined]
|
|
9
|
-
**priceE9** | **string** | The price in scientific notation with 9 decimal places of precision. | [default to undefined]
|
|
10
|
-
**source** | **string** | | [default to undefined]
|
|
11
|
-
**updatedAtMillis** | **number** | The timestamp of the price update. | [default to undefined]
|
|
12
|
-
|
|
13
|
-
## Example
|
|
14
|
-
|
|
15
|
-
```typescript
|
|
16
|
-
import { MarketPriceUpdate } from '@bluefin/api-client';
|
|
17
|
-
|
|
18
|
-
const instance: MarketPriceUpdate = {
|
|
19
|
-
symbol,
|
|
20
|
-
priceE9,
|
|
21
|
-
source,
|
|
22
|
-
updatedAtMillis,
|
|
23
|
-
};
|
|
24
|
-
```
|
|
25
|
-
|
|
26
|
-
[[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/MarketStatus.md
DELETED
|
@@ -1,16 +0,0 @@
|
|
|
1
|
-
# MarketStatus
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
## Enum
|
|
5
|
-
|
|
6
|
-
* `Active` (value: `'ACTIVE'`)
|
|
7
|
-
|
|
8
|
-
* `Beta` (value: `'BETA'`)
|
|
9
|
-
|
|
10
|
-
* `Maintenance` (value: `'MAINTENANCE'`)
|
|
11
|
-
|
|
12
|
-
* `Delisted` (value: `'DELISTED'`)
|
|
13
|
-
|
|
14
|
-
* `Unspecified` (value: `'UNSPECIFIED'`)
|
|
15
|
-
|
|
16
|
-
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|