SWGUserEventApi.md

SWGUserEventApi

All URIs are relative to https://www.bitmex.com/api/v1

Method	HTTP request	Description
userEventGet	GET /userEvent	Get your user events

userEventGet

-(NSURLSessionTask*) userEventGetWithCount: (NSNumber*) count
    startId: (NSNumber*) startId
        completionHandler: (void (^)(NSArray<SWGUserEvent>* output, NSError* error)) handler;

Get your user events

Example

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* count = @100; // Number of results to fetch. (optional) (default to 100)
NSNumber* startId = @1.2; // Cursor for pagination. (optional)

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

// Get your user events
[apiInstance userEventGetWithCount:count
              startId:startId
          completionHandler: ^(NSArray<SWGUserEvent>* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling SWGUserEventApi->userEventGet: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
count	NSNumber*	Number of results to fetch.	[optional] [default to 100]
startId	NSNumber*	Cursor for pagination.	[optional]

Return type

NSArray*

Authorization

apiExpires, apiKey, apiSignature

HTTP request headers

• 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]