Net Position

Net Position APIs

method	path	description
GET	https://api.mstock.trade/openapi/typea/portfolio/positions	view all their existing orders
POST	https://api.mstock.trade/openapi/typea/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:access_token.

cURLNode.jsPythonJava

curl --location 'https://api.mstock.trade/openapi/typea/portfolio/positions' \
    --header 'X-Mirae-Version: 1' \
    --header 'Authorization: token api_key:access_token'\

import axios from 'axios';

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

import requests

headers = {
    'X-Mirae-Version': '1',
    'Authorization': 'token api_key:access_token',
}

response = requests.get('https://api.mstock.trade/openapi/typea/portfolio/positions', headers=headers)

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/typea/portfolio/positions"))
    .GET()
    .setHeader("X-Mirae-Version", "1")
    .setHeader("Authorization", "token api_key:access_token")
    .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": "success",
    "data": {
        "net": [
            {
                "tradingsymbol": "YESBANK",
                "exchange": "NSE",
                "instrument_token": 11915,
                "product": "",
                "quantity": 100,
                "overnight_quantity": 0,
                "multiplier": 1,
                "average_price": 19.05,
                "close_price": 27.65,
                "last_price": 27.65,
                "value": 1905,
                "pnl": 0,
                "m2m": 860,
                "unrealised": 0,
                "realised": 0,
                "buy_quantity": 100,
                "buy_price": 19.05,
                "buy_value": 1905,
                "buy_m2m": 0,
                "sell_quantity": 0,
                "sell_price": 0,
                "sell_value": 0,
                "sell_m2m": 0,
                "day_buy_quantity": 100,
                "day_buy_price": 19.05,
                "day_buy_value": 1905,
                "day_sell_quantity": 0,
                "day_sell_price": 0,
                "day_sell_value": 0
            },
            {
                "tradingsymbol": "IDEA",
                "exchange": "NSE",
                "instrument_token": 14366,
                "product": "",
                "quantity": 4,
                "overnight_quantity": 0,
                "multiplier": 1,
                "average_price": 100,
                "close_price": 16.55,
                "last_price": 16.55,
                "value": 400,
                "pnl": 0,
                "m2m": -333.8,
                "unrealised": 0,
                "realised": 0,
                "buy_quantity": 4,
                "buy_price": 100,
                "buy_value": 400,
                "buy_m2m": 0,
                "sell_quantity": 0,
                "sell_price": 0,
                "sell_value": 0,
                "sell_m2m": 0,
                "day_buy_quantity": 4,
                "day_buy_price": 100,
                "day_buy_value": 400,
                "day_sell_quantity": 0,
                "day_sell_price": 0,
                "day_sell_value": 0
            }
        ],
        "day": null
    }
}

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

{
    "status": "error",
    "message": "Please provide valid api version.",
    "error_type": "VersionException",
    "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.