Skip to main content

Recommendations

Fetch broker-sent recommendations filtered by tenant and allowed news categories. Supports pagination and provides detailed info about each recommendation.

🛣️ Path Parameter

ParameterTypeDescriptionExample/ENUM
tenantidstringUnique identifier for tenant"TENANT001"

🔍Query Parameters

ParameterTypeDescriptionExample/ENUM
allowedNewsCatstringComma-separated allowed news category IDs"25014,25033,25000,25035,25034,25039"
pageNointegerPage number for paginated results1
pageSizeintegerNumber of records per page10

🔑Header Parameters

HeaderTypeDescriptionExample/ENUM
AuthorizationstringBearer token used for authenticationBearer {{access_token}}
Content-TypestringSpecifies media type of request bodyapplication/json
x-api-keystringAPI key for endpoint access{{x-api-key}}

🟢Success Response - 200 Ok

FieldTypeDescriptionExample/ENUM
statusbooleanIndicates API call resulttrue
resultarrayList of recommendationsSee details below

📄 Result Object Fields

FieldTypeDescriptionExample/ENUM
sRecoTagstringTag/category for the recommendation"Momentum Pick"
sRecoIdstringUnique ID for the recommendation"RECO12345"
sScripDescstringDescription of the stock/scrip"NSE Equities INFY EQ"
nMarketSegmentIdintegerSegment ID of the market1
nTokenintegerExchange token ID for the scrip123456
nRecoTypeinteger (enum)Recommendation Type: 1 = Buy, 2 = Sell1
sRecoDetailsstringDetailed text of the recommendation<RecoDetails><RecoChild sRecoId="028WABDYAA" sLongShort="L" SubTypeID="101" sSubTypes="..." />
sSourceinteger (enum)Source of recommendation: 1 = Internal, 2 = External1
IDstringInternal system ID"a1b2c3d4"
LastModifystring (ISO 8601)Last updated timestamp"2025-06-10T10:30:00Z"
nExpiryDatestring (ISO 8601)Expiry of recommendation"2025-06-20"
nTotalNoRecordsintegerTotal records available for the query250
get/nontransactional/{tenantid}/v1/recommendation