Net Position

Net Position APIs

method	path	description
GET	https://api.mstock.trade/openapi/typeb/portfolio/positions	view all their existing orders
POST	https://api.mstock.trade/openapi/typeb/portfolio/convertposition	Convert position

Net Position

This endpoint allows users to retrieve a list of their trading orders. Users can view all their existing orders

Request Headers -

X-Mirae-Version : Specifies the version of the API being used. In this case, it is set to 1.
Authorization : A token-based authentication header. The format is token api_key:jwtToken.
X-PrivateKey : api_key

cURLNode.jsPythonJava

curl --location 'https://api.mstock.trade/openapi/typeb/portfolio/positions' \
    --header 'X-Mirae-Version: 1' \
    --header 'X-PrivateKey: api_key' \
    --header 'Authorization: Bearer jwtToken'

import axios from 'axios';

const response = await axios.get('https://api.mstock.trade/openapi/typeb/portfolio/positions', {
headers: {
    'X-Mirae-Version': '1',
    'X-PrivateKey': 'api_key',
    'Authorization': 'Bearer jwtToken'
}
});

import http.client

conn = http.client.HTTPConnection('api.mstock.trade')
headers = {
    'X-Mirae-Version': '1',
    'X-PrivateKey': 'api_key',
    'Authorization': 'Bearer jwtToken',
}
conn.request('GET', 'openapi/typeb/portfolio/positions', headers=headers)
response = conn.getresponse()

import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

HttpClient client = HttpClient.newBuilder()
    .followRedirects(HttpClient.Redirect.NORMAL)
    .build();

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.mstock.trade/openapi/typeb/portfolio/positions"))
    .GET()
    .setHeader("X-Mirae-Version", "1")
    .setHeader("X-PrivateKey", "api_key")
    .setHeader("Authorization", "Bearer jwtToken")
    .build();

HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());

Request Body -

This endpoint does not require a request body or additional parameters in the query string for the retrieval of orders.

Response Structure -

The response of the request will be based on authentication outcome.

Success (HTTP Status 200): On successful retrieval, the server returns a JSON array of client positions.

{
    "status": "true",
    "message": "SUCCESS",
    "errorcode": "",
    "data": [
        {
            "exchange": "NSE",
            "symboltoken": "50374",
            "producttype": "INTRADAY",
            "tradingsymbol": "",
            "symbolname": "NIFTY-07Nov2024-24000-CE",
            "instrumenttype": "OPTIDX",
            "priceden": "",
            "pricenum": "",
            "genden": "",
            "gennum": "",
            "precision": "",
            "multiplier": "1",
            "boardlotsize": "",
            "buyqty": "100",
            "sellqty": "600",
            "buyamount": "800.1",
            "sellamount": "799.97",
            "symbolgroup": "",
            "strikeprice": "24000",
            "optiontype": "CE",
            "expirydate": "07-Nov-2024",
            "lotsize": "25",
            "cfbuyqty": "0",
            "cfsellqty": "0",
            "cfbuyamount": "",
            "cfsellamount": "",
            "buyavgprice": "800.1",
            "sellavgprice": "799.97",
            "avgnetprice": "799.94",
            "netvalue": "399970",
            "netqty": "-500",
            "totalbuyvalue": "80010",
            "totalsellvalue": "479980",
            "cfbuyavgprice": "0",
            "cfsellavgprice": "0",
            "totalbuyavgprice": "",
            "totalsellavgprice": "",
            "netprice": "799.94"
        },
        {
            "exchange": "NSE",
            "symboltoken": "50374",
            "producttype": "CARRYFORWARD",
            "tradingsymbol": "",
            "symbolname": "NIFTY-07Nov2024-24000-CE",
            "instrumenttype": "OPTIDX",
            "priceden": "",
            "pricenum": "",
            "genden": "",
            "gennum": "",
            "precision": "",
            "multiplier": "1",
            "boardlotsize": "",
            "buyqty": "150",
            "sellqty": "100",
            "buyamount": "800.1",
            "sellamount": "799.9",
            "symbolgroup": "",
            "strikeprice": "24000",
            "optiontype": "CE",
            "expirydate": "07-Nov-2024",
            "lotsize": "25",
            "cfbuyqty": "0",
            "cfsellqty": "0",
            "cfbuyamount": "",
            "cfsellamount": "",
            "buyavgprice": "800.1",
            "sellavgprice": "799.9",
            "avgnetprice": "800.5",
            "netvalue": "-40025",
            "netqty": "50",
            "totalbuyvalue": "120015",
            "totalsellvalue": "79990",
            "cfbuyavgprice": "0",
            "cfsellavgprice": "0",
            "totalbuyavgprice": "",
            "totalsellavgprice": "",
            "netprice": "800.5"
        }
    ]
}

- Failure (HTTP Status 401): If authentication fails, the server will return an error message

{
    "status": "false",
    "message": "Invalid request. Please try again.",
    "errorcode": "IA401",
    "data": null
}

Failure (HTTP Status 400): If the API Key is Invalid or expired.

{
    "status": "false",
    "message": "API is suspended/expired for use. Please check your API subscription and try again.",
    "errorcode": "IA403",
    "data": null
}

Position Converstion

Each position has one margin product. These products affect how the user's margin usage and free cash values are computed, and a user may wish to convert or change a position's margin product on timely basis.