Get statistics

This endpoint return statistics.

URL : /stats

Method : GET

X-HMAC required : YES

Response

The response will be a JSON object containing statistics.

interface Response {
    customerCount: number
    binCount: number
    publishCount: {
      ALL: number
      BTC: number
      ETH: number
    },
    queueCount: {
      NO_CHAIN: number
      BTC: number
      ETH: number
    },
    averageBinCount: number
}

Status Codes

The endpoint will return the following status codes based on the operation outcome:

  • 200OK: The request was successful.
  • 400Bad Request: No data are published.
  • 500Internal Server Error: An error occurred on the server while processing the request.

Example Request

GET /stats HTTP/1.1
Content-Type: application/json
Host: localhost:3000
X-HMAC: 5d41402abc4b2a76b9719d911017c592

Example Response

{
    "customerCount": 0,
    "binCount": 0,
    "publishCount": {
        "ALL": 0,
        "BTC": 0,
        "ETH": 0
    },
    "queueCount": {
        "NO_CHAIN": 0,
        "BTC": 0,
        "ETH": 0
    },
    "averageBinCount": null
}