コンテンツにスキップ

Historical.metadata.get_dataset_condition

GET/v0/metadata.get_dataset_conditionPython · HTTP

データセットの各日付の状態(available または missing)。XTKS.BRISK では、その日に自分の記録がカバーする時間帯(JST)も返します。

パラメーター

dataset str 必須

データセットコード。

start_date str | None 任意

最初の日付(YYYY-MM-DD)。既定: データセットの最初の日付。

end_date str | None 任意

最後の日付(含む)。既定: データセットの最後の日付。最大1年分。

戻り値

list[dict]

{date, condition, last_modified_date, windows} のリスト。

API メソッド
Historical.metadata.get_dataset_condition(
    dataset: str,
    start_date: str | None = None,
    end_date: str | None = None,
) -> list[dict]
使用例
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
レスポンス例デモで実行した結果
[{'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"
      ]
    ]
  }
]