SWGMarketApi

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

Method	HTTP request	Description
marketAccountRatio	GET /v2/public/account-ratio	Query Account Long Short Ratio
marketBigDeal	GET /v2/public/big-deal	Query Big Deal
marketLiqRecords	GET /v2/public/liq-records	Query liq records.
marketOpenInterest	GET /v2/public/open-interest	Query Open Interest
marketOrderbook	GET /v2/public/orderBook/L2	Get the orderbook.
marketSymbolInfo	GET /v2/public/tickers	Get the latest information for symbol.
marketTradingRecords	GET /v2/public/trading-records	Get recent trades

marketAccountRatio

-(NSURLSessionTask*) marketAccountRatioWithSymbol: (NSString*) symbol
    period: (NSString*) period
    limit: (NSNumber*) limit
        completionHandler: (void (^)(NSObject* output, NSError* error)) handler;

Query Account Long Short Ratio

Example

NSString* symbol = @"symbol_example"; // Contract type.
NSString* period = @"period_example"; // Data recording period. 5min, 15min, 30min, 1h, 4h, 1d
NSNumber* limit = @56; // Limit for data size, max size is 500. Default size is 50 (optional)

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

// Query Account Long Short Ratio
[apiInstance marketAccountRatioWithSymbol:symbol
              period:period
              limit:limit
          completionHandler: ^(NSObject* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling SWGMarketApi->marketAccountRatio: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
symbol	NSString*	Contract type.
period	NSString*	Data recording period. 5min, 15min, 30min, 1h, 4h, 1d
limit	NSNumber*	Limit for data size, max size is 500. Default size is 50	[optional]

Return type

NSObject*

Authorization

No authorization required

HTTP request headers

Content-Type: application/json, application/x-www-form-urlencoded
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

marketBigDeal

-(NSURLSessionTask*) marketBigDealWithSymbol: (NSString*) symbol
    limit: (NSNumber*) limit
        completionHandler: (void (^)(NSObject* output, NSError* error)) handler;

Query Big Deal

Example

NSString* symbol = @"symbol_example"; // Contract type.
NSNumber* limit = @56; // Limit for data size, max size is 1000. Default size is 500 (optional)

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

// Query Big Deal
[apiInstance marketBigDealWithSymbol:symbol
              limit:limit
          completionHandler: ^(NSObject* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling SWGMarketApi->marketBigDeal: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
symbol	NSString*	Contract type.
limit	NSNumber*	Limit for data size, max size is 1000. Default size is 500	[optional]

Return type

NSObject*

Authorization

No authorization required

HTTP request headers

Content-Type: application/json, application/x-www-form-urlencoded
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

marketLiqRecords

-(NSURLSessionTask*) marketLiqRecordsWithSymbol: (NSString*) symbol
    from: (NSNumber*) from
    limit: (NSNumber*) limit
    startTime: (NSNumber*) startTime
    endTime: (NSNumber*) endTime
        completionHandler: (void (^)(NSObject* output, NSError* error)) handler;

Query liq records.

Example

NSString* symbol = @"symbol_example"; // Contract type.
NSNumber* from = @56; // From ID. Default: return latest data (optional)
NSNumber* limit = @56; // Limit for data size, max size is 1000. Default size is 500 (optional)
NSNumber* startTime = @56; // Start timestamp point for result, in millisecond (optional)
NSNumber* endTime = @56; // End timestamp point for result, in millisecond (optional)

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

// Query liq records.
[apiInstance marketLiqRecordsWithSymbol:symbol
              from:from
              limit:limit
              startTime:startTime
              endTime:endTime
          completionHandler: ^(NSObject* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling SWGMarketApi->marketLiqRecords: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
symbol	NSString*	Contract type.
from	NSNumber*	From ID. Default: return latest data	[optional]
limit	NSNumber*	Limit for data size, max size is 1000. Default size is 500	[optional]
startTime	NSNumber*	Start timestamp point for result, in millisecond	[optional]
endTime	NSNumber*	End timestamp point for result, in millisecond	[optional]

Return type

NSObject*

Authorization

No authorization required

HTTP request headers

Content-Type: application/json, application/x-www-form-urlencoded
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

marketOpenInterest

-(NSURLSessionTask*) marketOpenInterestWithSymbol: (NSString*) symbol
    period: (NSString*) period
    limit: (NSNumber*) limit
        completionHandler: (void (^)(NSObject* output, NSError* error)) handler;

Query Open Interest

Example

NSString* symbol = @"symbol_example"; // Contract type.
NSString* period = @"period_example"; // Data recording period. 5min, 15min, 30min, 1h, 4h, 1d
NSNumber* limit = @56; // Limit for data size, max size is 200. Default size is 50 (optional)

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

// Query Open Interest
[apiInstance marketOpenInterestWithSymbol:symbol
              period:period
              limit:limit
          completionHandler: ^(NSObject* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling SWGMarketApi->marketOpenInterest: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
symbol	NSString*	Contract type.
period	NSString*	Data recording period. 5min, 15min, 30min, 1h, 4h, 1d
limit	NSNumber*	Limit for data size, max size is 200. Default size is 50	[optional]

Return type

NSObject*

Authorization

No authorization required

HTTP request headers

Content-Type: application/json, application/x-www-form-urlencoded
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

marketOrderbook

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

Get the orderbook.

Example

NSString* symbol = @"symbol_example"; // Contract type.

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

// Get the orderbook.
[apiInstance marketOrderbookWithSymbol:symbol
          completionHandler: ^(NSObject* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling SWGMarketApi->marketOrderbook: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
symbol	NSString*	Contract type.

Return type

NSObject*

Authorization

No authorization required

HTTP request headers

Content-Type: application/json, application/x-www-form-urlencoded
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

marketSymbolInfo

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

Get the latest information for symbol.

Example

NSString* symbol = @"symbol_example"; // Contract type. (optional)

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

// Get the latest information for symbol.
[apiInstance marketSymbolInfoWithSymbol:symbol
          completionHandler: ^(NSObject* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling SWGMarketApi->marketSymbolInfo: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
symbol	NSString*	Contract type.	[optional]

Return type

NSObject*

Authorization

No authorization required

HTTP request headers

Content-Type: application/json, application/x-www-form-urlencoded
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

marketTradingRecords

-(NSURLSessionTask*) marketTradingRecordsWithSymbol: (NSString*) symbol
    from: (NSNumber*) from
    limit: (NSNumber*) limit
        completionHandler: (void (^)(NSObject* output, NSError* error)) handler;

Get recent trades

Example

NSString* symbol = @"symbol_example"; // Contract type.
NSNumber* from = @56; // From ID. Default: return latest data (optional)
NSNumber* limit = @56; // Number of results. Default 500; max 1000 (optional)

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

// Get recent trades
[apiInstance marketTradingRecordsWithSymbol:symbol
              from:from
              limit:limit
          completionHandler: ^(NSObject* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling SWGMarketApi->marketTradingRecords: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
symbol	NSString*	Contract type.
from	NSNumber*	From ID. Default: return latest data	[optional]
limit	NSNumber*	Number of results. Default 500; max 1000	[optional]

Return type

NSObject*

Authorization

No authorization required

HTTP request headers

Content-Type: application/json, application/x-www-form-urlencoded
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

SWGMarketApi.md

Latest commit

History

SWGMarketApi.md

File metadata and controls

SWGMarketApi

marketAccountRatio

Example

Parameters

Return type

Authorization

HTTP request headers

marketBigDeal

Example

Parameters

Return type

Authorization

HTTP request headers

marketLiqRecords

Example

Parameters

Return type

Authorization

HTTP request headers

marketOpenInterest

Example

Parameters

Return type

Authorization

HTTP request headers

marketOrderbook

Example

Parameters

Return type

Authorization

HTTP request headers

marketSymbolInfo

Example

Parameters

Return type

Authorization

HTTP request headers

marketTradingRecords

Example

Parameters

Return type

Authorization

HTTP request headers