EDGAR (edgar_client v0.10.0)
Summary
Functions
Fetches the administrative proceedings feed
Fetches a CIK for a given company ticker
Fetches company concepts for a given CIK and concept (taxonomy, tag)
Fetches company facts for a given CIK
Fetches the company feed for a given CIK
Parses the company feed
Parses a company index file from file
Parses a company index file from string
Parses a company index file from url
Fetches a list of company tickers
Fetches a list of company tickers with exchange
Parses a crawler index file from file
Parses a crawler index file from a string
Parses a crawler index file from url
Fetches the current feed for a given CIK
Parses the current feed
Fetches the daily index
Fetches the division of corporation finance news feed
Fetches the division of investment management news feed
Fetches the entity directory
Fetches the filing directory
Parses a filing feed from a string
Fetches a list of filings from the submissions file
Fetches the recent filings rss feed
Parses form 3 and 3/A ownership filing types from a given file path
Parses form 3 and 3/A filing types from a given CIK and accession number
Parses form 3 and 3/A ownership filing types from a given string
Parses form 3 and 3/A ownership filing types from a given url
Parses form 4 and 4/A ownership filing types from a given file path
Parses form 4 and 4/A filing types from a given CIK and accession number
Parses form 4 and 4/A ownership filing types from a given string
Parses form 4 and 4/A ownership filing types from a given url
Parses form 5 and 5/A ownership filing types from a given file path
Parses form 5 and 5/A filing types from a given CIK and accession number
Parses form 5 and 5/A ownership filing types from a given string
Parses form 5 and 5/A ownership filing types from a given url
Parses a form 13F document from a given file path
Parses a form 13F filing primary document from a string
Parses a form 13F filing from a given url
Parses a form 13F filing for a given CIK and accession number
Parses a form 13F filing table from a file
Parses a form 13F filing table from a string
Parses a form 13F filing table from a given url
Parses a form index file from file
Parses a form index file from a string
Parses a form index file from url
Fetches frames for a given taxonomy, concept, unit, and period
Fetches the full index
Fetches the historical XBRL feed for the given year and month
Fetches the recent inline XBRL rss feed
Fetches the investor alerts feed
Fetches the litigation feed
Parses a master index file from file
Parses a master index file from a string
Parses a master index file from url
Fetches a CIK for a given mutual fund ticker
Fetches a list of mutual fund tickers
Fetch the recent mutual funds filings rss feed
Parses form 3, 3/A, 4, 4/A, 5, and 5/A ownership filing types from a file
Parses form 3, 3/A, 4, 4/A, 5, and 5/A filing types from a string
Parses form 3, 3/A, 4, 4/A, 5, and 5/A ownership filing types from a given url
Parses form 3, 3/A, 4, 4/A, 5, and 5/A ownership filing types from a given CIK and accession number
Fetches the press release feed
Parses the press release feed from a string
Fetches the speeches and statements feed
Fetches the speeches feed
Callback implementation for Application.start/2
.
Fetches the statements feed
Fetches submissions for a given CIK
Fetches the testimony feed
Fetches the trading suspensions feed
Fetches the recent XBRL rss feed
Parses a xbrl filing file from a given file path
Parses a XBRL file
Parses a xbrl filing from a given url
Parses a xbrl index file from file
Parses a xbrl index file from a string
Parses a xbrl index file from url
Types
error_type()
@type error_type() :: {:error, String.t()}
success_type(inner)
@type success_type(inner) :: {:ok, inner}
Functions
administrative_proceedings_feed()
@spec administrative_proceedings_feed() :: success_type(map()) | error_type()
Fetches the administrative proceedings feed
company_cik(ticker)
@spec company_cik(ticker :: String.t()) :: success_type(String.t()) | error_type()
Fetches a CIK for a given company ticker
Required
ticker
- The ticker of the company
company_concept(cik, taxonomy, tag)
@spec company_concept(cik :: String.t(), taxonomy :: String.t(), tag :: String.t()) :: success_type(map()) | error_type()
Fetches company concepts for a given CIK and concept (taxonomy, tag)
Required
cik
- The CIK of the entitytaxonomy
- The taxonomy of the concepttag
- The tag of the concept
company_facts(cik)
@spec company_facts(cik :: String.t()) :: success_type(map()) | error_type()
Fetches company facts for a given CIK
Required
cik
- The CIK of the entity
company_feed(cik, opts \\ %{})
@spec company_feed(cik :: String.t(), opts :: map()) :: success_type(map()) | error_type()
Fetches the company feed for a given CIK
Required
cik
- The CIK of the entity
Optional
type
- The type of filing to filter bystart
- The start index of the filings to returncount
- The number of filings to return
company_feed_from_string(xml_str)
@spec company_feed_from_string(xml_str :: String.t()) :: success_type(map()) | error_type()
Parses the company feed
Required
xml_str
- The RSS feed xml string to parse
company_index_from_file(file_path)
@spec company_index_from_file(file_path :: String.t()) :: success_type([map()]) | error_type()
Parses a company index file from file
Required
file_path
- The path to the company index file to parse
company_index_from_string(file_content)
@spec company_index_from_string(file_content :: String.t()) :: success_type([map()]) | error_type()
Parses a company index file from string
Required
file_content
- The content of the company index file to parse
company_index_from_url(url)
@spec company_index_from_url(url :: String.t()) :: success_type([map()]) | error_type()
Parses a company index file from url
Required
url
- The url to the company index file to parse
company_tickers()
@spec company_tickers() :: success_type(list()) | error_type()
Fetches a list of company tickers
company_tickers_with_exchange()
@spec company_tickers_with_exchange() :: success_type(list()) | error_type()
Fetches a list of company tickers with exchange
crawler_index_from_file(file_path)
@spec crawler_index_from_file(file_path :: String.t()) :: success_type([map()]) | error_type()
Parses a crawler index file from file
Required
file_path
- The path to the crawler index file to parse
crawler_index_from_string(file_content)
Parses a crawler index file from a string
Required
file_content
- The content of the crawler index file to parse
crawler_index_from_url(url)
@spec crawler_index_from_url(url :: String.t()) :: success_type([map()]) | error_type()
Parses a crawler index file from url
Required
url
- The url to the crawler index file to parse
current_feed(opts \\ %{})
@spec current_feed(opts :: map()) :: success_type(map()) | error_type()
Fetches the current feed for a given CIK
Optional
CIK
- The CIK of the entitytype
- The type of filing to filter bycompany
- The company to filter bydateb
- The date to filter byowner
- The owner to filter bystart
- The start index of the filings to returncount
- The number of filings to return
current_feed_from_string(xml_str)
@spec current_feed_from_string(xml_str :: String.t()) :: success_type(map()) | error_type()
Parses the current feed
Required
xml_str
- The RSS feed xml to parse
daily_index(year \\ nil, quarter \\ nil)
@spec daily_index(year :: nil | integer(), quarter :: nil | integer()) :: success_type(map()) | error_type()
Fetches the daily index
Optional
year
- The year of the daily index (must be 1994 or greater)quarter
- The quarter of the daily index
division_of_corporation_finance_feed()
@spec division_of_corporation_finance_feed() :: success_type(map()) | error_type()
Fetches the division of corporation finance news feed
division_of_investment_management_feed()
@spec division_of_investment_management_feed() :: success_type(map()) | error_type()
Fetches the division of investment management news feed
entity_directory(cik)
@spec entity_directory(cik :: String.t()) :: success_type(map()) | error_type()
Fetches the entity directory
Required
cik
- The CIK of the entity
filing_directory(cik, accession_number)
@spec filing_directory(cik :: String.t(), accession_number :: String.t()) :: success_type(map()) | error_type()
Fetches the filing directory
Required
cik
- The CIK of the entityaccession_number
- The accession number of the filing
filing_feed_from_string(xml_str)
@spec filing_feed_from_string(xml_str :: String.t()) :: success_type(map()) | error_type()
Parses a filing feed from a string
Required
xml_str
- The XBRL feed xml string to parse
filings(cik, opts \\ %{})
@spec filings(cik :: String.t(), opt :: map()) :: success_type(list()) | error_type()
Fetches a list of filings from the submissions file
Required
cik
- The CIK of the entity
Optional
form_type
- The form type of the filingoffset
- The offset of the filingslimit
- The limit of the filings
filings_feed()
@spec filings_feed() :: success_type(map()) | error_type()
Fetches the recent filings rss feed
form3_from_file(file_path)
@spec form3_from_file(file_path :: String.t()) :: success_type(map()) | error_type()
Parses form 3 and 3/A ownership filing types from a given file path
Required
file_path
- The path of the form 3 filing to parse
form3_from_filing(cik, accession_number)
@spec form3_from_filing(cik :: String.t(), accession_number :: String.t()) :: success_type(map()) | error_type()
Parses form 3 and 3/A filing types from a given CIK and accession number
Required
cik
- The CIK of the entityaccession_number
- The accession number of the filing
form3_from_string(xml_str)
@spec form3_from_string(xml_str :: String.t()) :: success_type(map()) | error_type()
Parses form 3 and 3/A ownership filing types from a given string
Required
xml_str
- The xml string of the form 3 filing to parse
form3_from_url(url)
@spec form3_from_url(url :: String.t()) :: success_type(map()) | error_type()
Parses form 3 and 3/A ownership filing types from a given url
Required
url
- The url of the form 3 filing
form4_from_file(file_path)
@spec form4_from_file(file_path :: String.t()) :: success_type(map()) | error_type()
Parses form 4 and 4/A ownership filing types from a given file path
Required
file_path
- The path of the form 4 filing to parse
form4_from_filing(cik, accession_number)
@spec form4_from_filing(cik :: String.t(), accession_number :: String.t()) :: success_type(map()) | error_type()
Parses form 4 and 4/A filing types from a given CIK and accession number
Required
cik
- The CIK of the entityaccession_number
- The accession number of the filing
form4_from_string(xml_str)
@spec form4_from_string(xml_str :: String.t()) :: success_type(map()) | error_type()
Parses form 4 and 4/A ownership filing types from a given string
Required
xml_str
- The xml string of the form 4 filing to parse
form4_from_url(url)
@spec form4_from_url(url :: String.t()) :: success_type(map()) | error_type()
Parses form 4 and 4/A ownership filing types from a given url
Required
url
- The url of the form 3 filing
form5_from_file(file_path)
@spec form5_from_file(file_path :: String.t()) :: success_type(map()) | error_type()
Parses form 5 and 5/A ownership filing types from a given file path
Required
file_path
- The path of the form 5 filing to parse
form5_from_filing(cik, accession_number)
@spec form5_from_filing(cik :: String.t(), accession_number :: String.t()) :: success_type(map()) | error_type()
Parses form 5 and 5/A filing types from a given CIK and accession number
Required
cik
- The CIK of the entityaccession_number
- The accession number of the filing
form5_from_string(xml_str)
@spec form5_from_string(xml_str :: String.t()) :: success_type(map()) | error_type()
Parses form 5 and 5/A ownership filing types from a given string
Required
xml_str
- The xml string of the form 5 filing to parse
form5_from_url(url)
@spec form5_from_url(url :: String.t()) :: success_type(map()) | error_type()
Parses form 5 and 5/A ownership filing types from a given url
Required
url
- The url of the form 3 filing
form13f_document_from_file(file_path)
@spec form13f_document_from_file(file_path :: String.t()) :: success_type(map()) | error_type()
Parses a form 13F document from a given file path
Required
file_path
- The path to the 13F document to parse
form13f_document_from_string(xml_str)
@spec form13f_document_from_string(xml_str :: String.t()) :: success_type(map()) | error_type()
Parses a form 13F filing primary document from a string
Required
xml_str
- The document xml string to parse
form13f_document_from_url(url)
@spec form13f_document_from_url(url :: String.t()) :: success_type(map()) | error_type()
Parses a form 13F filing from a given url
Required
url
- The url of the form 13F document to parse
form13f_from_filing(cik, accession_number)
@spec form13f_from_filing(cik :: String.t(), accession_number :: String.t()) :: success_type(map()) | error_type()
Parses a form 13F filing for a given CIK and accession number
Required
cik
- The CIK of the entityaccession_number
- The accession number of the filing
form13f_table_from_file(file_path)
@spec form13f_table_from_file(file_path :: String.t()) :: success_type(map()) | error_type()
Parses a form 13F filing table from a file
Required
file_path
- The path to the 13F table file to parse
form13f_table_from_string(xml_str)
@spec form13f_table_from_string(xml_str :: String.t()) :: success_type(map()) | error_type()
Parses a form 13F filing table from a string
Required
xml_str
- The table xml string to parse
form13f_table_from_url(url)
@spec form13f_table_from_url(url :: String.t()) :: success_type(map()) | error_type()
Parses a form 13F filing table from a given url
Required
url
- The url of the 13F table file to parse
form_index_from_file(file_path)
@spec form_index_from_file(file_path :: String.t()) :: success_type([map()]) | error_type()
Parses a form index file from file
Required
file_path
- The path to the form index file to parse
form_index_from_string(file_content)
Parses a form index file from a string
Required
file_content
- The content of the form index file to parse
form_index_from_url(url)
@spec form_index_from_url(url :: String.t()) :: success_type([map()]) | error_type()
Parses a form index file from url
Required
url
- The url to the form index file to parse
frames(taxonomy, tag, unit, period)
@spec frames( taxonomy :: String.t(), tag :: String.t(), unit :: String.t(), period :: String.t() ) :: success_type(map()) | error_type()
Fetches frames for a given taxonomy, concept, unit, and period
Required
taxonomy
- The taxonomy of the concepttag
- The tag of the conceptunit
- The unit of the conceptperiod
- The period of the concept
full_index(year \\ nil, quarter \\ nil)
@spec full_index(year :: nil | integer(), quarter :: nil | integer()) :: success_type(map()) | error_type()
Fetches the full index
Optional
year
- The year of the full index (must be 1994 or greater)quarter
- The quarter of the full index
historical_xbrl_feed(year, month)
@spec historical_xbrl_feed(year :: integer(), month :: integer()) :: success_type(map()) | error_type()
Fetches the historical XBRL feed for the given year and month
Required
year
- The year to fetch the XBRL feed for (must be 2005 or later)month
- The month to fetch the XBRL feed for
inline_xbrl_feed()
@spec inline_xbrl_feed() :: success_type(map()) | error_type()
Fetches the recent inline XBRL rss feed
investor_alerts_feed()
@spec investor_alerts_feed() :: success_type(map()) | error_type()
Fetches the investor alerts feed
litigation_feed()
@spec litigation_feed() :: success_type(map()) | error_type()
Fetches the litigation feed
master_index_from_file(file_path)
@spec master_index_from_file(file_path :: String.t()) :: success_type([map()]) | error_type()
Parses a master index file from file
Required
file_path
- The path to the master file to parse
master_index_from_string(file_content)
Parses a master index file from a string
Required
file_content
- The content of the master index file to parse
master_index_from_url(url)
@spec master_index_from_url(url :: String.t()) :: success_type([map()]) | error_type()
Parses a master index file from url
Required
url
- The url to the master file to parse
mutual_fund_cik(ticker)
@spec mutual_fund_cik(ticker :: String.t()) :: success_type(String.t()) | error_type()
Fetches a CIK for a given mutual fund ticker
Required
ticker
- The ticker of the mutual fund
mutual_fund_tickers()
@spec mutual_fund_tickers() :: success_type(list()) | error_type()
Fetches a list of mutual fund tickers
mutual_funds_feed()
@spec mutual_funds_feed() :: success_type(map()) | error_type()
Fetch the recent mutual funds filings rss feed
ownership_form_from_file(file_path)
@spec ownership_form_from_file(file_path :: String.t()) :: success_type(map()) | error_type()
Parses form 3, 3/A, 4, 4/A, 5, and 5/A ownership filing types from a file
Required
file_path
- The path to the file
ownership_form_from_string(form_str)
@spec ownership_form_from_string(form_str :: String.t()) :: success_type(map()) | error_type()
Parses form 3, 3/A, 4, 4/A, 5, and 5/A filing types from a string
Required
form_str
- The document string to parse
ownership_form_from_url(url)
@spec ownership_form_from_url(url :: String.t()) :: success_type(map()) | error_type()
Parses form 3, 3/A, 4, 4/A, 5, and 5/A ownership filing types from a given url
Required
url
- The url of the form 4 to parse
ownership_from_filing(cik, accession_number)
@spec ownership_from_filing(cik :: String.t(), accession_number :: String.t()) :: success_type(map()) | error_type()
Parses form 3, 3/A, 4, 4/A, 5, and 5/A ownership filing types from a given CIK and accession number
Required
cik
- The CIK of the entityaccession_number
- The accession number of the filing
press_release_feed()
@spec press_release_feed() :: success_type(map()) | error_type()
Fetches the press release feed
rss_feed_from_string(xml_str)
@spec rss_feed_from_string(xml_str :: String.t()) :: success_type(map()) | error_type()
Parses the press release feed from a string
Required
xml_str
- The RSS feed xml string to parse
speeches_and_statements_feed()
@spec speeches_and_statements_feed() :: success_type(map()) | error_type()
Fetches the speeches and statements feed
speeches_feed()
@spec speeches_feed() :: success_type(map()) | error_type()
Fetches the speeches feed
start(type, args)
Callback implementation for Application.start/2
.
statements_feed()
@spec statements_feed() :: success_type(map()) | error_type()
Fetches the statements feed
submissions(cik)
@spec submissions(cik :: String.t()) :: success_type(map()) | error_type()
Fetches submissions for a given CIK
Required
cik
- The CIK of the entity
testimony_feed()
@spec testimony_feed() :: success_type(map()) | error_type()
Fetches the testimony feed
trading_suspensions_feed()
@spec trading_suspensions_feed() :: success_type(map()) | error_type()
Fetches the trading suspensions feed
xbrl_feed()
@spec xbrl_feed() :: success_type(map()) | error_type()
Fetches the recent XBRL rss feed
xbrl_from_file(file_path)
@spec xbrl_from_file(file_path :: String.t()) :: success_type(map()) | error_type()
Parses a xbrl filing file from a given file path
Required
file_path
- The path of the xbrl filing to parse
xbrl_from_string(xbrl_str)
@spec xbrl_from_string(xbrl_str :: String.t()) :: success_type(map()) | error_type()
Parses a XBRL file
Required
xbrl_str
- The XBRL xml string to parse
xbrl_from_url(url)
@spec xbrl_from_url(url :: String.t()) :: success_type(map()) | error_type()
Parses a xbrl filing from a given url
Required
url
- The url of the xbrl filing to parse
xbrl_index_from_file(file_path)
@spec xbrl_index_from_file(file_path :: String.t()) :: success_type([map()]) | error_type()
Parses a xbrl index file from file
Required
file_path
- The path to the xbrl file to parse
xbrl_index_from_string(file_content)
Parses a xbrl index file from a string
Required
file_content
- The content of the xbrl index file to parse
xbrl_index_from_url(url)
@spec xbrl_index_from_url(url :: String.t()) :: success_type([map()]) | error_type()
Parses a xbrl index file from url
Required
url
- The url to the xbrl file to parse