Skip to content

Historical.metadata.get_dataset_condition

GET/v0/metadata.get_dataset_conditionPython · HTTP

Each date's condition in a dataset, available or missing, and, for XTKS.BRISK, the clock windows your recordings cover that day (JST).

Parameters

dataset str required

The dataset code.

start_date str | None optional

The first date (YYYY-MM-DD). Default: the dataset's first.

end_date str | None optional

The last date, inclusive. Default: the dataset's last. At most a year.

Returns

list[dict]

A list of {date, condition, last_modified_date, windows}.

API method
Historical.metadata.get_dataset_condition(
    dataset: str,
    start_date: str | None = None,
    end_date: str | None = None,
) -> list[dict]
Example usage
1
2
3
4
import briskapi

client = briskapi.Historical()
print(client.metadata.get_dataset_condition("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_condition' \
  -u "$BRISK_KEY:" \
  -d dataset=XTKS.BRISKDEMO
Example responseCaptured from the demo
[{'date': '2021-09-27',
  'condition': 'available',
  'last_modified_date': None,
  'windows': [['08:00:00', '09:02:59']]}]

[
  {
    "date": "2021-09-27",
    "condition": "available",
    "last_modified_date": null,
    "windows": [
      [
        "08:00:00",
        "09:02:59"
      ]
    ]
  }
]