Skip to content
Longport WhaleLongport Whale
Announcement Management

Announcement Management

Queries Announcement Management data. Combine business filters in filters, and use page and page_size to control pagination.

Response

On success, the API returns the matching records and pagination metadata. See each filter field for its purpose, allowed values, and dynamic value source.

GEThttps://b-api.longbridge.xyz/v1/datasets/announce_saas_announcements

This Dataset query is read-only. Use GET by default. If the encoded query parameters are too large, send the same parameters as a JSON body with POST to the same path.

Authorization

AuthorizationstringheaderRequired

Send the Broker ACCESS_TOKEN as Authorization: Bearer <token>.

Query parameters

filtersobject

Combines business filters. Omit a filter field to disable that filter.

Child attributes
announcement_idstring

Filters results by Notice ID.

begin_atstring

Filters results by Begin At.

end_atstring

Filters results by End At.

announcement_typestring

Filters results by Announcement Type.

Allowed values:

  • common - General Announcement
  • normal_closed - Regular Market Closure
  • ntemporary_closed - Temporary Market Closure
  • passageway - Channel Issue
  • only_shares - Single Stock
  • assets_out - Asset Withdrawal
  • assets_in - Asset Deposit

common · General Announcementnormal_closed · Regular Market Closurentemporary_closed · Temporary Market Closurepassageway · Channel Issueonly_shares · Single Stockassets_out · Asset Withdrawalassets_in · Asset Deposit

positionstring

Filters results by Position.

Allowed values:

  • watchlist - Follow
  • market - Market
  • portfolio - Assets
  • stockdetail - Stock Details
  • trade - Trading Hall
  • deposit - Deposit Statement
  • withdrawal - Withdrawal Bill
  • my_tab - My Tab

watchlist · Followmarket · Marketportfolio · Assetsstockdetail · Stock Detailstrade · Trading Halldeposit · Deposit Statementwithdrawal · Withdrawal Billmy_tab · My Tab

review_statusstring

Filters results by Audit status.

Allowed values:

  • 1 - Pending
  • 2 - In progress
  • 3 - Approved
  • 4 - Rejected
  • 5 - Closed

1 · Pending2 · In progress3 · Approved4 · Rejected5 · Closed

pageinteger

Page number to retrieve, starting from 1.

page_sizeinteger

Number of records to return per page.

Responses

HTTP 200On success, returns paginated Announcement Management records together with pagination metadata such as the page number, page size, and total record count.
Standard response envelopecodemessagedata
dataobjectdata structure
listarray<object>required

Returned value: List of list.

Child attributes
idstring

Returned value: Unique identifier of the current record.

begin_atstring

Returned value: Begin At. The date or time format follows the value returned by the API.

end_atstring

Returned value: End At. The date or time format follows the value returned by the API.

announcement_typestring

Returned value: Announcement Type.

announcement_type_valstring

Raw value of announcement_type. The announcement_type field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

reasonstring

Returned value: Reason.

statusstring

Returned value: Status.

status_valstring

Raw value of status. The status field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

announcement_statusstring

Returned value: Announcement Status.

announcement_status_valstring

Raw value of announcement_status. The announcement_status field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

review_statusstring

Returned value: Audit status.

review_status_valstring

Raw value of review_status. The review_status field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

positionsstring

Returned value: Positions.

positions_valstring

Raw value of positions. The positions field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

marketsstring

Returned value: Markets.

markets_valstring

Raw value of markets. The markets field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

counter_idsstring

Returned value: Counter Ids.

operatorstring

Returned value: Operator.

totalintegerrequired

Returned value: Total number of matching records, used for pagination.

HTTP 400Bad request. Check the business error code in code and the error details in message.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 401The user is not authenticated, or the login session has expired.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 403The current account is not authorized to use this feature. Grant the required permission to the account in User Permission.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 408The request timed out. Check the business error code in code and the error details in message.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

Whale Docs