Product Manuals and Documentation
IP Requests
IP Requests
GET https://api.geoplugin.com/?ip=X.X.X.X&auth=YOUR_API_KEY_HERE
This endpoint retrieves the IP metadata for a given IP
GeoPlugin uses API keys to allow access to the API. You can register a new GeoPlugin API key at our Developer Dashboard.
GeoPlugin expects for the API key to be included in all API requests to the server in a header that looks like the following:
You must replace YOUR_API_KEY_HERE with your personal API key.
Query Parameters
| Parameter | Description |
|---|---|
| ip | A valid IPv4 address |
| auth | Your API key you’ve retrieved from your account dashboard |
GET https://api.geoplugin.com/?ip=X.X.X.X&auth=YOUR_API_KEY_HERE&lang=XX
The above command returns JSON structured like this:
{
"geoplugin_request": "8.8.8.8",
"geoplugin_status": "200",
"geoplugin_credit": "Some of the returned data includes GeoLite2 data created by MaxMind, available from https://www.maxmind.com.",
"geoplugin_region": null,
"geoplugin_areaCode": null,
"geoplugin_dmaCode": null,
"geoplugin_countryName": "United States",
"geoplugin_countryCode": "US",
"geoplugin_euVATrate": null,
"geoplugin_continentName": "North America",
"geoplugin_inEU": "null",
"geoplugin_continentCode": "NA",
"geoplugin_city": null,
"geoplugin_regionName": null,
"geoplugin_regionCode": null,
"geoplugin_longitude": -97.822,
"geoplugin_latitude": 37.751,
"geoplugin_locationAccuracyRadius": null,
"geoplugin_timezone": "America/Chicago",
"geoplugin_currencyCode": USD,
"geoplugin_currencySymbol": null,
"geoplugin_currencyConverter": null,
"geoplugin_currencySymbol_UTF8": null,
"languages": "[ "en-US", "es-US", haw, "fr"]
}
Multi-lingual results
Multi-lingual results
GET https://api.geoplugin.com?ip=X.X.X.X&auth=YOUR_API_KEY_HERE&lang=XX
This endpoint retrieves the IP metadata for a given IP. If you pass in a a “lang” param with a valid iso eg. “en”, “fr”, “it”, “de”. Language will fallback to English when your chosen language is unavailable.
Full list of valid languages: see here:
| ISO Name | Language |
|---|---|
| aa | Afar |
| auth | Abkhazian |
| ae | Avestan |
| af | Afrikaans |
| ak | Akan |
| am | Amharic |
| an | Aragonese |
| ar | Arabic |
| as | Assamese |
| av | Avaric |
| ay | Aymara |
| az | Azerbaijani |
| ba | Bashkir |
| be | Belarusian |
| bg | Bulgarian |
| bh | Bihari |
| bi | Bislama |
| bm | Bambara |
| bn | Bengali |
| bo | Tibetan |
| br | Breton |
| bs | Bosnian |
| ca | Catalan |
| ce | Chechen |
| ch | Chamorro |
| co | Corsican |
| cr | Cree |
| cs | Czech |
| cu | Church Slavic |
| cv | Chuvash |
| cy | Welsh |
| da | Danish |
| de | German |
| dv | Dhivehi |
| dz | Dzongkha |
| ee | Ewe |
| el | Modern Greek (1453-) |
| en | English |
| eo | Esperanto |
| es | Spanish |
| et | Estonian |
| eu | Basque |
| fa | Persian |
| ff | Fulah |
| fi | Finnish |
| fj | Fijian |
| fo | Faroese |
| fr | French |
| fy | Western Frisian |
| ga | Irish |
| gd | Scottish Gaelic |
| gl | Galician |
| gn | Dhivehi |
| dv | Guarani |
| gu | Gujarati |
| gv | Manx |
| ha | Hausa |
| he | Hebrew |
| hi | Hindi |
| ho | Hiri Motu |
| hr | Croatian |
| ht | Haitian |
| hu | Hungarian |
| hy | Armenian |
| ia | Interlingua (International Auxiliary Language Association) |
| id | Indonesian |
| ie | Interlingue |
| ig | Igbo |
| ii | Sichuan Yi |
| ik | Inupiaq |
| io | Ido |
| is | Icelandic |
| it | Italian |
| iu | Inuktitut |
| ja | Japanese |
| jv | Javanese |
| ka | Georgian |
| ht | Haitian |
| kg | Kongo |
| ki | Kikuyu |
| kj | Kuanyama |
| kk | Kazakh |
| kl | Kalaallisut |
| kl | Central Khmer |
| kn | Kannada |
| ko | Korean |
| kr | Kanuri |
| ks | Kashmiri |
| ku | Kurdish |
| kv | Komi |
| kw | Cornish |
| ky | Kirghiz |
| la | Latin |
| lb | Luxembourgish |
| lg | Ganda |
| li | Limburgan |
| ln | Lingala |
| lo | Lao |
| lt | Lithuanian |
| lu | Luba-Katanga |
| lv | Latvian |
| mg | Malagasy |
| mh | Marshallese |
| mi | Maori |
| mk | Macedonian |
| ml | Malayalam |
| mn | Mongolian |
| mr | Marathi |
| ms | Malay (macrolanguage) |
| mt | Maltese |
| my | Burmese |
| na | Nauru |
| nb | Norwegian Bokmål |
| nd | North Ndebele |
| ne | Nepali (macrolanguage) |
| ng | Ndonga |
| nl | Dutch |
| nn | Norwegian Nynorsk |
| no | Norwegian |
| nr | South Ndebele |
| nv | Navajo |
| ny | Nyanja |
| oc | Occitan (post 1500) |
| oj | Ojibwa |
| om | Oromo |
| or | Oriya (macrolanguage) |
| os | Ossetian |
| pa | Panjabi |
| pa | Panjabi |
| pi | Pali |
| pl | Polish |
| ps | Pushto |
| pt | Portuguese |
| qu | Quechua |
| rm | Romansh |
| rn | Rundi |
| ro | Romanian |
| ru | Russian |
| rw | Kinyarwanda |
| sa | Sanskrit |
| sc | Sardinian |
| sd | Sindhi |
| se | Northern Sami |
| sg | Sango |
| sh | Serbo-Croatian |
| si | Sinhala |
| sk | Slovak |
| sl | Slovenian |
| sm | Samoan |
| sn | Shona |
| so | Somali |
| sq | Albanian |
| sr | Serbian |
| ss | Swati |
| st | Southern Sotho |
| su | Sundanese |
| sv | Swedish |
| sw | Swahili (macrolanguage) |
| ta | Tamil |
| te | Telugu |
| tg | Tajik |
| th | Thai |
| ti | Tigrinya |
| tk | Turkmen |
| tl | Tagalog |
| tn | Tswana |
| to | Tonga (Tonga Islands) |
| tr | Turkish |
| ts | Tsonga |
| tt | Tatar |
| tw | Twi |
| ty | Tahitian |
| ug | Uighur |
| uk | Ukrainian |
| ur | Urdu |
| uz | Uzbek |
| ve | Venda |
| vi | Vietnamese |
| vo | Volapük |
| wa | Walloon |
| wo | Wolof |
| xh | Xhosa |
| yi | Yiddish |
| yo | Yoruba |
| za | Zhuang |
| zh | Chinese |
| zu | Zulu |
IP Find uses API keys to allow access to the API. You can register a new IP Find API key at our Developer Dashboard
IP Find expects for the API key to be included in all API requests to the server in a header that looks like the following:
You must replace YOUR_API_KEY_HERE with your personal API key.
GET https://api.geoplugin.com/?ip=X.X.X.X&auth=YOUR_API_KEY_HERE&lang=XX
The above command with lang specified as “hi” returns JSON in Hindi structured like this.
If a name can’t be found with this language it will fall back to English
{
"geoplugin_request": "203.122.35.1",
"geoplugin_status": "200",
"geoplugin_credit": "Some of the returned data includes GeoLite2 data created by MaxMind, available from https://www.maxmind.com.",
"geoplugin_region": "दिल्ली",
"geoplugin_areaCode": null,
"geoplugin_dmaCode": null,
"geoplugin_countryName": "भारत",
"geoplugin_countryCode": "IN",
"geoplugin_euVATrate": null,
"geoplugin_continentName": "एशिया महाद्वीप",
"geoplugin_inEU": "null",
"geoplugin_continentCode": "AS",
"geoplugin_city": "नई दिल्ली",
"geoplugin_regionName": "दिल्ली",
"geoplugin_regionCode": "07",
"geoplugin_postal_code": "110020",
"geoplugin_longitude": 77.1663,
"geoplugin_latitude": 28.652,
"geoplugin_locationAccuracyRadius": null,
"geoplugin_timezone": "Asia/Kolkata",
"geoplugin_currencyCode": INR,
"geoplugin_currencySymbol": null,
"geoplugin_currencyConverter": null,
"geoplugin_currencySymbol_UTF8": null,
"languages": "[
"en-IN",
"hi",
"bn",
"te",
"mr",
"ta",
"ur",
"gu",
"kn",
"ml",
"or",
"pa",
"as",
"bh",
"sat",
"ks",
"ne",
"sd",
"kok",
"doi",
"mni",
"sit",
"sa",
"fr",
"lus",
"inc"
]"}
Get the Current User or client’s IP Location
Get the Current User or client’s IP Location
GET https://api.geoplugin.com/?ip=X.X.X.X&auth=YOUR_API_KEY_HERE&lang=XX
| Parameter | Description |
|---|---|
| ip | A valid IPv4 address |
| auth | Your API key you’ve retrieved from your account dashboard |
CURL" https://api.geoplugin.com/me?auth=YOUR_API_KEY_HERE"
The above command returns the meta data for the IP address of the request client: eg.
{
"geoplugin_request": "8.8.8.8",
"geoplugin_status": "200",
"geoplugin_credit": "Some of the returned data includes GeoLite2 data created by MaxMind, available from https://www.maxmind.com.",
"geoplugin_region": null,
"geoplugin_areaCode": null,
"geoplugin_dmaCode": null,
"geoplugin_countryName": "United States",
"geoplugin_countryCode": "US",
"geoplugin_euVATrate": null,
"geoplugin_continentName": "North America",
"geoplugin_inEU": "null",
"geoplugin_continentCode": "NA",
"geoplugin_city": null,
"geoplugin_regionName": null,
"geoplugin_regionCode": null,
"geoplugin_longitude": -97.822,
"geoplugin_latitude": 37.751,
"geoplugin_locationAccuracyRadius": null,
"geoplugin_timezone": "America/Chicago",
"geoplugin_currencyCode": USD,
"geoplugin_currencySymbol": null,
"geoplugin_currencyConverter": null,
"geoplugin_currencySymbol_UTF8": null,
"languages": "[ "en-US", "es-US", haw, "fr"]
}
Get a country flag from an IP address
Get a country flag from an IP address
GET https://api.geoplugin.com/flag?ip=X.X.X.X&auth=YOUR_API_KEY_HERE
Query Parameters
| Parameter | Description |
|---|---|
| ip | A valid IPv4 address |
| auth | Your API key you’ve retrieved from your account dashboard |
CURL" https://api.geoplugin.com/flag?ip=8.8.8.8&auth=YOUR_API_KEY_HERE"
The above command redirects to an image like this: https://api.geoplugin.com/flag/64/us.png