Skip to content

HealthApi.md

Latest commit

 

History

History
54 lines (35 loc) · 1.2 KB

HealthApi.md

File metadata and controls

54 lines (35 loc) · 1.2 KB

BuiltByBitApi.HealthApi

All URIs are relative to https://api.builtbybit.com

Method HTTP request Description
getV2Health GET /v2/health Retrieve a health status

getV2Health

GetV2Health200Response getV2Health()

Retrieve a health status

Example

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

let apiInstance = new BuiltByBitApi.HealthApi();
apiInstance.getV2Health((error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

This endpoint does not need any parameter.

Return type

GetV2Health200Response

Authorization

token

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json