A pure elixir port of the ruby countries gem that provides all sorts of useful information about every country packaged as convenient little country structs. It includes data from ISO 3166 (countries and states/subdivisions), ISO 4217 (currency), and E.164 (phone numbers).
Add countriex to your list of dependencies in mix.exs:
def deps do
[{:countriex, "~> 0.4"}]
endTo get all country information:
Countriex.allThe get_by/2 method can be used to retrieve the first matching country for any given criteria, for example:
Countriex.get_by(:alpha2, "US") # %Countriex.Country{name: "United States of America", alpha2: "US", alpha3: "USA", ...}
Countriex.get_by(:name, "United Kingdom") # %Countriex.Country{alpha2: "GB", alpha3: "GBR", ...}The filter/2 method can be used to retrieve all countries matching the given criteria:
Countriex.get_by(:region, "Oceania") # [%Countriex.Country{name: "Kiribati", ...}, %Countriex.Country{name: "American Samoa", ...}, ...]
Countriex.get_by(:eu_member, true) # [%Countriex.Country{name: "Luxembourg", ...}, %Countriex.Country{name: "Poland", ...}, ...]See the fields in the Countriex.Country struct for all possible field names that can be used for the above methods.
Run the following mix task to re-generate the country data.
mix countriex.generate_data
The MIT License
Copyright (c) 2016-present Navin Peiris
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.