All URIs are relative to https://www.bitmex.com/api/v1
| Method | HTTP request | Description |
|---|---|---|
| executionGet | GET /execution | Get all raw executions for your account. |
| executionGetTradeHistory | GET /execution/tradeHistory | Get all balance-affecting executions. |
-(NSURLSessionTask*) executionGetWithSymbol: (NSString*) symbol
filter: (NSString*) filter
columns: (NSString*) columns
count: (NSNumber*) count
start: (NSNumber*) start
reverse: (NSNumber*) reverse
startTime: (NSDate*) startTime
endTime: (NSDate*) endTime
completionHandler: (void (^)(NSArray<SWGExecution>* output, NSError* error)) handler;Get all raw executions for your account.
This returns all raw transactions, which includes order opening and cancelation, and order status changes. It can be quite noisy. More focused information is available at /execution/tradeHistory. You may also use the filter param to target your query. Specify an array as a filter value, such as {\"execType\": [\"Settlement\", \"Trade\"]} to filter on multiple values. See the FIX Spec for explanations of these fields.
SWGDefaultConfiguration *apiConfig = [SWGDefaultConfiguration sharedConfig];
// Configure API key authorization: (authentication scheme: apiExpires)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"api-expires"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"api-expires"];
// Configure API key authorization: (authentication scheme: apiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"api-key"];
// Configure API key authorization: (authentication scheme: apiSignature)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"api-signature"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"api-signature"];
NSString* symbol = @"symbol_example"; // 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`. Symbols are case-insensitive. (optional)
NSString* filter = @"filter_example"; // 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. (optional)
NSString* columns = @"columns_example"; // 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)
NSNumber* count = @100; // Number of results to fetch. Must be a positive integer. (optional) (default to 100)
NSNumber* start = @0; // Starting point for results. (optional) (default to 0)
NSNumber* reverse = @false; // If true, will sort results newest first. (optional) (default to false)
NSDate* startTime = @"2013-10-20T19:20:30+01:00"; // Starting date filter for results. (optional)
NSDate* endTime = @"2013-10-20T19:20:30+01:00"; // Ending date filter for results. (optional)
SWGExecutionApi*apiInstance = [[SWGExecutionApi alloc] init];
// Get all raw executions for your account.
[apiInstance executionGetWithSymbol:symbol
filter:filter
columns:columns
count:count
start:start
reverse:reverse
startTime:startTime
endTime:endTime
completionHandler: ^(NSArray<SWGExecution>* output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error calling SWGExecutionApi->executionGet: %@", error);
}
}];| Name | Type | Description | Notes |
|---|---|---|---|
| symbol | NSString* | 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`. Symbols are case-insensitive. | [optional] |
| filter | NSString* | 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 | NSString* | 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 | NSNumber* | Number of results to fetch. Must be a positive integer. | [optional] [default to 100] |
| start | NSNumber* | Starting point for results. | [optional] [default to 0] |
| reverse | NSNumber* | If true, will sort results newest first. | [optional] [default to false] |
| startTime | NSDate* | Starting date filter for results. | [optional] |
| endTime | NSDate* | Ending date filter for results. | [optional] |
apiExpires, apiKey, apiSignature
- Content-Type: application/json, application/x-www-form-urlencoded
- Accept: application/json, application/xml, text/xml, application/javascript, text/javascript
[Back to top] [Back to API list] [Back to Model list] [Back to README]
-(NSURLSessionTask*) executionGetTradeHistoryWithTargetAccountId: (NSNumber*) targetAccountId
targetAccountIds: (NSString*) targetAccountIds
symbol: (NSString*) symbol
filter: (NSString*) filter
columns: (NSString*) columns
count: (NSNumber*) count
start: (NSNumber*) start
reverse: (NSNumber*) reverse
startTime: (NSDate*) startTime
endTime: (NSDate*) endTime
completionHandler: (void (^)(NSArray<SWGExecution>* output, NSError* error)) handler;Get all balance-affecting executions.
SWGDefaultConfiguration *apiConfig = [SWGDefaultConfiguration sharedConfig];
// Configure API key authorization: (authentication scheme: apiExpires)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"api-expires"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"api-expires"];
// Configure API key authorization: (authentication scheme: apiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"api-key"];
// Configure API key authorization: (authentication scheme: apiSignature)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"api-signature"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"api-signature"];
NSNumber* targetAccountId = @1.2; // AccountId fetching the trade history, must be a paired account with main user. (optional)
NSString* targetAccountIds = @"targetAccountIds_example"; // AccountIds fetching the trade history, must be a paired account with main user. Can be wildcard * to get all accounts linked to the authenticated user (optional)
NSString* symbol = @"symbol_example"; // 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`. Symbols are case-insensitive. (optional)
NSString* filter = @"filter_example"; // 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. (optional)
NSString* columns = @"columns_example"; // 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)
NSNumber* count = @100; // Number of results to fetch. Must be a positive integer. (optional) (default to 100)
NSNumber* start = @0; // Starting point for results. (optional) (default to 0)
NSNumber* reverse = @false; // If true, will sort results newest first. (optional) (default to false)
NSDate* startTime = @"2013-10-20T19:20:30+01:00"; // Starting date filter for results. (optional)
NSDate* endTime = @"2013-10-20T19:20:30+01:00"; // Ending date filter for results. (optional)
SWGExecutionApi*apiInstance = [[SWGExecutionApi alloc] init];
// Get all balance-affecting executions.
[apiInstance executionGetTradeHistoryWithTargetAccountId:targetAccountId
targetAccountIds:targetAccountIds
symbol:symbol
filter:filter
columns:columns
count:count
start:start
reverse:reverse
startTime:startTime
endTime:endTime
completionHandler: ^(NSArray<SWGExecution>* output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error calling SWGExecutionApi->executionGetTradeHistory: %@", error);
}
}];| Name | Type | Description | Notes |
|---|---|---|---|
| targetAccountId | NSNumber* | AccountId fetching the trade history, must be a paired account with main user. | [optional] |
| targetAccountIds | NSString* | AccountIds fetching the trade history, must be a paired account with main user. Can be wildcard * to get all accounts linked to the authenticated user | [optional] |
| symbol | NSString* | 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`. Symbols are case-insensitive. | [optional] |
| filter | NSString* | 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 | NSString* | 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 | NSNumber* | Number of results to fetch. Must be a positive integer. | [optional] [default to 100] |
| start | NSNumber* | Starting point for results. | [optional] [default to 0] |
| reverse | NSNumber* | If true, will sort results newest first. | [optional] [default to false] |
| startTime | NSDate* | Starting date filter for results. | [optional] |
| endTime | NSDate* | Ending date filter for results. | [optional] |
apiExpires, apiKey, apiSignature
- Content-Type: application/json, application/x-www-form-urlencoded
- Accept: application/json, application/xml, text/xml, application/javascript, text/javascript
[Back to top] [Back to API list] [Back to Model list] [Back to README]