Skip to main content
GET
/
v1
/
public
/
campaign
/
ranking
Get campaign ranking
curl --request GET \
  --url https://api.orderly.org/v1/public/campaign/ranking
{
  "success": true,
  "timestamp": 1702989203989,
  "data": {
    "meta": {
      "total": 9,
      "records_per_page": 25,
      "current_page": 1
    },
    "rows": [
      {
        "broker_id": "woofi_dex",
        "account_id": "account01.eth",
        "address": "0xaccount01",
        "volume": 800.12,
        "pnl": 800.12,
        "total_deposit_amount": 800.12,
        "total_withdrawal_amount": 800.12,
        "start_account_value": 800.12,
        "end_account_value": 800.12
      }
    ]
  }
}

Query Parameters

​
campaign_id
integer
required
​
broker_id
string
​
page
integer

start from 1

​
size
integer
​
sort_by
string

volume/pnl

​
min_pnl
integer

Return only records where PnL is greater than or equal to this value.

​
min_volume
integer

Return only records where Volume is greater than or equal to this value.

​
aggregate_by
string

Response

200 - application/json

OK

​
success
boolean
required

Indicates whether the request was successful.

Example:

true

​
timestamp
integer

Server timestamp in milliseconds.

Example:

1702989203989

​
data
object