Skip to content

Latest commit

 

History

History
119 lines (82 loc) · 4.33 KB

SWGAnnouncementApi.md

File metadata and controls

119 lines (82 loc) · 4.33 KB
Raw

SWGAnnouncementApi

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

Method HTTP request Description
announcementGet GET /announcement Get site announcements.
announcementGetUrgent GET /announcement/urgent Get urgent (banner) announcements.

announcementGet

-(NSURLSessionTask*) announcementGetWithColumns: (NSString*) columns
        completionHandler: (void (^)(NSArray<SWGAnnouncement>* output, NSError* error)) handler;

Get site announcements.

Example

NSString* columns = @"columns_example"; // Array of column names to fetch. If omitted, will return all columns. (optional)

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

// Get site announcements.
[apiInstance announcementGetWithColumns:columns
          completionHandler: ^(NSArray<SWGAnnouncement>* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling SWGAnnouncementApi->announcementGet: %@", error);
                        }
                    }];

Parameters

Name Type Description Notes
columns NSString* Array of column names to fetch. If omitted, will return all columns. [optional]

Return type

NSArray*

Authorization

No authorization required

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]

announcementGetUrgent

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

Get urgent (banner) announcements.

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



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

// Get urgent (banner) announcements.
[apiInstance announcementGetUrgentWithCompletionHandler: 
          ^(NSArray<SWGAnnouncement>* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling SWGAnnouncementApi->announcementGetUrgent: %@", 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]