Timeseries Index Value
GET /v1/indexes/:index_id/timeseries
Timeseries Index Value
Path Parameters
- index_id string required
Query Parameters
- period_id string required
Identifier of requested timeseries period (e.g.
5SEC
or1DAY
) - time_start string required
Timeseries starting time in ISO 8601
- time_end string required
Timeseries ending time in ISO 8601
- limit int32
Default value:
100
Amount of items to return (optional, mininum is 1, maximum is 100000, default value is 100, if the parameter is used then every 100 output items are counted as one request)
- 200
successful operation
- text/plain
- application/json
- text/json
- application/x-msgpack
- Schema
- Example (from schema)
Schema
- Array [
- time_period_start date-time
The start time of the time period.
- time_period_end date-time
The end time of the time period.
- time_open date-time nullable
The time when the value opened.
- time_close date-time nullable
The time when the value closed.
- value_open double nullable
The opening value.
- value_high double nullable
The highest value during the time period.
- value_low double nullable
The lowest value during the time period.
- value_close double nullable
The closing value.
- value_count int64
The number of values during the time period.
- ]
[
{
"time_period_start": "2024-04-30T09:02:12.514Z",
"time_period_end": "2024-04-30T09:02:12.514Z",
"time_open": "2024-04-30T09:02:12.514Z",
"time_close": "2024-04-30T09:02:12.514Z",
"value_open": 0,
"value_high": 0,
"value_low": 0,
"value_close": 0,
"value_count": 0
}
]
- Schema
- Example (from schema)
Schema
- Array [
- time_period_start date-time
The start time of the time period.
- time_period_end date-time
The end time of the time period.
- time_open date-time nullable
The time when the value opened.
- time_close date-time nullable
The time when the value closed.
- value_open double nullable
The opening value.
- value_high double nullable
The highest value during the time period.
- value_low double nullable
The lowest value during the time period.
- value_close double nullable
The closing value.
- value_count int64
The number of values during the time period.
- ]
[
{
"time_period_start": "2024-04-30T09:02:12.515Z",
"time_period_end": "2024-04-30T09:02:12.515Z",
"time_open": "2024-04-30T09:02:12.515Z",
"time_close": "2024-04-30T09:02:12.515Z",
"value_open": 0,
"value_high": 0,
"value_low": 0,
"value_close": 0,
"value_count": 0
}
]
- Schema
- Example (from schema)
Schema
- Array [
- time_period_start date-time
The start time of the time period.
- time_period_end date-time
The end time of the time period.
- time_open date-time nullable
The time when the value opened.
- time_close date-time nullable
The time when the value closed.
- value_open double nullable
The opening value.
- value_high double nullable
The highest value during the time period.
- value_low double nullable
The lowest value during the time period.
- value_close double nullable
The closing value.
- value_count int64
The number of values during the time period.
- ]
[
{
"time_period_start": "2024-04-30T09:02:12.515Z",
"time_period_end": "2024-04-30T09:02:12.515Z",
"time_open": "2024-04-30T09:02:12.515Z",
"time_close": "2024-04-30T09:02:12.515Z",
"value_open": 0,
"value_high": 0,
"value_low": 0,
"value_close": 0,
"value_count": 0
}
]
- Schema
- Example (from schema)
Schema
- Array [
- time_period_start date-time
The start time of the time period.
- time_period_end date-time
The end time of the time period.
- time_open date-time nullable
The time when the value opened.
- time_close date-time nullable
The time when the value closed.
- value_open double nullable
The opening value.
- value_high double nullable
The highest value during the time period.
- value_low double nullable
The lowest value during the time period.
- value_close double nullable
The closing value.
- value_count int64
The number of values during the time period.
- ]
[
{
"time_period_start": "2024-04-30T09:02:12.515Z",
"time_period_end": "2024-04-30T09:02:12.515Z",
"time_open": "2024-04-30T09:02:12.515Z",
"time_close": "2024-04-30T09:02:12.515Z",
"value_open": 0,
"value_high": 0,
"value_low": 0,
"value_close": 0,
"value_count": 0
}
]