bluefin_api 1.13.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
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361

# \ExchangeApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**get_all_market_ticker**](ExchangeApi.md#get_all_market_ticker) | **GET** /v1/exchange/tickers | /exchange/tickers
[**get_candlestick_data**](ExchangeApi.md#get_candlestick_data) | **GET** /v1/exchange/candlesticks | /exchange/candlesticks
[**get_country**](ExchangeApi.md#get_country) | **GET** /v1/exchange/country | /exchange/country
[**get_exchange_info**](ExchangeApi.md#get_exchange_info) | **GET** /v1/exchange/info | /exchange/info
[**get_exchange_stats**](ExchangeApi.md#get_exchange_stats) | **GET** /v1/exchange/stats | /exchange/stats
[**get_exchange_stats_all_time**](ExchangeApi.md#get_exchange_stats_all_time) | **GET** /v1/exchange/stats/allTime | /v1/exchange/stats/allTime
[**get_funding_rate_history**](ExchangeApi.md#get_funding_rate_history) | **GET** /v1/exchange/fundingRateHistory | /exchange/fundingRateHistory
[**get_leaderboard**](ExchangeApi.md#get_leaderboard) | **GET** /api/v1/accounts/leaderboard | /accounts/leaderboard
[**get_market_ticker**](ExchangeApi.md#get_market_ticker) | **GET** /v1/exchange/ticker | /exchange/ticker
[**get_orderbook_depth**](ExchangeApi.md#get_orderbook_depth) | **GET** /v1/exchange/depth | /exchange/depth
[**get_recent_trades**](ExchangeApi.md#get_recent_trades) | **GET** /v1/exchange/trades | /exchange/trades



## get_all_market_ticker

> Vec<models::TickerResponse> get_all_market_ticker()
/exchange/tickers

Retrieves all market ticker information.

### Parameters

This endpoint does not need any parameter.

### Return type

[**Vec<models::TickerResponse>**](TickerResponse.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_candlestick_data

> Vec<Vec<String>> get_candlestick_data(symbol, interval, r#type, start_time_at_millis, end_time_at_millis, limit, page)
/exchange/candlesticks

Retrieves candle stick data for a market.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**symbol** | **String** | The market symbol to get the klines for. | [required] |
**interval** | [**KlineInterval**](.md) | The interval to get the klines for. | [required] |
**r#type** | [**CandlePriceType**](.md) | Candle price type (last price, market price, oracle or mark price). | [required] |
**start_time_at_millis** | Option<**u64**> | Timestamp in milliseconds in ms to get klines from. |  |
**end_time_at_millis** | Option<**u64**> | Timestamp in milliseconds in ms to get klines until. |  |
**limit** | Option<**u32**> | Default 50; max 1000. |  |[default to 50]
**page** | Option<**u32**> | The page number to retrieve in a paginated response. |  |

### Return type

[**Vec<Vec<String>>**](Vec.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_country

> models::CountryResponse get_country()
/exchange/country

Check if the country is geo restricted.

### Parameters

This endpoint does not need any parameter.

### Return type

[**models::CountryResponse**](CountryResponse.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_exchange_info

> models::ExchangeInfoResponse get_exchange_info()
/exchange/info

Returns the current exchange information including available margin assets, markets, and rules.

### Parameters

This endpoint does not need any parameter.

### Return type

[**models::ExchangeInfoResponse**](ExchangeInfoResponse.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_exchange_stats

> models::StatsResponse get_exchange_stats(interval, start_time_at_millis, end_time_at_millis, limit, page)
/exchange/stats

Retrieves exchange statistics.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**interval** | Option<[**StatsInterval**](.md)> |  |  |
**start_time_at_millis** | Option<**u64**> | Timestamp in milliseconds. |  |
**end_time_at_millis** | Option<**u64**> | Timestamp in milliseconds. |  |
**limit** | Option<**u32**> | Number of records to return. Default is 30; max is 200. |  |[default to 30]
**page** | Option<**u32**> | The page number to retrieve in a paginated response. |  |

### Return type

[**models::StatsResponse**](StatsResponse.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_exchange_stats_all_time

> models::StatsAllTimeResponse get_exchange_stats_all_time()
/v1/exchange/stats/allTime

Retrieves all time exchange statistics.

### Parameters

This endpoint does not need any parameter.

### Return type

[**models::StatsAllTimeResponse**](StatsAllTimeResponse.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_funding_rate_history

> Vec<models::FundingRateEntry> get_funding_rate_history(symbol, limit, start_time_at_millis, end_time_at_millis, page)
/exchange/fundingRateHistory

Retrieve the funding rate history for a specific market address.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**symbol** | **String** | The market symbol to get funding rate history for | [required] |
**limit** | Option<**u32**> | Number of records to return. Default is 100; max is 1000. |  |[default to 100]
**start_time_at_millis** | Option<**u64**> | The timestamp specifies the earliest point in time for which data should be returned. The value is not included. |  |
**end_time_at_millis** | Option<**u64**> | The timestamp specifies the latest point in time for which data should be returned. The value is included. |  |
**page** | Option<**u32**> | The page number to retrieve in a paginated response. |  |

### Return type

[**Vec<models::FundingRateEntry>**](FundingRateEntry.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_leaderboard

> models::LeaderboardResponse get_leaderboard(interval, sort_by, sort_order, limit, page)
/accounts/leaderboard

Retrieves the leaderboard of traders based on their performance.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**interval** | Option<[**LeaderboardInterval**](.md)> | The interval to get the leaderboard for. Default or Unspecified is 7d. |  |
**sort_by** | Option<**String**> | The field to sort by. Default or Unspecified is accountValue. |  |[default to accountValue]
**sort_order** | Option<[**SortOrder**](.md)> | The sort order, either ascending (ASC) or descending (DESC). Default or UNSPECIFIED is DESC. |  |
**limit** | Option<**u32**> | Default 50; max 100. |  |[default to 50]
**page** | Option<**u32**> | The page number to retrieve in a paginated response. |  |[default to 1]

### Return type

[**models::LeaderboardResponse**](LeaderboardResponse.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_market_ticker

> models::TickerResponse get_market_ticker(symbol)
/exchange/ticker

Retrieves aggregated ticker data for a market.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**symbol** | **String** | Market symbol. | [required] |

### Return type

[**models::TickerResponse**](TickerResponse.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_orderbook_depth

> models::OrderbookDepthResponse get_orderbook_depth(symbol, limit)
/exchange/depth

Returns the current state of the orderbook.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**symbol** | **String** | Market symbol to get the orderbook depth for. | [required] |
**limit** | Option<**u32**> | Maximum number of bids and asks to return. Default 500; max 1000. |  |[default to 500]

### Return type

[**models::OrderbookDepthResponse**](OrderbookDepthResponse.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_recent_trades

> Vec<models::Trade> get_recent_trades(symbol, trade_type, limit, start_time_at_millis, end_time_at_millis, page)
/exchange/trades

Retrieves recent trades executed on a market.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**symbol** | **String** | The market symbol to get the trades for. | [required] |
**trade_type** | Option<[**TradeType**](.md)> | Type of trade. |  |
**limit** | Option<**u32**> | Default 500; max 1000. |  |[default to 500]
**start_time_at_millis** | Option<**i64**> | The timestamp specifies the earliest point in time for which data should be returned. The value is not included. |  |
**end_time_at_millis** | Option<**u64**> | The timestamp specifies the latest point in time for which data should be returned. The value is included. |  |
**page** | Option<**u32**> | The page number to retrieve in a paginated response. |  |

### Return type

[**Vec<models::Trade>**](Trade.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)