EDGAR (edgar_client v0.2.0)

Link to this section Summary

Functions

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 a list of company tickers

Fetches the entity directory

Fetches the filing directory

Fetches a list of filings from the submissions file

Fetches a list of filings from the submissions file by form

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

Callback implementation for Application.start/2.

Fetches submissions for a given CIK

Link to this section Functions

Link to this function

cik_for_ticker(ticker)

Fetches a CIK for a given ticker

required

Required

  • ticker - The ticker of the company

examples

Examples

iex> {:ok, cik} = EDGAR.cik_for_ticker("AAPL") iex> cik "320193"

Link to this function

company_concept(cik, taxonomy, tag)

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

examples

Examples

iex> {:ok, company_concept} = EDGAR.company_concept("320193", "us-gaap", "AccountsPayableCurrent") iex> company_concept["cik"] 320193

Link to this function

company_facts(cik)

Fetches company facts for a given CIK

required

Required

  • cik - The CIK of the entity

examples

Examples

iex> {:ok, company_facts} = EDGAR.company_facts("320193") iex> company_facts["cik"] 320193

Link to this function

company_tickers()

Fetches a list of company tickers

examples

Examples

iex> {:ok, company_tickers} = EDGAR.company_tickers() iex> Enum.count(company_tickers) > 0 true

Link to this function

entity_directory(cik)

Fetches the entity directory

required

Required

  • cik - The CIK of the entity

examples

Examples

iex> {:ok, entity_directory} = EDGAR.entity_directory("320193") iex> entity_directory["directory"]["name"] "/Archives/edgar/data/320193"

Link to this function

filing_directory(cik, accession_number)

Fetches the filing directory

required

Required

  • cik - The CIK of the entity
  • accession_number - The accession number of the filing

examples

Examples

iex> {:ok, filing_directory} = EDGAR.filing_directory("320193", "000032019320000010") iex> filing_directory["directory"]["name"] "/Archives/edgar/data/320193/000032019320000010"

Fetches a list of filings from the submissions file

required

Required

  • cik - The CIK of the entity

examples

Examples

iex> {:ok, filings} = EDGAR.filings("320193") iex> Enum.count(filings) > 0 true

Link to this function

filings_by_forms(cik, forms)

Fetches a list of filings from the submissions file by form

required

Required

  • cik - The CIK of the entity
  • forms - The forms to filter by

examples

Examples

iex> {:ok, filings} = EDGAR.filings_by_forms("320193", ["10-K", "10-Q"]) iex> Enum.count(filings) > 0 true

Link to this function

frames(taxonomy, tag, unit, period)

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

examples

Examples

iex> {:ok, frames} = EDGAR.frames("us-gaap", "AccountsPayableCurrent", "USD", "CY2019Q1I") iex> frames["tag"] "AccountsPayableCurrent"

Link to this function

start(type, args)

Callback implementation for Application.start/2.

Link to this function

submissions(cik)

Fetches submissions for a given CIK

required

Required

  • cik - The CIK of the entity

examples

Examples

iex> {:ok, submissions} = EDGAR.submissions("320193") iex> submissions["cik"] "320193"