get_orderbook

TossSimpleOverseasStock.get_orderbook(ticker: str) → Dict[source]

특정 종목의 호가/잔량 정보를 조회하여 반환합니다.

Note

10호가 미만으로 응답되는 경우 부족한 항목을 {"price": 0, "volume": 0} 으로 채워 항상 10호가를 반환합니다. (KIS 와 동일한 형태)

Parameters:

ticker (str) – 티커(symbol)

Returns:

호가 정보가 포함된 사전.

  • total_bid_volume (int|Decimal): 총 매수 잔량.

  • total_ask_volume (int|Decimal): 총 매도 잔량.

  • ask_price (Decimal): 1차 매도 호가 가격.

  • ask_volume (int|Decimal): 1차 매도 호가 잔량.

  • bid_price (Decimal): 1차 매수 호가 가격.

  • bid_volume (int|Decimal): 1차 매수 호가 잔량.

  • time (dtm.datetime): 미국 동부 기준 호가 정보 조회 시간.

  • bids (list): 매수 호가 목록 (각 항목은 price와 volume을 포함하는 dict).

  • asks (list): 매도 호가 목록 (각 항목은 price과 volume을 포함하는 dict).

Return type:

dict