forked from BitMEX/api-connectors
-
Notifications
You must be signed in to change notification settings - Fork 0
/
api_quote.go
365 lines (321 loc) · 16.1 KB
/
api_quote.go
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
362
363
364
365
/*
* BitMEX API
*
* ## REST API for the BitMEX Trading Platform [View Changelog](/app/apiChangelog) #### Getting Started Base URI: [https://www.bitmex.com/api/v1](/api/v1) ##### Fetching Data All REST endpoints are documented below. You can try out any query right from this interface. Most table queries accept `count`, `start`, and `reverse` params. Set `reverse=true` to get rows newest-first. Additional documentation regarding filters, timestamps, and authentication is available in [the main API documentation](/app/restAPI). *All* table data is available via the [Websocket](/app/wsAPI). We highly recommend using the socket if you want to have the quickest possible data without being subject to ratelimits. ##### Return Types By default, all data is returned as JSON. Send `?_format=csv` to get CSV data or `?_format=xml` to get XML data. ##### Trade Data Queries *This is only a small subset of what is available, to get you started.* Fill in the parameters and click the `Try it out!` button to try any of these queries. * [Pricing Data](#!/Quote/Quote_get) * [Trade Data](#!/Trade/Trade_get) * [OrderBook Data](#!/OrderBook/OrderBook_getL2) * [Settlement Data](#!/Settlement/Settlement_get) * [Exchange Statistics](#!/Stats/Stats_history) Every function of the BitMEX.com platform is exposed here and documented. Many more functions are available. ##### Swagger Specification [⇩ Download Swagger JSON](swagger.json) ## All API Endpoints Click to expand a section.
*
* API version: 1.2.0
* Contact: [email protected]
* Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
*/
package swagger
import (
"context"
"io/ioutil"
"net/http"
"net/url"
"strings"
"github.com/antihax/optional"
)
// Linger please
var (
_ context.Context
)
type QuoteApiService service
/*
QuoteApiService Get Quotes.
* @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
* @param optional nil or *QuoteGetOpts - Optional Parameters:
* @param "Symbol" (optional.String) - Instrument symbol. Send a bare series (e.g. XBU) to get data for the nearest expiring contract in that series. You can also send a timeframe, e.g. `XBU:monthly`. Timeframes are `daily`, `weekly`, `monthly`, `quarterly`, and `biquarterly`.
* @param "Filter" (optional.String) - Generic table filter. Send JSON key/value pairs, such as `{\"key\": \"value\"}`. You can key on individual fields, and do more advanced querying on timestamps. See the [Timestamp Docs](https://www.bitmex.com/app/restAPI#Timestamp-Filters) for more details.
* @param "Columns" (optional.String) - Array of column names to fetch. If omitted, will return all columns. Note that this method will always return item keys, even when not specified, so you may receive more columns that you expect.
* @param "Count" (optional.Float32) - Number of results to fetch.
* @param "Start" (optional.Float32) - Starting point for results.
* @param "Reverse" (optional.Bool) - If true, will sort results newest first.
* @param "StartTime" (optional.Time) - Starting date filter for results.
* @param "EndTime" (optional.Time) - Ending date filter for results.
@return []Quote
*/
type QuoteGetOpts struct {
Symbol optional.String
Filter optional.String
Columns optional.String
Count optional.Float32
Start optional.Float32
Reverse optional.Bool
StartTime optional.Time
EndTime optional.Time
}
func (a *QuoteApiService) QuoteGet(ctx context.Context, localVarOptionals *QuoteGetOpts) ([]Quote, *http.Response, error) {
var (
localVarHttpMethod = strings.ToUpper("Get")
localVarPostBody interface{}
localVarFileName string
localVarFileBytes []byte
localVarReturnValue []Quote
)
// create path and map variables
localVarPath := a.client.cfg.BasePath + "/quote"
localVarHeaderParams := make(map[string]string)
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
if localVarOptionals != nil && localVarOptionals.Symbol.IsSet() {
localVarQueryParams.Add("symbol", parameterToString(localVarOptionals.Symbol.Value(), ""))
}
if localVarOptionals != nil && localVarOptionals.Filter.IsSet() {
localVarQueryParams.Add("filter", parameterToString(localVarOptionals.Filter.Value(), ""))
}
if localVarOptionals != nil && localVarOptionals.Columns.IsSet() {
localVarQueryParams.Add("columns", parameterToString(localVarOptionals.Columns.Value(), ""))
}
if localVarOptionals != nil && localVarOptionals.Count.IsSet() {
localVarQueryParams.Add("count", parameterToString(localVarOptionals.Count.Value(), ""))
}
if localVarOptionals != nil && localVarOptionals.Start.IsSet() {
localVarQueryParams.Add("start", parameterToString(localVarOptionals.Start.Value(), ""))
}
if localVarOptionals != nil && localVarOptionals.Reverse.IsSet() {
localVarQueryParams.Add("reverse", parameterToString(localVarOptionals.Reverse.Value(), ""))
}
if localVarOptionals != nil && localVarOptionals.StartTime.IsSet() {
localVarQueryParams.Add("startTime", parameterToString(localVarOptionals.StartTime.Value(), ""))
}
if localVarOptionals != nil && localVarOptionals.EndTime.IsSet() {
localVarQueryParams.Add("endTime", parameterToString(localVarOptionals.EndTime.Value(), ""))
}
// to determine the Content-Type header
localVarHttpContentTypes := []string{"application/json", "application/x-www-form-urlencoded"}
// set Content-Type header
localVarHttpContentType := selectHeaderContentType(localVarHttpContentTypes)
if localVarHttpContentType != "" {
localVarHeaderParams["Content-Type"] = localVarHttpContentType
}
// to determine the Accept header
localVarHttpHeaderAccepts := []string{"application/json", "application/xml", "text/xml", "application/javascript", "text/javascript"}
// set Accept header
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
if localVarHttpHeaderAccept != "" {
localVarHeaderParams["Accept"] = localVarHttpHeaderAccept
}
r, err := a.client.prepareRequest(ctx, localVarPath, localVarHttpMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFileName, localVarFileBytes)
if err != nil {
return localVarReturnValue, nil, err
}
localVarHttpResponse, err := a.client.callAPI(r)
if err != nil || localVarHttpResponse == nil {
return localVarReturnValue, localVarHttpResponse, err
}
localVarBody, err := ioutil.ReadAll(localVarHttpResponse.Body)
localVarHttpResponse.Body.Close()
if err != nil {
return localVarReturnValue, localVarHttpResponse, err
}
if localVarHttpResponse.StatusCode < 300 {
// If we succeed, return the data, otherwise pass on to decode error.
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHttpResponse.Header.Get("Content-Type"));
if err == nil {
return localVarReturnValue, localVarHttpResponse, err
}
}
if localVarHttpResponse.StatusCode >= 300 {
newErr := GenericSwaggerError{
body: localVarBody,
error: localVarHttpResponse.Status,
}
if localVarHttpResponse.StatusCode == 200 {
var v []Quote
err = a.client.decode(&v, localVarBody, localVarHttpResponse.Header.Get("Content-Type"));
if err != nil {
newErr.error = err.Error()
return localVarReturnValue, localVarHttpResponse, newErr
}
newErr.model = v
return localVarReturnValue, localVarHttpResponse, newErr
}
if localVarHttpResponse.StatusCode == 400 {
var v ModelError
err = a.client.decode(&v, localVarBody, localVarHttpResponse.Header.Get("Content-Type"));
if err != nil {
newErr.error = err.Error()
return localVarReturnValue, localVarHttpResponse, newErr
}
newErr.model = v
return localVarReturnValue, localVarHttpResponse, newErr
}
if localVarHttpResponse.StatusCode == 401 {
var v ModelError
err = a.client.decode(&v, localVarBody, localVarHttpResponse.Header.Get("Content-Type"));
if err != nil {
newErr.error = err.Error()
return localVarReturnValue, localVarHttpResponse, newErr
}
newErr.model = v
return localVarReturnValue, localVarHttpResponse, newErr
}
if localVarHttpResponse.StatusCode == 404 {
var v ModelError
err = a.client.decode(&v, localVarBody, localVarHttpResponse.Header.Get("Content-Type"));
if err != nil {
newErr.error = err.Error()
return localVarReturnValue, localVarHttpResponse, newErr
}
newErr.model = v
return localVarReturnValue, localVarHttpResponse, newErr
}
return localVarReturnValue, localVarHttpResponse, newErr
}
return localVarReturnValue, localVarHttpResponse, nil
}
/*
QuoteApiService Get previous quotes in time buckets.
* @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
* @param optional nil or *QuoteGetBucketedOpts - Optional Parameters:
* @param "BinSize" (optional.String) - Time interval to bucket by. Available options: [1m,5m,1h,1d].
* @param "Partial" (optional.Bool) - If true, will send in-progress (incomplete) bins for the current time period.
* @param "Symbol" (optional.String) - Instrument symbol. Send a bare series (e.g. XBU) to get data for the nearest expiring contract in that series. You can also send a timeframe, e.g. `XBU:monthly`. Timeframes are `daily`, `weekly`, `monthly`, `quarterly`, and `biquarterly`.
* @param "Filter" (optional.String) - Generic table filter. Send JSON key/value pairs, such as `{\"key\": \"value\"}`. You can key on individual fields, and do more advanced querying on timestamps. See the [Timestamp Docs](https://www.bitmex.com/app/restAPI#Timestamp-Filters) for more details.
* @param "Columns" (optional.String) - Array of column names to fetch. If omitted, will return all columns. Note that this method will always return item keys, even when not specified, so you may receive more columns that you expect.
* @param "Count" (optional.Float32) - Number of results to fetch.
* @param "Start" (optional.Float32) - Starting point for results.
* @param "Reverse" (optional.Bool) - If true, will sort results newest first.
* @param "StartTime" (optional.Time) - Starting date filter for results.
* @param "EndTime" (optional.Time) - Ending date filter for results.
@return []Quote
*/
type QuoteGetBucketedOpts struct {
BinSize optional.String
Partial optional.Bool
Symbol optional.String
Filter optional.String
Columns optional.String
Count optional.Float32
Start optional.Float32
Reverse optional.Bool
StartTime optional.Time
EndTime optional.Time
}
func (a *QuoteApiService) QuoteGetBucketed(ctx context.Context, localVarOptionals *QuoteGetBucketedOpts) ([]Quote, *http.Response, error) {
var (
localVarHttpMethod = strings.ToUpper("Get")
localVarPostBody interface{}
localVarFileName string
localVarFileBytes []byte
localVarReturnValue []Quote
)
// create path and map variables
localVarPath := a.client.cfg.BasePath + "/quote/bucketed"
localVarHeaderParams := make(map[string]string)
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
if localVarOptionals != nil && localVarOptionals.BinSize.IsSet() {
localVarQueryParams.Add("binSize", parameterToString(localVarOptionals.BinSize.Value(), ""))
}
if localVarOptionals != nil && localVarOptionals.Partial.IsSet() {
localVarQueryParams.Add("partial", parameterToString(localVarOptionals.Partial.Value(), ""))
}
if localVarOptionals != nil && localVarOptionals.Symbol.IsSet() {
localVarQueryParams.Add("symbol", parameterToString(localVarOptionals.Symbol.Value(), ""))
}
if localVarOptionals != nil && localVarOptionals.Filter.IsSet() {
localVarQueryParams.Add("filter", parameterToString(localVarOptionals.Filter.Value(), ""))
}
if localVarOptionals != nil && localVarOptionals.Columns.IsSet() {
localVarQueryParams.Add("columns", parameterToString(localVarOptionals.Columns.Value(), ""))
}
if localVarOptionals != nil && localVarOptionals.Count.IsSet() {
localVarQueryParams.Add("count", parameterToString(localVarOptionals.Count.Value(), ""))
}
if localVarOptionals != nil && localVarOptionals.Start.IsSet() {
localVarQueryParams.Add("start", parameterToString(localVarOptionals.Start.Value(), ""))
}
if localVarOptionals != nil && localVarOptionals.Reverse.IsSet() {
localVarQueryParams.Add("reverse", parameterToString(localVarOptionals.Reverse.Value(), ""))
}
if localVarOptionals != nil && localVarOptionals.StartTime.IsSet() {
localVarQueryParams.Add("startTime", parameterToString(localVarOptionals.StartTime.Value(), ""))
}
if localVarOptionals != nil && localVarOptionals.EndTime.IsSet() {
localVarQueryParams.Add("endTime", parameterToString(localVarOptionals.EndTime.Value(), ""))
}
// to determine the Content-Type header
localVarHttpContentTypes := []string{"application/json", "application/x-www-form-urlencoded"}
// set Content-Type header
localVarHttpContentType := selectHeaderContentType(localVarHttpContentTypes)
if localVarHttpContentType != "" {
localVarHeaderParams["Content-Type"] = localVarHttpContentType
}
// to determine the Accept header
localVarHttpHeaderAccepts := []string{"application/json", "application/xml", "text/xml", "application/javascript", "text/javascript"}
// set Accept header
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
if localVarHttpHeaderAccept != "" {
localVarHeaderParams["Accept"] = localVarHttpHeaderAccept
}
r, err := a.client.prepareRequest(ctx, localVarPath, localVarHttpMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFileName, localVarFileBytes)
if err != nil {
return localVarReturnValue, nil, err
}
localVarHttpResponse, err := a.client.callAPI(r)
if err != nil || localVarHttpResponse == nil {
return localVarReturnValue, localVarHttpResponse, err
}
localVarBody, err := ioutil.ReadAll(localVarHttpResponse.Body)
localVarHttpResponse.Body.Close()
if err != nil {
return localVarReturnValue, localVarHttpResponse, err
}
if localVarHttpResponse.StatusCode < 300 {
// If we succeed, return the data, otherwise pass on to decode error.
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHttpResponse.Header.Get("Content-Type"));
if err == nil {
return localVarReturnValue, localVarHttpResponse, err
}
}
if localVarHttpResponse.StatusCode >= 300 {
newErr := GenericSwaggerError{
body: localVarBody,
error: localVarHttpResponse.Status,
}
if localVarHttpResponse.StatusCode == 200 {
var v []Quote
err = a.client.decode(&v, localVarBody, localVarHttpResponse.Header.Get("Content-Type"));
if err != nil {
newErr.error = err.Error()
return localVarReturnValue, localVarHttpResponse, newErr
}
newErr.model = v
return localVarReturnValue, localVarHttpResponse, newErr
}
if localVarHttpResponse.StatusCode == 400 {
var v ModelError
err = a.client.decode(&v, localVarBody, localVarHttpResponse.Header.Get("Content-Type"));
if err != nil {
newErr.error = err.Error()
return localVarReturnValue, localVarHttpResponse, newErr
}
newErr.model = v
return localVarReturnValue, localVarHttpResponse, newErr
}
if localVarHttpResponse.StatusCode == 401 {
var v ModelError
err = a.client.decode(&v, localVarBody, localVarHttpResponse.Header.Get("Content-Type"));
if err != nil {
newErr.error = err.Error()
return localVarReturnValue, localVarHttpResponse, newErr
}
newErr.model = v
return localVarReturnValue, localVarHttpResponse, newErr
}
if localVarHttpResponse.StatusCode == 404 {
var v ModelError
err = a.client.decode(&v, localVarBody, localVarHttpResponse.Header.Get("Content-Type"));
if err != nil {
newErr.error = err.Error()
return localVarReturnValue, localVarHttpResponse, newErr
}
newErr.model = v
return localVarReturnValue, localVarHttpResponse, newErr
}
return localVarReturnValue, localVarHttpResponse, newErr
}
return localVarReturnValue, localVarHttpResponse, nil
}