richorama / country-code-lookup

:earth_africa: Finds countries by various country codes

Country Code Lookup

A node.js module to look up countries by various country codes.

Supported codes:

• FIPS 10-4 codes (2 digits)
• ISO 3166 (2 digits)
• ISO 3166 (3 digits)
• ISO 3166 (numbers)
• Internet codes

Installation

$ npm install country-code-lookup

Usage

const lookup = require('country-code-lookup')

// search by FIPS
lookup.byFips('UK')

// search by ISO
lookup.byIso('GB')
lookup.byIso('GBR')
lookup.byIso(826)

// search by internet code
lookup.byInternet('UK')

// search by country name
lookup.byCountry('United Kingdom')

// get an array of all countries
lookup.countries

Searching for a country will return either null, or a country object:

{ continent: 'Europe',
  region: 'Western Europe',
  country: 'United Kingdom',
  capital: 'London',
  fips: 'UK',
  iso2: 'GB',
  iso3: 'GBR',
  isoNo: '826',
  internet: 'UK' }

Useful Links

ISO 2 and 3 digit country codes: https://www.iban.com/country-codes

License

MIT

country-code-lookup's Issues

FIPS code for Kosovo is wrong

country-code-lookup/index.js

Line 2794 in d289890

fips: 'XK',

https://en.wikipedia.org/wiki/List_of_FIPS_country_codes#K

state is null when address ends with "-1234"

Hi, awesome library! I found some issue with postal codes that has dash in them.

state is null when address ends with "-1234", for example:

(async function () {
  const util = require('util')
  const parseAddressCallback = require('parse-address-string')
  const parseAddress = util.promisify(parseAddressCallback)

  const address = await parseAddress('1234 Road St, Brooklyn, NY 12345-1234')

  console.log(address)
})()

Will result with:

{
  street_address1: '1234 Road St',
  city: 'Brooklyn',
  state: null,
  postal_code: '12345',
  country: null
}

country-code-lookup version: 0.0.19
NodeJS version: 14.16.1

throw Error for ISO search

Hi there,
My point if you return null in other case, why you throw new Error in ISO case?
throw new Error('cannot determine ISO code type') in ISO case
VS
return null for other cases.
I think it is unexpectable result, isn't it?

byFips - Cannot search with country code VN

Hi,

VN is the country code of Viet Nam. But it's now impossible to search with byFips method.

https://en.wikipedia.org/wiki/List_of_FIPS_country_codes#V

Is this an issue or not?

Regards,

How can I query for England, Wales, Scotland, & Northern Ireland country iso codes?

England, Wales, & Scotland are countries (in GB)
Northern Ireland is a province (in UK)

const CountryCodeLookup = require('country-code-lookup');

let countryName = 'England';
const result = CountryCodeLookup.byCountry(countryName); // yields no results
const { iso2, iso3 } = result ?? {};

console.log(iso2, iso3, countryName);

I'd expect iso2 to be 'GB' for the 4 countries.

Also, bc all data is unpacked into the default export of this lib, we don't get autocomplete in node.js repl.

Update country info?

Hey, super happy I came across this today. Exactly what I need for a project (being able to lookup region/continents by country code). Curious where the data in the csv comes from? Probably could use updated after 2 years and I'd be happy to do it.

isoNo returns non-standardized format

Running the isoNo method can return a single or two character string. For example, looking up Afghanistan's ISO numeric-3 country code returns '4' instead of '004'. This can be fixed by enforcing string length of 3 for isoNo values and adding leading zeros as padding using JS's padStart method. I'd be happy to help you implement this if you want some assistance. 🙂

ISO number should be a numeric-3

There's a small issue in library with numeric iso codes. These codes are numeric-3 as per ISO, so they should not be defined without their leading zero.
Moreover, if I make a lookup as 004 that should anyway work.
I can send a fix, if there's any interest in fixing this.

Bundling app with Webpack, cannot resolve 'fs'

When bundling my app with webpack, and your library is being used, I get the following error:

Module not found: Error: Can't resolve 'fs' in '/path/to/project/node_modules/country-code-lookup'
@ ./node_modules/country-code-lookup/index.js 6:12-25

I have tried to use the suggestions listed here but they don't work and mostly just come up with the various other errors reported (e.g Can't resolve variable require, etc).

Do you have suggestions on how to fix this?

Should lower or upper case

Hello When I search by country using lower case it returns null .. you should lower or upper case the value to be as same as your data to give the right answer in all cases.

Missing country: Serbia, ISO2: RS

Czech Republic ⇾ Czechia

Hi there,
The Czech Republic is recommending the use of the new name "Czechia". Could that be reflected in this lib? Thank you

https://en.wikipedia.org/wiki/Name_of_the_Czech_Republic#Adoption_of_Czechia

Release process has undetected errors

Looks like npm publish is failing, but CI is still green:

npm ERR! code E404
npm ERR! 404 Not Found - PUT https://registry.npmjs.org/country-code-lookup - Not found
npm ERR! 404 
npm ERR! 404  '[email protected]' is not in the npm registry.
npm ERR! 404 You should bug the author to publish it (or use the name yourself!)
npm ERR! 404 
npm ERR! 404 Note that you can also install from a
npm ERR! 404 tarball, folder, http url, or git url.

Ref: https://github.com/richorama/country-code-lookup/actions/runs/8138888343/job/22240739416

can't lookup ByCountry for

I was just trying to use the library, looks like the following countries aren't returning for byCountry method:

[
  "UK",
  "S. Korea",
  "Czechia",
  "UAE",
  "Hong Kong",
  "Channel Islands",
  "Palestine",
  "DRC",
  "Faeroe Islands",
  "Brunei ",
  "Congo",
  "Bahamas",
  "Macao",
<--didn't read after this -->
  "Myanmar",
  "St. Vincent Grenadines",
  "MS Zaandam",
  "Gambia",
  "Turks and Caicos",
  "Cabo Verde",
  "CAR",
  "Vatican City",
  "St. Barth",
  "Falkland Islands",
  "Caribbean Netherlands",
  "Saint Pierre Miquelon"
]

M not sure, if all of these are valid countries. Feel free to close iff not.

Great library, unfortunately Isle of Man has no ISO code

Hey there,
just noticed (as our platform crashed), that Isle of Man has no ISO code. It's supposed to be IM!

ISO3 Country Code Romania

I think the country code of romania is ROU not ROM, so my program cant find romania with the country code ROU.

CD code for "Democratic Republic of Congo"

Hi,

Could you add the CD code (ISO-2) for Democratic Republic of Congo please? It's not the same country as Republic of Congo (CG code).

Thanks!

XKS returns null

Ran .byIso function for XKS, which according to Google is

xk is a temporary, unofficial country code top-level domain for Kosovo, assigned under the United Nations Security Council Resolution 1244 in 1999.

Publish version 0.1.1

Version 0.1.1 was never published. Any chance that you could publish it? Thanks

search TS definition

Hello,

search must be removed from d.ts definition or added to module

thanks

Proposal: To support IBAN country names

Taking this https://www.iban.com/country-codes as a reference. Should't UK name be:

United Kingdom of Great Britain and Northern Ireland

instead of only United Kingdom?

https://github.com/richorama/country-code-lookup/blob/master/index.js#L2385C15-L2385C29

We are trying to follow the IBAN Codes and names but wondering how practical would be to have the names here as they appear there. I noticed there are other discrepancies such as United States instead of the official name United States of America

I think that to avoid breaking changes it could be added as a separate property

Search by "United States of America" fails

byCountry('United States') works. However, while the official name listed here: https://www.iban.com/country-codes is "United States of America", byCountry('United States of America') returns null. Is it possible to add support for multiple names?

feat(Search): More flexible name search byCountry()

I find this library to be extremely useful, and grateful that I found it but I have a single suggestion.

Make the byCountry() function a bit more flexible by parsing both the input and the output by homologating both strings.
Ej.-

• Transform into all miniscule letters
• Trim extra spaces
• Maybe, add name variants for some countries EJ
  • The United States of America
  • United States of America

I would love to help implementing this new functionalities, if I may so 😄

Kosovo has wrong country code

Hello guys, we just noticed that the Kosovo iso3 country code in this repository is XKS, but the right code is XKX, we are having some issues because of this, reference: https://www.wikidata.org/wiki/Q1246

Country details using country currency code.

I want to be able to get country details, using the country's currency ISO code as the key.

Or better still I should be able to get any country's details by specifying the key I wanna search with.

Example .Find({key: "currency", value: "USD"})

Add TS type information

Handle country codes with "-"

lookup.byIso('BQ-BA') // BQ-BA represents bonaire but this throws an error

wikipedia link

could you please update the package to handle this.

Zambia country code is wrong

   continent: 'Africa',
    region: 'Southern Africa',
    country: 'Zambia',
    capital: 'Lusaka',
    fips: 'ZA',
    iso2: 'ZM',
    iso3: 'ZWB',
    isoNo: '894',
    internet: 'ZM'
  }

The Zambia iso3 code is 'ZMB' not 'ZWB'

Adding License text on a separate file.

Please add a separate License file as it makes the oss automation easy.