Get stats records

GET 
/api/v1/stats

Returns the most recent stat records in ascending order of time.

Request

Query Parameters

id stringrequired

ID of stream

streamtype stringrequired

Stream type, must be one of volume, weight, constituentresult, or rti

Responses

200

successful operation

application/json

Schema

Schema

serverTime date-time
error stringnullable

description of error in natural language, absent in case of successful operation

payload

object[]

nullable

The response data

Array [

time int64

Milliseconds since Unix epoch

amendTime int64

If the value has been amended after being previously published, this field indicates the time of the amendment in milliseconds since Unix epoch. If no amendment has been made, the field will be absent.

repeatOfPreviousValue boolean

If an error has occurred during calculation such that an index value could not be calculated for that day, and it has been replaced with the value from the previous day, this boolean field will exist, and will be true. If no such error has occurred, the field will be absent.

]

Example (from schema)

{
  "serverTime": "2024-01-01T09:00:00.000Z",
  "error": "string",
  "payload": [
    {
      "time": 0,
      "amendTime": 0,
      "repeatOfPreviousValue": true,
      "value": "string",
      "volume": "string",
      "volumes": {}
    },
    {
      "time": 0,
      "amendTime": 0,
      "repeatOfPreviousValue": true,
      "value": "string",
      "weights": {}
    },
    {
      "time": 0,
      "amendTime": 0,
      "repeatOfPreviousValue": true,
      "divisor": "string",
      "value": "string",
      "constituents": [
        {
          "constituent": "string",
          "value": "string",
          "weightPercent": "string",
          "exchanges": [
            {
              "exchange": "string",
              "weightPercent": "string"
            }
          ]
        }
      ]
    },
    {
      "time": 0,
      "amendTime": 0,
      "repeatOfPreviousValue": true,
      "value": "string",
      "utilizedDepth": "string",
      "valueAsk": "string",
      "valueBid": "string",
      "midPrice": "string"
    }
  ]
}

Loading...