Skip to main content

Market_Connect

Span Calculator

The Span Calculator API provides you with the capability to determine the margin requirement for your portfolio prior to executing any trades.

Method: POST​

https://connect-go.thefirstock.tech/api/V5/spanCalculators

Request details

API Parameters
Parameter Type Mandatory Example
userId String Yes NP2997
jKey String Yes abc123

Libraries and SDKs

Tabbed Interface 
curl --location 'https://connect-go.thefirstock.tech/api/V5
/spanCalculators' \
--header 'User-Agent: Apidog/1.0.0 (https://apidog.com)' \
--header 'Content-Type: application/json' \
--data '{
    "userId": "NP2997",
    "jKey": "1478b9b71707210d8851258599b23a6a73d31b19809ac5068560f38dad493d35",
    "data": [
        {
            "exchange": "NFO",
            "symbolName": "NIFTY",
            "expireDate": "13-MAR-2025",
            "instrumentName": "OPTIDX",
            "optionType": "PE",
            "strikePrice": "22300",
            "netQuantity": "1800"
        }
    ]
}'

Success response details

API Parameters
Parameter Description Example
status
string		 Status of the API request indicating
success		 success
data.status
string		 Specific status of the response,
indicating 'Ok'		 ok
data.requestTime
string		 Time at which the response was
received		 17:38:33 17-02-2023
data.span
string		 Span margin value 83866.00
data.expo
string		 Exposure margin value 17954.10
data.span_trade
string		 Span margin after trade 83866.00
data.expo_trade
String		 Exposure margin after trade 17954.10 
{
    "status": "success",
    "data": {
        "marginList": [
            {
                "expo": "0.00",
                "expo_trade": "0.00",
                "requestTime": "14:52:00 12-03-2025",
                "span": "0.00",
                "span_trade": "0.00"
            }
        ],
        "totalValue": {
            "expo": "0.00",
            "expo_trade": "0.00",
            "requestTime": "14:52:00 12-03-2025",
            "span": "0.00",
            "span_trade": "0.00"
        }
    }
}

Failure response details

API Error Parameters
Parameter Description Example
status
String 		Indicates the result status of the API operation failed
code
String 		HTTP status code associated with the error 401
name
String 		Specifies the type or category of the error encountered INVALID_JKEY
error.field
String 		Field in the request that triggered the error jkey
error.message
String 		Detailed message describing the error jKey parameter is invalid 
{
  "status": "failed",
  "code": "401",
  "name": "SESSION_EXPIRED",
  "error": {
      "field": "jKey",
      "message": "Session key has been expired, please login in again"
  }
}