コンテンツにスキップ

Historical

GET/v0/metadata.list_datasetsPython · HTTP

クラウド API のクライアントです。自分のアーカイブの ID が API キーなので、サインアップは不要です。リクエストは HTTPS でアーカイブの照会サービスに送られ、読めるのは自分の記録と公開デモだけです。

パラメーター

key str | None 任意

自分のアーカイブの ID。既定: このコンピューターのもの（BRISK_IDENTITY、システムの資格情報ストア、または ~/.config/brisk/identity.json）。どれもなければ新しく作られ、復元コードの保管方法を示す警告が表示されます。

gateway str | None 任意

クラウド API の URL。既定: インストール済みの briskapi/archive.json にある、アーカイブのもの。https://（または http://localhost）でなければなりません。

戻り値

None

Historical クライアント。timeseries と metadata を備えています。

API メソッド
briskapi.Historical(
    key: str | None = None,
    gateway: str | None = None,
)
使用例
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:"
レスポンス例デモで実行した結果
['XTKS.BRISK', 'XTKS.BRISKDEMO']

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