Skip to main content
GET
/
v1
/
notification
/
inbox
/
notifications
Get all notifications
curl --request GET \
  --url https://api.orderly.org/v1/notification/inbox/notifications \
  --header 'orderly-account-id: <orderly-account-id>' \
  --header 'orderly-key: <orderly-key>' \
  --header 'orderly-signature: <orderly-signature>' \
  --header 'orderly-timestamp: <orderly-timestamp>'
import requests

url = "https://api.orderly.org/v1/notification/inbox/notifications"

headers = {
    "orderly-timestamp": "<orderly-timestamp>",
    "orderly-account-id": "<orderly-account-id>",
    "orderly-key": "<orderly-key>",
    "orderly-signature": "<orderly-signature>"
}

response = requests.get(url, headers=headers)

print(response.text)
const options = {
  method: 'GET',
  headers: {
    'orderly-timestamp': '<orderly-timestamp>',
    'orderly-account-id': '<orderly-account-id>',
    'orderly-key': '<orderly-key>',
    'orderly-signature': '<orderly-signature>'
  }
};

fetch('https://api.orderly.org/v1/notification/inbox/notifications', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.orderly.org/v1/notification/inbox/notifications",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "orderly-account-id: <orderly-account-id>",
    "orderly-key: <orderly-key>",
    "orderly-signature: <orderly-signature>",
    "orderly-timestamp: <orderly-timestamp>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.orderly.org/v1/notification/inbox/notifications"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("orderly-timestamp", "<orderly-timestamp>")
	req.Header.Add("orderly-account-id", "<orderly-account-id>")
	req.Header.Add("orderly-key", "<orderly-key>")
	req.Header.Add("orderly-signature", "<orderly-signature>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.orderly.org/v1/notification/inbox/notifications")
  .header("orderly-timestamp", "<orderly-timestamp>")
  .header("orderly-account-id", "<orderly-account-id>")
  .header("orderly-key", "<orderly-key>")
  .header("orderly-signature", "<orderly-signature>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.orderly.org/v1/notification/inbox/notifications")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["orderly-timestamp"] = '<orderly-timestamp>'
request["orderly-account-id"] = '<orderly-account-id>'
request["orderly-key"] = '<orderly-key>'
request["orderly-signature"] = '<orderly-signature>'

response = http.request(request)
puts response.read_body
{
  "success": true,
  "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
    }
  },
  "timestamp": 1702989203989
}

Headers

orderly-timestamp
string
required

Timestamp of the signed request in milliseconds.

orderly-account-id
string
required

Account ID of the authenticated account.

orderly-key
string
required

Public orderly key used to sign the request.

orderly-signature
string
required

Signature of the request payload generated with the orderly key.

Query Parameters

type
string

Filter notifications by type: TRADE or SYSTEM.

page
number

start from 1

size
number

Number of notifications to return per page.

Response

200 - application/json

OK

success
boolean
required

Indicates whether the request was successful.

Example:

true

data
object
required
timestamp
integer

Server timestamp in milliseconds.

Example:

1702989203989