Documentationยถ

class coredotfinance.data.KrxReader(api_key=None)ยถ

krx data๋ฅผ ์ฝ์–ด์˜ค๋Š” ์ธ์Šคํ„ด์Šค๋ฅผ ์ƒ์„ฑํ•œ๋‹ค.

listed_company()ยถ

์ƒ์žฅ๋œ ์ฃผ์‹ ์ •๋ณด๋ฅผ ์ฝ์–ด์˜จ๋‹ค.

Returns

data

Return type

pd.DataFrame

read(symbol, *, start=None, end=None, kind='stock', api=False, **kwargs)ยถ

ํ•ด๋‹น ์ฃผ์‹ ๊ฐ€๊ฒฉ ๋ฐ์ดํ„ฐ๋ฅผ ์‹œ์ž‘์ผ(start) ๋ถ€ํ„ฐ ์ข…๋ฃŒ์ผ(end) ๊นŒ์ง€ ์ฝ์–ด์˜จ๋‹ค.

Parameters
  • symbol (str) --

    ์กฐํšŒํ•˜๊ณ ์ž ํ•˜๋Š” ๋ฐ์ดํ„ฐ์˜ ์ข…๋ชฉ์ฝ”๋“œ.

    ํ˜•ํƒœ๋Š” ์ข…๋ชฉ๊ณผ ์ข…๋ฅ˜๋งˆ๋‹ค ๋‹ค๋ฅด๋‹ค.

    ์˜ˆ) ์‚ผ์„ฑ์ „์ž : '005930', ARIRANG 200 : '152100'

  • start (str) --

    ์กฐํšŒํ•˜๊ณ ์ž ํ•˜๋Š” ๋ฐ์ดํ„ฐ์˜ ์‹œ์ž‘์ผ.

    ํ˜•ํƒœ๋Š” YYYY-MM-DD๊ฐ€ ๋˜์–ด์•ผ ํ•œ๋‹ค.

    ์˜ˆ) 2021-06-01

  • end (str) --

    ์กฐํšŒํ•˜๊ณ ์ž ํ•˜๋Š” ๋ฐ์ดํ„ฐ์˜ ์ข…๋ฃŒ์ผ.

    ํ˜•ํƒœ๋Š” YYYY-MM-DD๊ฐ€ ๋˜์–ด์•ผ ํ•œ๋‹ค.

    ์˜ˆ) 2021-06-01

  • kind (str, default "stock") --

    ์กฐํšŒํ•˜๊ณ ์ž ํ•˜๋Š” ๋ฐ์ดํ„ฐ์˜ ์ข…๋ฅ˜.

    krx : ['stock', 'etf', 'index' ,'per', 'index', 'other_index']

  • kwargs --

    divisionstr

    ์กฐํšŒํ•˜๊ณ ์ž ํ•˜๋Š” ๋ฐ์ดํ„ฐ์˜ ์„ธ๋ถ€ ๊ตฌ๋ถ„

    other_index : ['์„ ๋ฌผ์ง€์ˆ˜', '์˜ต์…˜์ง€์ˆ˜', '์ „๋žต์ง€์ˆ˜', '์ƒํ’ˆ์ง€์ˆ˜']

    reversebool, default false

    dataframe์„ ๊ฑฐ๊พธ๋กœ ์ •๋ ฌํ•˜๊ธฐ

    korbool, default false

    columns๋ฅผ ํ•œ๊ธ€๋กœ ๋ฐ›์•„์˜ค๊ธฐ

    adjustbool, default false

    ์ˆ˜์ •์ฃผ๊ฐ€ ์ ์šฉํ•˜๊ธฐ

Returns

data

Return type

pd.DataFrame

Examples

>>> from coredotfinance.data import KrxReader
>>> krx = KrxReader()
>>> dataframe = krx.read('000660', start='2021-07-01')
read_all(symbol, *, kind='stock', api=False, **kwargs)ยถ

์ „๊ธฐ๊ฐ„์˜ ํ•ด๋‹น ์ฃผ์‹ ๊ฐ€๊ฒฉ ๋ฐ์ดํ„ฐ๋ฅผ ์ฝ์–ด์˜จ๋‹ค.

Parameters
  • symbol (str) --

    ์กฐํšŒํ•˜๊ณ ์ž ํ•˜๋Š” ๋ฐ์ดํ„ฐ์˜ ์ข…๋ชฉ์ฝ”๋“œ.

    ํ˜•ํƒœ๋Š” ์ข…๋ชฉ๊ณผ ์ข…๋ฅ˜๋งˆ๋‹ค ๋‹ค๋ฅด๋‹ค.

    ์˜ˆ) ์‚ผ์„ฑ์ „์ž : '005930', ARIRANG 200 : '152100'

  • kind (str, default "stock") --

    ์กฐํšŒํ•˜๊ณ ์ž ํ•˜๋Š” ๋ฐ์ดํ„ฐ์˜ ์ข…๋ฅ˜.

    krx : ["stock", "etf", "etn", "elw", "per"]

  • kwargs --

    kindstr

    ์กฐํšŒํ•˜๊ณ ์ž ํ•˜๋Š” ๋ฐ์ดํ„ฐ์˜ ์ข…๋ฅ˜

    krx : ['stock', 'etf', 'index' ,'per', 'index', 'other_index']

    divisionstr

    ์กฐํšŒํ•˜๊ณ ์ž ํ•˜๋Š” ๋ฐ์ดํ„ฐ์˜ ์„ธ๋ถ€ ๊ตฌ๋ถ„

    other_index : ['์„ ๋ฌผ์ง€์ˆ˜', '์˜ต์…˜์ง€์ˆ˜', '์ „๋žต์ง€์ˆ˜', '์ƒํ’ˆ์ง€์ˆ˜']

    reversebool, default false

    dataframe์„ ๊ฑฐ๊พธ๋กœ ์ •๋ ฌํ•˜๊ธฐ

    korbool, default false

    columns๋ฅผ ํ•œ๊ธ€๋กœ ๋ฐ›์•„์˜ค๊ธฐ

    adjustbool, default false

    ์ˆ˜์ •์ฃผ๊ฐ€ ์ ์šฉํ•˜๊ธฐ

Returns

data

Return type

pd.DataFrame

Examples

>>> from coredotfinance.data import KrxReader
>>> krx = KrxReader()
>>> dataframe = krx.read_all('000660')
read_date(date=None, *, kind='stock', api=False, **kwargs)ยถ

ํ•ด๋‹น ์ผ์ž์˜ ์ „ ์ข…๋ชฉ ์ฃผ์‹ ๋ฐ์ดํ„ฐ๋ฅผ ๋ถˆ๋Ÿฌ์˜จ๋‹ค.

Parameters
  • date (str) --

    ์กฐํšŒํ•˜๊ณ ์ž ํ•˜๋Š” ๋ฐ์ดํ„ฐ์˜ ์กฐํšŒ์ผ.

    ํ˜•ํƒœ๋Š” YYYY-MM-DD๊ฐ€ ๋˜์–ด์•ผ ํ•œ๋‹ค.

    ์˜ˆ) 2021-06-01

  • kind (str, default "stock") --

    ์กฐํšŒํ•˜๊ณ ์ž ํ•˜๋Š” ๋ฐ์ดํ„ฐ์˜ ์ข…๋ฅ˜.

    krx : ['stock', 'etf', 'index' ,'per', 'index', 'other_index']

  • kwargs --

    divisionstr

    ์กฐํšŒํ•˜๊ณ ์ž ํ•˜๋Š” ๋ฐ์ดํ„ฐ์˜ ์„ธ๋ถ€ ๊ตฌ๋ถ„

    other_index : ['์„ ๋ฌผ์ง€์ˆ˜', '์˜ต์…˜์ง€์ˆ˜', '์ „๋žต์ง€์ˆ˜', '์ƒํ’ˆ์ง€์ˆ˜']

    reversebool, default false

    dataframe์„ ๊ฑฐ๊พธ๋กœ ์ •๋ ฌํ•˜๊ธฐ

    korbool, default false

    columns๋ฅผ ํ•œ๊ธ€๋กœ ๋ฐ›์•„์˜ค๊ธฐ

    adjustbool, default false

    ์ˆ˜์ •์ฃผ๊ฐ€ ์ ์šฉํ•˜๊ธฐ

Returns

data

Return type

pd.DataFrame

Examples

>>> from coredotfinance.data import KrxReader
>>> krx = KrxReader()
>>> dataframe = krx.read_date('2021-07-20')
search(find, kind='stock', **kwargs)ยถ

ํ•„์š” ์ฃผ์‹์˜ ์ข…๋ชฉ์ฝ”๋“œ ๋˜๋Š” ์ข…๋ชฉ๋ช…์„ ๊ฒ€์ƒ‰ํ•œ๋‹ค.

Parameters
  • find (str) -- ์ข…๋ชฉ๋ช… ๋˜๋Š” ์ข…๋ชฉ์ฝ”๋“œ

  • kind (str) --

    ์กฐํšŒํ•˜๊ณ ์ž ํ•˜๋Š” ๋ฐ์ดํ„ฐ์˜ ์ข…๋ฅ˜

    krx : ['stock', 'etf', 'index' ,'per', 'index', 'other_index']

  • kwargs --

    divisionstr

    ์กฐํšŒํ•˜๊ณ ์ž ํ•˜๋Š” ๋ฐ์ดํ„ฐ์˜ ์„ธ๋ถ€ ๊ตฌ๋ถ„

Returns

์ข…๋ชฉ๋ช…, ์ข…๋ชฉ์ฝ”๋“œ, ์ข…๋ชฉ์ฝ”๋“œ์•ฝ์‹

Return type

tuple

Examples

>>> from coredotfinance.data import KrxReader
>>> krx = KrxReader()
>>> krx.search('์‚ผ์„ฑ์ „์ž')
>>> ('์‚ผ์„ฑ์ „์ž', 'KR7005930003', '005930')