Account Notifications
Get Unread Notifications
Partner Support
User Flows
General API
- Builder Info
- System Info
- USDC Faucet
User API
- Registration
- Key Management
- Account/User Info
- Account Notifications
- Account Config
- Delegate Signer
Trading API
- Order Management
- Liquidations
- Assets/Withdraw/Settle PnL
- Positions
- Funding
Rewards API
- Trading Rewards
- Market Making Rewards
Staking & Valor API
- Staking
- Valor
Builder API
- User Data
- Trading Campaigns
- Fee Setting
- Referral Program
Market Data API
- TradingView
- Funding Rates
- Market Info
Websocket API
- Introduction
- PING/PONG
- Authentication
- Error Response
- Public Market Data
- Private User Data
Account Notifications
Get Unread Notifications
Limit: 10 requests per 60 seconds
GET /v1/notification/inbox/unread
Get the information on unread messages for the user.
GET
/
v1
/
notification
/
inbox
/
unread
curl --request GET \
--url https://api.orderly.org/v1/notification/inbox/unread \
--header 'orderly-account-id: <orderly-account-id>' \
--header 'orderly-key: <orderly-key>' \
--header 'orderly-signature: <orderly-signature>' \
--header 'orderly-timestamp: <orderly-timestamp>'
{
"success": true,
"timestamp": 1702989203989,
"data": {
"rows": [
{
"id": 12345,
"message_type": "ORDER_FILLED",
"email": "test@orderly.network",
"application_id": "0x0f29bfb4c1bc9fea3f3be46bab6d795e22a6272354b136fde05f6b80cfcad546",
"title": " Your order has been filled",
"type": "TRADE",
"level": "GENERAL",
"content_summary": "Your order to buy 1 NEAR-PERP has been filled: 0.5/1 at 1.9876.",
"content": "<p>Your order to buy 1 NEAR-PERP has been filled: 0.5/1 at 1.9876.</p>",
"content_raw": {
"symbol": "PERP_NEAR_USDC",
"side": "BUY",
"order_id": 1,
"executed_price": 1.9876,
"executed_quantity": 0.5,
"executed_timestamp": 1567382401000
},
"mark_read": 1,
"operator": 1,
"created_time": 1670425970373,
"announcement_id": 123
}
],
"meta": {
"total": 9,
"records_per_page": 25,
"current_page": 1
},
"count": 123,
"lastId": 123
}
}
Headers
Response
200 - application/json
OK
ORDER_FILLED
email if bounded to the account
wallet address of the account
TRADE / SYSTEM
GENERAL / IMPORTANT
1 = READ, 0 = UNREAD
number of unread messages
the id of the last unread message
curl --request GET \
--url https://api.orderly.org/v1/notification/inbox/unread \
--header 'orderly-account-id: <orderly-account-id>' \
--header 'orderly-key: <orderly-key>' \
--header 'orderly-signature: <orderly-signature>' \
--header 'orderly-timestamp: <orderly-timestamp>'
{
"success": true,
"timestamp": 1702989203989,
"data": {
"rows": [
{
"id": 12345,
"message_type": "ORDER_FILLED",
"email": "test@orderly.network",
"application_id": "0x0f29bfb4c1bc9fea3f3be46bab6d795e22a6272354b136fde05f6b80cfcad546",
"title": " Your order has been filled",
"type": "TRADE",
"level": "GENERAL",
"content_summary": "Your order to buy 1 NEAR-PERP has been filled: 0.5/1 at 1.9876.",
"content": "<p>Your order to buy 1 NEAR-PERP has been filled: 0.5/1 at 1.9876.</p>",
"content_raw": {
"symbol": "PERP_NEAR_USDC",
"side": "BUY",
"order_id": 1,
"executed_price": 1.9876,
"executed_quantity": 0.5,
"executed_timestamp": 1567382401000
},
"mark_read": 1,
"operator": 1,
"created_time": 1670425970373,
"announcement_id": 123
}
],
"meta": {
"total": 9,
"records_per_page": 25,
"current_page": 1
},
"count": 123,
"lastId": 123
}
}