Get Unread Notifications

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,
  "data": {
    "rows": [
      {
        "id": 12345,
        "message_type": "ORDER_FILLED",
        "email": "[email protected]",
        "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
  },
  "timestamp": 1702989203989
}

GET

notification

inbox

unread

Get Unread Notifications

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,
  "data": {
    "rows": [
      {
        "id": 12345,
        "message_type": "ORDER_FILLED",
        "email": "[email protected]",
        "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
  },
  "timestamp": 1702989203989
}

Headers

orderly-timestamp

string

required

orderly-account-id

string

required

orderly-key

string

required

orderly-signature

string

required

Response

200 - application/json

success

boolean

required

Example:

true

data

object

required

Show child attributes

data.rows

object[]

required

Show child attributes

data.rows.id

integer

Example:

12345

data.rows.message_type

string

ORDER_FILLED

Example:

"ORDER_FILLED"

data.rows.email

string

email if bounded to the account

Example:

"[email protected]"

data.rows.application_id

string

wallet address of the account

Example:

"0x0f29bfb4c1bc9fea3f3be46bab6d795e22a6272354b136fde05f6b80cfcad546"

data.rows.title

string

Example:

" Your order has been filled"

data.rows.type

string

TRADE / SYSTEM

Example:

"TRADE"

data.rows.level

string

GENERAL / IMPORTANT

Example:

"GENERAL"

data.rows.content_summary

string

Example:

"Your order to buy 1 NEAR-PERP has been filled: 0.5/1 at 1.9876."

data.rows.content

string

Example:

"<p>Your order to buy 1 NEAR-PERP has been filled: 0.5/1 at 1.9876.</p>"

data.rows.content_raw

object

Show child attributes

data.rows.content_raw.symbol

string

required

Example:

"PERP_NEAR_USDC"

data.rows.content_raw.side

string

required

Example:

"BUY"

data.rows.content_raw.order_id

integer

required

Example:

1

data.rows.content_raw.executed_price

number

required

Example:

1.9876

data.rows.content_raw.executed_quantity

number

required

Example:

0.5

data.rows.content_raw.executed_timestamp

integer

required

Example:

1567382401000

data.rows.mark_read

integer

1 = READ, 0 = UNREAD

Example:

1

data.rows.operator

integer

Example:

1

data.rows.created_time

integer

Example:

1670425970373

data.rows.announcement_id

integer

data.meta

object

required

Show child attributes

data.meta.total

integer

required

Example:

9

data.meta.records_per_page

integer

required

Example:

25

data.meta.current_page

integer

required

start from 1

Example:

1

data.count

integer

required

number of unread messages

data.lastId

integer

required

the id of the last unread message

timestamp

integer

Example:

1702989203989

Get All Notifications Set Read Status of Notifications

⌘I

Getting Started

Partner Support

User Flows

About APIs

General API

User API

Trading API

Strategy Vault API

Rewards API

Staking & Valor API

Builder API

Market Data API

Websocket API

Get Unread Notifications

Headers

Response