Reference on jfinance

Ticker

Mon, 01 Jan 0001 00:00:00 +0000

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.

Financial data

Mon, 01 Jan 0001 00:00:00 +0000

Financial data

Three families of method return financial figures.

Method	Shape
`financials`, `balance_sheet`, `cashflow`	The statements folded into yfinance’s line items
`get_jp_financials`	Japanese items yfinance has no name for
`get_statements`	Every line of the filed statements, in the filed order

Statements

get_income_stmt

Ticker.financials -> pandas.DataFrame
Ticker.income_stmt -> pandas.DataFrame
Ticker.get_income_stmt(as_dict=False, pretty=False, freq="yearly")
Ticker.get_financials(as_dict=False, pretty=False, freq="yearly")

Income statement. financials, income_stmt, incomestmt and get_financials are aliases of the same data, as in yfinance.

Parameters

Name	Type	Default	Description
`as_dict`	`bool`	`False`	Return a `dict` instead of a `DataFrame`
`pretty`	`bool`	`False`	Space-separated row labels (`Total Revenue`) instead of keys (`TotalRevenue`)
`freq`	`str`	`"yearly"`	`"yearly"`, `"semiannual"` or `"quarterly"`. `"trailing"` raises `ValueError`

Returns — pandas.DataFrame, line items as rows and period end dates as columns, newest first. Values are in yen.

Shareholders

Mon, 01 Jan 0001 00:00:00 +0000

Shareholders

Japanese disclosure splits shareholder information across several filings, and jfinance exposes each one separately rather than merging them.

Method	Source
`major_holders`	Annual report, ownership breakdown
`major_shareholders`	Annual report, major shareholders
`institutional_holders`	Large shareholding reports, special filing rule
`insider_roster_holders`	Annual report, officers
`large_holders`, `large_holder_transactions`, `large_holder_activity`, `large_holding_reports`	Large shareholding reports

From the annual report

get_major_holders

Ticker.major_holders -> pandas.DataFrame
Ticker.get_major_holders(as_dict=False) -> pandas.DataFrame | dict

Ownership percentages by holder type, from the ownership breakdown in the annual report. Available from fiscal 2019 annual reports.

Officers and pay

Mon, 01 Jan 0001 00:00:00 +0000

Officers and pay

Officers are disclosed once a year, in the annual report. These methods therefore give a yearly snapshot, not a record of appointments and resignations. All of them have amendment filings applied.

Officers

get_officers

Ticker.officers -> pandas.DataFrame
Ticker.get_officers(year=None) -> pandas.DataFrame

The officers named in the annual report.

Parameters

Name	Type	Default	Description
`year`	`int`	`None`	Fiscal year. Latest annual report when omitted. Available years are in `.attrs["years"]`

Returns — pandas.DataFrame, one row per officer.

Filings and disclosures

Mon, 01 Jan 0001 00:00:00 +0000

Filings and disclosures

Filings themselves, and the parts of the annual report that are neither financial statements nor officer information.

Filings

sec_filings

Ticker.sec_filings -> list[dict]
Ticker.get_sec_filings() -> list[dict]

The 100 most recent filings, newest first, under yfinance’s key names. Use get_filings for filtering and paging.

Returns — list[dict]

Key	Type	Description
`date`	`datetime.date`	Filing date
`epochDate`	`int`	Filing date, Unix seconds
`type`	`str`	Document type, as in `自己株券買付状況報告書`
`title`	`str`	Title of the filing
`documentId`	`str`	EDINET document ID, as in `S100Z1LW`
`docTypeCode`	`str`	EDINET document type code, as in `"220"`
`edgarUrl`	`None`	Present for yfinance compatibility and always `None`

get_filings

Ticker.filings -> pandas.DataFrame
Ticker.get_filings(types=None, year=None, limit=100, offset=0) -> pandas.DataFrame

Every filing made for the company, newest first. The total number of filings is in .attrs["total"].

Investment trusts

Mon, 01 Jan 0001 00:00:00 +0000

Investment trusts

A fund is identified by its EDINET fund code, which begins with G, or by its securities code if it is exchange traded.

f = jf.Ticker("1306.T") # "G02925" works too
f.get_fund_financials()

get_fund_financials

Ticker.get_fund_financials(freq="yearly", start=None) -> pandas.DataFrame

The 25 financial items disclosed in fund reports.

Parameters

Name	Type	Default	Description
`freq`	`str`	`"yearly"`	`"yearly"` or `"semiannual"`. Funds file no quarterly reports, and there is no trailing-twelve-month figure
`start`	`str`	`None`	Earliest period end to return, as `"2020-07-10"`. All periods when omitted

Returns — pandas.DataFrame, items as rows and period end dates as columns, newest first.

Search, industries, screener

Mon, 01 Jan 0001 00:00:00 +0000

Search, industries, screener

Search

jfinance.Search(query, max_results=8, session=None, timeout=30, raise_errors=True)

Finds companies and funds by name or code.

Parameters

Name	Type	Default	Description
`query`	`str`	—	Company name, securities code or EDINET code
`max_results`	`int`	`8`	Maximum number of matches
`session`	`requests.Session`	`None`	Session to reuse
`timeout`	`int`	`30`	Seconds
`raise_errors`	`bool`	`True`	Raise on an HTTP error instead of returning empty

The remaining yfinance arguments — news_count, lists_count, include_research and the rest — are accepted and ignored, since EDINET carries none of that.

Configuration

Mon, 01 Jan 0001 00:00:00 +0000

Configuration

Settings are global and apply for the life of the process.

Settings

config

jfinance.config

Settings object, the same one yfinance uses.

Setting	Type	Default	Description
`config.locale.lang`	`str`	`"en-US"`	`"ja-JP"` returns company and industry names in Japanese
`config.locale.region`	`str`	`"US"`	Region
`config.network.proxy`	`str`	`None`	HTTP proxy
`config.network.retries`	`int`	`0`	Retries on a failed request
`config.debug.logging`	`bool`	`False`	Log requests and responses
`config.debug.hide_exceptions`	`bool`	`True`	Swallow exceptions inside attribute access

jf.config.locale.lang = "ja-JP"
jf.Ticker("7203.T").info["shortName"] # 'トヨタ自動車株式会社'

Values with no English original — business descriptions, and the names of officers and shareholders — are returned in Japanese under either setting.

Financial keys

Mon, 01 Jan 0001 00:00:00 +0000

Financial keys

Of the 371 financial keys yfinance 1.5.2 requests, these are the ones jfinance returns a value for. A key not listed here produces no row at all, the same as in yfinance: the rows that appear are those the company actually discloses, in yfinance’s order.

Row — the name shown by Ticker.financials and similar (pretty=True). get_financials(pretty=False) uses the key instead
Status — Direct = same meaning / Caveat = returned, but the meaning can shift with accounting standard, industry or sign
Values are in yen (per-share figures in yen, share counts in shares). Ratios are decimals (0.101 = 10.1%)

Income statement

Key	Row	Status	Note
`NetIncomeFromContinuingOperationNetMinorityInterest`	Net Income From Continuing Operation Net Minority Interest	Caveat	Discontinued operations are not separated
`ReconciledDepreciation`	Reconciled Depreciation	Direct
`ReconciledCostOfRevenue`	Reconciled Cost Of Revenue	Direct
`InterestExpense`	Interest Expense	Direct
`InterestIncome`	Interest Income	Direct
`TotalOperatingIncomeAsReported`	Total Operating Income As Reported	Direct
`DilutedEPS`	Diluted EPS	Direct
`BasicEPS`	Basic EPS	Direct
`NetIncomeCommonStockholders`	Net Income Common Stockholders	Direct
`NetIncome`	Net Income	Direct	Profit attributable to owners of the parent
`MinorityInterests`	Minority Interests	Direct	Profit attributable to non-controlling interests
`TaxProvision`	Tax Provision	Direct
`PretaxIncome`	Pretax Income	Direct
`InterestExpenseNonOperating`	Interest Expense Non Operating	Direct
`InterestIncomeNonOperating`	Interest Income Non Operating	Direct
`OperatingIncome`	Operating Income	Direct	IFRS filers define operating income differently from Japanese GAAP
`DepreciationAndAmortizationInIncomeStatement`	Depreciation And Amortization In Income Statement	Caveat	Taken from the cash flow statement
`ResearchAndDevelopment`	Research And Development	Caveat	The total disclosed in the notes is used, not the portion within SG&A
`SellingGeneralAndAdministration`	Selling General And Administration	Direct
`GrossProfit`	Gross Profit	Direct
`CostOfRevenue`	Cost Of Revenue	Direct
`TotalRevenue`	Total Revenue	Caveat	The underlying line item differs by industry (net sales / operating revenue / ordinary revenue)
`OperatingRevenue`	Operating Revenue	Caveat	Returns the same value as TotalRevenue

Balance sheet

Key	Row	Status	Note
`OrdinarySharesNumber`	Ordinary Shares Number	Caveat	Total shares issued, including treasury shares
`ShareIssued`	Share Issued	Direct
`TotalEquityGrossMinorityInterest`	Total Equity Gross Minority Interest	Direct	Total net assets, including non-controlling interests
`MinorityInterest`	Minority Interest	Direct
`RetainedEarnings`	Retained Earnings	Direct
`CapitalStock`	Capital Stock	Direct
`CommonStock`	Common Stock	Direct
`TotalLiabilitiesNetMinorityInterest`	Total Liabilities Net Minority Interest	Direct
`TotalAssets`	Total Assets	Direct
`Goodwill`	Goodwill	Direct
`CashAndCashEquivalents`	Cash And Cash Equivalents	Caveat	Closing balance from the cash flow statement, not cash and deposits on the balance sheet
`CashFinancial`	Cash Financial	Caveat	Cash and deposits on a Japanese GAAP balance sheet

Cash flow statement

Key	Row	Status	Note
`CapitalExpenditure`	Capital Expenditure	Caveat	An outflow, therefore negative. Taken from the cash flow statement
`EndCashPosition`	End Cash Position	Direct
`FinancingCashFlow`	Financing Cash Flow	Direct
`CashFlowFromContinuingFinancingActivities`	Cash Flow From Continuing Financing Activities	Direct
`CashDividendsPaid`	Cash Dividends Paid	Caveat	An outflow, therefore negative
`CommonStockDividendPaid`	Common Stock Dividend Paid	Caveat	As above
`InvestingCashFlow`	Investing Cash Flow	Direct
`CashFlowFromContinuingInvestingActivities`	Cash Flow From Continuing Investing Activities	Direct
`OperatingCashFlow`	Operating Cash Flow	Direct
`CashFlowFromContinuingOperatingActivities`	Cash Flow From Continuing Operating Activities	Direct
`DepreciationAmortizationDepletion`	Depreciation Amortization Depletion	Direct
`DepreciationAndAmortization`	Depreciation And Amortization	Direct

Japan-specific keys

Disclosure items with no equivalent name in Yahoo Finance. Retrieve them with Ticker.get_jp_financials(). Over HTTP, prefix them with annual, quarterly or semiannual in type= (for example annualOrdinaryIncome).