Skip to content
/ zipcodes.js Public

Free global postal code validation & lookup for the web. Fast, with no dependencies.

License

GPL-3.0 license
81 stars 12 forks Branches Tags Activity
Star
Notifications You must be signed in to change notification settings

zipcodes/zipcodes.js

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

19 Commits
.gitignore
.gitignore
 
 
LICENSE
LICENSE
 
 
README.md
README.md
 
 
cities.php
cities.php
 
 
icon.png
icon.png
 
 
update.php
update.php
 
 
zipcodes.js
zipcodes.js
 
 

Repository files navigation

zipcodes.js

Free postal code validation for the web.

Features

  • Validates against expected regex patterns of the country.
  • Looks up the code via a CDN for accurate validation and geographical data.

Usage

<script src="https://cdn.jsdelivr.net/gh/zipcodes/zipcodes.js@1/zipcodes.min.js"></script>
getZipCode('US', '90210', function (result) {
    console.log(result);
});

Output:

{
    "input":{
        "country": "US",
        "zip": "90210"
    },
    "lookup":{
        "countryCode": "US",
        "postalCode": "90210",
        "placeName": "Beverly Hills",
        "adminName1": "California",
        "adminCode1": "CA",
        "adminName2": "Los Angeles",
        "adminCode2": "037",
        "adminName3": "",
        "adminCode3": "",
        "latitude": "34.0901",
        "longitude": "-118.4065",
        "accuracy": "4"
    },
    "pattern": /^\d{5}(-\d{4})?$/,
    "validPattern": true,
    "validLookup": true,
    "valid": true
}

Supported Countries

Country codes should follow ISO 3166-1 alpha-2

Flag Code Country Regex Lookup
AD Andorra ✓ ✓
AE United Arab Emirates ✖ ✖
AF Afghanistan ✖ ✖
AG Antigua and Barbuda ✖ ✖
AI Anguilla ✖ ✖
AL Albania ✖ ✖
AM Armenia ✓ ✖
AO Angola ✖ ✖
AQ Antarctica ✖ ✖
AR Argentina ✓ ✓
AS American Samoa ✓ ✓
AT Austria ✓ ✓
AU Australia ✓ ✓
AW Aruba ✖ ✖
AX sort ✖ ✓
AZ Azerbaijan ✓ ✓
BA Bosnia and Herzegovina ✓ ✖
BB Barbados ✖ ✖
BD Bangladesh ✓ ✓
BE Belgium ✓ ✓
BF Burkina Faso ✖ ✖
BG Bulgaria ✓ ✓
BH Bahrain ✖ ✖
BI Burundi ✖ ✖
BJ Benin ✓ ✖
BL Saint Barthélemy ✖ ✖
BM Bermuda ✓ ✓
BN Brunei ✓ ✖
BO Bolivia ✖ ✖
BQ Caribbean Netherlands ✖ ✖
BR Brazil ✓ ✓
BS The Bahamas ✖ ✖
BT Bhutan ✖ ✖
BV Bouvet Island ✖ ✖
BW Botswana ✖ ✖
BY Belarus ✓ ✓
BZ Belize ✖ ✖
CA Canada ✓ ✓
CC Cocos (Keeling) Islands ✖ ✖
CD Democratic Republic of the Congo ✖ ✖
CF Central African Republic ✖ ✖
CG Republic of the Congo ✖ ✖
CH Switzerland ✓ ✓
CI Cote d'Ivoire ✖ ✖
CK Cook Islands ✖ ✖
CL Chile ✖ ✖
CM Cameroon ✖ ✖
CN China ✓ ✖
CO Colombia ✖ ✓
CR Costa Rica ✖ ✓
CU Cuba ✓ ✖
CV Cabo Verde ✖ ✖
CW Curaçao ✖ ✖
CX Christmas Island ✓ ✖
CY Cyprus ✓ ✖
CZ Czechia ✓ ✓
DE Germany ✓ ✓
DJ Djibouti ✖ ✖
DK Denmark ✓ ✓
DM Dominica ✖ ✖
DO Dominican Republic ✖ ✓
DZ Algeria ✓ ✓
EC Ecuador ✖ ✖
EE Estonia ✓ ✖
EG Egypt ✖ ✖
EH Western Sahara ✖ ✖
ER Eritrea ✖ ✖
ES Spain ✓ ✓
ET Ethiopia ✖ ✖
FI Finland ✓ ✓
FJ Fiji ✖ ✖
FK Falkland Islands ✖ ✖
FM Federated States of Micronesia ✓ ✓
FO Faroe Islands ✓ ✓
FR France ✓ ✓
GA Gabon ✖ ✖
GB United Kingdom ✓ ✓
GD Grenada ✖ ✖
GE Georgia ✖ ✖
GF French Guiana ✓ ✓
GG Guernsey ✖ ✓
GH Ghana ✖ ✖
GI Gibraltar ✖ ✖
GL Greenland ✓ ✓
GM The Gambia ✖ ✖
GN Guinea ✖ ✖
GP Guadeloupe ✓ ✓
GQ Equatorial Guinea ✖ ✖
GR Greece ✓ ✖
GS South Georgia and the South Sandwich Islands ✖ ✖
GT Guatemala ✓ ✓
GU Guam ✓ ✓
GW Guinea-Bissau ✓ ✖
GY Guyana ✖ ✖
HK Hong Kong ✖ ✖
HM Heard Island and McDonald Islands ✖ ✖
HN Honduras ✖ ✖
HR Croatia ✓ ✓
HT Haiti ✖ ✖
HU Hungary ✓ ✓
ID Indonesia ✓ ✖
IE Republic of Ireland ✓ ✓
IL Israel ✓ ✖
IM Isle of Man ✖ ✓
IN India ✓ ✓
IO British Indian Ocean Territory ✖ ✖
IQ Iraq ✖ ✖
IR Iran ✖ ✖
IS Iceland (IC) ✓ ✓
IT Italy ✓ ✓
JE Jersey ✖ ✓
JM Jamaica ✖ ✖
JO Jordan ✖ ✖
JP Japan ✓ ✓
KE Kenya ✓ ✖
KG Kyrgyzstan ✓ ✖
KH Cambodia ✖ ✖
KI Kiribati ✖ ✖
KM Comoros ✖ ✖
KN Saint Kitts and Nevis ✖ ✖
KP North Korea ✖ ✖
KR South Korea ✓ ✓
KW Kuwait ✓ ✖
KY Cayman Islands ✖ ✖
KZ Kazakhstan ✓ ✖
LA Laos ✖ ✖
LB Lebanon ✖ ✖
LC Saint Lucia ✖ ✖
LI Liechtenstein ✓ ✓
LK Sri Lanka ✖ ✓
LR Liberia ✖ ✖
LS Lesotho ✖ ✖
LT Lithuania ✓ ✓
LU Luxembourg ✓ ✓
LV Latvia ✓ ✓
LY Libya ✖ ✖
MA Morocco ✓ ✖
MC Monaco ✖ ✓
MD Moldova ✓ ✓
ME Montenegro ✓ ✖
MF Collectivity of Saint Martin ✖ ✖
MG Madagascar ✓ ✖
MH Marshall Islands ✓ ✓
MK Republic of Macedonia ✓ ✓
ML Mali ✖ ✖
MM Myanmar ✓ ✖
MN Mongolia ✓ ✖
MO Macau ✖ ✖
MP Northern Mariana Islands ✓ ✓
MQ Martinique ✓ ✓
MR Mauritania ✖ ✖
MS Montserrat ✖ ✖
MT Malta ✓ ✓
MU Mauritius ✖ ✖
MV Maldives ✓ ✖
MW Malawi ✖ ✖
MX Mexico ✓ ✓
MY Malaysia ✓ ✓
MZ Mozambique ✓ ✖
NA Namibia ✖ ✖
NC New Caledonia ✖ ✓
NE Niger ✖ ✖
NF Norfolk Island ✖ ✖
NG Nigeria ✖ ✖
NI Nicaragua ✖ ✖
NL Netherlands ✓ ✓
NO Norway ✓ ✓
NP Nepal ✖ ✖
NR Nauru ✖ ✖
NU Niue ✖ ✖
NZ New Zealand ✓ ✓
OM Oman ✖ ✖
PA Panama ✖ ✖
PE Peru ✖ ✖
PF French Polynesia ✖ ✖
PG Papua New Guinea ✖ ✖
PH Philippines ✓ ✓
PK Pakistan ✓ ✓
PL Poland ✓ ✓
PM Saint Pierre and Miquelon ✓ ✓
PN Pitcairn Islands ✖ ✖
PR Puerto Rico ✓ ✓
PS State of Palestine ✓ ✖
PT Portugal ✓ ✓
PW Palau ✓ ✓
PY Paraguay ✖ ✖
QA Qatar ✖ ✖
RE Réunion ✓ ✓
RO Romania ✓ ✓
RS Serbia. ✓ ✓
RU Russia ✓ ✓
RW Rwanda ✖ ✖
SA Saudi Arabia ✓ ✖
SB Solomon Islands ✖ ✖
SC Seychelles ✖ ✖
SD Sudan ✓ ✖
SE Sweden ✓ ✓
SG Singapore ✓ ✓
SH Saint Helena, Ascension and Tristan da Cunha ✖ ✖
SI Slovenia ✓ ✓
SJ Svalbard and Jan Mayen ✖ ✓
SK Slovakia ✓ ✓
SL Sierra Leone ✖ ✖
SM San Marino ✓ ✓
SN Senegal ✖ ✖
SO Somalia ✖ ✖
SR Suriname ✖ ✖
SS South Sudan ✖ ✖
ST São Tomé and Príncipe ✖ ✖
SV El Salvador ✖ ✖
SX Sint Maarten ✖ ✖
SY Syria ✖ ✖
SZ Swaziland ✓ ✖
TC Turks and Caicos Islands ✖ ✖
TD Chad ✖ ✖
TF French Southern and Antarctic Lands ✖ ✖
TG Togo ✖ ✖
TH Thailand ✓ ✓
TJ Tajikistan ✓ ✖
TK Tokelau ✖ ✖
TL East Timor ✖ ✖
TM Turkmenistan ✓ ✖
TN Tunisia ✓ ✖
TO Tonga ✖ ✖
TR Turkey ✓ ✓
TT Trinidad and Tobago ✖ ✖
TV Tuvalu ✖ ✖
TW Taiwan ✓ ✖
TZ Tanzania ✖ ✖
UA Ukraine ✓ ✓
UG Uganda ✖ ✖
UM United States Minor Outlying Islands ✖ ✖
US United States ✓ ✓
UY Uruguay ✓ ✓
UZ Uzbekistan ✓ ✖
VA Vatican City ✖ ✓
VC Saint Vincent and the Grenadines ✖ ✖
VE Venezuela ✓ ✖
VG British Virgin Islands ✖ ✖
VI United States Virgin Islands ✓ ✓
VN Vietnam ✓ ✖
VU Vanuatu ✖ ✖
WF Wallis and Futuna ✖ ✓
WS Samoa ✖ ✖
YE Yemen ✖ ✖
YT Mayotte ✖ ✓
ZA South Africa ✓ ✓
ZM Zambia ✓ ✖
ZW Zimbabwe ✖ ✖

Sources

About

Free global postal code validation & lookup for the web. Fast, with no dependencies.

Topics

javascript regex zipcodes postal-code international

Resources

Readme

License

GPL-3.0 license
Activity
Custom properties

Stars

81 stars

Watchers

4 watching

Forks

12 forks
Report repository

Releases 3

Added countries: AZ, EE, MW, KR, SG Latest
Nov 26, 2019
+ 2 releases

Packages

No packages published

Contributors 2

  •  
  •  

Languages