Account Notifications

#Account Notifications

These endpoints list account notifications, report unread-message counts, and update the read state of selected or all notifications.

#Authentication headers

All four operations require: orderly-timestamp (string, signed request time in milliseconds), orderly-account-id (string, authenticated account ID), orderly-key (string, public signing key), and orderly-signature (string, request signature).

#Get All Notifications

GET /v1/notification/inbox/notifications
Mainnet: GET https://api.orderly.org/v1/notification/inbox/notifications\\ Testnet: GET https://testnet-api.orderly.org/v1/notification/inbox/notifications\\ Rate limit: 10 requests per 60 seconds.

Optional query parameters: type (string, filter by TRADE or SYSTEM), page (number, starting at 1), and size (number of records per page).

HTTP 200 returns required data.rows and data.meta. Each notification row may include id (integer), message_type (string, internal message kind), email (string, when present), application_id (string, wallet address), title (string), type (TRADE or SYSTEM), level (GENERAL or IMPORTANT), content_summary (string), content (string, can contain HTML), content_raw (object), mark_read (integer: 1 read, 0 unread), operator (integer), created_time (integer milliseconds), and announcement_id (integer when linked to an announcement). Metadata includes required integers total, records_per_page, and current_page (starting at 1). The response also includes success and server timestamp.

#Get Unread Notifications

GET /v1/notification/inbox/unread
Mainnet: GET https://api.orderly.org/v1/notification/inbox/unread\\ Testnet: GET https://testnet-api.orderly.org/v1/notification/inbox/unread\\ Rate limit: 10 requests per 60 seconds.

No query or path parameters. HTTP 200 returns success, required data.count (integer, number of unread messages), required data.last_id (integer, ID of the newest unread message), and server timestamp.

#Set Read Status of Notifications

POST /v1/notification/inbox/mark_read
Mainnet: POST https://api.orderly.org/v1/notification/inbox/mark\\_read\\ Testnet: POST https://testnet-api.orderly.org/v1/notification/inbox/mark\\_read\\ Rate limit: 10 requests per 60 seconds.

Required query parameters: flag (number: 1 sets READ, 0 sets UNREAD) and ids (string array of notification IDs to update). HTTP 200 returns success (boolean) and server timestamp (integer, milliseconds).

#Set Read Status of All Notifications

POST /v1/notification/inbox/mark_read_all
Mainnet: POST https://api.orderly.org/v1/notification/inbox/mark\\_read\\_all\\ Testnet: POST https://testnet-api.orderly.org/v1/notification/inbox/mark\\_read\\_all\\ Rate limit: 10 requests per 60 seconds.

Required query parameter: flag (number: 1 sets READ, 0 sets UNREAD). HTTP 200 returns success (boolean) and server timestamp (integer, milliseconds).