Method Name
private/get_notifications
private/get_notificationsGet the notifications related to a subaccount.
Required minimum session key permission level is read_only
Parameters
| pageinteger Page number of results to return |
| page_sizeinteger Number of results per page (must be between 0-50) |
| statusstring Status of the notification enum unseenseenhidden |
| subaccount_idinteger Subaccount_id (must be set if wallet param is not set) |
| typearray of strings List of notification types to filter by |
| walletstring Wallet address (if set, subaccount_id ignored) |
Response
| idstring or integerrequired |
| resultobjectrequired |
| result.notificationsarray of objectsrequired Notification response |
| result.notifications[].eventstringrequired The specific event leading to the notification. |
| result.notifications[].idintegerrequired The unique identifier for the notification. |
| result.notifications[].statusstringrequired The status of the notification, indicating if it has been read, pending, or processed. |
| result.notifications[].subaccount_idintegerrequired The subaccount_id associated with the notification. |
| result.notifications[].timestampintegerrequired The timestamp indicating when the notification was created or triggered. |
| result.notifications[].event_detailsobjectrequired A JSON-structured dictionary containing detailed data or context about the event. |
| result.notifications[].transaction_idinteger or null The transaction id associated with the notification. |
| result.notifications[].tx_hashstring or null The transaction hash associated with the notification. |
| result.paginationobjectrequired Pagination info |
| result.pagination.countintegerrequired Total number of items, across all pages |
| result.pagination.num_pagesintegerrequired Number of pages |
Example
{request_example_shell}{request_example_javascript}{request_example_python}The above command returns JSON structured like this:
{response_example_json}