コンテンツにスキップ

Historical.timeseries.get_range (bars)

POST/v0/timeseries.get_rangePython · HTTP · CLI

OHLCV バー: 約定のあった銘柄・間隔ごとに1行で、始値から終値までを表します。XTKS.BRISK のバーは、自分のライブ記録からあらかじめ作られ、自分の記録がその銘柄と、取引時間（前場 09:00〜11:30、後場 12:30〜15:30 JST）内のそのバーの全期間をカバーしている場合にだけ受け取れます。デモのバーは誰でも使えます。

パラメーター

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 任意 = "ohlcv-1m"

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

limit int | None 任意

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

戻り値

DataStore

バーの DataStore: ts_event（バーの開始時刻）、open、high、low、close（円）、volume（株数）。

API メソッド
Historical.timeseries.get_range(
    dataset: str,
    start: str | int | date,
    end: str | int | date | None = None,
    symbols: Iterable[str] | str = "ALL_SYMBOLS",
    schema: str = "ohlcv-1m",   # ohlcv-1s, ohlcv-1h, ohlcv-1d
    limit: int | None = None,
) -> DataStore
使用例
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import briskapi

client = briskapi.Historical()
bars = client.timeseries.get_range(
    dataset="XTKS.BRISKDEMO",
    symbols=["7203", "6758"],
    schema="ohlcv-1m",
    start="2021-09-27",
)
print(bars.to_df(tz="Asia/Tokyo"))

1
2
3
4
5
6
7
8
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/timeseries.get_range' \
  -u "$BRISK_KEY:" \
  -d dataset=XTKS.BRISKDEMO \
  -d symbols=7203,6758 \
  -d schema=ohlcv-1m \
  -d start=2021-09-27 \
  -d encoding=csv

1
brisk query XTKS.BRISKDEMO --schema ohlcv-1m --symbols 7203,6758 --start 2021-09-27
レスポンス例デモで実行した結果
                           publisher_id  instrument_id     open     high      low    close  volume symbol
ts_event
2021-09-27 09:00:00+09:00             2           6758  13190.0  13200.0  13070.0  13115.0  297600   6758
2021-09-27 09:00:00+09:00             2           7203  10155.0  10175.0  10150.0  10175.0  342300   7203
2021-09-27 09:01:00+09:00             2           6758  13105.0  13110.0  13050.0  13080.0   73400   6758
2021-09-27 09:01:00+09:00             2           7203  10175.0  10230.0  10175.0  10220.0  177700   7203
2021-09-27 09:02:00+09:00             2           6758  13085.0  13110.0  13075.0  13080.0   92200   6758
2021-09-27 09:02:00+09:00             2           7203  10230.0  10245.0  10225.0  10240.0   49100   7203

"ts_event","publisher_id","instrument_id","open","high","low","close","volume","symbol"
"2021-09-27T00:00:00.000000000Z",2,6758,13190,13200,13070,13115,297600,"6758"
"2021-09-27T00:00:00.000000000Z",2,7203,10155,10175,10150,10175,342300,"7203"
"2021-09-27T00:01:00.000000000Z",2,6758,13105,13110,13050,13080,73400,"6758"
"2021-09-27T00:01:00.000000000Z",2,7203,10175,10230,10175,10220,177700,"7203"
"2021-09-27T00:02:00.000000000Z",2,6758,13085,13110,13075,13080,92200,"6758"
"2021-09-27T00:02:00.000000000Z",2,7203,10230,10245,10225,10240,49100,"7203"

"ts_event","publisher_id","instrument_id","open","high","low","close","volume","symbol"
"2021-09-27T00:00:00.000000000Z",2,6758,13190,13200,13070,13115,297600,"6758"
"2021-09-27T00:00:00.000000000Z",2,7203,10155,10175,10150,10175,342300,"7203"
"2021-09-27T00:01:00.000000000Z",2,6758,13105,13110,13050,13080,73400,"6758"
"2021-09-27T00:01:00.000000000Z",2,7203,10175,10230,10175,10220,177700,"7203"
"2021-09-27T00:02:00.000000000Z",2,6758,13085,13110,13075,13080,92200,"6758"
"2021-09-27T00:02:00.000000000Z",2,7203,10230,10245,10225,10240,49100,"7203"