コンテンツにスキップ

Historical.metadata.get_record_count

POST/v0/metadata.get_record_countPython · HTTP

get_range のリクエストが返すレコード数。実行する前にサイズを見積もるために使います。

パラメーター

dataset str 必須

XTKS.BRISK（自分のライブ記録）または XTKS.BRISKDEMO（公開デモ。どの ID からでも照会できます）。

start str | int | date 必須

開始（含む）。ISO 8601 形式の時刻（タイムゾーンの指定がなければ JST）、日付（その取引日の JST 0時から）、または UTC ナノ秒。

end str | int | date | None 任意

終了（含まない）。形式は start と同じです。既定: start の取引日の終わり。start から最大31日後まで。どちらも2000年から2100年の間。

symbols Iterable[str] | str 任意 = "ALL_SYMBOLS"

JPX の銘柄コード（"7203"、"167A"）を最大2,000銘柄。リストまたはカンマ区切りで指定します。既定: "ALL_SYMBOLS"。

schema str 任意 = "trades"

trades（既定）、mbp-10、definition、imbalance、brisk-quotes、または ohlcv-1s、ohlcv-1m、ohlcv-1h、ohlcv-1d。データ形式を参照してください。

limit int | None 任意

返すレコード数の上限（時刻順に並べたあとで適用）。

戻り値

int

レコード数。

API メソッド
Historical.metadata.get_record_count(
    dataset: str,
    start: str | int | date,
    end: str | int | date | None = None,
    symbols: Iterable[str] | str = "ALL_SYMBOLS",
    schema: str = "trades",
    limit: int | None = None,
) -> int
使用例
1
2
3
4
5
6
7
8
9
import briskapi

client = briskapi.Historical()
print(client.metadata.get_record_count(
    dataset="XTKS.BRISKDEMO",
    symbols=["7203"],
    schema="trades",
    start="2021-09-27",
))

1
2
3
4
5
6
7
export BRISK_KEY=$(brisk identity --export)   # your archive identity is the API key
curl -X POST 'https://h2dxahfcj6436nlf3y255exu6e0omhrk.lambda-url.ap-northeast-1.on.aws/v0/metadata.get_record_count' \
  -u "$BRISK_KEY:" \
  -d dataset=XTKS.BRISKDEMO \
  -d symbols=7203 \
  -d schema=trades \
  -d start=2021-09-27
レスポンス例デモで実行した結果
312

312