Skip to content
Announcements and Disclosures

List Security Announcements

Returns paged company announcements by security, market, and announcement category, for the Announcements list under News on the security detail page, including pull-up loading.

On the first request, send the current time in milliseconds as tail_mark. For the next page, send tail_mark from the previous response. If fewer than size items return, treat the page as the last one.

GEThttps://api.lbkrs.com/v1/notices

Parameters

counter_idstringqueryRequired

Security ID in the format ST/<market>/<code>, such as ST/US/ROKU

marketstringqueryRequired

Market of the security, such as US or HK

categoryintegerquery

Announcement category value. 0 means all categories

sizeintegerqueryRequired

Items per page. The Broker App sends 10

tail_markstringquery

Pagination cursor. Send the current time in milliseconds on the first request, then tail_mark from the previous response

Responses

HTTP 200The request succeeded. The response body contains the result of the “List Security Announcements” operation.
Standard response envelopecodemessagedata
dataobjectdata structure
noticesarray<object>

Announcements

Child attributes
idstring

Announcement ID

titlestring

Announcement title

descriptionstring

Short description of the announcement

categoryinteger

Announcement category value

marketsarray<string>

Markets the announcement relates to, such as US

counter_idsarray<string>

IDs of the securities the announcement relates to

file_namestring

Display name of the main file

file_urlsarray<string>

Announcement file URLs. The first item is the main file

share_urlstring

Share URL. Can be empty

detail_urlstring

Announcement detail page URL. Can be empty

publish_atstring

Publication time as a Unix timestamp, in seconds

publish_at_with_timezonestring

Publication time string with time zone

description_itemsarray<string>

Key points of the announcement, such as the Items in an 8-K filing

summary_itemsarray<string>

Summary entries for the announcement. The Broker App shows them in an expandable area in the list

tail_markstring

Pagination cursor for the next page

Whale Docs