SWGGlobalNotificationApi.md

SWGGlobalNotificationApi

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

Method	HTTP request	Description
globalNotificationGet	GET /globalNotification	Get your current GlobalNotifications.

globalNotificationGet

-(NSURLSessionTask*) globalNotificationGetWithCompletionHandler: 
        (void (^)(NSArray<SWGGlobalNotification>* output, NSError* error)) handler;

Get your current GlobalNotifications.

This is an upcoming feature and currently does not return data.

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"];



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

// Get your current GlobalNotifications.
[apiInstance globalNotificationGetWithCompletionHandler: 
          ^(NSArray<SWGGlobalNotification>* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling SWGGlobalNotificationApi->globalNotificationGet: %@", error);
                        }
                    }];

Parameters

This endpoint does not need any parameter.

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]