Skip to content

Latest commit

 

History

History
176 lines (134 loc) · 7.53 KB

SWGExecutionApi.md

File metadata and controls

176 lines (134 loc) · 7.53 KB
Raw

SWGExecutionApi

All URIs are relative to https://api.bybit.com

Method HTTP request Description
executionGetTrades GET /v2/private/execution/list Get user’s trade records.
positionsClosePnlRecords GET /v2/private/trade/closed-pnl/list Get user's closed profit and loss records

executionGetTrades

-(NSURLSessionTask*) executionGetTradesWithOrderId: (NSString*) orderId
    symbol: (NSString*) symbol
    startTime: (NSString*) startTime
    page: (NSString*) page
    limit: (NSString*) limit
        completionHandler: (void (^)(NSObject* output, NSError* error)) handler;

Get user’s trade records.

Example

SWGDefaultConfiguration *apiConfig = [SWGDefaultConfiguration sharedConfig];

// 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:@"sign"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sign"];

// Configure API key authorization: (authentication scheme: timestamp)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"timestamp"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"timestamp"];


NSString* orderId = @"orderId_example"; // OrderID. If not provided, will return user’s trading records. (optional)
NSString* symbol = @"symbol_example"; // Contract type. If order_id not provided, symbol is required. (optional)
NSString* startTime = @"startTime_example"; // Start timestamp point for result. (optional)
NSString* page = @"page_example"; // Page. Default getting first page data. (optional)
NSString* limit = @"limit_example"; // Limit for data size per page, max size is 50. Default as showing 20 pieces of data per page. (optional)

SWGExecutionApi*apiInstance = [[SWGExecutionApi alloc] init];

// Get user’s trade records.
[apiInstance executionGetTradesWithOrderId:orderId
              symbol:symbol
              startTime:startTime
              page:page
              limit:limit
          completionHandler: ^(NSObject* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling SWGExecutionApi->executionGetTrades: %@", error);
                        }
                    }];

Parameters

Name Type Description Notes
orderId NSString* OrderID. If not provided, will return user’s trading records. [optional]
symbol NSString* Contract type. If order_id not provided, symbol is required. [optional]
startTime NSString* Start timestamp point for result. [optional]
page NSString* Page. Default getting first page data. [optional]
limit NSString* Limit for data size per page, max size is 50. Default as showing 20 pieces of data per page. [optional]

Return type

NSObject*

Authorization

apiKey, apiSignature, timestamp

HTTP request headers

  • Content-Type: application/json, application/x-www-form-urlencoded
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

positionsClosePnlRecords

-(NSURLSessionTask*) positionsClosePnlRecordsWithSymbol: (NSString*) symbol
    startTime: (NSNumber*) startTime
    endTime: (NSNumber*) endTime
    execType: (NSString*) execType
    page: (NSNumber*) page
    limit: (NSNumber*) limit
        completionHandler: (void (^)(NSObject* output, NSError* error)) handler;

Get user's closed profit and loss records

Example

SWGDefaultConfiguration *apiConfig = [SWGDefaultConfiguration sharedConfig];

// 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:@"sign"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sign"];

// Configure API key authorization: (authentication scheme: timestamp)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"timestamp"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"timestamp"];


NSString* symbol = @"symbol_example"; // Contract type
NSNumber* startTime = @56; // Start timestamp point for result, in second (optional)
NSNumber* endTime = @56; // End timestamp point for result, in second (optional)
NSString* execType = @"execType_example"; // Execution type (optional)
NSNumber* page = @56; // Page. By default, gets first page of data. Maximum of 50 pages (optional)
NSNumber* limit = @56; // Limit for data size per page, max size is 50. Default as showing 20 pieces of data per page. (optional)

SWGExecutionApi*apiInstance = [[SWGExecutionApi alloc] init];

// Get user's closed profit and loss records
[apiInstance positionsClosePnlRecordsWithSymbol:symbol
              startTime:startTime
              endTime:endTime
              execType:execType
              page:page
              limit:limit
          completionHandler: ^(NSObject* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling SWGExecutionApi->positionsClosePnlRecords: %@", error);
                        }
                    }];

Parameters

Name Type Description Notes
symbol NSString* Contract type
startTime NSNumber* Start timestamp point for result, in second [optional]
endTime NSNumber* End timestamp point for result, in second [optional]
execType NSString* Execution type [optional]
page NSNumber* Page. By default, gets first page of data. Maximum of 50 pages [optional]
limit NSNumber* Limit for data size per page, max size is 50. Default as showing 20 pieces of data per page. [optional]

Return type

NSObject*

Authorization

apiKey, apiSignature, timestamp

HTTP request headers

  • Content-Type: application/json, application/x-www-form-urlencoded
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]