Skip to main content
GET
Get announcement details

Query Parameters

announcement_id
integer<int64>

Announcement ID. Provide either this parameter or slug.

slug
string

Announcement slug. Leading and trailing whitespace is trimmed. Provide either this parameter or announcement_id.

is_official
boolean
default:false

When looking up by slug, set to true to search official announcements. In this case, broker_id is ignored. This parameter has no effect on ID lookups.

broker_id
string

Optional for ID lookups. Required for slug lookups unless is_official is true.

Response

OK

success
boolean
required

Indicates whether the request was successful.

Example:

true

timestamp
integer<int64>
required

Time the response was generated, as a Unix timestamp in milliseconds.

Example:

1702989203989

data
object
required