Skip to content

Historical.metadata.list_schemas

GET/v0/metadata.list_schemasPython · HTTP

The schemas a dataset offers.

Parameters

dataset str required

The dataset code.

Returns

list[str]

A list of schema names.

API method
Historical.metadata.list_schemas(
    dataset: str,
) -> list[str]
Example usage
1
2
3
4
import briskapi

client = briskapi.Historical()
print(client.metadata.list_schemas("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.list_schemas' \
  -u "$BRISK_KEY:" \
  -d dataset=XTKS.BRISKDEMO
Example responseCaptured from the demo
['trades',
 'mbp-10',
 'definition',
 'imbalance',
 'brisk-quotes',
 'ohlcv-1s',
 'ohlcv-1m',
 'ohlcv-1h',
 'ohlcv-1d']

[
  "trades",
  "mbp-10",
  "definition",
  "imbalance",
  "brisk-quotes",
  "ohlcv-1s",
  "ohlcv-1m",
  "ohlcv-1h",
  "ohlcv-1d"
]