public/get_announcements

Retrieves platform announcements and important notices. Announcements include system updates, maintenance schedules, new features, policy changes, and other important information.

Results are returned in reverse chronological order (newest first). The default start_timestamp is the current time, and the count parameter must be between 1 and 50 (default is 5).

Try in API console

cURL

cURL

curl --request GET \
  --url https://test.deribit.com/api/v2/public/get_announcements \
  --header 'Content-Type: application/json' \
  --data '
{
  "jsonrpc": "2.0",
  "id": 7661,
  "method": "public/get_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."
    }
  ]
}

Query Parameters

start_timestamp · integer · default: Current time

The most recent timestamp to return the results for (milliseconds since the UNIX epoch) The timestamp (milliseconds since the Unix epoch)

Example:

1536569522277

count · integer · default: 5

Maximum count of returned announcements, default - 5, maximum - 50

Required range: 1 <= x <= 50

Example:

10

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