Skip to content

Latest commit

 

History

History
137 lines (105 loc) · 4.38 KB

AnnouncementApi.md

File metadata and controls

137 lines (105 loc) · 4.38 KB
Raw

IO.Swagger.Api.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

List AnnouncementGet (string columns = null)

Get site announcements.

Example

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class AnnouncementGetExample
    {
        public void main()
        {
            var apiInstance = new AnnouncementApi();
            var columns = columns_example;  // string | Array of column names to fetch. If omitted, will return all columns. (optional) 

            try
            {
                // Get site announcements.
                List<Announcement> result = apiInstance.AnnouncementGet(columns);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AnnouncementApi.AnnouncementGet: " + e.Message );
            }
        }
    }
}

Parameters

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

Return type

List

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

List AnnouncementGetUrgent ()

Get urgent (banner) announcements.

Example

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class AnnouncementGetUrgentExample
    {
        public void main()
        {
            // Configure API key authorization: apiExpires
            Configuration.Default.AddApiKey("api-expires", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-expires", "Bearer");
            // Configure API key authorization: apiKey
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
            // Configure API key authorization: apiSignature
            Configuration.Default.AddApiKey("api-signature", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-signature", "Bearer");

            var apiInstance = new AnnouncementApi();

            try
            {
                // Get urgent (banner) announcements.
                List<Announcement> result = apiInstance.AnnouncementGetUrgent();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AnnouncementApi.AnnouncementGetUrgent: " + e.Message );
            }
        }
    }
}

Parameters

This endpoint does not need any parameter.

Return type

List

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]