Method Name
private/get_notifications
private/get_notificationsGet the notifications related to a subaccount.
Required minimum session key permission level is read_only
Parameters
page integer Page number of results to return |
|
page_size
integer Number of results per page (must be between 0-50) |
|
status
string Status of the notification enum unseen seen hidden
|
|
subaccount_id
integer Subaccount_id (must be set if wallet param is not set) |
|
type
array of strings List of notification types to filter by |
|
wallet
string Wallet address (if set, subaccount_id ignored) |
Response
id string or integer required |
| result object required |
|
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. |
|
result.
pagination
object required Pagination info |
|
result.pagination.
count
integer required Total number of items, across all pages |
|
result.pagination.
num_pages
integer required Number of pages |
Example
{request_example_shell}{request_example_javascript}{request_example_python}The above command returns JSON structured like this:
{response_example_json}