{"openapi":"3.1.0","info":{"title":"JapanStake API","version":"0.4.0","description":"Japanese listed-company data from EDINET, in English."},"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"security":[{"bearer":[]}],"paths":{"/v1/companies/search":{"get":{"summary":"Search listed companies by ticker or English/Japanese name","parameters":[{"name":"q","in":"query","required":true},{"name":"limit","in":"query","required":false}]}},"/v1/companies/{ticker}":{"get":{"summary":"Company profile with FIGI and common ticker symbols","parameters":[{"name":"ticker","in":"path","required":true}]}},"/v1/companies/{ticker}/financials":{"get":{"summary":"Five-year key metrics and current/prior income statement, balance sheet and cash flow","parameters":[{"name":"ticker","in":"path","required":true}]}},"/v1/companies/{ticker}/details":{"get":{"summary":"Officer titles (no names), workforce, major shareholders (individuals not named), shareholder mix, auditor and fees","parameters":[{"name":"ticker","in":"path","required":true}]}},"/v1/companies/{ticker}/segments":{"get":{"summary":"Segments stated in the latest annual securities report","parameters":[{"name":"ticker","in":"path","required":true}]}},"/v1/companies/{ticker}/voting":{"get":{"summary":"Shareholder-meeting voting results for one company","parameters":[{"name":"ticker","in":"path","required":true},{"name":"since","in":"query","required":false},{"name":"limit","in":"query","required":false}]}},"/v1/companies/{ticker}/tender-offers":{"get":{"summary":"Tender-offer notifications, results and target opinions for one company","parameters":[{"name":"ticker","in":"path","required":true},{"name":"since","in":"query","required":false},{"name":"limit","in":"query","required":false}]}},"/v1/voting":{"get":{"summary":"Shareholder-meeting voting results across companies","parameters":[{"name":"since","in":"query","required":false},{"name":"limit","in":"query","required":false}]}},"/v1/tender-offers":{"get":{"summary":"Tender-offer notifications, results and target opinions across companies","parameters":[{"name":"since","in":"query","required":false},{"name":"limit","in":"query","required":false}]}},"/v1/companies/{ticker}/us-funds":{"get":{"summary":"U.S. mutual funds and ETFs holding the stock, from SEC N-PORT","parameters":[{"name":"ticker","in":"path","required":true}]}},"/v1/large-holdings":{"get":{"summary":"5% rule filings with holders, purposes and changes","parameters":[{"name":"ticker","in":"query","required":false},{"name":"filer","in":"query","required":false},{"name":"since","in":"query","required":false},{"name":"limit","in":"query","required":false}]}},"/v1/investors/{code}":{"get":{"summary":"An investor's 5% filings, latest positions and joint holders","parameters":[{"name":"code","in":"path","required":true},{"name":"limit","in":"query","required":false}]}},"/v1/companies/{ticker}/cross-holdings":{"get":{"summary":"Cross-shareholdings: strategic stakes the company holds, listed companies holding it, mutual pairs, and unwinding totals","parameters":[{"name":"ticker","in":"path","required":true}]}},"/v1/companies/{ticker}/trades":{"get":{"summary":"Trades disclosed by 5% holders in the last 60 days of each report: date, shares, on/off market, unit price, with net flow and average disclosed price per holder","parameters":[{"name":"ticker","in":"path","required":true},{"name":"since","in":"query","required":false},{"name":"limit","in":"query","required":false}]}},"/v1/investors/{code}/trades":{"get":{"summary":"Trades one filer disclosed across all companies","parameters":[{"name":"code","in":"path","required":true},{"name":"since","in":"query","required":false},{"name":"limit","in":"query","required":false}]}},"/v1/companies/{ticker}/indicators":{"get":{"summary":"Per-metric financial percentile ranks (not a rating), policy-uncertainty counts by area, results wording balance, ownership activity counts and a 50 bp interest example on reported debt","parameters":[{"name":"ticker","in":"path","required":true}]}},"/v1/companies/{ticker}/earnings-releases":{"get":{"summary":"Period results from half-year and quarterly securities reports on EDINET, with year-on-year % as filed and the source filing","parameters":[{"name":"ticker","in":"path","required":true},{"name":"limit","in":"query","required":false}]}},"/v1/earnings-releases":{"get":{"summary":"Latest period results across companies, from EDINET half-year and quarterly reports","parameters":[{"name":"since","in":"query","required":false},{"name":"limit","in":"query","required":false}]}},"/v1/companies/{ticker}/brief":{"get":{"summary":"One company on one page, from its filings: latest results, indicator figures, ownership changes in the last 180 days and a mechanical 50 bp interest example on its reported debt, each dated","parameters":[{"name":"ticker","in":"path","required":true}]}},"/v1/companies/{ticker}/credit-ratings":{"get":{"summary":"Credit ratings as the company states them in its bond filings on EDINET: agency, rating, date, bond, source filing. We do not rate anything","parameters":[{"name":"ticker","in":"path","required":true}]}},"/v1/credit-ratings":{"get":{"summary":"Ratings stated in bond filings across issuers, including unlisted ones","parameters":[{"name":"agency","in":"query","required":false},{"name":"since","in":"query","required":false},{"name":"limit","in":"query","required":false}]}},"/v1/companies/{ticker}/buybacks":{"get":{"summary":"Monthly share-buyback reports: resolution limits, shares and yen acquired, progress and average price as arithmetic","parameters":[{"name":"ticker","in":"path","required":true},{"name":"limit","in":"query","required":false}]}},"/v1/companies/{ticker}/governance":{"get":{"summary":"Internal-control conclusions and auditor changes as the company states them, with source","parameters":[{"name":"ticker","in":"path","required":true},{"name":"limit","in":"query","required":false}]}},"/v1/governance":{"get":{"summary":"Governance filings across companies, by type: internal_control or auditor_change","parameters":[{"name":"type","in":"query","required":false},{"name":"since","in":"query","required":false},{"name":"limit","in":"query","required":false}]}},"/v1/cross-holdings/trades":{"get":{"summary":"Disclosed trades and prices where a listed filer also lists the stock as a strategic holding","parameters":[{"name":"ticker","in":"query","required":false},{"name":"holder","in":"query","required":false},{"name":"since","in":"query","required":false},{"name":"limit","in":"query","required":false}]}},"/v1/indicators/policy-uncertainty":{"get":{"summary":"Japan corporate policy-uncertainty index by filing month, with shares by policy area"}},"/v1/indicators/sorted":{"get":{"summary":"Companies in the order of one figure or percentile, optionally by sector. Arithmetic order, no judgement","parameters":[{"name":"metric","in":"query","required":true},{"name":"order","in":"query","required":false},{"name":"sector","in":"query","required":false},{"name":"limit","in":"query","required":false}]}},"/v1/cross-holdings/unwinding":{"get":{"summary":"Companies with the largest stated sales of listed strategic shares in their latest fiscal year","parameters":[{"name":"limit","in":"query","required":false}]}},"/v1/investor-groups":{"get":{"summary":"Search investor groups by English or Japanese name, or list them by companies held. Natural persons are excluded","parameters":[{"name":"q","in":"query","required":false},{"name":"kind","in":"query","required":false},{"name":"limit","in":"query","required":false}]}},"/v1/investor-groups/{id}":{"get":{"summary":"One group: members, match rule and confidence per member","parameters":[{"name":"id","in":"path","required":true}]}},"/v1/investor-groups/{id}/portfolio":{"get":{"summary":"What a group's filers report holding, with dated entries and exits","parameters":[{"name":"id","in":"path","required":true},{"name":"status","in":"query","required":false},{"name":"limit","in":"query","required":false}]}},"/v1/investor-groups/{id}/changes":{"get":{"summary":"Ownership events of a group's filers, cursor-paged","parameters":[{"name":"id","in":"path","required":true},{"name":"after_at","in":"query","required":false},{"name":"after_id","in":"query","required":false},{"name":"limit","in":"query","required":false}]}},"/v1/investor-groups/{id}/overlap":{"get":{"summary":"Groups with disclosed stakes in the same companies, and joint holders as filings state them","parameters":[{"name":"id","in":"path","required":true},{"name":"source","in":"query","required":false},{"name":"limit","in":"query","required":false}]}},"/v1/companies/{ticker}/timeline":{"get":{"summary":"Merged dated list: stake changes, buybacks, cross-holding changes and tender-offer filings, including disclosed trades","parameters":[{"name":"ticker","in":"path","required":true},{"name":"since","in":"query","required":false},{"name":"type","in":"query","required":false},{"name":"limit","in":"query","required":false}]}},"/v1/companies/{ticker}/unwinding-trades":{"get":{"summary":"Strategic-holding reductions from annual reports next to trades the holder disclosed in 5% reports","parameters":[{"name":"ticker","in":"path","required":true},{"name":"limit","in":"query","required":false}]}},"/v1/events":{"get":{"summary":"Ownership-change events from 5% filings with English summaries: new_stake, stake_increase, stake_decrease, exit_below_5pct, threshold_crossed, stated_may_make_proposals, purpose_changed, amendment","parameters":[{"name":"ticker","in":"query","required":false},{"name":"filer","in":"query","required":false},{"name":"type","in":"query","required":false},{"name":"since","in":"query","required":false},{"name":"limit","in":"query","required":false}]}},"/v1/webhooks":{"get":{"summary":"Your webhook subscriptions and delivery status"},"post":{"summary":"Subscribe a URL to ownership events. Body: {url, types?, tickers?, replay_from?}. Returns the signing secret once"}},"/v1/webhooks/{id}":{"delete":{"summary":"Delete a webhook","parameters":[{"name":"id","in":"path","required":true}]}},"/v1/webhooks/{id}/test":{"post":{"summary":"Send the latest event to the webhook, marked test: true","parameters":[{"name":"id","in":"path","required":true}]}},"/v1/filings":{"get":{"summary":"EDINET filing metadata","parameters":[{"name":"ticker","in":"query","required":false},{"name":"doc_type","in":"query","required":false},{"name":"since","in":"query","required":false},{"name":"limit","in":"query","required":false}]}},"/v1/status":{"get":{"summary":"Overall data status and each dataset's status (no key)","security":[]}},"/v1/freshness":{"get":{"summary":"Every dataset: source, target interval, last successful run, newest source date, rows, status, coverage (no key)","security":[]}},"/v1/filings/latest":{"get":{"summary":"Filings newest first by when they were first seen on EDINET's list, within minutes","parameters":[{"name":"ticker","in":"query","required":false},{"name":"since","in":"query","required":false},{"name":"limit","in":"query","required":false}]}},"/v1/companies/{ticker}/refresh":{"post":{"summary":"Queue a re-check of one company's EDINET documents. Rate-limited; joins an open request","parameters":[{"name":"ticker","in":"path","required":true}]},"get":{"summary":"Latest refresh status and when it was checked","parameters":[{"name":"ticker","in":"path","required":true}]}},"/v1/batch/companies":{"get":{"summary":"Company profiles for up to 50 tickers. Counts one request per ticker","parameters":[{"name":"tickers","in":"query","required":true}]}},"/v1/batch/financials":{"get":{"summary":"Five-year key metrics for up to 50 tickers; statements=true adds the statements. Counts one request per ticker","parameters":[{"name":"tickers","in":"query","required":true},{"name":"statements","in":"query","required":false}]}},"/v1/usage":{"get":{"summary":"Your plan, requests used this month, remaining, reset time and per-minute limit"}},"/v1/companies":{"get":{"summary":"All listed companies in ticker order, paged with next_cursor","parameters":[{"name":"cursor","in":"query","required":false},{"name":"limit","in":"query","required":false}]}},"/v1/sectors":{"get":{"summary":"Sectors with slug, English and Japanese names and company counts"}},"/v1/sectors/{sector}/benchmarks":{"get":{"summary":"Median and quartiles of filing figures across a sector's companies","parameters":[{"name":"sector","in":"path","required":true}]}},"/v1/companies/{ticker}/peers":{"get":{"summary":"Companies in the same sector with the nearest revenue","parameters":[{"name":"ticker","in":"path","required":true},{"name":"limit","in":"query","required":false}]}},"/v1/screener":{"get":{"summary":"Filter companies on figures from filings: sector, revenue, margins, ROE, equity ratio, growth, cross-held share, percentiles, policy uncertainty, and a bond rating as stated in filings (the agency's opinion on that date, not ours). No stock prices","parameters":[{"name":"sector","in":"query","required":false},{"name":"min_revenue","in":"query","required":false},{"name":"max_revenue","in":"query","required":false},{"name":"min_net_income","in":"query","required":false},{"name":"max_net_income","in":"query","required":false},{"name":"min_total_assets","in":"query","required":false},{"name":"max_total_assets","in":"query","required":false},{"name":"min_ordinary_margin","in":"query","required":false},{"name":"max_ordinary_margin","in":"query","required":false},{"name":"min_net_margin","in":"query","required":false},{"name":"max_net_margin","in":"query","required":false},{"name":"min_roe","in":"query","required":false},{"name":"max_roe","in":"query","required":false},{"name":"min_equity_ratio","in":"query","required":false},{"name":"max_equity_ratio","in":"query","required":false},{"name":"min_revenue_growth","in":"query","required":false},{"name":"max_revenue_growth","in":"query","required":false},{"name":"min_net_income_growth","in":"query","required":false},{"name":"max_net_income_growth","in":"query","required":false},{"name":"min_ocf_to_assets","in":"query","required":false},{"name":"max_ocf_to_assets","in":"query","required":false},{"name":"min_cross_held_pct","in":"query","required":false},{"name":"max_cross_held_pct","in":"query","required":false},{"name":"min_mean_percentile","in":"query","required":false},{"name":"max_mean_percentile","in":"query","required":false},{"name":"min_mean_percentile_within_sector","in":"query","required":false},{"name":"max_mean_percentile_within_sector","in":"query","required":false},{"name":"min_policy_uncertainty","in":"query","required":false},{"name":"max_policy_uncertainty","in":"query","required":false},{"name":"min_policy_uncertainty_percentile","in":"query","required":false},{"name":"max_policy_uncertainty_percentile","in":"query","required":false},{"name":"has_stated_rating","in":"query","required":false},{"name":"min_stated_rating","in":"query","required":false},{"name":"sort","in":"query","required":false},{"name":"order","in":"query","required":false},{"name":"limit","in":"query","required":false},{"name":"cursor","in":"query","required":false}]}}}}