SWGWalletApi

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

Method	HTTP request	Description
walletExchangeOrder	GET /v2/private/exchange-order/list	Asset Exchange Records
walletGetBalance	GET /v2/private/wallet/balance	get wallet balance info
walletGetRecords	GET /open-api/wallet/fund/records	Get wallet fund records
walletGetRiskLimit	GET /open-api/wallet/risk-limit/list	Get risk limit.
walletSetRiskLimit	POST /open-api/wallet/risk-limit	Set risk limit
walletWithdraw	GET /open-api/wallet/withdraw/list	Get wallet fund records

walletExchangeOrder

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

Asset Exchange Records

Example

SWGDefaultConfiguration *apiConfig = [SWGDefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: apiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"api_key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"api_key"];

// Configure API key authorization: (authentication scheme: apiSignature)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sign"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sign"];

// Configure API key authorization: (authentication scheme: timestamp)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"timestamp"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"timestamp"];


NSNumber* limit = @8.14; // Limit for data size per page, max size is 50. Default as showing 20 pieces of data per page (optional)
NSNumber* from = @8.14; // Start ID. By default, returns the latest IDs (optional)
NSString* direction = @"direction_example"; // Search direction. Prev: searches in ascending order from start ID, Next: searches in descending order from start ID. Defaults to Next (optional)

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

// Asset Exchange Records
[apiInstance walletExchangeOrderWithLimit:limit
              from:from
              direction:direction
          completionHandler: ^(NSObject* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling SWGWalletApi->walletExchangeOrder: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
limit	NSNumber*	Limit for data size per page, max size is 50. Default as showing 20 pieces of data per page	[optional]
from	NSNumber*	Start ID. By default, returns the latest IDs	[optional]
direction	NSString*	Search direction. Prev: searches in ascending order from start ID, Next: searches in descending order from start ID. Defaults to Next	[optional]

Return type

NSObject*

Authorization

apiKey, apiSignature, timestamp

HTTP request headers

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

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

walletGetBalance

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

get wallet balance info

Example

SWGDefaultConfiguration *apiConfig = [SWGDefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: apiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"api_key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"api_key"];

// Configure API key authorization: (authentication scheme: apiSignature)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sign"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sign"];

// Configure API key authorization: (authentication scheme: timestamp)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"timestamp"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"timestamp"];


NSString* coin = @"coin_example"; // Coin.enum {BTC,EOS,XRP,ETH,USDT} (optional)

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

// get wallet balance info
[apiInstance walletGetBalanceWithCoin:coin
          completionHandler: ^(NSObject* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling SWGWalletApi->walletGetBalance: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
coin	NSString*	Coin.enum {BTC,EOS,XRP,ETH,USDT}	[optional]

Return type

NSObject*

Authorization

apiKey, apiSignature, timestamp

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]

walletGetRecords

-(NSURLSessionTask*) walletGetRecordsWithStartDate: (NSString*) startDate
    endDate: (NSString*) endDate
    currency: (NSString*) currency
    walletFundType: (NSString*) walletFundType
    page: (NSString*) page
    limit: (NSString*) limit
        completionHandler: (void (^)(NSObject* output, NSError* error)) handler;

Get wallet fund records

Example

SWGDefaultConfiguration *apiConfig = [SWGDefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: apiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"api_key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"api_key"];

// Configure API key authorization: (authentication scheme: apiSignature)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sign"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sign"];

// Configure API key authorization: (authentication scheme: timestamp)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"timestamp"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"timestamp"];


NSString* startDate = @"startDate_example"; // Start point for result (optional)
NSString* endDate = @"endDate_example"; // End point for result (optional)
NSString* currency = @"currency_example"; // Currency type (optional)
NSString* walletFundType = @"walletFundType_example"; // wallet fund type (optional)
NSString* page = @"page_example"; // Page. Default getting first page data (optional)
NSString* limit = @"limit_example"; // Limit for data size per page, max size is 50. Default as showing 20 pieces of data per page (optional)

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

// Get wallet fund records
[apiInstance walletGetRecordsWithStartDate:startDate
              endDate:endDate
              currency:currency
              walletFundType:walletFundType
              page:page
              limit:limit
          completionHandler: ^(NSObject* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling SWGWalletApi->walletGetRecords: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
startDate	NSString*	Start point for result	[optional]
endDate	NSString*	End point for result	[optional]
currency	NSString*	Currency type	[optional]
walletFundType	NSString*	wallet fund type	[optional]
page	NSString*	Page. Default getting first page data	[optional]
limit	NSString*	Limit for data size per page, max size is 50. Default as showing 20 pieces of data per page	[optional]

Return type

NSObject*

Authorization

apiKey, apiSignature, timestamp

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]

walletGetRiskLimit

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

Get risk limit.

Example

SWGDefaultConfiguration *apiConfig = [SWGDefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: apiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"api_key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"api_key"];

// Configure API key authorization: (authentication scheme: apiSignature)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sign"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sign"];

// Configure API key authorization: (authentication scheme: timestamp)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"timestamp"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"timestamp"];



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

// Get risk limit.
[apiInstance walletGetRiskLimitWithCompletionHandler: 
          ^(NSObject* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling SWGWalletApi->walletGetRiskLimit: %@", error);
                        }
                    }];

Parameters

This endpoint does not need any parameter.

Return type

NSObject*

Authorization

apiKey, apiSignature, timestamp

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]

walletSetRiskLimit

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

Set risk limit

Example

SWGDefaultConfiguration *apiConfig = [SWGDefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: apiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"api_key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"api_key"];

// Configure API key authorization: (authentication scheme: apiSignature)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sign"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sign"];

// Configure API key authorization: (authentication scheme: timestamp)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"timestamp"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"timestamp"];


NSString* symbol = @"symbol_example"; // Contract type.
NSNumber* riskId = @8.14; // Risk ID. Can be found with the Get risk limit list endpoint.

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

// Set risk limit
[apiInstance walletSetRiskLimitWithSymbol:symbol
              riskId:riskId
          completionHandler: ^(NSObject* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling SWGWalletApi->walletSetRiskLimit: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
symbol	NSString*	Contract type.
riskId	NSNumber*	Risk ID. Can be found with the Get risk limit list endpoint.

Return type

NSObject*

Authorization

apiKey, apiSignature, timestamp

HTTP request headers

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

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

walletWithdraw

-(NSURLSessionTask*) walletWithdrawWithStartDate: (NSString*) startDate
    endDate: (NSString*) endDate
    coin: (NSString*) coin
    status: (NSString*) status
    page: (NSString*) page
    limit: (NSString*) limit
        completionHandler: (void (^)(NSObject* output, NSError* error)) handler;

Get wallet fund records

Example

SWGDefaultConfiguration *apiConfig = [SWGDefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: apiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"api_key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"api_key"];

// Configure API key authorization: (authentication scheme: apiSignature)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sign"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sign"];

// Configure API key authorization: (authentication scheme: timestamp)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"timestamp"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"timestamp"];


NSString* startDate = @"startDate_example"; // Start point for result (optional)
NSString* endDate = @"endDate_example"; // End point for result (optional)
NSString* coin = @"coin_example"; // Currency (optional)
NSString* status = @"status_example"; // Withdraw status (optional)
NSString* page = @"page_example"; // Page. Default getting first page data (optional)
NSString* limit = @"limit_example"; // Limit for data size per page, max size is 50. Default as showing 20 pieces of data per page (optional)

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

// Get wallet fund records
[apiInstance walletWithdrawWithStartDate:startDate
              endDate:endDate
              coin:coin
              status:status
              page:page
              limit:limit
          completionHandler: ^(NSObject* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling SWGWalletApi->walletWithdraw: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
startDate	NSString*	Start point for result	[optional]
endDate	NSString*	End point for result	[optional]
coin	NSString*	Currency	[optional]
status	NSString*	Withdraw status	[optional]
page	NSString*	Page. Default getting first page data	[optional]
limit	NSString*	Limit for data size per page, max size is 50. Default as showing 20 pieces of data per page	[optional]

Return type

NSObject*

Authorization

apiKey, apiSignature, timestamp

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

SWGWalletApi.md

Latest commit

History

SWGWalletApi.md

File metadata and controls

SWGWalletApi

walletExchangeOrder

Example

Parameters

Return type

Authorization

HTTP request headers

walletGetBalance

Example

Parameters

Return type

Authorization

HTTP request headers

walletGetRecords

Example

Parameters

Return type

Authorization

HTTP request headers

walletGetRiskLimit

Example

Parameters

Return type

Authorization

HTTP request headers

walletSetRiskLimit

Example

Parameters

Return type

Authorization

HTTP request headers

walletWithdraw

Example

Parameters

Return type

Authorization

HTTP request headers