Skip to main content

Sayou Stock Package for Financial Data from SEC, FnGuide, Naver, OpenDART, Yahoo

Project description

Sayou Stock

PyPI version License Docs

๐Ÿ“ฆ Installation

sayou-stock is automatically installed when you install any Sayou library.

pip install sayou-stock

๐Ÿ”‘ Key Components

  1. EDGARCrawler: SEC EDGAR 10-K, 10-Q, 8-K, 13F, DEF 14A
  2. FnGuideCrawler: FnGuide Company Information
  3. NaverCrawler: Naver Market API/Crawling
  4. OpenDartCrawler: OpenDART API
  5. YahooCrawler: Yahoo Finance API

๐Ÿค Usage Example

Retrieve SEC EDGAR 10-K

from sayou.stock.edgar import EDGARCrawler

crawler = EDGARCrawler(user_agent="Sayouzone sjkim@sayouzone.com")
ticker = "AAPL"

# Retrieve CIK by Ticker
cik = crawler.fetch_cik_by_ticker(ticker)

# EDGAR 10-K Annual Report
filings = crawler.fetch_filings(cik, doc_type="10-K", count=1)
data = crawler.extract_10k(cik, filings[0].document_url, filings[0].accession_number)

# EDGAR 10-Q Quarterly Report
filings = crawler.fetch_filings(cik, doc_type="10-Q", count=1)
data = crawler.extract_10q(cik, filings[0].document_url, filings[0].accession_number)

# EDGAR 8-K Current Report
filings = crawler.fetch_filings(cik, doc_type="8-K", count=1)
data = crawler.extract_8k(cik, filings[0].document_url, filings[0].accession_number)

# EDGAR 13F Institutional Holdings
filings = crawler.fetch_filings(cik, doc_type="13F", count=1)
data = crawler.extract_13f(cik, filings[0].document_url, filings[0].accession_number)

# EDGAR DEF 14A Proxy Statement 
filings = crawler.fetch_filings(cik, doc_type="DEF 14A", count=1)
data = crawler.extract_def14a(cik, filings[0].document_url, filings[0].accession_number)

Retrieve FnGuide's Company Information

from sayou.stock.fnguide import FnGuideCrawler

stock = "005930"
crawler = FnGuideCrawler()

data = crawler.finance(stock)
print(data)

data = crawler.company(stock)
print(data)

data = crawler.finance_ratio(stock)
print(data)

data = crawler.invest(stock)
print(data)

data = crawler.consensus(stock)
print(data)

๐Ÿ“š Package Hierarchy

sayou/stock
โ”‚   โ”œโ”€โ”€ edgar/
โ”‚   โ”‚   โ”œโ”€โ”€ __init__.py          # Public API Definition
โ”‚   โ”‚   โ”œโ”€โ”€ client.py            # SEC EDGAR HTTP Client
โ”‚   โ”‚   โ”œโ”€โ”€ models.py            # Data Class (DTO)
โ”‚   โ”‚   โ”œโ”€โ”€ utils.py             # Utility Functions & Constants
โ”‚   โ”‚   โ”œโ”€โ”€ crawler.py           # Unified Interface Crawler
โ”‚   โ”‚   โ””โ”€โ”€ parsers/
โ”‚   โ”‚       โ”œโ”€โ”€ __init__.py
โ”‚   โ”‚       โ”œโ”€โ”€ form_10k.py      # 10-K/10-Q Parser
โ”‚   โ”‚       โ”œโ”€โ”€ form_8k.py       # 8-K Parser
โ”‚   โ”‚       โ”œโ”€โ”€ form_13f.py      # 13F Parser
โ”‚   โ”‚       โ””โ”€โ”€ def14a.py        # DEF 14A Parser
โ”‚   โ”œโ”€โ”€ fnguide/
โ”‚   โ”‚   โ”œโ”€โ”€ __init__.py          # Public API Definition
โ”‚   โ”‚   โ”œโ”€โ”€ client.py            # OpenDART HTTP Client
โ”‚   โ”‚   โ”œโ”€โ”€ models.py            # Data Class (DTO)
โ”‚   โ”‚   โ”œโ”€โ”€ utils.py             # Utility Functions & Constants
โ”‚   โ”‚   โ”œโ”€โ”€ crawler.py           # Unified Interface Crawler
โ”‚   โ”‚   โ””โ”€โ”€ parsers/
โ”‚   โ”‚       โ”œโ”€โ”€ __init__.py
โ”‚   โ”‚       โ”œโ”€โ”€ company.py            # FnGuide Company Overview Parser
โ”‚   โ”‚       โ”œโ”€โ”€ comparison.py         # FnGuide Comparison Parser
โ”‚   โ”‚       โ”œโ”€โ”€ consensus.py          # FnGuide Consensus Parser
โ”‚   โ”‚       โ”œโ”€โ”€ dart.py               # FnGuide Dart Parser
โ”‚   โ”‚       โ”œโ”€โ”€ disclosure.py         # FnGuide Disclosure Parser
โ”‚   โ”‚       โ”œโ”€โ”€ finance_ratio.py      # FnGuide Finance Ratio Parser
โ”‚   โ”‚       โ”œโ”€โ”€ finance.py            # FnGuide Financial Statement Parser
โ”‚   โ”‚       โ”œโ”€โ”€ industry_analysis.py  # FnGuide Industry Analysis Parser
โ”‚   โ”‚       โ”œโ”€โ”€ invest.py             # FnGuide Investment Parser
โ”‚   โ”‚       โ”œโ”€โ”€ json_parser.py        # FnGuide JSON Parser
โ”‚   โ”‚       โ”œโ”€โ”€ main.py               # FnGuide Main Parser
โ”‚   โ”‚       โ”œโ”€โ”€ share_analysis.py     # FnGuide Share Analysis Parser
โ”‚   โ”‚       โ””โ”€โ”€ tables.py             # FnGuide Tables Parser
โ”‚   โ”œโ”€โ”€ naver/
โ”‚   โ”‚   โ”œโ”€โ”€ __init__.py          # Public API Definition
โ”‚   โ”‚   โ”œโ”€โ”€ client.py            # OpenDART HTTP Client
โ”‚   โ”‚   โ”œโ”€โ”€ models.py            # Data Class (DTO)
โ”‚   โ”‚   โ”œโ”€โ”€ utils.py             # Utility Functions & Constants
โ”‚   โ”‚   โ”œโ”€โ”€ crawler.py           # Unified Interface Crawler
โ”‚   โ”‚   โ””โ”€โ”€ parsers/
โ”‚   โ”‚       โ”œโ”€โ”€ __init__.py
โ”‚   โ”‚       โ”œโ”€โ”€ news.py          # Naver News Crawling Parser
โ”‚   โ”‚       โ””โ”€โ”€ market.py        # Naver Market API/Crawling Parser
โ”‚   โ”œโ”€โ”€ opendart/
โ”‚   โ”‚   โ”œโ”€โ”€ __init__.py          # Public API Definition
โ”‚   โ”‚   โ”œโ”€โ”€ client.py            # OpenDART HTTP Client
โ”‚   โ”‚   โ”œโ”€โ”€ models.py            # Data Class (DTO)
โ”‚   โ”‚   โ”œโ”€โ”€ utils.py             # Utility Functions & Constants
โ”‚   โ”‚   โ”œโ”€โ”€ crawler.py           # Unified Interface Crawler
โ”‚   โ”‚   โ””โ”€โ”€ parsers/
โ”‚   โ”‚       โ”œโ”€โ”€ __init__.py
โ”‚   โ”‚       โ”œโ”€โ”€ document.py        # Document API Parser
โ”‚   โ”‚       โ”œโ”€โ”€ document_viewer.py # Document Viewer API Parser
โ”‚   โ”‚       โ”œโ”€โ”€ disclosure.py      # Disclosure API Parser
โ”‚   โ”‚       โ”œโ”€โ”€ finance.py         # Finance API Parser
โ”‚   โ”‚       โ”œโ”€โ”€ material_facts.py  # Material Facts API Parser
โ”‚   โ”‚       โ”œโ”€โ”€ ownership.py       # Ownership API Parser
โ”‚   โ”‚       โ”œโ”€โ”€ registration.py    # Registration API Parser
โ”‚   โ”‚       โ””โ”€โ”€ reports.py         # Reports API Parser
โ”‚   โ””โ”€โ”€ yahoo/
โ”‚       โ”œโ”€โ”€ __init__.py          # Public API Definition
โ”‚       โ”œโ”€โ”€ client.py            # OpenDART HTTP Client
โ”‚       โ”œโ”€โ”€ models.py            # Data Class (DTO)
โ”‚       โ”œโ”€โ”€ utils.py             # Utility Functions & Constants
โ”‚       โ”œโ”€โ”€ crawler.py           # Unified Interface Crawler
โ”‚       โ””โ”€โ”€ parsers/
โ”‚           โ”œโ”€โ”€ __init__.py
โ”‚           โ”œโ”€โ”€ analysis.py      # Analysis API Parser
โ”‚           โ”œโ”€โ”€ chart.py         # Chart API Parser
โ”‚           โ”œโ”€โ”€ conversations.py # Conversations API Parser
โ”‚           โ”œโ”€โ”€ financials.py    # Financials API Parser
โ”‚           โ”œโ”€โ”€ fundamentals.py  # Fundamentals API Parser
โ”‚           โ”œโ”€โ”€ holders.py       # Holders API Parser
โ”‚           โ”œโ”€โ”€ market.py        # Market API Parser
โ”‚           โ”œโ”€โ”€ news.py          # News API Parser
โ”‚           โ”œโ”€โ”€ options.py       # Options API Parser
โ”‚           โ”œโ”€โ”€ profile.py       # Profile API Parser
โ”‚           โ”œโ”€โ”€ quotes.py        # Quotes API Parser
โ”‚           โ”œโ”€โ”€ statistics.py    # Statistics API Parser
โ”‚           โ””โ”€โ”€ summary.py       # Summary API Parser
โ”œโ”€โ”€ docs/
โ”œโ”€โ”€ tests/
โ”‚   โ”œโ”€โ”€ test_edgar_.py          # Edgar Test
โ”‚   โ”œโ”€โ”€ test_fnguide_.py        # FnGuide Test
โ”‚   โ”œโ”€โ”€ test_naver_.py          # Naver Test
โ”‚   โ”œโ”€โ”€ test_opendart_.py       # OpenDART Test
โ”‚   โ””โ”€โ”€ test_yahoo_.py          # Yahoo Test
โ”œโ”€โ”€ LICENSE
โ”œโ”€โ”€ pyproject.toml
โ””โ”€โ”€ README.md

๐Ÿ“œ License

Apache 2.0 License ยฉ 2025 Sayouzone

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sayou_stock-0.0.6.tar.gz (3.4 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sayou_stock-0.0.6-py3-none-any.whl (184.7 kB view details)

Uploaded Python 3

File details

Details for the file sayou_stock-0.0.6.tar.gz.

File metadata

  • Download URL: sayou_stock-0.0.6.tar.gz
  • Upload date:
  • Size: 3.4 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for sayou_stock-0.0.6.tar.gz
Algorithm Hash digest
SHA256 cc9f5e47c3f4567df276ebfa187c1684ce9b2901b711f85ae10ad3276ebb6aa0
MD5 715e61b2b4274d398e65c02108531f5a
BLAKE2b-256 13060657a757af5b8a659519c9684931f3fe1254727f25ad06998b81d59460b1

See more details on using hashes here.

File details

Details for the file sayou_stock-0.0.6-py3-none-any.whl.

File metadata

  • Download URL: sayou_stock-0.0.6-py3-none-any.whl
  • Upload date:
  • Size: 184.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for sayou_stock-0.0.6-py3-none-any.whl
Algorithm Hash digest
SHA256 6205478b8ad9a68a0a8db264d73557ae7ad980e1d153906dc8c3a79196717293
MD5 754bbcbeeb6f2ea5a0f38773cdc63a70
BLAKE2b-256 f5f066c9fc3a426a4571a46b917d9b5f2d28d1336e01ba13209f949f1e280359

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page