upstox-nodejs

UpstoxClient.PortfolioApi

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

Method	HTTP request	Description
convertPositions	PUT /portfolio/convert-position	Convert Positions
getHoldings	GET /portfolio/long-term-holdings	Get Holdings
getPositions	GET /portfolio/short-term-positions	Get Positions

convertPositions

ConvertPositionResponse convertPositions(body, apiVersion)

Convert Positions

Convert the margin product of an open position

Example

import {UpstoxClient} from 'upstox-js-sdk';
let defaultClient = UpstoxClient.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAUTH2
let OAUTH2 = defaultClient.authentications['OAUTH2'];
OAUTH2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new UpstoxClient.PortfolioApi();
let body = new UpstoxClient.ConvertPositionRequest(); // ConvertPositionRequest | 
let apiVersion = "apiVersion_example"; // String | API Version Header

apiInstance.convertPositions(body, apiVersion, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description	Notes
body	ConvertPositionRequest
apiVersion	String	API Version Header

Return type

ConvertPositionResponse

Authorization

OAUTH2

HTTP request headers

• Content-Type: application/json
• Accept: /, application/json

getHoldings

GetHoldingsResponse getHoldings(apiVersion)

Get Holdings

Fetches the holdings which the user has bought/sold in previous trading sessions.

Example

import {UpstoxClient} from 'upstox-js-sdk';
let defaultClient = UpstoxClient.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAUTH2
let OAUTH2 = defaultClient.authentications['OAUTH2'];
OAUTH2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new UpstoxClient.PortfolioApi();
let apiVersion = "apiVersion_example"; // String | API Version Header

apiInstance.getHoldings(apiVersion, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description	Notes
apiVersion	String	API Version Header

Return type

GetHoldingsResponse

Authorization

OAUTH2

HTTP request headers

• Content-Type: Not defined
• Accept: /, application/json

getPositions

GetPositionResponse getPositions(apiVersion)

Get Positions

Fetches the current positions for the user for the current day.

Example

import {UpstoxClient} from 'upstox-js-sdk';
let defaultClient = UpstoxClient.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAUTH2
let OAUTH2 = defaultClient.authentications['OAUTH2'];
OAUTH2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new UpstoxClient.PortfolioApi();
let apiVersion = "apiVersion_example"; // String | API Version Header

apiInstance.getPositions(apiVersion, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description	Notes
apiVersion	String	API Version Header

Return type

GetPositionResponse

Authorization

OAUTH2

HTTP request headers

• Content-Type: Not defined
• Accept: /, application/json