akkru_companies

Find a company and see what is covered for it.

#Actions

Action	What it does
`search`	Companies whose name contains query, or whose ticker or registrant id starts with it; up to 8 candidates, best match first. 10 credits.
`lookup`	One company by exactly one of ticker, cik, dart_corp_code, edinet_code, lei or uscc: its identity, every ticker it has traded under, links to its filings lists, and the forms, fiscal years and quarters on file. 8 credits, also when no company matches.
`list`	Every company covered, 100 per page; jurisdiction filters by market. 30 credits per page.

Results stop at your plan's coverage. On Pro plans and above, search and list also give each company's industry classification.

#Parameters

querystring

Name, ticker or registrant id to search for (1-64 characters); English names only.

jurisdictionstring

Market: "US", "KR", "JP", "EU", "CN", or "all" (default: every market your plan covers).

tickerstring

Ticker, e.g. "AAPL", "000100", "1332", "VIRI_F", "600519_CN"; any symbol the company has traded under.

cikstring

SEC CIK, digits, e.g. "320193" (companies filing with the SEC).

dart_corp_codestring

Korean DART corp code, 8 digits, e.g. "00126380".

edinet_codestring

Japanese EDINET code, e.g. "E02778".

leistring

Legal Entity Identifier, 20 characters (European filers).

usccstring

Unified Social Credit Code, 18 characters (China A-share companies).

pageinteger

Page number, from 1; the response's next_page gives the next one.

page_sizeinteger

Companies per page, 1-100 (default 100).

detailstring

Response detail: "full" (default) returns the most detail available; "light" leaves out the bulkiest fields, such as breakdown lists; "minimal" returns the values with only what defines them. All three are charged the same. One of full, light, minimal.

#Examples

JSON

{"action": "search", "query": "apple"}

JSON

{"action": "lookup", "ticker": "AAPL"}

JSON

{"action": "list", "jurisdiction": "US", "page": 1}