Skip to content

Historical.metadata.get_dataset_range

GET/v0/metadata.get_dataset_rangePython · HTTP

The first and last trading date with data in a dataset: for XTKS.BRISK, of your own recordings.

Parameters

dataset str required

The dataset code.

Returns

dict

{start, end}, as ISO 8601 dates (both inclusive). Without data, an error (HTTP 404).

API method
Historical.metadata.get_dataset_range(
    dataset: str,
) -> dict
Example usage
1
2
3
4
import briskapi

client = briskapi.Historical()
print(client.metadata.get_dataset_range("XTKS.BRISKDEMO"))

1
2
3
4
export BRISK_KEY=$(brisk identity --export)   # your archive identity is the API key
curl -G 'https://h2dxahfcj6436nlf3y255exu6e0omhrk.lambda-url.ap-northeast-1.on.aws/v0/metadata.get_dataset_range' \
  -u "$BRISK_KEY:" \
  -d dataset=XTKS.BRISKDEMO
Example responseCaptured from the demo
{'start': '2021-09-27', 'end': '2021-09-27'}

{
  "start": "2021-09-27",
  "end": "2021-09-27"
}