private/get_new_announcements

Retrieves only unread announcements for the authenticated account. Announcements are marked as read when you use the set_announcement_as_read method or view them through the web interface.

This method is useful for displaying notification badges or highlighting new announcements that require the user’s attention.

Scope: account:read

Try in API console

cURL

cURL

curl --request GET \
  --url https://test.deribit.com/api/v2/private/get_new_announcements \
  --header 'Content-Type: application/json' \
  --data '
{
  "jsonrpc": "2.0",
  "id": 3022,
  "method": "private/get_new_announcements",
  "params": {}
}
'

200

{
  "jsonrpc": "2.0",
  "id": 3022,
  "result": [
    {
      "title": "Example announcement",
      "publication_timestamp": 1550058362418,
      "important": false,
      "id": 1550058362418,
      "body": "Lorem ipsum dolor sit amet, consectetur adipiscing elit."
    }
  ]
}

Response

200 - application/json

Success response

jsonrpc · enum<string> · required

The JSON-RPC version (2.0)

Available options: 2.0

result · object[] · required

Hide child attributes

result. body · string · required

The HTML body of the announcement

Example:

"An announcement"

result. publication_timestamp · integer · required

The timestamp (milliseconds since the Unix epoch) of announcement publication

Example:

1527844253000

result. id · number · required

A unique identifier for the announcement

Example:

19288317

result. important · boolean · required

Whether the announcement is marked as important

Example:

false

result. title · string · required

The title of the announcement

Example:

"Example announcement"

result. confirmation · boolean

Whether the user confirmation is required for this announcement

Example:

false

id · integer

The id that was sent in the request