Skip to main content

EXCHANGE MESSAGES

This API retrieves exchange-level messages, alerts, and broadcast notifications for a specific market segment. Results can be filtered by the number of recent hours and are returned in a paginated format.

🔗 Path Parameters

ParameterTypeRequiredDescriptionExample
tenantidstringYesUnique id provided for the tenant by SIPL"tenant001"
segmentIdstringYesMarket Segment Identifier"NSE_EQ"

🔍 Query Parameters

ParameterTypeRequiredDescriptionExample
userIdstringYesUser ID (UCC)"{{user_id}}"
noofhrsintegerNoFetch messages from the last specified number of hours1
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 exchange messages

📦 Exchange Message Fields

FieldTypeDescriptionExample
SegmentIdintegerMarket Segment ID1
TimestringTime of the exchange message"10:30:15"
MessagesstringExchange message text"Market will remain closed on account of..."

📝 Notes

  • Messages are often split across multiple consecutive records (e.g. a long corporate announcement broken into several Messages entries with the same Time) — you may need to concatenate related entries to reconstruct the full announcement text.
  • Always trim both null-byte padding and trailing whitespace before using Messages or Time values downstream.