api/v1/customer/rank-info

GET

/api/v1/customer/rank-info

This API method will retrieve the top ranking customers based on balance (overall), with your info included as well.

Sample Request body

Parameter

Value / Type

Required

limit

INTEGER (Default: 100)

True

Sample Response

{
  "status": true,
  "item": {
    "rank_info": [
      {
        "customer_id": "LZWBJx0PmYkEwjGdr2vO",
        "name": "Bob Thorton",
        "total_balance": 217260,
        "rank": 1,
        "avatar": "http:\/\/controlcenter.ftx\/customer\/images\/default-avatars\/4?v=1545921441"
      },
      {
        "customer_id": "bZ6xBGP2mdPm3R8VX17L",
        "name": "Devin Smith",
        "total_balance": 720,
        "rank": 2,
        "avatar": "http:\/\/controlcenter.ftx\/customer\/images\/default-avatars\/4?v=1545921441"
      }
    ],
    "top_limit": 100,
    "your_rank": 1
    "your_total_balance": 20200
  }
}
{
  "status": false,
  "errorCode": "VALIDATION_EXCEPTION",
  "messages": {
    "limit": [
      "The limit must be a number."
    ]
  }
}