Skip to content

Limits

Limits contain all the details about cash available, margin used, collateral margin, pay in for the day, etc.

POST: /apiV2/limit

https://connect.thefirstock.com/apiV2/limit

Request Details

Parameter Description
userId User Id of the login user
jKey Key Obtained on login success.

Code

curl -X POST 'https://connect.thefirstock.com/apiV2/limit' \
-H 'Content-Type: application/json' \
-d '{
    "userId": "",
    "jKey": "",
}'

from thefirstock import thefirstock

limits = thefirstock.firstock_Limits()

const Firstock = require('thefirstock');

const firstock = new Firstock();

firstock.limits((err, result)=>{
    console.log("Error, ",err)
    console.log("Result: ",result)
})

using thefirstock;

class Program
{
public static void Main()
{
    Firstock firstock = new Firstock();
    var result = firstock.limits();
}
}

Response Success Details

Parameter Description
Status Success
data.requestTime Response received time.
data.payin Total Amount transferred using Payins today
data.payout Total amount requested for withdrawal today
data.marginused Total margin / fund used today
data.brkcollamt Prevalued Collateral Amount
data.peak_mar Peak margin used by the client
data.span Span used
data.expo Exposure margin
data.premium Premium used
data.collateral Collateral calculated based on uploaded holdings

Response Success Details

Parameter Description
Status Failed
data Type of error
requestTime Response received time.

Sample Response

{
"Status": "Success",
"data": {
        "requestTime": "20:01:33 11-10-2022",
        "cash": "500.00",
        "payin": "0.00",
        "marginused": "1.57",
        "brkcollamt": "0.00",
        "peak_mar": "197.06",
        "span": "0.00",
        "expo": "0.00",
        "premium": "0.00",
        "collateral": "0.00"
    }
}   

{
  "Status": "Failed",
  "data": "",
  "requestTime": ""
}