Skip to content
This repository has been archived by the owner on Nov 25, 2021. It is now read-only.

Latest commit

 

History

History
357 lines (262 loc) · 12.1 KB

PositionsApi.md

File metadata and controls

357 lines (262 loc) · 12.1 KB
Raw

BybitApi.PositionsApi

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

Method HTTP request Description
positionsChangeMargin POST /position/change-position-margin Update margin.
positionsClosePnlRecords GET /v2/private/trade/closed-pnl/list Get user's closed profit and loss records
positionsMyPosition GET /v2/private/position/list Get my position list.
positionsSaveLeverage POST /user/leverage/save Change user leverage.
positionsTradingStop POST /open-api/position/trading-stop Set Trading-Stop Condition.

positionsChangeMargin

Object positionsChangeMargin(symbol, margin)

Update margin.

Example

var BybitApi = require('bybit_api');
var defaultClient = BybitApi.ApiClient.instance;

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

// Configure API key authorization: apiSignature
var apiSignature = defaultClient.authentications['apiSignature'];
apiSignature.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiSignature.apiKeyPrefix = 'Token';

// Configure API key authorization: timestamp
var timestamp = defaultClient.authentications['timestamp'];
timestamp.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//timestamp.apiKeyPrefix = 'Token';

var apiInstance = new BybitApi.PositionsApi();

var symbol = "symbol_example"; // String | Contract type which you want update its margin

var margin = "margin_example"; // String | New margin you want set


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.positionsChangeMargin(symbol, margin, callback);

Parameters

Name Type Description Notes
symbol String Contract type which you want update its margin
margin String New margin you want set

Return type

Object

Authorization

apiKey, apiSignature, timestamp

HTTP request headers

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

positionsClosePnlRecords

Object positionsClosePnlRecords(symbol, opts)

Get user's closed profit and loss records

Example

var BybitApi = require('bybit_api');
var defaultClient = BybitApi.ApiClient.instance;

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

// Configure API key authorization: apiSignature
var apiSignature = defaultClient.authentications['apiSignature'];
apiSignature.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiSignature.apiKeyPrefix = 'Token';

// Configure API key authorization: timestamp
var timestamp = defaultClient.authentications['timestamp'];
timestamp.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//timestamp.apiKeyPrefix = 'Token';

var apiInstance = new BybitApi.PositionsApi();

var symbol = "symbol_example"; // String | Contract type

var opts = { 
  'startTime': 56, // Number | Start timestamp point for result, in second
  'endTime': 56, // Number | End timestamp point for result, in second
  'execType': "execType_example", // String | Execution type
  'page': 56, // Number | Page. By default, gets first page of data. Maximum of 50 pages
  'limit': 56 // Number | Limit for data size per page, max size is 50. Default as showing 20 pieces of data per page.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.positionsClosePnlRecords(symbol, opts, callback);

Parameters

Name Type Description Notes
symbol String Contract type
startTime Number Start timestamp point for result, in second [optional]
endTime Number End timestamp point for result, in second [optional]
execType String Execution type [optional]
page Number Page. By default, gets first page of data. Maximum of 50 pages [optional]
limit Number Limit for data size per page, max size is 50. Default as showing 20 pieces of data per page. [optional]

Return type

Object

Authorization

apiKey, apiSignature, timestamp

HTTP request headers

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

positionsMyPosition

Object positionsMyPosition(opts)

Get my position list.

Example

var BybitApi = require('bybit_api');
var defaultClient = BybitApi.ApiClient.instance;

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

// Configure API key authorization: apiSignature
var apiSignature = defaultClient.authentications['apiSignature'];
apiSignature.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiSignature.apiKeyPrefix = 'Token';

// Configure API key authorization: timestamp
var timestamp = defaultClient.authentications['timestamp'];
timestamp.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//timestamp.apiKeyPrefix = 'Token';

var apiInstance = new BybitApi.PositionsApi();

var opts = { 
  'symbol': "symbol_example" // String | Contract type which you want update its margin
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.positionsMyPosition(opts, callback);

Parameters

Name Type Description Notes
symbol String Contract type which you want update its margin [optional]

Return type

Object

Authorization

apiKey, apiSignature, timestamp

HTTP request headers

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

positionsSaveLeverage

Object positionsSaveLeverage(symbol, leverage)

Change user leverage.

Example

var BybitApi = require('bybit_api');
var defaultClient = BybitApi.ApiClient.instance;

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

// Configure API key authorization: apiSignature
var apiSignature = defaultClient.authentications['apiSignature'];
apiSignature.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiSignature.apiKeyPrefix = 'Token';

// Configure API key authorization: timestamp
var timestamp = defaultClient.authentications['timestamp'];
timestamp.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//timestamp.apiKeyPrefix = 'Token';

var apiInstance = new BybitApi.PositionsApi();

var symbol = "symbol_example"; // String | A symbol which you want change its leverage

var leverage = "leverage_example"; // String | New leverage you want set


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.positionsSaveLeverage(symbol, leverage, callback);

Parameters

Name Type Description Notes
symbol String A symbol which you want change its leverage
leverage String New leverage you want set

Return type

Object

Authorization

apiKey, apiSignature, timestamp

HTTP request headers

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

positionsTradingStop

Object positionsTradingStop(symbol, opts)

Set Trading-Stop Condition.

Example

var BybitApi = require('bybit_api');
var defaultClient = BybitApi.ApiClient.instance;

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

// Configure API key authorization: apiSignature
var apiSignature = defaultClient.authentications['apiSignature'];
apiSignature.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiSignature.apiKeyPrefix = 'Token';

// Configure API key authorization: timestamp
var timestamp = defaultClient.authentications['timestamp'];
timestamp.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//timestamp.apiKeyPrefix = 'Token';

var apiInstance = new BybitApi.PositionsApi();

var symbol = "symbol_example"; // String | Contract type

var opts = { 
  'takeProfit': "takeProfit_example", // String | Not less than 0, 0 means cancel TP
  'stopLoss': "stopLoss_example", // String | Not less than 0, 0 means cancel SL
  'trailingStop': "trailingStop_example", // String | Not less than 0, 0 means cancel TS
  'newTrailingActive': "newTrailingActive_example" // String | Trailing stop trigger price. Trailing stops are triggered only when the price reaches the specified price. Trailing stops are triggered immediately by default.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.positionsTradingStop(symbol, opts, callback);

Parameters

Name Type Description Notes
symbol String Contract type
takeProfit String Not less than 0, 0 means cancel TP [optional]
stopLoss String Not less than 0, 0 means cancel SL [optional]
trailingStop String Not less than 0, 0 means cancel TS [optional]
newTrailingActive String Trailing stop trigger price. Trailing stops are triggered only when the price reaches the specified price. Trailing stops are triggered immediately by default. [optional]

Return type

Object

Authorization

apiKey, apiSignature, timestamp

HTTP request headers

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