Ticker
jfinance.Ticker(ticker, session=None)Holds the data for one company or fund. Every attribute is fetched from the server on first access and reused for the lifetime of the object.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
ticker | str | — | Securities code ("7203.T"), EDINET code ("E02144"), ISIN ("JP3633400001") or EDINET fund code ("G02925"). See Ticker symbols |
session | requests.Session | None | Session to reuse. A shared session is created when omitted |
import jfinance as jf
t = jf.Ticker("7203.T")
t.info["shortName"] # 'TOYOTA MOTOR CORPORATION'Most attributes have a get_ method of the same name. The attribute takes no arguments; the
method accepts the arguments documented alongside it.
Index
| Attribute or method | Documented in |
|---|---|
info, isin, min_fiscal_year, shares, get_shares_full | This page |
financials, balance_sheet, cashflow, quarterly_*, get_jp_financials, get_statements, get_segments | Financial data |
major_holders, major_shareholders, institutional_holders, insider_roster_holders, large_holders, large_holder_transactions, large_holder_activity, large_holding_reports | Shareholders |
officers, officer_compensation, officer_remuneration, audit_fees | Officers and pay |
sec_filings, filings, report_filing_dates, employees, emissions, dividend_resolutions | Filings and disclosures |
funds_data, get_fund_financials | Investment trusts |
Share prices, dividend history, splits, options, analyst estimates, news, earnings calendars
and ESG scores do not exist in EDINET. The corresponding yfinance attributes are not
defined, and accessing one raises AttributeError.
Company profile
info
Ticker.info -> dict
Ticker.get_info() -> dictCompany profile, headline figures and the officer list, under the key names yfinance uses. 52 keys are returned for a listed company. A key with no source in EDINET is absent from the dictionary rather than present and empty.
Returns — dict
| Key | Type | Description |
|---|---|---|
symbol, shortName, longName | str | Symbol and company name. English unless config.locale.lang is "ja-JP" |
edinetCode, isin, corporateNumber | str | EDINET code, ISIN, corporate number |
sector, sectorKey, sectorCode | str, str, int | TOPIX-17 classification |
industry, industryKey, industryCode | str, str, int | TSE 33 industry classification |
market, marketSegment, topixScale, listingStatus | str | Market and segment, as in プライム(内国株式), TOPIX Core30, listed |
country, currency, financialCurrency, region | str | Always Japan, JPY, JP |
fiscalYearEnd | str | Fiscal year end as disclosed, as in 3月31日 |
lastFiscalYearEnd, nextFiscalYearEnd | int | Unix seconds |
fullTimeEmployees | int | Employees of the filing company |
longBusinessSummary | str | Business description. Japanese under either language setting — EDINET holds no English original |
businessSummaryDocumentId | str | Document ID the description was taken from |
companyOfficers | list[dict] | Officers, each with name, title, age and totalPay where disclosed |
totalRevenue, grossProfits, netIncomeToCommon, operatingCashflow, totalCash | int | Latest annual figures, in yen |
sharesOutstanding | int | Shares outstanding |
trailingEps, dilutedEps, bookValue, dividendRate | float | Per share, in yen |
returnOnEquity, equityRatio, payoutRatio | float | Decimals, so 0.101 is 10.1% |
capitalMillionJpy | int | Stated capital, in millions of yen |
quoteType | str | "EQUITY" or "MUTUALFUND" |
Price-derived keys such as
currentPrice,marketCap,trailingPEandfiftyTwoWeekHighare never present.
isin
Ticker.isin -> str | None
Ticker.get_isin() -> str | NoneISIN of the security, or None where the filer has none, as for an unlisted company.
min_fiscal_year
Ticker.min_fiscal_year -> int | NoneEarliest fiscal year the server will return. Requests for earlier years give empty results
rather than an error. https://query1.jfnc.org returns 2016; a self-hosted server sets no
limit by default and returns None. The value is unknown until the first request has been
made, and is None until then.
Share count
shares
Ticker.shares -> pandas.DataFrame
Ticker.get_shares(as_dict=False) -> pandas.DataFrame | dictShares outstanding by fiscal year, from the annual report.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
as_dict | bool | False | Return a dict instead of a DataFrame |
get_shares_full
Ticker.get_shares_full(start=None, end=None) -> pandas.Series | NoneShares outstanding over a period.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
start | str, datetime.date | None | Start of the period. Earliest available when omitted |
end | str, datetime.date | None | End of the period. Today when omitted |
Japanese disclosure reports the share count once a year, so the series changes only at fiscal year ends.