CIK Lookup

The CIKLookup class allows users to get company filings using company tickers and/or company names.

Note

By default, the CompanyFilings class wraps any given string or an iterable with string objects (e.g. a list of strings or a tuple of strings). You will probably not need to use this class. However, it can be useful if you wish to save the CIKs for lookup terms.

Below is an example of how you can retrieve lookup CIKs by using the CIKLookup class.

from secedgar.core.cik_lookup import CIKLookup

lookups = CIKLookup(['aapl', 'msft', 'Facebook'],
                    user_agent="Name (email)")

Accessing lookups.lookup_dict would then return

{'aapl': '320193', 'msft': '789019', 'Facebook': '0001326801'}

Another alternative to using the CIKLookup class directly is to use the provided secedgar.cik_lookup.get_cik_map() function.

class secedgar.cik_lookup.CIKLookup(lookups, client, **kwargs)

CIK Lookup object.

Given list of tickers/company names to lookup, this object can return associated CIKs.

Parameters

New in version 0.1.5.

property ciks

List of CIKs (as string of digits).

Type

list of str

property client

Client to use to fetch requests.

Type

secedgar.client.NetworkClient

get_ciks()

Validate lookup values and return corresponding CIKs.

Returns

Dictionary with lookup terms as keys and CIKs as values.

Return type

ciks (dict)

property lookup_dict

Dictionary that makes tickers and company names to CIKs.

Type

dict

property lookups

list of str to lookup (to get CIK values).

property params

dict Search parameters to add to client.

property path

Path to add to client base.

Type

str