@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.
Files changed (210) hide show
  1. package/dist/{example.js → cjs/example.js} +3 -0
  2. package/dist/cjs/example.js.map +1 -0
  3. package/dist/{index.js → cjs/index.js} +1 -0
  4. package/dist/cjs/index.js.map +1 -0
  5. package/dist/{src → cjs/src}/api.js +75 -1
  6. package/dist/cjs/src/api.js.map +1 -0
  7. package/dist/{src → cjs/src}/base.js +5 -1
  8. package/dist/cjs/src/base.js.map +1 -0
  9. package/dist/{src → cjs/src}/common.js +1 -0
  10. package/dist/cjs/src/common.js.map +1 -0
  11. package/dist/{src → cjs/src}/configuration.js +1 -0
  12. package/dist/cjs/src/configuration.js.map +1 -0
  13. package/dist/{src → cjs/src}/index.js +1 -0
  14. package/dist/cjs/src/index.js.map +1 -0
  15. package/dist/{src → cjs/src}/request-signer.js +11 -0
  16. package/dist/cjs/src/request-signer.js.map +1 -0
  17. package/dist/{src → cjs/src}/sdk.js +47 -4
  18. package/dist/cjs/src/sdk.js.map +1 -0
  19. package/dist/{src → cjs/src}/utils.js +1 -0
  20. package/dist/cjs/src/utils.js.map +1 -0
  21. package/dist/{src → cjs/src}/websocket.js +1 -0
  22. package/dist/cjs/src/websocket.js.map +1 -0
  23. package/dist/esm/example.js +218 -0
  24. package/dist/esm/example.js.map +1 -0
  25. package/dist/esm/index.js +18 -0
  26. package/dist/esm/index.js.map +1 -0
  27. package/dist/esm/src/api.js +4318 -0
  28. package/dist/esm/src/api.js.map +1 -0
  29. package/dist/esm/src/base.js +69 -0
  30. package/dist/esm/src/base.js.map +1 -0
  31. package/dist/esm/src/common.js +162 -0
  32. package/dist/esm/src/common.js.map +1 -0
  33. package/dist/esm/src/configuration.js +45 -0
  34. package/dist/esm/src/configuration.js.map +1 -0
  35. package/dist/esm/src/index.js +23 -0
  36. package/dist/esm/src/index.js.map +1 -0
  37. package/dist/esm/src/request-signer.js +231 -0
  38. package/dist/esm/src/request-signer.js.map +1 -0
  39. package/dist/esm/src/sdk.js +786 -0
  40. package/dist/esm/src/sdk.js.map +1 -0
  41. package/dist/esm/src/utils.js +10 -0
  42. package/dist/esm/src/utils.js.map +1 -0
  43. package/dist/esm/src/websocket.js +159 -0
  44. package/dist/esm/src/websocket.js.map +1 -0
  45. package/dist/types/example.d.ts +2 -0
  46. package/dist/types/example.d.ts.map +1 -0
  47. package/dist/types/index.d.ts +2 -0
  48. package/dist/types/index.d.ts.map +1 -0
  49. package/dist/{src → types/src}/api.d.ts +126 -47
  50. package/dist/types/src/api.d.ts.map +1 -0
  51. package/dist/{src → types/src}/base.d.ts +1 -0
  52. package/dist/types/src/base.d.ts.map +1 -0
  53. package/dist/{src → types/src}/common.d.ts +1 -0
  54. package/dist/types/src/common.d.ts.map +1 -0
  55. package/dist/{src → types/src}/configuration.d.ts +1 -0
  56. package/dist/types/src/configuration.d.ts.map +1 -0
  57. package/dist/{src → types/src}/index.d.ts +1 -0
  58. package/dist/types/src/index.d.ts.map +1 -0
  59. package/dist/{src → types/src}/request-signer.d.ts +6 -1
  60. package/dist/types/src/request-signer.d.ts.map +1 -0
  61. package/dist/{src → types/src}/sdk.d.ts +12 -1
  62. package/dist/types/src/sdk.d.ts.map +1 -0
  63. package/dist/{src → types/src}/utils.d.ts +1 -0
  64. package/dist/types/src/utils.d.ts.map +1 -0
  65. package/dist/{src → types/src}/websocket.d.ts +1 -0
  66. package/dist/types/src/websocket.d.ts.map +1 -0
  67. package/package.json +21 -7
  68. package/dist/example.d.ts +0 -1
  69. package/dist/index.d.ts +0 -1
  70. package/example.ts +0 -323
  71. package/index.ts +0 -1
  72. package/openapitools.json +0 -24
  73. package/src/.openapi-generator/FILES +0 -128
  74. package/src/.openapi-generator/VERSION +0 -1
  75. package/src/.openapi-generator-ignore +0 -28
  76. package/src/README.md +0 -46
  77. package/src/api.ts +0 -8918
  78. package/src/base.ts +0 -86
  79. package/src/common.ts +0 -150
  80. package/src/configuration.ts +0 -115
  81. package/src/docs/Account.md +0 -64
  82. package/src/docs/AccountAggregatedTradeUpdate.md +0 -21
  83. package/src/docs/AccountAuthorizationRequest.md +0 -24
  84. package/src/docs/AccountAuthorizationRequestSignedFields.md +0 -28
  85. package/src/docs/AccountCommandFailureUpdate.md +0 -29
  86. package/src/docs/AccountDataApi.md +0 -374
  87. package/src/docs/AccountDataStream.md +0 -21
  88. package/src/docs/AccountEventReason.md +0 -25
  89. package/src/docs/AccountEventType.md +0 -21
  90. package/src/docs/AccountFundingRateHistory.md +0 -20
  91. package/src/docs/AccountFundingRateHistoryData.md +0 -30
  92. package/src/docs/AccountMarketPreference.md +0 -22
  93. package/src/docs/AccountOrderUpdate.md +0 -71
  94. package/src/docs/AccountPositionLeverageUpdateRequest.md +0 -22
  95. package/src/docs/AccountPositionLeverageUpdateRequestSignedFields.md +0 -30
  96. package/src/docs/AccountPositionUpdate.md +0 -47
  97. package/src/docs/AccountPreference.md +0 -24
  98. package/src/docs/AccountStreamMessage.md +0 -25
  99. package/src/docs/AccountStreamMessagePayload.md +0 -153
  100. package/src/docs/AccountSubscriptionMessage.md +0 -25
  101. package/src/docs/AccountTradeUpdate.md +0 -21
  102. package/src/docs/AccountTransactionUpdate.md +0 -31
  103. package/src/docs/AccountUpdate.md +0 -61
  104. package/src/docs/ActiveOrderUpdate.md +0 -65
  105. package/src/docs/AdjustIsolatedMarginRequest.md +0 -22
  106. package/src/docs/AdjustIsolatedMarginRequestSignedFields.md +0 -32
  107. package/src/docs/AdjustMarginOperation.md +0 -11
  108. package/src/docs/AffiliateIntervalOverview.md +0 -56
  109. package/src/docs/AffiliateLeaderDashboard.md +0 -38
  110. package/src/docs/AffiliateMetadata.md +0 -36
  111. package/src/docs/AffiliateMetadataFees.md +0 -31
  112. package/src/docs/AffiliateOnboardResponse.md +0 -22
  113. package/src/docs/AffiliateOverview.md +0 -46
  114. package/src/docs/AffiliateSummary.md +0 -30
  115. package/src/docs/Asset.md +0 -29
  116. package/src/docs/AssetConfig.md +0 -28
  117. package/src/docs/AuthApi.md +0 -243
  118. package/src/docs/AuthorizedWallet.md +0 -24
  119. package/src/docs/CampaignMetadata.md +0 -28
  120. package/src/docs/CampaignRewards.md +0 -18
  121. package/src/docs/CancelOrdersRequest.md +0 -23
  122. package/src/docs/CancelOrdersResponse.md +0 -21
  123. package/src/docs/CandlePriceType.md +0 -14
  124. package/src/docs/CandlestickUpdate.md +0 -41
  125. package/src/docs/CommandFailureReasonCode.md +0 -24
  126. package/src/docs/ContractsConfig.md +0 -31
  127. package/src/docs/CreateOrderRequest.md +0 -36
  128. package/src/docs/CreateOrderRequestSignedFields.md +0 -40
  129. package/src/docs/CreateOrderResponse.md +0 -20
  130. package/src/docs/EpochConfigs.md +0 -34
  131. package/src/docs/EpochConfigsResponse.md +0 -24
  132. package/src/docs/EpochMetadata.md +0 -30
  133. package/src/docs/Error.md +0 -22
  134. package/src/docs/ExchangeApi.md +0 -473
  135. package/src/docs/ExchangeInfoResponse.md +0 -30
  136. package/src/docs/FailedCommandType.md +0 -12
  137. package/src/docs/FeeConfigs.md +0 -33
  138. package/src/docs/FundingRateEntry.md +0 -24
  139. package/src/docs/GetAffiliateIntervalOverview200Response.md +0 -26
  140. package/src/docs/GetAffiliateLeaderDashboard200Response.md +0 -26
  141. package/src/docs/GetAffiliateOverview200Response.md +0 -26
  142. package/src/docs/IntervalMetadata.md +0 -28
  143. package/src/docs/IntervalRewards.md +0 -30
  144. package/src/docs/KlineInterval.md +0 -36
  145. package/src/docs/LoginRequest.md +0 -25
  146. package/src/docs/LoginResponse.md +0 -26
  147. package/src/docs/MarginType.md +0 -13
  148. package/src/docs/MarkPriceUpdate.md +0 -26
  149. package/src/docs/Market.md +0 -82
  150. package/src/docs/MarketDataStreamName.md +0 -142
  151. package/src/docs/MarketEventType.md +0 -25
  152. package/src/docs/MarketPriceUpdate.md +0 -26
  153. package/src/docs/MarketStatus.md +0 -16
  154. package/src/docs/MarketStreamMessage.md +0 -23
  155. package/src/docs/MarketStreamMessagePayload.md +0 -123
  156. package/src/docs/MarketSubscriptionMessage.md +0 -23
  157. package/src/docs/MarketSubscriptionStreams.md +0 -23
  158. package/src/docs/OnboardAffiliateRequest.md +0 -26
  159. package/src/docs/OnboardAffiliateRequestSocialUserNames.md +0 -27
  160. package/src/docs/OnboardRefereeRequest.md +0 -20
  161. package/src/docs/OpenOrderResponse.md +0 -64
  162. package/src/docs/Operators.md +0 -28
  163. package/src/docs/OraclePriceUpdate.md +0 -26
  164. package/src/docs/OrderCancelReason.md +0 -65
  165. package/src/docs/OrderCancellationFailureReason.md +0 -19
  166. package/src/docs/OrderCancellationUpdate.md +0 -35
  167. package/src/docs/OrderSide.md +0 -13
  168. package/src/docs/OrderStatus.md +0 -25
  169. package/src/docs/OrderTimeInForce.md +0 -15
  170. package/src/docs/OrderType.md +0 -29
  171. package/src/docs/OrderbookDepthResponse.md +0 -38
  172. package/src/docs/OrderbookDiffDepthUpdate.md +0 -30
  173. package/src/docs/OrderbookPartialDepthUpdate.md +0 -30
  174. package/src/docs/Position.md +0 -52
  175. package/src/docs/PositionSide.md +0 -13
  176. package/src/docs/RecentTradesUpdates.md +0 -20
  177. package/src/docs/RefereeOnboardResponse.md +0 -20
  178. package/src/docs/RefreshTokenRequest.md +0 -20
  179. package/src/docs/RefreshTokenResponse.md +0 -26
  180. package/src/docs/RewardsApi.md +0 -859
  181. package/src/docs/RewardsSummary.md +0 -26
  182. package/src/docs/SelfTradePreventionType.md +0 -15
  183. package/src/docs/StatsEntry.md +0 -26
  184. package/src/docs/StatsInterval.md +0 -14
  185. package/src/docs/StatsResponse.md +0 -20
  186. package/src/docs/StreamsApi.md +0 -126
  187. package/src/docs/SubscriptionResponseMessage.md +0 -23
  188. package/src/docs/SubscriptionType.md +0 -11
  189. package/src/docs/TickerAllUpdate.md +0 -20
  190. package/src/docs/TickerResponse.md +0 -82
  191. package/src/docs/TickerUpdate.md +0 -83
  192. package/src/docs/Trade.md +0 -54
  193. package/src/docs/TradeApi.md +0 -589
  194. package/src/docs/TradeSide.md +0 -13
  195. package/src/docs/TradeType.md +0 -15
  196. package/src/docs/TradingFees.md +0 -24
  197. package/src/docs/Transaction.md +0 -34
  198. package/src/docs/TransactionType.md +0 -25
  199. package/src/docs/UpdateAccountPreferenceRequest.md +0 -24
  200. package/src/docs/UpdateAffiliateFeeConfigRequest.md +0 -20
  201. package/src/docs/UserCampaignRewards.md +0 -48
  202. package/src/docs/WithdrawRequest.md +0 -22
  203. package/src/docs/WithdrawRequestSignedFields.md +0 -30
  204. package/src/git_push.sh +0 -57
  205. package/src/index.ts +0 -6
  206. package/src/request-signer.ts +0 -405
  207. package/src/sdk.ts +0 -982
  208. package/src/utils.ts +0 -6
  209. package/src/websocket.ts +0 -165
  210. package/tsconfig.json +0 -23
@@ -1,23 +0,0 @@
1
- # MarketStreamMessage
2
-
3
- A market stream message containing an event type and a payload. The payload structure depends on the event type.
4
-
5
- ## Properties
6
-
7
- Name | Type | Description | Notes
8
- ------------ | ------------- | ------------- | -------------
9
- **event** | [**MarketEventType**](MarketEventType.md) | | [default to undefined]
10
- **payload** | [**MarketStreamMessagePayload**](MarketStreamMessagePayload.md) | | [default to undefined]
11
-
12
- ## Example
13
-
14
- ```typescript
15
- import { MarketStreamMessage } from '@bluefin/api-client';
16
-
17
- const instance: MarketStreamMessage = {
18
- event,
19
- payload,
20
- };
21
- ```
22
-
23
- [[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,123 +0,0 @@
1
- # MarketStreamMessagePayload
2
-
3
- The payload of the message, which varies based on the event type.
4
-
5
- ## Properties
6
-
7
- Name | Type | Description | Notes
8
- ------------ | ------------- | ------------- | -------------
9
- **trades** | [**Array<Trade>**](Trade.md) | | [default to undefined]
10
- **symbol** | **string** | The symbol of the market for the partial depth update. | [default to undefined]
11
- **lastQuantityE9** | **string** | Last trade quantity (e9 format). | [default to undefined]
12
- **lastTimeAtMillis** | **number** | Last trade time in milliseconds. | [default to undefined]
13
- **lastPriceE9** | **string** | Last trade price (e9 format). | [default to undefined]
14
- **lastFundingRateE9** | **string** | Funding rate value (e9 format). | [default to undefined]
15
- **nextFundingTimeAtMillis** | **number** | Time in milliseconds of next funding rate update. | [default to undefined]
16
- **avgFundingRate8hrE9** | **string** | 8 hr average funding rate (e9 format). | [default to undefined]
17
- **oraclePriceE9** | **string** | Oracle price of the asset (e9 format). | [default to undefined]
18
- **oraclePriceDirection** | **number** | Direction of oracle price computed by comparing current oracle price to last oracle price. 0 = no change, -1 = negative trend (current < last), 1 = positive trend (current > last). | [default to undefined]
19
- **markPriceE9** | **string** | Mark price on the exchange (e9 format). | [default to undefined]
20
- **markPriceDirection** | **number** | Direction of mark price computed by comparing current mark price to last mark price. 0 = no change, -1 = negative trend (current < last), 1 = positive trend (current > last). | [default to undefined]
21
- **marketPriceE9** | **string** | Simple average of bestBid and bestAsk, or lastPrice if either is not present (e9 format). | [default to undefined]
22
- **marketPriceDirection** | **number** | Direction of market price computed by comparing current market price to last market price. 0 = no change, -1 = negative trend (current < last), 1 = positive trend (current > last). | [default to undefined]
23
- **bestBidPriceE9** | **string** | Best bid price (e9 format). | [default to undefined]
24
- **bestBidQuantityE9** | **string** | Best bid quantity (e9 format). | [default to undefined]
25
- **bestAskPriceE9** | **string** | Best ask price (e9 format). | [default to undefined]
26
- **bestAskQuantityE9** | **string** | Best ask quantity (e9 format). | [default to undefined]
27
- **openInterestE9** | **string** | Open interest value (e9 format). | [default to undefined]
28
- **highPrice24hrE9** | **string** | Highest Price in the last 24 hours (e9 format). | [default to undefined]
29
- **lowPrice24hrE9** | **string** | Lowest Price in the last 24 hours (e9 format). | [default to undefined]
30
- **volume24hrE9** | **string** | Total market volume in last 24 hours of asset (e9 format). | [default to undefined]
31
- **quoteVolume24hrE9** | **string** | Total market volume in last 24 hours in USDC (e9 format). | [default to undefined]
32
- **closePrice24hrE9** | **string** | Close price 24 hours ago (e9 format). | [default to undefined]
33
- **openPrice24hrE9** | **string** | Open price in the last 24 hours (e9 format). | [default to undefined]
34
- **closeTime24hrAtMillis** | **number** | 24 hour close timestamp in milliseconds. | [default to undefined]
35
- **openTime24hrAtMillis** | **number** | 24 hour open timetamp in milliseconds. | [default to undefined]
36
- **firstId24hr** | **number** | First trade ID in the last 24 hours. | [default to undefined]
37
- **lastId24hr** | **number** | Last trade ID in the last 24 hours. | [default to undefined]
38
- **count24hr** | **string** | Total number of trades in the last 24 hours. | [default to undefined]
39
- **priceChange24hrE9** | **string** | 24 hour Market price change (e9 format). | [default to undefined]
40
- **priceChangePercent24hrE9** | **string** | 24 hour Market price change as a percentage (e9 format). | [default to undefined]
41
- **updatedAtMillis** | **number** | The timestamp of the partial depth update. | [default to undefined]
42
- **tickerAll** | [**Array<TickerUpdate>**](TickerUpdate.md) | Array of detailed market ticker information for all markets. | [default to undefined]
43
- **priceE9** | **string** | The price in scientific notation with 9 decimal places of precision. | [default to undefined]
44
- **source** | **string** | | [default to undefined]
45
- **startTime** | **number** | The start time of the candlestick in milliseconds since epoch. | [default to undefined]
46
- **endTime** | **number** | The end time of the candlestick in milliseconds since epoch. | [default to undefined]
47
- **interval** | **string** | The interval of the candlestick (e.g., 1m, 5m, 1h). | [default to undefined]
48
- **openPriceE9** | **string** | The opening price of the candlestick. | [default to undefined]
49
- **closePriceE9** | **string** | The closing price of the candlestick. | [default to undefined]
50
- **highPriceE9** | **string** | The highest price during the candlestick interval. | [default to undefined]
51
- **lowPriceE9** | **string** | The lowest price during the candlestick interval. | [default to undefined]
52
- **volumeE9** | **string** | The total trading volume during the candlestick interval. | [default to undefined]
53
- **quoteVolumeE9** | **string** | The total quote volume traded during the candlestick interval. | [default to undefined]
54
- **numTrades** | **number** | The number of trades that occurred during the candlestick interval. | [default to undefined]
55
- **bidsE9** | **Array<Array<string>>** | | [default to undefined]
56
- **asksE9** | **Array<Array<string>>** | | [default to undefined]
57
- **firstUpdateId** | **number** | The ID of the first update in this batch. | [default to undefined]
58
- **lastUpdateId** | **number** | The ID of the last update in this batch. | [default to undefined]
59
- **orderbookUpdateId** | **number** | The unique identifier for the orderbook update. | [default to undefined]
60
- **depthLevel** | **string** | The depth level of the orderbook snapshot. | [default to undefined]
61
-
62
- ## Example
63
-
64
- ```typescript
65
- import { MarketStreamMessagePayload } from '@bluefin/api-client';
66
-
67
- const instance: MarketStreamMessagePayload = {
68
- trades,
69
- symbol,
70
- lastQuantityE9,
71
- lastTimeAtMillis,
72
- lastPriceE9,
73
- lastFundingRateE9,
74
- nextFundingTimeAtMillis,
75
- avgFundingRate8hrE9,
76
- oraclePriceE9,
77
- oraclePriceDirection,
78
- markPriceE9,
79
- markPriceDirection,
80
- marketPriceE9,
81
- marketPriceDirection,
82
- bestBidPriceE9,
83
- bestBidQuantityE9,
84
- bestAskPriceE9,
85
- bestAskQuantityE9,
86
- openInterestE9,
87
- highPrice24hrE9,
88
- lowPrice24hrE9,
89
- volume24hrE9,
90
- quoteVolume24hrE9,
91
- closePrice24hrE9,
92
- openPrice24hrE9,
93
- closeTime24hrAtMillis,
94
- openTime24hrAtMillis,
95
- firstId24hr,
96
- lastId24hr,
97
- count24hr,
98
- priceChange24hrE9,
99
- priceChangePercent24hrE9,
100
- updatedAtMillis,
101
- tickerAll,
102
- priceE9,
103
- source,
104
- startTime,
105
- endTime,
106
- interval,
107
- openPriceE9,
108
- closePriceE9,
109
- highPriceE9,
110
- lowPriceE9,
111
- volumeE9,
112
- quoteVolumeE9,
113
- numTrades,
114
- bidsE9,
115
- asksE9,
116
- firstUpdateId,
117
- lastUpdateId,
118
- orderbookUpdateId,
119
- depthLevel,
120
- };
121
- ```
122
-
123
- [[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,23 +0,0 @@
1
- # MarketSubscriptionMessage
2
-
3
- Subscription message for market data streams.
4
-
5
- ## Properties
6
-
7
- Name | Type | Description | Notes
8
- ------------ | ------------- | ------------- | -------------
9
- **method** | [**SubscriptionType**](SubscriptionType.md) | | [default to undefined]
10
- **dataStreams** | [**Array<MarketSubscriptionStreams>**](MarketSubscriptionStreams.md) | List of market data streams to subscribe or unsubscribe from. | [default to undefined]
11
-
12
- ## Example
13
-
14
- ```typescript
15
- import { MarketSubscriptionMessage } from '@bluefin/api-client';
16
-
17
- const instance: MarketSubscriptionMessage = {
18
- method,
19
- dataStreams,
20
- };
21
- ```
22
-
23
- [[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,23 +0,0 @@
1
- # MarketSubscriptionStreams
2
-
3
- Represents the type of market data stream and its parameters.
4
-
5
- ## Properties
6
-
7
- Name | Type | Description | Notes
8
- ------------ | ------------- | ------------- | -------------
9
- **symbol** | **string** | The symbol of the market stream to subscribe to (Leave empty for TickerAll stream) | [default to undefined]
10
- **streams** | [**Array<MarketDataStreamName>**](MarketDataStreamName.md) | | [default to undefined]
11
-
12
- ## Example
13
-
14
- ```typescript
15
- import { MarketSubscriptionStreams } from '@bluefin/api-client';
16
-
17
- const instance: MarketSubscriptionStreams = {
18
- symbol,
19
- streams,
20
- };
21
- ```
22
-
23
- [[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
- # OnboardAffiliateRequest
2
-
3
-
4
- ## Properties
5
-
6
- Name | Type | Description | Notes
7
- ------------ | ------------- | ------------- | -------------
8
- **parentReferralCode** | **string** | Referral code of the parent affiliate | [optional] [default to undefined]
9
- **name** | **string** | Name of the applicant | [default to undefined]
10
- **email** | **string** | Email address of the applicant | [default to undefined]
11
- **socialUserNames** | [**OnboardAffiliateRequestSocialUserNames**](OnboardAffiliateRequestSocialUserNames.md) | | [optional] [default to undefined]
12
-
13
- ## Example
14
-
15
- ```typescript
16
- import { OnboardAffiliateRequest } from '@bluefin/api-client';
17
-
18
- const instance: OnboardAffiliateRequest = {
19
- parentReferralCode,
20
- name,
21
- email,
22
- socialUserNames,
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,27 +0,0 @@
1
- # OnboardAffiliateRequestSocialUserNames
2
-
3
- Map of social media usernames
4
-
5
- ## Properties
6
-
7
- Name | Type | Description | Notes
8
- ------------ | ------------- | ------------- | -------------
9
- **twitter** | **string** | Twitter username | [optional] [default to undefined]
10
- **instagram** | **string** | Instagram username | [optional] [default to undefined]
11
- **youtube** | **string** | YouTube channel name | [optional] [default to undefined]
12
- **tiktok** | **string** | TikTok username | [optional] [default to undefined]
13
-
14
- ## Example
15
-
16
- ```typescript
17
- import { OnboardAffiliateRequestSocialUserNames } from '@bluefin/api-client';
18
-
19
- const instance: OnboardAffiliateRequestSocialUserNames = {
20
- twitter,
21
- instagram,
22
- youtube,
23
- tiktok,
24
- };
25
- ```
26
-
27
- [[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,20 +0,0 @@
1
- # OnboardRefereeRequest
2
-
3
-
4
- ## Properties
5
-
6
- Name | Type | Description | Notes
7
- ------------ | ------------- | ------------- | -------------
8
- **code** | **string** | Referral code of the parent affiliate | [default to undefined]
9
-
10
- ## Example
11
-
12
- ```typescript
13
- import { OnboardRefereeRequest } from '@bluefin/api-client';
14
-
15
- const instance: OnboardRefereeRequest = {
16
- code,
17
- };
18
- ```
19
-
20
- [[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,64 +0,0 @@
1
- # OpenOrderResponse
2
-
3
-
4
- ## Properties
5
-
6
- Name | Type | Description | Notes
7
- ------------ | ------------- | ------------- | -------------
8
- **orderHash** | **string** | The Order Hash, which is the default way to uniquely identify an order in the system | [default to undefined]
9
- **clientOrderId** | **string** | The Client Order ID, which is used a unique identifier for an order, provided by the client, in case of proprietary order management systems | [optional] [default to undefined]
10
- **symbol** | **string** | The market symbol | [default to undefined]
11
- **accountAddress** | **string** | The account address of the order. May be an account user is authorized for. | [default to undefined]
12
- **signerAddress** | **string** | The signer address of the order. May be an account user is authorized for. | [default to undefined]
13
- **priceE9** | **string** | The price in base e9 of the asset to be traded. Should always be a number | [default to undefined]
14
- **quantityE9** | **string** | The quantity in base e9 of the asset to be traded. Should always be a number | [default to undefined]
15
- **side** | [**OrderSide**](OrderSide.md) | | [default to undefined]
16
- **leverageE9** | **string** | The leverage in base e9 of the order to be traded. Should always be a number | [default to undefined]
17
- **isIsolated** | **boolean** | Is this order isolated or cross margin. Note market must be set to the same mode. | [default to false]
18
- **salt** | **string** | The random generated SALT. Should always be a number | [default to undefined]
19
- **expiresAtMillis** | **number** | Unix timestamp in millis at which order will expire. Defaults to 1 month for LIMIT orders if not provided | [default to undefined]
20
- **signedAtMillis** | **number** | The timestamp in millis at which the request was signed | [default to undefined]
21
- **type** | [**OrderType**](OrderType.md) | | [default to undefined]
22
- **reduceOnly** | **boolean** | Is this order to only reduce a position? Default false | [default to false]
23
- **postOnly** | **boolean** | If set to TRUE, the order can only be a maker order | [default to false]
24
- **timeInForce** | [**OrderTimeInForce**](OrderTimeInForce.md) | | [default to undefined]
25
- **triggerPriceE9** | **string** | Trigger price in base e9 for stop orders. This should always be a number | [optional] [default to undefined]
26
- **filledQuantityE9** | **string** | The quantity in base e9 of the asset currently filled. This should always be a number | [default to undefined]
27
- **status** | [**OrderStatus**](OrderStatus.md) | | [default to undefined]
28
- **selfTradePreventionType** | [**SelfTradePreventionType**](SelfTradePreventionType.md) | | [default to undefined]
29
- **orderTimeAtMillis** | **number** | The timestamp in millis when the order was opened | [default to undefined]
30
- **updatedAtMillis** | **number** | The timestamp in millis that this order was last updated (including status updates) | [default to undefined]
31
-
32
- ## Example
33
-
34
- ```typescript
35
- import { OpenOrderResponse } from '@bluefin/api-client';
36
-
37
- const instance: OpenOrderResponse = {
38
- orderHash,
39
- clientOrderId,
40
- symbol,
41
- accountAddress,
42
- signerAddress,
43
- priceE9,
44
- quantityE9,
45
- side,
46
- leverageE9,
47
- isIsolated,
48
- salt,
49
- expiresAtMillis,
50
- signedAtMillis,
51
- type,
52
- reduceOnly,
53
- postOnly,
54
- timeInForce,
55
- triggerPriceE9,
56
- filledQuantityE9,
57
- status,
58
- selfTradePreventionType,
59
- orderTimeAtMillis,
60
- updatedAtMillis,
61
- };
62
- ```
63
-
64
- [[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
- # Operators
2
-
3
-
4
- ## Properties
5
-
6
- Name | Type | Description | Notes
7
- ------------ | ------------- | ------------- | -------------
8
- **admin** | **string** | Admin operator address | [default to undefined]
9
- **operator** | **string** | General operator address; AKA Guardian | [default to undefined]
10
- **sequencer** | **string** | Sequencer operator address | [default to undefined]
11
- **funding** | **string** | Funding operator address | [default to undefined]
12
- **fee** | **string** | Fee operator address | [default to undefined]
13
-
14
- ## Example
15
-
16
- ```typescript
17
- import { Operators } from '@bluefin/api-client';
18
-
19
- const instance: Operators = {
20
- admin,
21
- operator,
22
- sequencer,
23
- funding,
24
- fee,
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,26 +0,0 @@
1
- # OraclePriceUpdate
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 { OraclePriceUpdate } from '@bluefin/api-client';
17
-
18
- const instance: OraclePriceUpdate = {
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)
@@ -1,65 +0,0 @@
1
- # OrderCancelReason
2
-
3
- The reason for an order cancellation.
4
-
5
- ## Enum
6
-
7
- * `Unspecified` (value: `'UNSPECIFIED'`)
8
-
9
- * `InsufficientMargin` (value: `'INSUFFICIENT_MARGIN'`)
10
-
11
- * `DuplicateOrder` (value: `'DUPLICATE_ORDER'`)
12
-
13
- * `PostOnlyWouldTrade` (value: `'POST_ONLY_WOULD_TRADE'`)
14
-
15
- * `InvalidSymbol` (value: `'INVALID_SYMBOL'`)
16
-
17
- * `SignedAtTooOld` (value: `'SIGNED_AT_TOO_OLD'`)
18
-
19
- * `OrderExpired` (value: `'ORDER_EXPIRED'`)
20
-
21
- * `InvalidLeverage` (value: `'INVALID_LEVERAGE'`)
22
-
23
- * `InvalidInput` (value: `'INVALID_INPUT'`)
24
-
25
- * `PriceOutOfBound` (value: `'PRICE_OUT_OF_BOUND'`)
26
-
27
- * `QuantityOutOfBound` (value: `'QUANTITY_OUT_OF_BOUND'`)
28
-
29
- * `PriceOutOfTickSize` (value: `'PRICE_OUT_OF_TICK_SIZE'`)
30
-
31
- * `QuantityOutOfStepSize` (value: `'QUANTITY_OUT_OF_STEP_SIZE'`)
32
-
33
- * `ReduceOnlyWouldOpen` (value: `'REDUCE_ONLY_WOULD_OPEN'`)
34
-
35
- * `TooManyOpenOrdersOnMarket` (value: `'TOO_MANY_OPEN_ORDERS_ON_MARKET'`)
36
-
37
- * `UserCancelled` (value: `'USER_CANCELLED'`)
38
-
39
- * `UserCancelledAllOnMarket` (value: `'USER_CANCELLED_ALL_ON_MARKET'`)
40
-
41
- * `SelfTradePrevention` (value: `'SELF_TRADE_PREVENTION'`)
42
-
43
- * `LeverageUpdate` (value: `'LEVERAGE_UPDATE'`)
44
-
45
- * `AccountNotFound` (value: `'ACCOUNT_NOT_FOUND'`)
46
-
47
- * `MarketNotTrading` (value: `'MARKET_NOT_TRADING'`)
48
-
49
- * `InsufficientLiquidity` (value: `'INSUFFICIENT_LIQUIDITY'`)
50
-
51
- * `PositionNotFound` (value: `'POSITION_NOT_FOUND'`)
52
-
53
- * `LiquidationOutOfOrder` (value: `'LIQUIDATION_OUT_OF_ORDER'`)
54
-
55
- * `AccountNotLiquidatable` (value: `'ACCOUNT_NOT_LIQUIDATABLE'`)
56
-
57
- * `OrderNotReducingPosition` (value: `'ORDER_NOT_REDUCING_POSITION'`)
58
-
59
- * `UserCancelledAllStandbyOnMarket` (value: `'USER_CANCELLED_ALL_STANDBY_ON_MARKET'`)
60
-
61
- * `PositionExceedsMaxOpenInterest` (value: `'POSITION_EXCEEDS_MAX_OPEN_INTEREST'`)
62
-
63
- * `AccountDeauthorized` (value: `'ACCOUNT_DEAUTHORIZED'`)
64
-
65
- [[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,19 +0,0 @@
1
- # OrderCancellationFailureReason
2
-
3
- The reason for failure to cancel an order.
4
-
5
- ## Enum
6
-
7
- * `OrderNotFound` (value: `'ORDER_NOT_FOUND'`)
8
-
9
- * `MarketNotFound` (value: `'MARKET_NOT_FOUND'`)
10
-
11
- * `AccountNotFound` (value: `'ACCOUNT_NOT_FOUND'`)
12
-
13
- * `NoOpenOrdersOnMarket` (value: `'NO_OPEN_ORDERS_ON_MARKET'`)
14
-
15
- * `NoFailure` (value: `'NO_FAILURE'`)
16
-
17
- * `Unspecified` (value: `'UNSPECIFIED'`)
18
-
19
- [[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,35 +0,0 @@
1
- # OrderCancellationUpdate
2
-
3
- Details of an order cancellation.
4
-
5
- ## Properties
6
-
7
- Name | Type | Description | Notes
8
- ------------ | ------------- | ------------- | -------------
9
- **orderHash** | **string** | The unique hash of the order. | [default to undefined]
10
- **clientOrderId** | **string** | The client-provided order ID. | [optional] [default to undefined]
11
- **symbol** | **string** | The symbol of the market. | [default to undefined]
12
- **accountAddress** | **string** | The address of the account. | [default to undefined]
13
- **createdAtMillis** | **number** | The timestamp of the order creation in milliseconds. | [default to undefined]
14
- **cancellationReason** | [**OrderCancelReason**](OrderCancelReason.md) | | [default to undefined]
15
- **failureToCancelReason** | [**OrderCancellationFailureReason**](OrderCancellationFailureReason.md) | | [optional] [default to undefined]
16
- **remainingQuantityE9** | **string** | The remaining quantity of the order. | [default to undefined]
17
-
18
- ## Example
19
-
20
- ```typescript
21
- import { OrderCancellationUpdate } from '@bluefin/api-client';
22
-
23
- const instance: OrderCancellationUpdate = {
24
- orderHash,
25
- clientOrderId,
26
- symbol,
27
- accountAddress,
28
- createdAtMillis,
29
- cancellationReason,
30
- failureToCancelReason,
31
- remainingQuantityE9,
32
- };
33
- ```
34
-
35
- [[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,13 +0,0 @@
1
- # OrderSide
2
-
3
- Side of the order
4
-
5
- ## Enum
6
-
7
- * `Long` (value: `'LONG'`)
8
-
9
- * `Short` (value: `'SHORT'`)
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,25 +0,0 @@
1
- # OrderStatus
2
-
3
- The current status of the order.
4
-
5
- ## Enum
6
-
7
- * `Standby` (value: `'STANDBY'`)
8
-
9
- * `Open` (value: `'OPEN'`)
10
-
11
- * `PartiallyFilledOpen` (value: `'PARTIALLY_FILLED_OPEN'`)
12
-
13
- * `PartiallyFilledCanceled` (value: `'PARTIALLY_FILLED_CANCELED'`)
14
-
15
- * `Filled` (value: `'FILLED'`)
16
-
17
- * `Cancelled` (value: `'CANCELLED'`)
18
-
19
- * `Expired` (value: `'EXPIRED'`)
20
-
21
- * `PartiallyFilledExpired` (value: `'PARTIALLY_FILLED_EXPIRED'`)
22
-
23
- * `Unspecified` (value: `'UNSPECIFIED'`)
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,15 +0,0 @@
1
- # OrderTimeInForce
2
-
3
- The time-in-force policy for the order. By default, all orders are GTT. UNSPECIFIED is set to default. GTT: Good Til Time IOC: Immediate Or Cancel FOK: Fill Or Kill
4
-
5
- ## Enum
6
-
7
- * `Gtt` (value: `'GTT'`)
8
-
9
- * `Ioc` (value: `'IOC'`)
10
-
11
- * `Fok` (value: `'FOK'`)
12
-
13
- * `Unspecified` (value: `'UNSPECIFIED'`)
14
-
15
- [[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,29 +0,0 @@
1
- # OrderType
2
-
3
- The type of order. (BANKRUPTCY_LIQUIDATION is deprecated)
4
-
5
- ## Enum
6
-
7
- * `Limit` (value: `'LIMIT'`)
8
-
9
- * `Market` (value: `'MARKET'`)
10
-
11
- * `StopLimit` (value: `'STOP_LIMIT'`)
12
-
13
- * `StopMarket` (value: `'STOP_MARKET'`)
14
-
15
- * `Liquidation` (value: `'LIQUIDATION'`)
16
-
17
- * `StopLossMarket` (value: `'STOP_LOSS_MARKET'`)
18
-
19
- * `TakeProfitMarket` (value: `'TAKE_PROFIT_MARKET'`)
20
-
21
- * `StopLossLimit` (value: `'STOP_LOSS_LIMIT'`)
22
-
23
- * `TakeProfitLimit` (value: `'TAKE_PROFIT_LIMIT'`)
24
-
25
- * `BankruptcyLiquidation` (value: `'BANKRUPTCY_LIQUIDATION'`)
26
-
27
- * `Unspecified` (value: `'UNSPECIFIED'`)
28
-
29
- [[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,38 +0,0 @@
1
- # OrderbookDepthResponse
2
-
3
-
4
- ## Properties
5
-
6
- Name | Type | Description | Notes
7
- ------------ | ------------- | ------------- | -------------
8
- **symbol** | **string** | Market symbol. | [default to undefined]
9
- **lastUpdateId** | **number** | Count indicating the number of changes in orderbook state. | [default to undefined]
10
- **updatedAtMillis** | **number** | Timestamp at which the last change in orderbook state took place, in milliseconds. | [default to undefined]
11
- **responseSentAtMillis** | **number** | The time at which the orderbook server sent the response, in milliseconds. | [default to undefined]
12
- **bestBidPriceE9** | **string** | The best bid price on orderbook at the moment (e9 format). | [default to undefined]
13
- **bestBidQuantityE9** | **string** | The best bid quantity on orderbook at the moment (e9 format). | [default to undefined]
14
- **bestAskPriceE9** | **string** | The best ask price on orderbook at the moment (e9 format). | [default to undefined]
15
- **bestAskQuantityE9** | **string** | The best ask quantity on orderbook at the moment (e9 format). | [default to undefined]
16
- **bidsE9** | **Array<Array<string>>** | Bids to be filled. Index 0 is price, index 1 is quantity at price bin. Prices are in e9 format. | [default to undefined]
17
- **asksE9** | **Array<Array<string>>** | Asks to be filled. Index 0 is price, index 1 is quantity at price bin. Prices are in e9 format. | [default to undefined]
18
-
19
- ## Example
20
-
21
- ```typescript
22
- import { OrderbookDepthResponse } from '@bluefin/api-client';
23
-
24
- const instance: OrderbookDepthResponse = {
25
- symbol,
26
- lastUpdateId,
27
- updatedAtMillis,
28
- responseSentAtMillis,
29
- bestBidPriceE9,
30
- bestBidQuantityE9,
31
- bestAskPriceE9,
32
- bestAskQuantityE9,
33
- bidsE9,
34
- asksE9,
35
- };
36
- ```
37
-
38
- [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)