Skip to content

Historical

GET/v0/metadata.list_datasetsPython · HTTP

The cloud API's client. Your archive identity is the API key: nothing to sign up for. Requests go to the archive's query service over HTTPS, and only reach your own recordings and the public demo.

Parameters

key str | None optional

Your archive identity. Default: this computer's (BRISK_IDENTITY, the system's credential store or ~/.config/brisk/identity.json); if there is none, one is made and a warning says how to keep its recovery code.

gateway str | None optional

The cloud API's URL. Default: the archive's, from the installed briskapi/archive.json. Must be https:// (or http://localhost).

Returns

None

A Historical client, with timeseries and metadata.

API method
briskapi.Historical(
    key: str | None = None,
    gateway: str | None = None,
)
Example usage
1
2
3
4
import briskapi

client = briskapi.Historical()
print(client.metadata.list_datasets())

1
2
3
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.list_datasets' \
  -u "$BRISK_KEY:"
Example responseCaptured from the demo
['XTKS.BRISK', 'XTKS.BRISKDEMO']

[
  "XTKS.BRISK",
  "XTKS.BRISKDEMO"
]