IP Geolocation API
Abstract’s IP Geolocation API is a fast, lightweight, modern, and RESTful JSON API that determines the location and other details of IP addresses from over 190 countries.
It’s very simple to use: you only need to submit your API key and an IP address, and the API will respond with the location of that IP including postal code, city, region, country and lat/long data.
Getting started
REST
The IP Geolocation API, like all of Abstract’s APIs, is organized around REST. It is designed to use predictable, resource-oriented URLs and to use HTTP status codes to indicate errors.
HTTPS
The IP Geolocation API requires all communications to be secured with TLS 1.2 or greater.
API Versions
All of Abstract’s APIs are versioned. The IP Geolocation API is currently on Version 1.
Your API Key
Your API key is your unique authentication key to be used to access Abstract’s IP Geolocation API. Note that each of Abstract’s APIs has a unique API key, so you will need different keys to access the IP Geolocation and Email Validation APIs, for example. To authenticate your requests, you will need to append your API key to the base URL.
Base URL
https://ipgeolocation.abstractapi.com/v1/
Validation endpoint
Abstract’s IP Geolocation API simply requires your unique API key and will automatically detect the IP address from the client where it is called. You can also append the “ip_address” parameter to specify the IP to analyze:
https://ipgeolocation.abstractapi.com/v1/
? api_key = YOUR_UNIQUE_API_KEY
& ip_address = 166.171.248.255 (optional)
This was a successful request, so the IP address and details associated with it are returned below:
Request parameters
Your unique API key. Note that each user has unique API keys for each of Abstract’s APIs, so your IP Geolocation API key will not work for your Email Validation API, for example.
The IP address to geolocate. Both IPv4 and IPv6 addresses are supported. Note that if you leave this parameter blank, the service will geolocate the IP address from which the request was made.
You can chose to only receive a few fields from the JSON response. To do so, you can include a fields value in the query parameters with a comma separated list of the top-level keys you want to be returned. For example, adding ?fields=city will return only the city in the JSON response.
Response parameters
The API response is returned in a universal and lightweight JSON format.
The IP address submitted for geolocation.
City’s name.
City’s geoname ID.
State or province in which the the city is located.
State or province’s ISO 3166-2 code.
State or province’s geoname ID.
ZIP or postal code.
Country’s name.
Country’s ISO 3166-1 alpha-2 code.
Country’s geoname ID.
True if the country is in the EU, false if it is not.
Continent’s name.
2 letter continent code: AF, AS, EU, NA, OC, SA, AN.
Continent’s geoname ID.
Decimal of the longitude.
Decimal of the latitude.
Whether the IP address is using from a VPN or using a proxy
Timezone’s name from the IANA Time Zone Database.
Timezone’s abbreviation, also from the IANA Time Zone Database.
Timezone’s offset from Greenwich Mean Time (GMT).
Current time in the local time zone.
True if the location is currently in Daylight Savings Time (DST).
Link to a hosted version of the country’s flag in SVG format.
Link to a hosted version of the country’s flag in PNG format.
Country’s flag as an emoji.
Country’s flag in unicode.
The currency’s name.
The currency’s code in ISO 4217 format.
Type of network connection: Dialup, Cable/DSL, Cellular, Corporate.
Autonomous System number.
Autonomous System Organization name.
Internet Service Provider (ISP) name.
Organization name.
Limiting response fields
You can choose to only receive a few fields from the JSON response. To do so, you can include a fields value in the query parameters with a comma separated list of the top-level keys you want to be returned.
For example, a request to only get the country and city of an IP will look like this:
https://ipgeolocation.abstractapi.com/v1/
? api_key = YOUR_API_KEY
& ip_address = 166.171.248.255
& fields = country,city
The response would look like this:
{
"country": "United States",
"city": "Modesto"
}
Use cases
Geolocating a website visitor
To request the geolocation from an IP address, simply include your unique API key in the template below.
Note that you don’t need to know the IP of the visitor to make the request.
$.getJSON("https://ipgeolocation.abstractapi.com/v1/?api_key=YOUR_UNIQUE_API_KEY", function(data) {
console.log(data.ip_address);
console.log(data.country);
})
That’s all your need to get the geolocation and other data from a visitor! There is only one required parameter: your unique API key.
Response and error codes
Whenever you make a request that fails for some reason, an error is returned also in the JSON format. The errors include an error code and description, which you can find in detail below.
Code | Type | Details |
---|---|---|
200 | OK | Everything worked as expected. |
204 | OK | Their is no location data for the submitted IP. |
400 | Bad request | Bad request. |
401 | Unauthorized | The request was unacceptable. Typically due to the API key missing or incorrect. |
422 | Quota reached | The request was aborted due to insufficient API credits. (Free plans) |
429 | Too many requests | The request was aborted due to the number of allowed requests per second being reached. This happens on free plans as requests are limited to 1 per second. |
500 | Internal server error | The request could not be completed due to an error on the server side. |
503 | Service unavailable | The server was unavailable. |
Country Codes
Below is a list of two-letter ISO 3166 Alpha 2 country codes that are used in the response. View this list in a CSV.
Country name | Country code |
---|---|
Afghanistan | AF |
Albania | AL |
Algeria | DZ |
American Samoa | AS |
Andorra | AD |
Angola | AO |
Anguilla | AI |
Antigua and Barbuda | AG |
Argentina | AR |
Armenia | AM |
Aruba | AW |
Australia | AU |
Austria | AT |
Azerbaijan | AZ |
Bahrain | BH |
Bangladesh | BD |
Barbados | BB |
Belarus | BY |
Belgium | BE |
Belize | BZ |
Benin | BJ |
Bermuda | BM |
Bhutan | BT |
Bolivia | BO |
Bosnia and Herzegovina | BA |
Botswana | BW |
Brazil | BR |
British Virgin Islands | VG |
Brunei | BN |
Bulgaria | BG |
Burkina Faso | BF |
Burundi | BI |
Cabo Verde | CV |
Cambodia | KH |
Cameroon | CM |
Canada | CA |
Cayman Islands | KY |
Central African Republic | CF |
Chad | TD |
Chile | CL |
China | CN |
Colombia | CO |
Comoros | KM |
Congo | CG |
Congo Democratic Republic | CD |
Cook Islands | CK |
Costa Rica | CR |
Cote d’Ivoire | CI |
Croatia | HR |
Cuba | CU |
Curaçao | CW |
Cyprus | CY |
Czechia | CZ |
Denmark | DK |
Djibouti | DJ |
Dominica | DM |
Dominican Republic | DO |
East Timor | TL |
Ecuador | EC |
Egypt | EG |
El Salvador | SV |
Equatorial Guinea | GQ |
Eritrea | ER |
Estonia | EE |
eSwatini | SZ |
Ethiopia | ET |
Falkland Islands | FK |
Faroe Islands | FO |
Fiji | FJ |
Finland | FI |
France | FR |
French Guiana | GF |
French Polynesia | PF |
Gabon | GA |
Gambia | GM |
Georgia | GE |
Germany | DE |
Ghana | GH |
Gibraltar | GI |
Greece | GR |
Greenland | GL |
Grenada | GD |
Guadeloupe | GP |
Guam | GU |
Guatemala | GT |
Guernsey | GG |
Guinea | GN |
Guinea-Bissau | GW |
Guyana | GY |
Haiti | HT |
Honduras | HN |
Hong Kong | HK |
Hungary | HU |
Iceland | IS |
India | IN |
Indonesia | ID |
Iran | IR |
Iraq | IQ |
Ireland | IE |
Isle of Man | IM |
Israel | IL |
Italy | IT |
Jamaica | JM |
Japan | JP |
Jersey | JE |
Jordan | JO |
Kazakhstan | KZ |
Kenya | KE |
Kiribati | KI |
Kosovo | XK |
Kuwait | KW |
Kyrgyzstan | KG |
Laos | LA |
Latvia | LV |
Lebanon | LB |
Lesotho | LS |
Liberia | LR |
Libya | LY |
Liechtenstein | LI |
Lithuania | LT |
Luxembourg | LU |
Macau | MO |
Madagascar | MG |
Malawi | MW |
Malaysia | MY |
Maldives | MV |
Mali | ML |
Malta | MT |
Marshall Islands | MH |
Martinique | MQ |
Mauritania | MR |
Mauritius | MU |
Mayotte | YT |
Mexico | MX |
Micronesia | FM |
Moldova | MD |
Monaco | MC |
Mongolia | MN |
Montenegro | ME |
Montserrat | MS |
Morocco | MA |
Mozambique | MZ |
Myanmar | MM |
Namibia | NA |
Nauru | NR |
Nepal | NP |
Netherlands | NL |
New Caledonia | NC |
New Zealand | NZ |
Nicaragua | NI |
Niger | NE |
Nigeria | NG |
North Korea | KP |
North Macedonia | MK |
Northern Mariana Islands | MP |
Norway | NO |
Oman | OM |
Pakistan | PK |
Palau | PW |
Panama | PA |
Papua New Guinea | PG |
Paraguay | PY |
Peru | PE |
Philippines | PH |
Poland | PL |
Portugal | PT |
Puerto Rico | PR |
Qatar | QA |
Reunion | RE |
Romania | RO |
Russia | RE |
Rwanda | RW |
Saint Helena | SH |
Saint Kitts and Nevis | KN |
Saint Lucia | LC |
Saint Martin | MF |
Saint Pierre and Miquelon | PM |
Saint Vincent and the Grenadines | VC |
Samoa | WS |
San Marino | SM |
Sao Tome and Principe | ST |
Saudi Arabia | SA |
Senegal | SN |
Serbia | RS |
Seychelles | SC |
Sierra Leone | SL |
Singapore | SG |
Sint Maarten | SX |
Slovakia | SK |
Slovenia | SI |
Solomon Islands | SB |
Somalia | SO |
South Africa | ZA |
South Korea | KR |
South Sudan | SS |
Spain | ES |
Sri Lanka | LK |
St. Barts | BL |
Sudan | SD |
Suriname | SR |
Sweden | SE |
Switzerland | CH |
Syria | SY |
Taiwan | TW |
Tajikistan | TJ |
Tanzania | TZ |
Thailand | TH |
The Bahamas | BH |
Togo | TG |
Tonga | TO |
Trinidad and Tobago | TT |
Tunisia | TN |
Turkey | TR |
Turkmenistan | TM |
Turks and Caicos Islands | TC |
Tuvalu | TV |
Uganda | UG |
Ukraine | UA |
United Arab Emirates | AE |
United Kingdom | GB |
United States | US |
Uruguay | UY |
US Virgin Islands | VI |
Uzbekistan | UZ |
Vanuatu | VU |
Vatican City (Holy See) | VA |
Venezuela | VE |
Vietnam | VN |
Wallis and Futuna | WF |
Yemen | YE |
Zambia | ZM |
Zimbabwe | ZW |
Code samples and libraries
Please see the top of this page for code samples for these languages and more. If we’re missing a code sample, or if you’d like to contribute a code sample or library in exchange for free credits, email us at: team@abstractapi.com
Other notes
A note on metered billing: Each individual IP you submit counts as a credit used. Credits are also counted per request, not per successful response. So if you submit a request for the (invalid) IP address “kasj8929hs”, that still counts as 1 credit.