コンテンツにスキップ

Historical.timeseries.get_range

POST/v0/timeseries.get_rangePython · HTTP · CLI

クラウドにある自分の記録から、1つのスキーマのレコードを、複数の銘柄・指定した期間について返します。重なった記録は統合され（各レコードは1回だけ）、時刻順に並びます。OHLCV バーはクラウドにしかなく、自分のアップロードだけから作られるため、アップロードがカバーする銘柄と時間帯の分だけが得られます。

パラメーター

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。データ形式を参照してください。

stype_in str 任意 = "raw_symbol"

raw_symbol（JPX の銘柄コード）のみ。

stype_out str 任意 = "instrument_id"

instrument_id のみ。どのレコードにも銘柄コードが symbol として入ります。

limit int | None 任意

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

path str | Path | None 任意

レコードを Parquet としてこのファイルにも書き出します。

戻り値

DataStore

レコードの DataStore。

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 = "trades",
    stype_in: str = "raw_symbol",
    stype_out: str = "instrument_id",
    limit: int | None = None,
    path: str | Path | None = None,
) -> DataStore
使用例
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
import briskapi

client = briskapi.Historical()
data = client.timeseries.get_range(
    dataset="XTKS.BRISKDEMO",
    symbols=["7203"],
    schema="trades",
    start="2021-09-27T09:00",
    end="2021-09-27T09:01",
    limit=1,
)
print(data.to_df(tz="Asia/Tokyo").iloc[0])

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
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 \
  -d schema=trades \
  -d start=2021-09-27T09:00 \
  -d end=2021-09-27T09:01 \
  -d encoding=json \
  -d limit=1

1
2
brisk query XTKS.BRISKDEMO --schema trades --symbols 7203 \
  --start 2021-09-27T09:00 --end 2021-09-27T09:01 --limit 1
レスポンス例デモで実行した結果
ts_event         2021-09-27 09:00:00.072765+09:00
publisher_id                                    2
instrument_id                                7203
action                                          T
side                                            A
depth                                           0
price                                     10155.0
size                                       305500
flags                                           0
sequence                                     8224
trade_id                                   8224-0
symbol                                       7203
Name: 2021-09-27 09:00:00.072765+09:00, dtype: object

{
  "ts_recv": "2021-09-27T00:00:00.072765000Z",
  "ts_event": "2021-09-27T00:00:00.072765000Z",
  "publisher_id": 2,
  "instrument_id": 7203,
  "action": "T",
  "side": "A",
  "depth": 0,
  "price": 10155.0,
  "size": 305500,
  "flags": 0,
  "sequence": 8224,
  "trade_id": "8224-0",
  "symbol": "7203"
}

"ts_recv","ts_event","publisher_id","instrument_id","action","side","depth","price","size","flags","sequence","trade_id","symbol"
"2021-09-27T00:00:00.072765000Z","2021-09-27T00:00:00.072765000Z",2,7203,"T","A",0,10155,305500,0,8224,"8224-0","7203"