Skip to content
Announcements and Disclosures

Get Announcement Details

Returns the full information of one announcement, including all files and their names, key points, and the related security name. The announcement detail page and the announcement file list use it. The Broker App opens the main file in file_urls or detail_url, and lists every separate file from file_details.

GEThttps://api.lbkrs.com/v1/notices/{id}

Parameters

idstringpathRequired

Announcement ID, taken from id in the announcement list

Responses

HTTP 200The request succeeded. The response body contains the result of the “Get Announcement Details” operation.
Standard response envelopecodemessagedata
dataobjectdata structure

Announcement

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

stock_namestring

Name of the related security

file_detailsarray<object>

Separate files of the announcement. The first item is the main file

Child attributes
namestring

File name

urlstring

File URL

Whale Docs