Trading APIs

Holdings

Purpose

This function is used to provide the client’s holdings as of beginning of the day.

Request URL https://Openapi.5paisa.com/VendorsAPI/Service1.svc/V2/Holding

Request Method POST
Request format: JSON

Request Header Content-Type:application/json

Request Body

Header

Field Name Description Data Type (max length) Validation Sample Value
appName App Name provided at the time of registration String Cannot be empty. APPTRIAL
appVer Developer App Version String Cannot be empty. 1.0
key UserKey generated at the time of registration String Cannot be empty. ue73jHVeEzBswG5ss9ugyrAasdasdyKYxg
osName Channel of order String Cannot be Empty WEB, Android, iOS
requestCode Request Code of the API called String Cannot be Empty 5PMarginV3
userId User ID generated at the time of registration String Cannot be empty. asdue73jHVeE
password Password generated at the time of registration String Cannot be empty. 9ugyrAasdasdy

Body

Field Name Description Data Type (max length) Validation Sample Value
ClientCode Pass the registered client code of the user. String(10) Cannot be empty. 12345678

Response Body

Field Name Type Description
Exch char Gets the Exchange of the scrip.(N-Nse,B-Bse)
ExchType Char Exchange segment of the scrip (C-Cash, D-Derivative, U-Currency)
NseCode Integer NSE Scrip Code
BseCode Integer BSE Scrip Code
Symbol String Symbol of the scrip
FullName String Full Name of that Scrip
Quantity Long Available BOD quantity
CurrentPrice Double Current price of the share (symbol)
PoolQty Integer Qty of that scrip in Broker Beneficiary account
DPQty Integer Qty of that Scrip in Client’s DP account
POASigned Char Whether POA is Signed

Sample Request

{
    "head": {
    "appName": "APPTRIAL",
    "appVer": "1.0",
    "key": "ue73jH6AKVXeEzASDASD121BswG5ss9ugyrAyKYxg",
    "osName": "WEB",
    "requestCode": "5PHoldingV2",
    "userId": "s9RzKASACjdL9N",
    "password": "nznS4fDSASDA34zXw"
    },
    "body": {
    "ClientCode": "12345678"
    }
}

Sample Response

{
    "body": {
    "CacheTime": 300,
    "Data": [
    {
    "BseCode": 539437,
    "CurrentPrice": 53.2,
    "DPQty": 0,
    "Exch":"N",
    "ExchType":"C",
    "FullName": "IDFC FIRST BANK LIMITED",
    "NseCode": 11184,
    "POASigned": "N",
    "PoolQty": 1,
    "Quantity": 1,
    "ScripMultiplier": 1,
    "Symbol": "IDFCFIRSTB"
    },
    {
    "BseCode": 532081,
    "CurrentPrice": 0.19,
    "DPQty": 0,
    "Exch": "N",
    "ExchType": "C",
    "FullName": "KSS LIMITED",
    "NseCode": 13663,
    "POASigned": "N",
    "PoolQty": 10,
    "Quantity": 10,
    "ScripMultiplier": 1,
    "Symbol": "KSERASERA"
    },
    {
    "BseCode": 539351,
    "CurrentPrice": 75.25,
    "DPQty": 0,
    "Exch": "N",
    "ExchType": "C",
    "FullName": "Prabhat Dairy Limited",
    "NseCode": 10650,
    "POASigned": "N",
    "PoolQty": 1,
    "Quantity": 1,
    "ScripMultiplier": 1,
    "Symbol": "PRABHAT"
    }
    ],
    "Message": "Success",
    "Status": 0
    },
    "head": {
    "responseCode": "5PHoldingV2",
    "status": "0",
    "statusDescription": "Success"
    }
}