コンテンツにスキップ

DataStore.to_df

Python

レコードを pandas の DataFrame として返します(pip install 'briskapi[pandas]' が必要)。インデックスは ts_recv(バーでは ts_event)。Databento のものと同じです。

パラメーター

price_type str 任意 = "float"

"float"(円)、"fixed"(1e-9 円単位の整数)、または "decimal"(decimal.Decimal)。

pretty_ts bool 任意 = True

タイムスタンプを pandas.Timestamp で返します。False にすると UTC ナノ秒になります。

map_symbols bool 任意 = True

symbol 列(JPX の銘柄コード)を残します。

tz str 任意 = "UTC"

タイムスタンプを表示するタイムゾーン。たとえば "Asia/Tokyo"。

count int | None 任意

1つあたり最大この行数の DataFrame のイテレーターを返します。

戻り値

pandas.DataFrame | Iterator[pandas.DataFrame]

DataFrame。count を指定した場合は DataFrame のイテレーターです。

API メソッド
DataStore.to_df(
    price_type: str = "float",
    pretty_ts: bool = True,
    map_symbols: bool = True,
    tz: str = "UTC",
    count: int | None = None,
) -> pandas.DataFrame | Iterator[pandas.DataFrame]
使用例
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:00:05",
)
print(data.to_df(tz="Asia/Tokyo")[["symbol", "price", "size", "side"]])
レスポンス例デモで実行した結果
                                 symbol    price    size side
ts_recv
2021-09-27 09:00:00.072765+09:00   7203  10155.0  305500    A
2021-09-27 09:00:00.327866+09:00   7203  10155.0     400    A
2021-09-27 09:00:00.801729+09:00   7203  10155.0     700    A
2021-09-27 09:00:00.803944+09:00   7203  10160.0     100    B
2021-09-27 09:00:00.817904+09:00   7203  10150.0     100    A
2021-09-27 09:00:00.876274+09:00   7203  10160.0     100    B
2021-09-27 09:00:01.671092+09:00   7203  10160.0     100    B
2021-09-27 09:00:02.104003+09:00   7203  10160.0     100    B
2021-09-27 09:00:02.168343+09:00   7203  10160.0    5400    B
2021-09-27 09:00:02.176897+09:00   7203  10155.0     100    A
2021-09-27 09:00:02.176897+09:00   7203  10150.0     400    A
2021-09-27 09:00:02.183538+09:00   7203  10155.0     100    A
2021-09-27 09:00:02.186961+09:00   7203  10160.0     100    B
2021-09-27 09:00:03.038753+09:00   7203  10160.0     100    B
2021-09-27 09:00:03.038753+09:00   7203  10165.0     100    B
2021-09-27 09:00:03.068028+09:00   7203  10160.0     100    B
2021-09-27 09:00:03.068028+09:00   7203  10165.0     100    B
2021-09-27 09:00:03.824183+09:00   7203  10160.0     400    B
2021-09-27 09:00:04.746295+09:00   7203  10150.0     100    A
2021-09-27 09:00:04.817684+09:00   7203  10155.0     100    B