SecioEx.MappingApi (secio_ex v0.1.0)
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
@type mapping_opts() :: [{:api_key, String.t()}]
Functions
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",
...
}]}
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",
...
}]}
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",
...
}]}
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,
...
}]}
Maps a CUSIP to company details.
Examples
iex> SecioEx.MappingApi.map_cusip("88160R101", api_key: "your_api_key")
{:ok, [%{
"name" => "Tesla Inc",
"cusip" => "88160R101",
...
}]}
Maps a company name to company details.
Examples
iex> SecioEx.MappingApi.map_name("Tesla", api_key: "your_api_key")
{:ok, [%{
"name" => "Tesla Inc",
...
}]}
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",
...
}]}