EDGAR (edgar_client v0.8.1)

Link to this section Summary

Functions

Fetches the administrative proceedings feed

Fetches a CIK for a given 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

Fetches a list of company tickers

Fetches the current feed for a given CIK

Fetches the daily index

Fetches the daily index for a given year

Fetches the daily index for a given year and quarter

Fetches the division of corporation finance news feed

Fetches the division of investment management news feed

Fetches the entity directory

Fetches the filing directory

Fetches a list of filings from the submissions file

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 url

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 url

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 url

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 given url

Fetches frames for a given taxonomy, concept, unit, and period

Fetches the full index

Fetches the full index for a given year

Fetches the full index for a given year and quarter

Fetches the investor alerts feed

Fetches the litigation feed

Parses form 3, 3/A, 4, 4/A, 5, and 5/A ownership filing types from a given CIK and accession number

Parses form 3, 3/A, 4, 4/A, 5, and 5/A ownership filing types from a given url

Parses the company feed

Parses the current feed

Parses a form 13F filing primary document

Parses a form 13F filing table

Parses form 3, 3/A, 4, 4/A, 5, and 5/A filing types.

Parses the press release feed

Parses a XBRL file

Fetches the press release feed

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

Parses a xbrl filing from a given url

Link to this section Types

Link to this type

error_type()

@type error_type() :: {:error, String.t()}
Link to this type

success_type(inner)

@type success_type(inner) :: {:ok, inner}

Link to this section Functions

Link to this function

administrative_proceedings_feed()

@spec administrative_proceedings_feed() :: success_type(map()) | error_type()

Fetches the administrative proceedings feed

Link to this function

cik_for_ticker(ticker)

@spec cik_for_ticker(ticker :: String.t()) :: success_type(String.t()) | error_type()

Fetches a CIK for a given ticker

required

Required

  • ticker - The ticker of the company
Link to this function

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

Required

  • cik - The CIK of the entity
  • taxonomy - The taxonomy of the concept
  • tag - The tag of the concept
Link to this function

company_facts(cik)

@spec company_facts(cik :: String.t()) :: success_type(map()) | error_type()

Fetches company facts for a given CIK

required

Required

  • cik - The CIK of the entity
Link to this function

company_feed(cik, opts \\ %{})

@spec company_feed(cik :: String.t(), opts :: Map.t()) ::
  success_type(map()) | error_type()

Fetches the company feed for a given CIK

required

Required

  • cik - The CIK of the entity

optional

Optional

  • type - The type of filing to filter by
  • start - The start index of the filings to return
  • count - The number of filings to return
Link to this function

company_tickers()

@spec company_tickers() :: success_type(list()) | error_type()

Fetches a list of company tickers

Link to this function

current_feed(opts \\ %{})

@spec current_feed(opts :: Map.t()) :: success_type(map()) | error_type()

Fetches the current feed for a given CIK

optional

Optional

  • CIK - The CIK of the entity
  • type - The type of filing to filter by
  • company - The company to filter by
  • dateb - The date to filter by
  • owner - The owner to filter by
  • start - The start index of the filings to return
  • count - The number of filings to return
@spec daily_index() :: success_type(map()) | error_type()

Fetches the daily index

Link to this function

daily_index(year)

@spec daily_index(year :: integer()) :: success_type(map()) | error_type()

Fetches the daily index for a given year

required

Required

  • year - The year of the daily index
Link to this function

daily_index(year, quarter)

@spec daily_index(year :: integer(), quarter :: integer()) ::
  success_type(map()) | error_type()

Fetches the daily index for a given year and quarter

required

Required

  • year - The year of the daily index
  • quarter - The quarter of the daily index
Link to this function

division_of_corporation_finance_feed()

@spec division_of_corporation_finance_feed() :: success_type(map()) | error_type()

Fetches the division of corporation finance news feed

Link to this function

division_of_investment_management_feed()

@spec division_of_investment_management_feed() :: success_type(map()) | error_type()

Fetches the division of investment management news feed

Link to this function

entity_directory(cik)

@spec entity_directory(cik :: String.t()) :: success_type(map()) | error_type()

Fetches the entity directory

required

Required

  • cik - The CIK of the entity
Link to this function

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

Required

  • cik - The CIK of the entity
  • accession_number - The accession number of the filing
Link to this function

filings(cik, opts \\ %{})

@spec filings(cik :: String.t(), opt :: Map.t()) ::
  success_type(list()) | error_type()

Fetches a list of filings from the submissions file

required

Required

  • cik - The CIK of the entity

optional

Optional

  • form_type - The form type of the filing
  • offset - The offset of the filings
  • limit - The limit of the filings
Link to this function

form3_filing(cik, accession_number)

@spec form3_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

Based on the XML schema found here:

required

Required

  • cik - The CIK of the entity
  • accession_number - The accession number of the filing
Link to this function

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

Required

  • url - The url of the form 3 filing
Link to this function

form4_filing(cik, accession_number)

@spec form4_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

Based on the XML schema found here:

required

Required

  • cik - The CIK of the entity
  • accession_number - The accession number of the filing
Link to this function

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

Required

  • url - The url of the form 3 filing
Link to this function

form5_filing(cik, accession_number)

@spec form5_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

Based on the XML schema found here:

required

Required

  • cik - The CIK of the entity
  • accession_number - The accession number of the filing
Link to this function

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

Required

  • url - The url of the form 3 filing
Link to this function

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

Required

  • url - The url of the form 13F document filing
Link to this function

form13f_filing(cik, accession_number)

@spec form13f_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

Required

  • cik - The CIK of the entity
  • accession_number - The accession number of the filing
Link to this function

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

Required

  • url - The url of the form 13F table filing
Link to this function

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

Required

  • taxonomy - The taxonomy of the concept
  • tag - The tag of the concept
  • unit - The unit of the concept
  • period - The period of the concept
@spec full_index() :: success_type(map()) | error_type()

Fetches the full index

Link to this function

full_index(year)

@spec full_index(year :: integer()) :: success_type(map()) | error_type()

Fetches the full index for a given year

required

Required

  • year - The year of the full index
Link to this function

full_index(year, quarter)

@spec full_index(year :: integer(), quarter :: integer()) ::
  success_type(map()) | error_type()

Fetches the full index for a given year and quarter

required

Required

  • year - The year of the full index
  • quarter - The quarter of the full index
Link to this function

investor_alerts_feed()

@spec investor_alerts_feed() :: success_type(map()) | error_type()

Fetches the investor alerts feed

Link to this function

litigation_feed()

@spec litigation_feed() :: success_type(map()) | error_type()

Fetches the litigation feed

Link to this function

ownership_filing(cik, accession_number)

@spec ownership_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

Based on the XML schema found here:

required

Required

  • cik - The CIK of the entity
  • accession_number - The accession number of the filing
Link to this function

ownership_filing_from_url(url)

@spec ownership_filing_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

Based on the XML schema found here:

required

Required

  • url - The url of the form 4 filing
Link to this function

parse_company_feed(xml)

@spec parse_company_feed(xml :: String.t()) :: success_type(map()) | error_type()

Parses the company feed

required

Required

  • xml - The RSS feed xml to parse
Link to this function

parse_current_feed(xml)

@spec parse_current_feed(xml :: String.t()) :: success_type(map()) | error_type()

Parses the current feed

required

Required

  • xml - The RSS feed xml to parse
Link to this function

parse_form13f_document(xml)

@spec parse_form13f_document(xml :: String.t()) :: success_type(map()) | error_type()

Parses a form 13F filing primary document

required

Required

  • xml - The document xml to parse
Link to this function

parse_form13f_table(xml)

@spec parse_form13f_table(xml :: String.t()) :: success_type(map()) | error_type()

Parses a form 13F filing table

required

Required

  • xml - The table xml to parse
Link to this function

parse_ownership_form(document)

@spec parse_ownership_form(document :: String.t()) ::
  success_type(map()) | error_type()

Parses form 3, 3/A, 4, 4/A, 5, and 5/A filing types.

Based on the XML schema found here:

required

Required

  • document - The document xml to parse
Link to this function

parse_rss_feed(xml)

@spec parse_rss_feed(xml :: String.t()) :: success_type(map()) | error_type()

Parses the press release feed

required

Required

  • xml - The RSS feed xml to parse
Link to this function

parse_xbrl(xml)

@spec parse_xbrl(xml :: String.t()) :: success_type(map()) | error_type()

Parses a XBRL file

required

Required

  • xml - The XBRL xml to parse
Link to this function

press_release_feed()

@spec press_release_feed() :: success_type(map()) | error_type()

Fetches the press release feed

Link to this function

speeches_and_statements_feed()

@spec speeches_and_statements_feed() :: success_type(map()) | error_type()

Fetches the speeches and statements feed

Link to this function

speeches_feed()

@spec speeches_feed() :: success_type(map()) | error_type()

Fetches the speeches feed

Link to this function

start(type, args)

Callback implementation for Application.start/2.

Link to this function

statements_feed()

@spec statements_feed() :: success_type(map()) | error_type()

Fetches the statements feed

Link to this function

submissions(cik)

@spec submissions(cik :: String.t()) :: success_type(map()) | error_type()

Fetches submissions for a given CIK

required

Required

  • cik - The CIK of the entity
Link to this function

testimony_feed()

@spec testimony_feed() :: success_type(map()) | error_type()

Fetches the testimony feed

Link to this function

trading_suspensions_feed()

@spec trading_suspensions_feed() :: success_type(map()) | error_type()

Fetches the trading suspensions feed

Link to this function

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

Required

  • url - The url of the xbrl filing