bluefin_api 1.8.0

Bluefin API
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235

# Rust API client for bluefin_api

Bluefin API


## Overview

This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project.  By using the [openapi-spec](https://openapis.org) from a remote server, you can easily generate an API client.

- API version: 1.0.0
- Package version: 1.8.0
- Generator version: 7.13.0
- Build package: `org.openapitools.codegen.languages.RustClientCodegen`

## Installation

Put the package under your project folder in a directory named `bluefin_api` and add the following to `Cargo.toml` under `[dependencies]`:

```
bluefin_api = { path = "./bluefin_api" }
```

## Documentation for API Endpoints

All URIs are relative to *https://api.sui-staging.bluefin.io*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*AccountDataApi* | [**get_account_details**](docs/AccountDataApi.md#get_account_details) | **GET** /api/v1/account | /account
*AccountDataApi* | [**get_account_funding_rate_history**](docs/AccountDataApi.md#get_account_funding_rate_history) | **GET** /api/v1/account/fundingRateHistory | /account/fundingRateHistory
*AccountDataApi* | [**get_account_preferences**](docs/AccountDataApi.md#get_account_preferences) | **GET** /api/v1/account/preferences | /account/preferences
*AccountDataApi* | [**get_account_trades**](docs/AccountDataApi.md#get_account_trades) | **GET** /api/v1/account/trades | /account/trades
*AccountDataApi* | [**get_account_transaction_history**](docs/AccountDataApi.md#get_account_transaction_history) | **GET** /api/v1/account/transactions | /account/transactions
*AccountDataApi* | [**get_account_value_history**](docs/AccountDataApi.md#get_account_value_history) | **GET** /api/v1/account/valueHistory | /account/valueHistory
*AccountDataApi* | [**patch_account_group_id**](docs/AccountDataApi.md#patch_account_group_id) | **PATCH** /api/v1/account/groupId | Set the group ID for an account.
*AccountDataApi* | [**put_account_preferences**](docs/AccountDataApi.md#put_account_preferences) | **PUT** /api/v1/account/preferences | /account/preferences
*AccountDataApi* | [**sponsor_tx**](docs/AccountDataApi.md#sponsor_tx) | **POST** /api/v1/account/sponsorTx | /account/sponsorTx
*AuthApi* | [**auth_jwks_get**](docs/AuthApi.md#auth_jwks_get) | **GET** /auth/jwks | 
*AuthApi* | [**auth_token_post**](docs/AuthApi.md#auth_token_post) | **POST** /auth/token | 
*AuthApi* | [**auth_token_refresh_put**](docs/AuthApi.md#auth_token_refresh_put) | **PUT** /auth/token/refresh | 
*AuthApi* | [**auth_v2_token_post**](docs/AuthApi.md#auth_v2_token_post) | **POST** /auth/v2/token | 
*AuthApi* | [**get_zk_login_user_details**](docs/AuthApi.md#get_zk_login_user_details) | **GET** /auth/zklogin | /auth/zklogin
*AuthApi* | [**post_zk_login_zkp**](docs/AuthApi.md#post_zk_login_zkp) | **POST** /auth/zklogin/zkp | /auth/zklogin/zkp
*ExchangeApi* | [**get_all_market_ticker**](docs/ExchangeApi.md#get_all_market_ticker) | **GET** /v1/exchange/tickers | /exchange/tickers
*ExchangeApi* | [**get_candlestick_data**](docs/ExchangeApi.md#get_candlestick_data) | **GET** /v1/exchange/candlesticks | /exchange/candlesticks
*ExchangeApi* | [**get_country**](docs/ExchangeApi.md#get_country) | **GET** /v1/exchange/country | /exchange/country
*ExchangeApi* | [**get_exchange_info**](docs/ExchangeApi.md#get_exchange_info) | **GET** /v1/exchange/info | /exchange/info
*ExchangeApi* | [**get_exchange_stats**](docs/ExchangeApi.md#get_exchange_stats) | **GET** /v1/exchange/stats | /exchange/stats
*ExchangeApi* | [**get_exchange_stats_all_time**](docs/ExchangeApi.md#get_exchange_stats_all_time) | **GET** /v1/exchange/stats/allTime | /v1/exchange/stats/allTime
*ExchangeApi* | [**get_funding_rate_history**](docs/ExchangeApi.md#get_funding_rate_history) | **GET** /v1/exchange/fundingRateHistory | /exchange/fundingRateHistory
*ExchangeApi* | [**get_market_ticker**](docs/ExchangeApi.md#get_market_ticker) | **GET** /v1/exchange/ticker | /exchange/ticker
*ExchangeApi* | [**get_orderbook_depth**](docs/ExchangeApi.md#get_orderbook_depth) | **GET** /v1/exchange/depth | /exchange/depth
*ExchangeApi* | [**get_recent_trades**](docs/ExchangeApi.md#get_recent_trades) | **GET** /v1/exchange/trades | /exchange/trades
*RewardsApi* | [**get_affiliate_interval_overview**](docs/RewardsApi.md#get_affiliate_interval_overview) | **GET** /v1/rewards/affiliate/intervalOverview | /rewards/affiliate/intervalOverview
*RewardsApi* | [**get_affiliate_leader_dashboard**](docs/RewardsApi.md#get_affiliate_leader_dashboard) | **GET** /v1/rewards/affiliate/leaderDashboard | /rewards/affiliate/leaderDashboard
*RewardsApi* | [**get_affiliate_metadata**](docs/RewardsApi.md#get_affiliate_metadata) | **GET** /v1/rewards/affiliate | /rewards/affiliate
*RewardsApi* | [**get_affiliate_overview**](docs/RewardsApi.md#get_affiliate_overview) | **GET** /v1/rewards/affiliate/overview | /rewards/affiliate/overview
*RewardsApi* | [**get_affiliate_summary**](docs/RewardsApi.md#get_affiliate_summary) | **GET** /v1/rewards/affiliate/summary | /rewards/affiliate/summary
*RewardsApi* | [**get_campaign_rewards**](docs/RewardsApi.md#get_campaign_rewards) | **GET** /v1/rewards/campaign | /rewards/campaign
*RewardsApi* | [**get_contract_config**](docs/RewardsApi.md#get_contract_config) | **GET** /v1/rewards/contract/config | Get contract configurations
*RewardsApi* | [**get_rewards**](docs/RewardsApi.md#get_rewards) | **GET** /v1/rewards | /rewards
*RewardsApi* | [**get_rewards_campaign_metadata**](docs/RewardsApi.md#get_rewards_campaign_metadata) | **GET** /v1/rewards/metadata/campaign | /rewards/metadata/campaign
*RewardsApi* | [**get_rewards_epoch_config_metadata**](docs/RewardsApi.md#get_rewards_epoch_config_metadata) | **GET** /v1/rewards/metadata/epoch/configs | /rewards/metadata/epoch/configs
*RewardsApi* | [**get_rewards_epoch_metadata**](docs/RewardsApi.md#get_rewards_epoch_metadata) | **GET** /v1/rewards/metadata/epoch | /rewards/metadata/epoch
*RewardsApi* | [**get_rewards_interval_metadata**](docs/RewardsApi.md#get_rewards_interval_metadata) | **GET** /v1/rewards/metadata/interval | /rewards/metadata/interval
*RewardsApi* | [**get_rewards_summary**](docs/RewardsApi.md#get_rewards_summary) | **GET** /v1/rewards/summary | /rewards/summary
*RewardsApi* | [**mark_as_claimed**](docs/RewardsApi.md#mark_as_claimed) | **POST** /v1/rewards/claims/mark-claimed | /v1/rewards/claims/mark-claimed
*RewardsApi* | [**onboard_affiliate**](docs/RewardsApi.md#onboard_affiliate) | **POST** /v1/rewards/affiliate/onboard | /rewards/affiliate/onboard
*RewardsApi* | [**onboard_referee**](docs/RewardsApi.md#onboard_referee) | **POST** /v1/rewards/affiliate/onboard/referee | /rewards/affiliate/onboard/referee
*RewardsApi* | [**update_affiliate_ember_refferal_share**](docs/RewardsApi.md#update_affiliate_ember_refferal_share) | **POST** /v1/rewards/affiliate/emberRefferalShare | /rewards/affiliate/emberRefferalShare
*RewardsApi* | [**update_affiliate_fee_config**](docs/RewardsApi.md#update_affiliate_fee_config) | **POST** /v1/rewards/affiliate/feeConfig | /rewards/affiliate/feeConfig
*StreamsApi* | [**web_socket_account_data**](docs/StreamsApi.md#web_socket_account_data) | **GET** /ws/account | 
*StreamsApi* | [**web_socket_market_data**](docs/StreamsApi.md#web_socket_market_data) | **GET** /ws/market | 
*TradeApi* | [**cancel_orders**](docs/TradeApi.md#cancel_orders) | **PUT** /api/v1/trade/orders/cancel | /trade/orders/cancel
*TradeApi* | [**cancel_standby_orders**](docs/TradeApi.md#cancel_standby_orders) | **PUT** /api/v1/trade/orders/cancel/standby | /trade/orders/cancel/standby
*TradeApi* | [**get_open_orders**](docs/TradeApi.md#get_open_orders) | **GET** /api/v1/trade/openOrders | /trade/openOrders
*TradeApi* | [**get_standby_orders**](docs/TradeApi.md#get_standby_orders) | **GET** /api/v1/trade/standbyOrders | /trade/standbyOrders
*TradeApi* | [**post_create_order**](docs/TradeApi.md#post_create_order) | **POST** /api/v1/trade/orders | /trade/orders
*TradeApi* | [**post_withdraw**](docs/TradeApi.md#post_withdraw) | **POST** /api/v1/trade/withdraw | /trade/withdraw
*TradeApi* | [**put_adjust_isolated_margin**](docs/TradeApi.md#put_adjust_isolated_margin) | **PUT** /api/v1/trade/adjustIsolatedMargin | /trade/adjustIsolatedMargin
*TradeApi* | [**put_authorize_account**](docs/TradeApi.md#put_authorize_account) | **PUT** /api/v1/trade/accounts/authorize | /trade/accounts/authorize
*TradeApi* | [**put_deauthorize_account**](docs/TradeApi.md#put_deauthorize_account) | **PUT** /api/v1/trade/accounts/deauthorize | /trade/accounts/deauthorize
*TradeApi* | [**put_leverage_update**](docs/TradeApi.md#put_leverage_update) | **PUT** /api/v1/trade/leverage | /trade/leverage


## Documentation For Models

 - [Account](docs/Account.md)
 - [AccountAggregatedTradeUpdate](docs/AccountAggregatedTradeUpdate.md)
 - [AccountAuthorizationRequest](docs/AccountAuthorizationRequest.md)
 - [AccountAuthorizationRequestSignedFields](docs/AccountAuthorizationRequestSignedFields.md)
 - [AccountCommandFailureUpdate](docs/AccountCommandFailureUpdate.md)
 - [AccountDataStream](docs/AccountDataStream.md)
 - [AccountEventReason](docs/AccountEventReason.md)
 - [AccountEventType](docs/AccountEventType.md)
 - [AccountFundingRateHistory](docs/AccountFundingRateHistory.md)
 - [AccountFundingRateHistoryData](docs/AccountFundingRateHistoryData.md)
 - [AccountGroupIdPatch](docs/AccountGroupIdPatch.md)
 - [AccountMarketPreference](docs/AccountMarketPreference.md)
 - [AccountOrderUpdate](docs/AccountOrderUpdate.md)
 - [AccountPositionLeverageUpdateRequest](docs/AccountPositionLeverageUpdateRequest.md)
 - [AccountPositionLeverageUpdateRequestSignedFields](docs/AccountPositionLeverageUpdateRequestSignedFields.md)
 - [AccountPositionUpdate](docs/AccountPositionUpdate.md)
 - [AccountPreference](docs/AccountPreference.md)
 - [AccountStreamMessage](docs/AccountStreamMessage.md)
 - [AccountStreamMessagePayload](docs/AccountStreamMessagePayload.md)
 - [AccountSubscriptionMessage](docs/AccountSubscriptionMessage.md)
 - [AccountTradeUpdate](docs/AccountTradeUpdate.md)
 - [AccountTransactionUpdate](docs/AccountTransactionUpdate.md)
 - [AccountUpdate](docs/AccountUpdate.md)
 - [AccountValueHistory](docs/AccountValueHistory.md)
 - [AccountValueHistoryData](docs/AccountValueHistoryData.md)
 - [ActiveOrderUpdate](docs/ActiveOrderUpdate.md)
 - [AdjustIsolatedMarginRequest](docs/AdjustIsolatedMarginRequest.md)
 - [AdjustIsolatedMarginRequestSignedFields](docs/AdjustIsolatedMarginRequestSignedFields.md)
 - [AdjustMarginOperation](docs/AdjustMarginOperation.md)
 - [AffiliateIntervalOverview](docs/AffiliateIntervalOverview.md)
 - [AffiliateLeaderDashboard](docs/AffiliateLeaderDashboard.md)
 - [AffiliateMetadata](docs/AffiliateMetadata.md)
 - [AffiliateOnboardResponse](docs/AffiliateOnboardResponse.md)
 - [AffiliateOverview](docs/AffiliateOverview.md)
 - [AffiliateSummary](docs/AffiliateSummary.md)
 - [Asset](docs/Asset.md)
 - [AssetConfig](docs/AssetConfig.md)
 - [AuthorizedWallet](docs/AuthorizedWallet.md)
 - [CampaignMetadata](docs/CampaignMetadata.md)
 - [CancelOrdersRequest](docs/CancelOrdersRequest.md)
 - [CancelOrdersResponse](docs/CancelOrdersResponse.md)
 - [CandlePriceType](docs/CandlePriceType.md)
 - [CandlestickUpdate](docs/CandlestickUpdate.md)
 - [ClaimSignatureItem](docs/ClaimSignatureItem.md)
 - [CommandFailureReasonCode](docs/CommandFailureReasonCode.md)
 - [ContractConfig](docs/ContractConfig.md)
 - [ContractsConfig](docs/ContractsConfig.md)
 - [CountryResponse](docs/CountryResponse.md)
 - [CreateOrderRequest](docs/CreateOrderRequest.md)
 - [CreateOrderRequestSignedFields](docs/CreateOrderRequestSignedFields.md)
 - [CreateOrderResponse](docs/CreateOrderResponse.md)
 - [EpochConfigs](docs/EpochConfigs.md)
 - [EpochConfigsResponse](docs/EpochConfigsResponse.md)
 - [EpochMetadata](docs/EpochMetadata.md)
 - [Error](docs/Error.md)
 - [ExchangeInfoResponse](docs/ExchangeInfoResponse.md)
 - [FailedCommandType](docs/FailedCommandType.md)
 - [FeeConfigs](docs/FeeConfigs.md)
 - [FundingRateEntry](docs/FundingRateEntry.md)
 - [GetAccountValueHistoryParamsInterval](docs/GetAccountValueHistoryParamsInterval.md)
 - [GetAffiliateIntervalOverview200Response](docs/GetAffiliateIntervalOverview200Response.md)
 - [GetAffiliateLeaderDashboard200Response](docs/GetAffiliateLeaderDashboard200Response.md)
 - [GetAffiliateOverview200Response](docs/GetAffiliateOverview200Response.md)
 - [IntervalMetadata](docs/IntervalMetadata.md)
 - [IntervalRewards](docs/IntervalRewards.md)
 - [IssBase64Details](docs/IssBase64Details.md)
 - [KlineInterval](docs/KlineInterval.md)
 - [LoginRequest](docs/LoginRequest.md)
 - [LoginResponse](docs/LoginResponse.md)
 - [MarginType](docs/MarginType.md)
 - [MarkAsClaimedRequest](docs/MarkAsClaimedRequest.md)
 - [MarkAsClaimedResponse](docs/MarkAsClaimedResponse.md)
 - [MarkPriceUpdate](docs/MarkPriceUpdate.md)
 - [Market](docs/Market.md)
 - [MarketDataStreamName](docs/MarketDataStreamName.md)
 - [MarketEventType](docs/MarketEventType.md)
 - [MarketPriceUpdate](docs/MarketPriceUpdate.md)
 - [MarketStatus](docs/MarketStatus.md)
 - [MarketStreamMessage](docs/MarketStreamMessage.md)
 - [MarketStreamMessagePayload](docs/MarketStreamMessagePayload.md)
 - [MarketSubscriptionMessage](docs/MarketSubscriptionMessage.md)
 - [MarketSubscriptionStreams](docs/MarketSubscriptionStreams.md)
 - [OnboardAffiliateRequest](docs/OnboardAffiliateRequest.md)
 - [OnboardAffiliateRequestSocialUserNames](docs/OnboardAffiliateRequestSocialUserNames.md)
 - [OnboardRefereeRequest](docs/OnboardRefereeRequest.md)
 - [OpenOrderResponse](docs/OpenOrderResponse.md)
 - [Operators](docs/Operators.md)
 - [OraclePriceUpdate](docs/OraclePriceUpdate.md)
 - [OrderCancelReason](docs/OrderCancelReason.md)
 - [OrderCancellationFailureReason](docs/OrderCancellationFailureReason.md)
 - [OrderCancellationUpdate](docs/OrderCancellationUpdate.md)
 - [OrderSide](docs/OrderSide.md)
 - [OrderStatus](docs/OrderStatus.md)
 - [OrderTimeInForce](docs/OrderTimeInForce.md)
 - [OrderTwapConfig](docs/OrderTwapConfig.md)
 - [OrderType](docs/OrderType.md)
 - [OrderbookDepthResponse](docs/OrderbookDepthResponse.md)
 - [OrderbookDiffDepthUpdate](docs/OrderbookDiffDepthUpdate.md)
 - [OrderbookPartialDepthUpdate](docs/OrderbookPartialDepthUpdate.md)
 - [Position](docs/Position.md)
 - [PositionSide](docs/PositionSide.md)
 - [ProofPoints](docs/ProofPoints.md)
 - [RecentTradesUpdates](docs/RecentTradesUpdates.md)
 - [RefereeOnboardResponse](docs/RefereeOnboardResponse.md)
 - [RefreshTokenRequest](docs/RefreshTokenRequest.md)
 - [RefreshTokenResponse](docs/RefreshTokenResponse.md)
 - [RewardsPoolEntry](docs/RewardsPoolEntry.md)
 - [RewardsSummary](docs/RewardsSummary.md)
 - [SelfTradePreventionType](docs/SelfTradePreventionType.md)
 - [SigPayload](docs/SigPayload.md)
 - [SponsorTxRequest](docs/SponsorTxRequest.md)
 - [SponsorTxResponse](docs/SponsorTxResponse.md)
 - [StatsAllTimeResponse](docs/StatsAllTimeResponse.md)
 - [StatsEntry](docs/StatsEntry.md)
 - [StatsInterval](docs/StatsInterval.md)
 - [StatsResponse](docs/StatsResponse.md)
 - [SubscriptionResponseMessage](docs/SubscriptionResponseMessage.md)
 - [SubscriptionType](docs/SubscriptionType.md)
 - [TickerAllUpdate](docs/TickerAllUpdate.md)
 - [TickerResponse](docs/TickerResponse.md)
 - [TickerUpdate](docs/TickerUpdate.md)
 - [Trade](docs/Trade.md)
 - [TradeSide](docs/TradeSide.md)
 - [TradeType](docs/TradeType.md)
 - [TradingFees](docs/TradingFees.md)
 - [Transaction](docs/Transaction.md)
 - [TransactionType](docs/TransactionType.md)
 - [UpdateAccountPreferenceRequest](docs/UpdateAccountPreferenceRequest.md)
 - [UpdateAffiliateEmberRefferalShareRequest](docs/UpdateAffiliateEmberRefferalShareRequest.md)
 - [UpdateAffiliateFeeConfigRequest](docs/UpdateAffiliateFeeConfigRequest.md)
 - [UserCampaignRewards](docs/UserCampaignRewards.md)
 - [WithdrawRequest](docs/WithdrawRequest.md)
 - [WithdrawRequestSignedFields](docs/WithdrawRequestSignedFields.md)
 - [ZkLoginUserDetailsResponse](docs/ZkLoginUserDetailsResponse.md)
 - [ZkLoginZkpRequest](docs/ZkLoginZkpRequest.md)
 - [ZkLoginZkpResponse](docs/ZkLoginZkpResponse.md)


To get access to the crate's generated documentation, use:

```
cargo doc --open
```

## Author