Skip to main content

RECOMMENDATIONS

This API retrieves broker-generated trading recommendations and investment ideas based on the categories available to the user.

🔗 Path Parameters

ParameterTypeRequiredDescriptionExample
tenantidstringYesUnique id provided for the tenant by SIPL"tenant001"

🔍 Query Parameters

ParameterTypeRequiredDescriptionExample
userIdstringYesUser ID (UCC)"{{user_id}}"
allowedNewsCatstringNoComma-separated list of allowed recommendation/news categories"25014,25033,25000,25035,25034,25039"
pageNointegerNoPage number for pagination1
pageSizeintegerNoNumber of records per page10

🔑 Header Parameters

HeaderTypeDescriptionExample
Content-TypestringRequest payload formatapplication/json
AuthorizationstringAccess token for authenticated requests{{access_token}}
x-api-keystringAPI key used to authorize request{{x-api-key}}

🟢 Success Response - 200 OK

Content-Type: application/json

FieldTypeDescription
statusbooleanStatus of API call
resultarrayList of broker recommendations

📦 Recommendation Fields

FieldTypeDescriptionExample
sRecoTagstringFree-text tag assigned to the recommendation"Short Term Buy"
sRecoIdstringUnique recommendation identifier"REC12345"
sScripDescstringScrip description"INFOSYS LTD"
nMarketSegmentIdintegerMarket Segment ID1
nTokenintegerExchange token number of the scrip1594
nRecoTypeintegerRecommendation type1 = Buy, 2 = Sell
sRecoDetailsstringRecommendation details — an XML string embedded inside this text fieldSee note below
sSourceintegerRecommendation source identifier1
IDstringRecord ID"98765"
LastModifystringLast modified date/time"2022-04-02T00:26:17.390Z"
nTotalNoRecordsintegerTotal number of available recommendation records125
nExpiryDatestringRecommendation expiry date"2022-04-02T23:59:00.000Z"

📝 Notes

  • sRecoDetails requires XML parsing to extract structured recommendation data (entry price, stop-loss, square-off targets).
  • Timestamps (LastModify, nExpiryDate) are in UTC — convert to local time as needed for display.