Skip to content
Security Details

Get Pinned Security Activities

Retrieves the pinned activities shown at the top of a security detail page, such as pinned news, dividend and earnings event reminders, ticker change notices, and daily event digests, in the order returned by the server. Use style to decide whether to show the title, time, and description, and open redirect_url when the user taps an activity. For news with target_meta.content_via set to 2, open the original article at source_url. Exclude unwanted action types with omit_actions.

GEThttps://api.lbkrs.com/v1/stock/pinned_activities

Parameters

counter_idstringqueryRequired

Security ID (counter_id), for example ST/US/AAPL or ST/HK/700

omit_actionsstringquery

Action types to exclude (matching the returned action), for example Live; nothing is excluded when omitted

Responses

HTTP 200The request succeeded. The response body contains the result of the “Get Pinned Security Activities” operation.
Standard response envelopecodemessagedata
dataobjectdata structure
activitiesarray<object>

Pinned activities; hide the pinned area when empty

Child attributes
idstring

Activity ID

counter_idstring

Security ID

acted_atinteger

Activity time, such as the article publication time or event start time

actionstring

Action type, for example AIDailyEvent (daily event digest) or Topic; values can be passed in the omit_actions request parameter

action_titlestring

Primary title, such as “Pinned news” or “Dividend information”

target_typestring

Type of the linked object, such as a news article, dividend event, earnings event, or ticker change

target_idstring

ID of the linked object

titlestring

Secondary title

descriptionstring

Description; currently returned only for news flash activities

iconstring

Icon URL

overviewstring

Call-to-action text

redirect_urlstring

Link to open when the activity is tapped

target_metaobject

Additional information about the linked object

Child attributes
source_urlstring

Original article URL

content_viainteger

Article content source:

  • 0 - Regular article
  • 1 - Title links to an external page
  • 2 - External link without republishing rights; open source_url
Values
0
1
2
styleobject

Display style of a pinned activity

Child attributes
show_titleboolean

Whether to show the secondary title title

bold_titleboolean

Whether the title is bold

show_timeboolean

Whether to show the activity time acted_at

show_descriptionboolean

Whether to show description

desc_max_lineinteger

Maximum number of lines for the description

Whale Docs