All URIs are relative to https://localhost/api/v1
| Method | HTTP request | Description |
|---|---|---|
| instrument_get | GET /instrument | Get instruments. |
| instrument_get_active | GET /instrument/active | Get all active instruments and instruments that have expired in <24hrs. |
| instrument_get_active_and_indices | GET /instrument/activeAndIndices | Helper method. Gets all active instruments and all indices. This is a join of the result of /indices and /active. |
| instrument_get_active_intervals | GET /instrument/activeIntervals | Return all active contract series and interval pairs. |
| instrument_get_composite_index | GET /instrument/compositeIndex | Show constituent parts of an index. |
| instrument_get_indices | GET /instrument/indices | Get all price indices. |
Array<Instrument> instrument_get(opts)
Get instruments.
This returns all instruments and indices, including those that have settled or are unlisted. Use this endpoint if you want to query for individual instruments or use a complex filter. Use /instrument/active to return active instruments, or use a filter like {\"state\": \"Open\"}.
# load the gem
require 'swagger_client'
api_instance = SwaggerClient::InstrumentApi.new
opts = {
symbol: 'symbol_example', # 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`.
filter: 'filter_example', # 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.
columns: 'columns_example', # 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.
count: 100, # Float | Number of results to fetch.
start: 0, # Float | Starting point for results.
reverse: false, # BOOLEAN | If true, will sort results newest first.
start_time: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Starting date filter for results.
end_time: DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | Ending date filter for results.
}
begin
#Get instruments.
result = api_instance.instrument_get(opts)
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling InstrumentApi->instrument_get: #{e}"
end| Name | Type | Description | Notes |
|---|---|---|---|
| symbol | 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`. | [optional] |
| filter | 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 for more details. | [optional] |
| columns | 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. | [optional] |
| count | Float | Number of results to fetch. | [optional] [default to 100] |
| start | Float | Starting point for results. | [optional] [default to 0] |
| reverse | BOOLEAN | If true, will sort results newest first. | [optional] [default to false] |
| start_time | DateTime | Starting date filter for results. | [optional] |
| end_time | DateTime | Ending date filter for results. | [optional] |
No authorization required
- Content-Type: application/json, application/x-www-form-urlencoded
- Accept: application/json, application/xml, text/xml, application/javascript, text/javascript
Array<Instrument> instrument_get_active
Get all active instruments and instruments that have expired in <24hrs.
# load the gem
require 'swagger_client'
api_instance = SwaggerClient::InstrumentApi.new
begin
#Get all active instruments and instruments that have expired in <24hrs.
result = api_instance.instrument_get_active
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling InstrumentApi->instrument_get_active: #{e}"
endThis endpoint does not need any parameter.
No authorization required
- Content-Type: application/json, application/x-www-form-urlencoded
- Accept: application/json, application/xml, text/xml, application/javascript, text/javascript
Array<Instrument> instrument_get_active_and_indices
Helper method. Gets all active instruments and all indices. This is a join of the result of /indices and /active.
# load the gem
require 'swagger_client'
api_instance = SwaggerClient::InstrumentApi.new
begin
#Helper method. Gets all active instruments and all indices. This is a join of the result of /indices and /active.
result = api_instance.instrument_get_active_and_indices
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling InstrumentApi->instrument_get_active_and_indices: #{e}"
endThis endpoint does not need any parameter.
No authorization required
- Content-Type: application/json, application/x-www-form-urlencoded
- Accept: application/json, application/xml, text/xml, application/javascript, text/javascript
InstrumentInterval instrument_get_active_intervals
Return all active contract series and interval pairs.
This endpoint is useful for determining which pairs are live. It returns two arrays of strings. The first is intervals, such as [\"XBT:perpetual\", \"XBT:monthly\", \"XBT:quarterly\", \"ETH:monthly\", ...]. These identifiers are usable in any query's symbol param. The second array is the current resolution of these intervals. Results are mapped at the same index.
# load the gem
require 'swagger_client'
api_instance = SwaggerClient::InstrumentApi.new
begin
#Return all active contract series and interval pairs.
result = api_instance.instrument_get_active_intervals
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling InstrumentApi->instrument_get_active_intervals: #{e}"
endThis endpoint does not need any parameter.
No authorization required
- Content-Type: application/json, application/x-www-form-urlencoded
- Accept: application/json, application/xml, text/xml, application/javascript, text/javascript
Array<IndexComposite> instrument_get_composite_index(opts)
Show constituent parts of an index.
Composite indices are built from multiple external price sources. Use this endpoint to get the underlying prices of an index. For example, send a symbol of .XBT to get the ticks and weights of the constituent exchanges that build the ".XBT" index. A tick with reference \"BMI\" and weight null is the composite index tick.
# load the gem
require 'swagger_client'
api_instance = SwaggerClient::InstrumentApi.new
opts = {
account: 1.2, # Float |
symbol: '.XBT', # String | The composite index symbol.
filter: 'filter_example', # 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.
columns: 'columns_example', # 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.
count: 100, # Float | Number of results to fetch.
start: 0, # Float | Starting point for results.
reverse: false, # BOOLEAN | If true, will sort results newest first.
start_time: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Starting date filter for results.
end_time: DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | Ending date filter for results.
}
begin
#Show constituent parts of an index.
result = api_instance.instrument_get_composite_index(opts)
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling InstrumentApi->instrument_get_composite_index: #{e}"
end| Name | Type | Description | Notes |
|---|---|---|---|
| account | Float | [optional] | |
| symbol | String | The composite index symbol. | [optional] [default to .XBT] |
| filter | 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 for more details. | [optional] |
| columns | 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. | [optional] |
| count | Float | Number of results to fetch. | [optional] [default to 100] |
| start | Float | Starting point for results. | [optional] [default to 0] |
| reverse | BOOLEAN | If true, will sort results newest first. | [optional] [default to false] |
| start_time | DateTime | Starting date filter for results. | [optional] |
| end_time | DateTime | Ending date filter for results. | [optional] |
No authorization required
- Content-Type: application/json, application/x-www-form-urlencoded
- Accept: application/json, application/xml, text/xml, application/javascript, text/javascript
Array<Instrument> instrument_get_indices
Get all price indices.
# load the gem
require 'swagger_client'
api_instance = SwaggerClient::InstrumentApi.new
begin
#Get all price indices.
result = api_instance.instrument_get_indices
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling InstrumentApi->instrument_get_indices: #{e}"
endThis endpoint does not need any parameter.
No authorization required
- Content-Type: application/json, application/x-www-form-urlencoded
- Accept: application/json, application/xml, text/xml, application/javascript, text/javascript