SWGSchemaApi.md

SWGSchemaApi

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

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

schemaGet

-(NSURLSessionTask*) schemaGetWithModel: (NSString*) model
        completionHandler: (void (^)(NSObject* output, NSError* error)) handler;

Get model schemata for data objects returned by this API.

Example

NSString* model = @"model_example"; // Optional model filter. If omitted, will return all models. (optional)

SWGSchemaApi*apiInstance = [[SWGSchemaApi alloc] init];

// Get model schemata for data objects returned by this API.
[apiInstance schemaGetWithModel:model
          completionHandler: ^(NSObject* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling SWGSchemaApi->schemaGet: %@", error);
                        }
                    }];

Parameters

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

Return type

NSObject*

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]

schemaWebsocketHelp

-(NSURLSessionTask*) schemaWebsocketHelpWithCompletionHandler: 
        (void (^)(NSObject* output, NSError* error)) handler;

Returns help text & subject list for websocket usage.

Example

SWGSchemaApi*apiInstance = [[SWGSchemaApi alloc] init];

// Returns help text & subject list for websocket usage.
[apiInstance schemaWebsocketHelpWithCompletionHandler: 
          ^(NSObject* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling SWGSchemaApi->schemaWebsocketHelp: %@", error);
                        }
                    }];

Parameters

This endpoint does not need any parameter.

Return type

NSObject*

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]