Timeseries Index Value
GET/v1/indexes/:index_id/timeseries
Timeseries Index Value
Request
Path Parameters
Query Parameters
Identifier of requested timeseries period (e.g. 5SEC
or 1DAY
)
Timeseries starting time in ISO 8601
Timeseries ending time in ISO 8601
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)
Responses
- 200
successful operation
- text/plain
- application/json
- text/json
- application/x-msgpack
- Schema
- Example (from schema)
- Example response
Schema
Array [
]
Gets or sets the start time of the time period.
Gets or sets the end time of the time period.
Gets or sets the time when the value opened.
Gets or sets the time when the value closed.
Gets or sets the opening value.
Gets or sets the highest value during the time period.
Gets or sets the lowest value during the time period.
Gets or sets the closing value.
Gets or sets the number of values during the time period.
[
{
"time_period_start": "2024-11-12T12:17:30.649Z",
"time_period_end": "2024-11-12T12:17:30.649Z",
"time_open": "2024-11-12T12:17:30.649Z",
"time_close": "2024-11-12T12:17:30.649Z",
"value_open": 0,
"value_high": 0,
"value_low": 0,
"value_close": 0,
"value_count": 0
}
]
[
{
"time_period_start": "2024-09-05T08:00:00+00:00",
"time_period_end": "2024-09-05T09:00:00+00:00",
"time_open": "2024-09-05T08:00:44+00:00",
"time_close": "2024-09-05T08:59:44+00:00",
"value_open": 57146.1153570673,
"value_high": 57210.0651836076,
"value_low": 56950.4558254606,
"value_close": 56993.5152800002,
"value_count": 0
},
{
"time_period_start": "2024-09-05T09:00:00+00:00",
"time_period_end": "2024-09-05T10:00:00+00:00",
"time_open": "2024-09-05T09:00:44+00:00",
"time_close": "2024-09-05T09:59:59.9+00:00",
"value_open": 57000.6574615287,
"value_high": 57000.6574615287,
"value_low": 56650.5866347198,
"value_close": 56787.2920819528,
"value_count": 0
},
{
"time_period_start": "2024-09-05T10:00:00+00:00",
"time_period_end": "2024-09-05T11:00:00+00:00",
"time_open": "2024-09-05T10:00:00+00:00",
"time_close": "2024-09-05T10:59:59.9+00:00",
"value_open": 56787.2920819528,
"value_high": 56788.3686345929,
"value_low": 56786.7251004355,
"value_close": 56787.2066526585,
"value_count": 0
}
]
- Schema
- Example (from schema)
- Example response
Schema
Array [
]
Gets or sets the start time of the time period.
Gets or sets the end time of the time period.
Gets or sets the time when the value opened.
Gets or sets the time when the value closed.
Gets or sets the opening value.
Gets or sets the highest value during the time period.
Gets or sets the lowest value during the time period.
Gets or sets the closing value.
Gets or sets the number of values during the time period.
[
{
"time_period_start": "2024-11-12T12:17:30.650Z",
"time_period_end": "2024-11-12T12:17:30.650Z",
"time_open": "2024-11-12T12:17:30.650Z",
"time_close": "2024-11-12T12:17:30.650Z",
"value_open": 0,
"value_high": 0,
"value_low": 0,
"value_close": 0,
"value_count": 0
}
]
[
{
"time_period_start": "2024-09-05T08:00:00+00:00",
"time_period_end": "2024-09-05T09:00:00+00:00",
"time_open": "2024-09-05T08:00:44+00:00",
"time_close": "2024-09-05T08:59:44+00:00",
"value_open": 57146.1153570673,
"value_high": 57210.0651836076,
"value_low": 56950.4558254606,
"value_close": 56993.5152800002,
"value_count": 0
},
{
"time_period_start": "2024-09-05T09:00:00+00:00",
"time_period_end": "2024-09-05T10:00:00+00:00",
"time_open": "2024-09-05T09:00:44+00:00",
"time_close": "2024-09-05T09:59:59.9+00:00",
"value_open": 57000.6574615287,
"value_high": 57000.6574615287,
"value_low": 56650.5866347198,
"value_close": 56787.2920819528,
"value_count": 0
},
{
"time_period_start": "2024-09-05T10:00:00+00:00",
"time_period_end": "2024-09-05T11:00:00+00:00",
"time_open": "2024-09-05T10:00:00+00:00",
"time_close": "2024-09-05T10:59:59.9+00:00",
"value_open": 56787.2920819528,
"value_high": 56788.3686345929,
"value_low": 56786.7251004355,
"value_close": 56787.2066526585,
"value_count": 0
}
]
- Schema
- Example (from schema)
- Example response
Schema
Array [
]
Gets or sets the start time of the time period.
Gets or sets the end time of the time period.
Gets or sets the time when the value opened.
Gets or sets the time when the value closed.
Gets or sets the opening value.
Gets or sets the highest value during the time period.
Gets or sets the lowest value during the time period.
Gets or sets the closing value.
Gets or sets the number of values during the time period.
[
{
"time_period_start": "2024-11-12T12:17:30.650Z",
"time_period_end": "2024-11-12T12:17:30.650Z",
"time_open": "2024-11-12T12:17:30.650Z",
"time_close": "2024-11-12T12:17:30.650Z",
"value_open": 0,
"value_high": 0,
"value_low": 0,
"value_close": 0,
"value_count": 0
}
]
[
{
"time_period_start": "2024-09-05T08:00:00+00:00",
"time_period_end": "2024-09-05T09:00:00+00:00",
"time_open": "2024-09-05T08:00:44+00:00",
"time_close": "2024-09-05T08:59:44+00:00",
"value_open": 57146.1153570673,
"value_high": 57210.0651836076,
"value_low": 56950.4558254606,
"value_close": 56993.5152800002,
"value_count": 0
},
{
"time_period_start": "2024-09-05T09:00:00+00:00",
"time_period_end": "2024-09-05T10:00:00+00:00",
"time_open": "2024-09-05T09:00:44+00:00",
"time_close": "2024-09-05T09:59:59.9+00:00",
"value_open": 57000.6574615287,
"value_high": 57000.6574615287,
"value_low": 56650.5866347198,
"value_close": 56787.2920819528,
"value_count": 0
},
{
"time_period_start": "2024-09-05T10:00:00+00:00",
"time_period_end": "2024-09-05T11:00:00+00:00",
"time_open": "2024-09-05T10:00:00+00:00",
"time_close": "2024-09-05T10:59:59.9+00:00",
"value_open": 56787.2920819528,
"value_high": 56788.3686345929,
"value_low": 56786.7251004355,
"value_close": 56787.2066526585,
"value_count": 0
}
]
- Schema
- Example (from schema)
- Example response
Schema
Array [
]
Gets or sets the start time of the time period.
Gets or sets the end time of the time period.
Gets or sets the time when the value opened.
Gets or sets the time when the value closed.
Gets or sets the opening value.
Gets or sets the highest value during the time period.
Gets or sets the lowest value during the time period.
Gets or sets the closing value.
Gets or sets the number of values during the time period.
[
{
"time_period_start": "2024-11-12T12:17:30.650Z",
"time_period_end": "2024-11-12T12:17:30.650Z",
"time_open": "2024-11-12T12:17:30.650Z",
"time_close": "2024-11-12T12:17:30.650Z",
"value_open": 0,
"value_high": 0,
"value_low": 0,
"value_close": 0,
"value_count": 0
}
]
[
{
"time_period_start": "2024-09-05T08:00:00+00:00",
"time_period_end": "2024-09-05T09:00:00+00:00",
"time_open": "2024-09-05T08:00:44+00:00",
"time_close": "2024-09-05T08:59:44+00:00",
"value_open": 57146.1153570673,
"value_high": 57210.0651836076,
"value_low": 56950.4558254606,
"value_close": 56993.5152800002,
"value_count": 0
},
{
"time_period_start": "2024-09-05T09:00:00+00:00",
"time_period_end": "2024-09-05T10:00:00+00:00",
"time_open": "2024-09-05T09:00:44+00:00",
"time_close": "2024-09-05T09:59:59.9+00:00",
"value_open": 57000.6574615287,
"value_high": 57000.6574615287,
"value_low": 56650.5866347198,
"value_close": 56787.2920819528,
"value_count": 0
},
{
"time_period_start": "2024-09-05T10:00:00+00:00",
"time_period_end": "2024-09-05T11:00:00+00:00",
"time_open": "2024-09-05T10:00:00+00:00",
"time_close": "2024-09-05T10:59:59.9+00:00",
"value_open": 56787.2920819528,
"value_high": 56788.3686345929,
"value_low": 56786.7251004355,
"value_close": 56787.2066526585,
"value_count": 0
}
]