GlobalNotificationApi.md

SwaggerClient::GlobalNotificationApi

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

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

global_notification_get

Array<GlobalNotification> global_notification_get

Get your current GlobalNotifications.

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

Example

# load the gem
require 'swagger_client'
# setup authorization
SwaggerClient.configure do |config|
  # Configure API key authorization: apiExpires
  config.api_key['api-expires'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-expires'] = 'Bearer'

  # Configure API key authorization: apiKey
  config.api_key['api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-key'] = 'Bearer'

  # Configure API key authorization: apiSignature
  config.api_key['api-signature'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-signature'] = 'Bearer'
end

api_instance = SwaggerClient::GlobalNotificationApi.new

begin
  #Get your current GlobalNotifications.
  result = api_instance.global_notification_get
  p result
rescue SwaggerClient::ApiError => e
  puts "Exception when calling GlobalNotificationApi->global_notification_get: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return type

Array<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