SchemaApi.md

SwaggerClient::SchemaApi

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

Method	HTTP request	Description
schema_get	GET /schema	Get model schemata for data objects returned by this API.
schema_websocket_help	GET /schema/websocketHelp	Returns help text & subject list for websocket usage.

schema_get

Object schema_get(opts)

Get model schemata for data objects returned by this API.

Example

# load the gem
require 'swagger_client'

api_instance = SwaggerClient::SchemaApi.new

opts = { 
  model: 'model_example' # String | Optional model filter. If omitted, will return all models.
}

begin
  #Get model schemata for data objects returned by this API.
  result = api_instance.schema_get(opts)
  p result
rescue SwaggerClient::ApiError => e
  puts "Exception when calling SchemaApi->schema_get: #{e}"
end

Parameters

Name	Type	Description	Notes
model	String	Optional model filter. If omitted, will return all models.	[optional]

Return type

Object

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

schema_websocket_help

Object schema_websocket_help

Returns help text & subject list for websocket usage.

Example

# load the gem
require 'swagger_client'

api_instance = SwaggerClient::SchemaApi.new

begin
  #Returns help text & subject list for websocket usage.
  result = api_instance.schema_websocket_help
  p result
rescue SwaggerClient::ApiError => e
  puts "Exception when calling SchemaApi->schema_websocket_help: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return type

Object

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