AnnouncementApi.md

BitMexApi.AnnouncementApi

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

[Announcement] announcementGet(opts)

Get site announcements.

Example

var BitMexApi = require('bit_mex_api');

var apiInstance = new BitMexApi.AnnouncementApi();

var opts = { 
  'columns': "columns_example" // String | Array of column names to fetch. If omitted, will return all columns.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.announcementGet(opts, callback);

Parameters

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

Return type

[Announcement]

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

announcementGetUrgent

[Announcement] announcementGetUrgent()

Get urgent (banner) announcements.

Example

var BitMexApi = require('bit_mex_api');
var defaultClient = BitMexApi.ApiClient.instance;

// Configure API key authorization: apiExpires
var apiExpires = defaultClient.authentications['apiExpires'];
apiExpires.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiExpires.apiKeyPrefix = 'Token';

// Configure API key authorization: apiKey
var apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

// Configure API key authorization: apiSignature
var apiSignature = defaultClient.authentications['apiSignature'];
apiSignature.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiSignature.apiKeyPrefix = 'Token';

var apiInstance = new BitMexApi.AnnouncementApi();

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.announcementGetUrgent(callback);

Parameters

This endpoint does not need any parameter.

Return type

[Announcement]

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