Skip to content

Latest commit

 

History

History
72 lines (52 loc) · 2.5 KB

GlobalNotificationApi.md

File metadata and controls

72 lines (52 loc) · 2.5 KB

GlobalNotificationApi

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

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

globalNotificationGet

List<GlobalNotification> globalNotificationGet()

Get your current GlobalNotifications.

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

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.GlobalNotificationApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: apiExpires
ApiKeyAuth apiExpires = (ApiKeyAuth) defaultClient.getAuthentication("apiExpires");
apiExpires.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiExpires.setApiKeyPrefix("Token");

// Configure API key authorization: apiKey
ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("apiKey");
apiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.setApiKeyPrefix("Token");

// Configure API key authorization: apiSignature
ApiKeyAuth apiSignature = (ApiKeyAuth) defaultClient.getAuthentication("apiSignature");
apiSignature.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiSignature.setApiKeyPrefix("Token");

GlobalNotificationApi apiInstance = new GlobalNotificationApi();
try {
    List<GlobalNotification> result = apiInstance.globalNotificationGet();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling GlobalNotificationApi#globalNotificationGet");
    e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

List<GlobalNotification>

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