Get Notifications

Method Name

private/get_notifications

Get the notifications related to a subaccount.

Parameters

subaccount_id integer required
Subaccount_id
page integer
Page number of results to return
page_size integer
Number of results per page
status string
Status of the notification
enum unseen seen hidden
type string
Status of the notification
enum deposit withdraw transfer trade settlement liquidation custom

Response

id string or integer required
result object required
result.subaccount_id integer required
Subaccount_id
result.notifications array of objects required
Notification response
result.notifications[].event string required
The specific event leading to the notification.
result.notifications[].id integer required
The unique identifier for the notification.
result.notifications[].status string required
The status of the notification, indicating if it has been read, pending, or processed.
result.notifications[].subaccount_id integer required
The subaccount_id associated with the notification.
result.notifications[].timestamp integer required
The timestamp indicating when the notification was created or triggered.
result.notifications[].event_details object required
A JSON-structured dictionary containing detailed data or context about the event.
result.notifications[].transaction_id integer or null
The transaction id associated with the notification.
result.notifications[].tx_hash string or null
The transaction hash associated with the notification.

Example

{request_example_shell}
{request_example_javascript}
{request_example_python}

The above command returns JSON structured like this:

{response_example_json}