All URIs are relative to https://www.bitmex.com/api/v1
Method | HTTP request | Description |
---|---|---|
tradeGet | GET /trade | Get Trades. |
tradeGetBucketed | GET /trade/bucketed | Get previous trades in time buckets. |
[Trade] tradeGet(opts)
Get Trades.
Please note that indices (symbols starting with .
) post trades at intervals to the trade feed. These have a size
of 0 and are used only to indicate a changing price. See the FIX Spec for explanations of these fields.
var BitMexApi = require('bit_mex_api');
var apiInstance = new BitMexApi.TradeApi();
var opts = {
'symbol': "symbol_example", // String | Instrument symbol. Send a bare series (e.g. XBT) to get data for the nearest expiring contract in that series. You can also send a timeframe, e.g. `XBT:quarterly`. Timeframes are `nearest`, `daily`, `weekly`, `monthly`, `quarterly`, `biquarterly`, and `perpetual`.
'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, // Number | Number of results to fetch.
'start': 0, // Number | Starting point for results.
'reverse': false, // Boolean | If true, will sort results newest first.
'startTime': new Date("2013-10-20T19:20:30+01:00"), // Date | Starting date filter for results.
'endTime': new Date("2013-10-20T19:20:30+01:00") // Date | Ending date filter for results.
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.tradeGet(opts, callback);
Name | Type | Description | Notes |
---|---|---|---|
symbol | String | Instrument symbol. Send a bare series (e.g. XBT) to get data for the nearest expiring contract in that series. You can also send a timeframe, e.g. XBT:quarterly . Timeframes are nearest , daily , weekly , monthly , quarterly , biquarterly , and perpetual . |
[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 | Number | Number of results to fetch. | [optional] [default to 100] |
start | Number | Starting point for results. | [optional] [default to 0] |
reverse | Boolean | If true, will sort results newest first. | [optional] [default to false] |
startTime | Date | Starting date filter for results. | [optional] |
endTime | Date | 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
[TradeBin] tradeGetBucketed(opts)
Get previous trades in time buckets.
Timestamps returned by our bucketed endpoints are the end of the period, indicating when the bucket was written to disk. Some other common systems use the timestamp as the beginning of the period. Please be aware of this when using this endpoint. Also note the open
price is equal to the close
price of the previous timeframe bucket.
var BitMexApi = require('bit_mex_api');
var apiInstance = new BitMexApi.TradeApi();
var opts = {
'binSize': "1m", // String | Time interval to bucket by. Available options: [1m,5m,1h,1d].
'partial': false, // Boolean | If true, will send in-progress (incomplete) bins for the current time period.
'symbol': "symbol_example", // String | Instrument symbol. Send a bare series (e.g. XBT) to get data for the nearest expiring contract in that series. You can also send a timeframe, e.g. `XBT:quarterly`. Timeframes are `nearest`, `daily`, `weekly`, `monthly`, `quarterly`, `biquarterly`, and `perpetual`.
'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, // Number | Number of results to fetch.
'start': 0, // Number | Starting point for results.
'reverse': false, // Boolean | If true, will sort results newest first.
'startTime': new Date("2013-10-20T19:20:30+01:00"), // Date | Starting date filter for results.
'endTime': new Date("2013-10-20T19:20:30+01:00") // Date | Ending date filter for results.
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.tradeGetBucketed(opts, callback);
Name | Type | Description | Notes |
---|---|---|---|
binSize | String | Time interval to bucket by. Available options: [1m,5m,1h,1d]. | [optional] [default to 1m] |
partial | Boolean | If true, will send in-progress (incomplete) bins for the current time period. | [optional] [default to false] |
symbol | String | Instrument symbol. Send a bare series (e.g. XBT) to get data for the nearest expiring contract in that series. You can also send a timeframe, e.g. XBT:quarterly . Timeframes are nearest , daily , weekly , monthly , quarterly , biquarterly , and perpetual . |
[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 | Number | Number of results to fetch. | [optional] [default to 100] |
start | Number | Starting point for results. | [optional] [default to 0] |
reverse | Boolean | If true, will sort results newest first. | [optional] [default to false] |
startTime | Date | Starting date filter for results. | [optional] |
endTime | Date | 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