SecioEx.MappingApi (secio_ex v0.1.3)

A mapping of various ids, tickers, etc.

Summary

Functions

Lists all companies on a given exchange.

Lists all companies in a given industry.

Lists all companies in a given sector.

Maps a CIK to company details.

Maps a CUSIP to company details.

Maps a company name to company details.

Maps a ticker symbol to company details.

Types

mapping_opts()

@type mapping_opts() :: [{:api_key, String.t()}]

Functions

list_by_exchange(exchange, opts \\ [])

Lists all companies on a given exchange.

Examples

iex> SecioEx.MappingApi.list_by_exchange("NASDAQ", api_key: "your_api_key")
{:ok, [%{
  "name" => "Company1",
  "exchange" => "NASDAQ",
  ...
}]}

list_by_industry(industry, opts \\ [])

Lists all companies in a given industry.

Examples

iex> SecioEx.MappingApi.list_by_industry("Auto Manufacturers", api_key: "your_api_key")
{:ok, [%{
  "name" => "Company1",
  "industry" => "Auto Manufacturers",
  ...
}]}

list_by_sector(sector, opts \\ [])

Lists all companies in a given sector.

Examples

iex> SecioEx.MappingApi.list_by_sector("Technology", api_key: "your_api_key")
{:ok, [%{
  "name" => "Company1",
  "sector" => "Technology",
  ...
}]}

map_cik(cik, opts \\ [])

Maps a CIK to company details.

Parameters

  • cik: The CIK number (without leading zeros)
  • opts: Keyword list of options including :api_key

Examples

iex> SecioEx.MappingApi.map_cik("1318605", api_key: "your_api_key")
{:ok, [%{
  "name" => "Tesla Inc",
  "ticker" => "TSLA",
  "cik" => "1318605",
  "cusip" => "88160R101",
  "exchange" => "NASDAQ",
  "isDelisted" => false,
  ...
}]}

map_cusip(cusip, opts \\ [])

Maps a CUSIP to company details.

Examples

iex> SecioEx.MappingApi.map_cusip("88160R101", api_key: "your_api_key")
{:ok, [%{
  "name" => "Tesla Inc",
  "cusip" => "88160R101",
  ...
}]}

map_name(name, opts \\ [])

Maps a company name to company details.

Examples

iex> SecioEx.MappingApi.map_name("Tesla", api_key: "your_api_key")
{:ok, [%{
  "name" => "Tesla Inc",
  ...
}]}

map_ticker(ticker, opts \\ [])

Maps a ticker symbol to company details.

Examples

iex> SecioEx.MappingApi.map_ticker("TSLA", api_key: "your_api_key")
{:ok, [%{
  "name" => "Tesla Inc",
  "ticker" => "TSLA",
  ...
}]}