bluefin_api 1.0.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

# 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.0.0
- Generator version: 7.11.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 | Get user's account details.
*AccountDataApi* | [**get_account_funding_rate_history**](docs/AccountDataApi.md#get_account_funding_rate_history) | **GET** /api/v1/account/fundingRateHistory | Get user's funding rate history
*AccountDataApi* | [**get_account_preferences**](docs/AccountDataApi.md#get_account_preferences) | **GET** /api/v1/account/preferences | Get user's account preferences.
*AccountDataApi* | [**get_account_trades**](docs/AccountDataApi.md#get_account_trades) | **GET** /api/v1/account/trades | Get user's trade history.
*AccountDataApi* | [**get_account_transaction_history**](docs/AccountDataApi.md#get_account_transaction_history) | **GET** /api/v1/account/transactions | Get user's transaction history (any change in balance).
*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 | 
*ExchangeApi* | [**get_all_market_ticker**](docs/ExchangeApi.md#get_all_market_ticker) | **GET** /v1/exchange/tickers | Get all market ticker information
*ExchangeApi* | [**get_candlestick_data**](docs/ExchangeApi.md#get_candlestick_data) | **GET** /v1/exchange/candlesticks | Kline/candlestick data.
*ExchangeApi* | [**get_exchange_info**](docs/ExchangeApi.md#get_exchange_info) | **GET** /v1/exchange/info | Get exchange information
*ExchangeApi* | [**get_funding_rate_history**](docs/ExchangeApi.md#get_funding_rate_history) | **GET** /v1/exchange/fundingRateHistory | Get funding rate history
*ExchangeApi* | [**get_market_ticker**](docs/ExchangeApi.md#get_market_ticker) | **GET** /v1/exchange/ticker | Aggregated market ticker information
*ExchangeApi* | [**get_orderbook_depth**](docs/ExchangeApi.md#get_orderbook_depth) | **GET** /v1/exchange/depth | Orderbook depth
*ExchangeApi* | [**get_recent_trades**](docs/ExchangeApi.md#get_recent_trades) | **GET** /v1/exchange/trades | Recent trades list
*StreamsApi* | [**web_socket_account_data**](docs/StreamsApi.md#web_socket_account_data) | **GET** /ws/account | WebSocket Account Streams
*StreamsApi* | [**web_socket_market_data**](docs/StreamsApi.md#web_socket_market_data) | **GET** /ws/market | WebSocket Market Streams
*TradeApi* | [**cancel_orders**](docs/TradeApi.md#cancel_orders) | **PUT** /api/v1/trade/orders/cancel | Cancel orders for a market using order hashes
*TradeApi* | [**get_open_orders**](docs/TradeApi.md#get_open_orders) | **GET** /api/v1/trade/openOrders | Get Open Orders
*TradeApi* | [**post_create_order**](docs/TradeApi.md#post_create_order) | **POST** /api/v1/trade/orders | Create a new order
*TradeApi* | [**post_withdraw**](docs/TradeApi.md#post_withdraw) | **POST** /api/v1/trade/withdraw | Initiate a withdraw
*TradeApi* | [**put_adjust_isolated_margin**](docs/TradeApi.md#put_adjust_isolated_margin) | **PUT** /api/v1/trade/adjustIsolatedMargin | Adjust margin for an isolated position for a symbol
*TradeApi* | [**put_authorize_account**](docs/TradeApi.md#put_authorize_account) | **PUT** /api/v1/trade/accounts/authorize | Authorizes an account
*TradeApi* | [**put_deauthorize_account**](docs/TradeApi.md#put_deauthorize_account) | **PUT** /api/v1/trade/accounts/deauthorize | Deauthorizes an account
*TradeApi* | [**put_leverage_update**](docs/TradeApi.md#put_leverage_update) | **PUT** /api/v1/trade/leverage | Updates leverage for positions


## 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)
 - [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)
 - [ActiveOrderUpdate](docs/ActiveOrderUpdate.md)
 - [AdjustIsolatedMarginRequest](docs/AdjustIsolatedMarginRequest.md)
 - [AdjustIsolatedMarginRequestSignedFields](docs/AdjustIsolatedMarginRequestSignedFields.md)
 - [AdjustMarginOperation](docs/AdjustMarginOperation.md)
 - [Asset](docs/Asset.md)
 - [AssetConfig](docs/AssetConfig.md)
 - [CancelOrdersRequest](docs/CancelOrdersRequest.md)
 - [CandlePriceType](docs/CandlePriceType.md)
 - [CandlestickUpdate](docs/CandlestickUpdate.md)
 - [ContractsConfig](docs/ContractsConfig.md)
 - [CreateOrderRequest](docs/CreateOrderRequest.md)
 - [CreateOrderRequestSignedFields](docs/CreateOrderRequestSignedFields.md)
 - [Error](docs/Error.md)
 - [ExchangeInfoResponse](docs/ExchangeInfoResponse.md)
 - [FundingRateEntry](docs/FundingRateEntry.md)
 - [KlineInterval](docs/KlineInterval.md)
 - [LoginRequest](docs/LoginRequest.md)
 - [LoginResponse](docs/LoginResponse.md)
 - [MarginType](docs/MarginType.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)
 - [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)
 - [OrderType](docs/OrderType.md)
 - [OrderbookDepthResponse](docs/OrderbookDepthResponse.md)
 - [OrderbookDiffDepthUpdate](docs/OrderbookDiffDepthUpdate.md)
 - [OrderbookPartialDepthUpdate](docs/OrderbookPartialDepthUpdate.md)
 - [Position](docs/Position.md)
 - [PositionSide](docs/PositionSide.md)
 - [PostCreateOrder202Response](docs/PostCreateOrder202Response.md)
 - [RecentTradesUpdates](docs/RecentTradesUpdates.md)
 - [RefreshTokenRequest](docs/RefreshTokenRequest.md)
 - [RefreshTokenResponse](docs/RefreshTokenResponse.md)
 - [SelfTradePreventionType](docs/SelfTradePreventionType.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)
 - [WithdrawRequest](docs/WithdrawRequest.md)
 - [WithdrawRequestSignedFields](docs/WithdrawRequestSignedFields.md)


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

```
cargo doc --open
```

## Author