[](https://circleci.com/gh/vikram7/sec_cik_ticker_mapper)
# SecCikTickerMapper
This library provides a mapping between SEC CIK codes (which are 10 digits long)
and US Exchange (NYSE, Nasdaq, AMEX, OTCBB) listed stock tickers.
The library can be used as follows:
```elixir
SecCikTickerMapper.Getter.ticker(CIK)
# => Ticker
SecCikTickerMapper.Getter.cik(Ticker)
# => CIK
```
examples:
```elixir
SecCikTickerMapper.Getter.ticker("0001418091")
# => "TWTR"
SecCikTickerMapper.Getter.cik("TWTR")
# => "0001418091"
```
#### Notes
* The database is being constantly updated, so apologies in advance if there are Ticker-CIK mappings missing. Do feel free to open an issue in the event you come across such a missing pair!
## Installation
If [available in Hex](https://hex.pm/docs/publish), the package can be installed as:
1. Add sec_cik_ticker_mapper to your list of dependencies in `mix.exs`:
def deps do
[{:sec_cik_ticker_mapper, "~> 0.0.1"}]
end
2. Ensure sec_cik_ticker_mapper is started before your application:
def application do
[applications: [:sec_cik_ticker_mapper]]
end
## License
The MIT License (MIT) Copyright (c) 2016 Vikram Ramakrishnan
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
