API Guide

Our API provides IP related information using a REST interface that returns the following data:

• hostname
• owner
• continent name, continent code
• country name, country code
• region name, region code
• county name
• city name
• latitude, longitude
• timezone
• official language
• currency

Calling the iplocate API is easy and intuitive. Make the request by appending valid parameters for your query:

https://api.iplocate.com/ip/«ip_address»/key/«api_key»/output/«format»/timezone/«bool»/hostname/«bool»/language/«bool»/currency/«bool»

the parameters can be specified in any order inside URL

Parameters

In order to obtain a valid API key for your application or website, please register for a iplocate user account.

By default, iplocate API sends responses in structured XML data format. You can also request the response in JSON data format or plain text (RAW).

Sample XML Response

<response>
<status>Propper Request</status>
<message>Success</message>
<notes>The following results has been returned</notes>
<code>200_1</code>
<location>
<ip>8.8.8.8</ip>
<owner>LEVEL 3 COMMUNICATIONS INC</owner>
<continent_name>NORTH AMERICA</continent_name>
<continent_code>NA</continent_code>
<country_name>UNITED STATES</country_name>
<country_code>US</country_code>
<region_name>CALIFORNIA</region_name>
<region_code>CA</region_code>
<county_name>SANTA CLARA</county_name>
<city_name>MOUNTAIN VIEW</city_name>
<latitude>37.3801</latitude>
<longitude>-122.0865</longitude>
<timezone>PST</timezone>
</location>
<languages>
<language>
<alpha2_code>EN</alpha2_code>
<alpha3_code>ENG</alpha3_code>
<language_name>ENGLISH</language_name>
<native_name>ENGLISH</native_name>
</language>
</languages>
<currencies>
<currency>
<alpha_code>USD</alpha_code>
<numeric_code>840</numeric_code>
<currency_name>US DOLLAR</currency_name>
<currency_symbol>$</currency_symbol>
<fractional_unit>CENT</fractional_unit>
</currency>
</currencies>
<unit_test>
<elapsed_time>0.0609</elapsed_time>
<memory_usage>0.76MB</memory_usage>
</unit_test>
</response>

Sample JSON Response

{
"response": {
"status": "Propper Request",
"message": "Success",
"notes": "The following results has been returned",
"code": "200_1",
"location": {
"ip": "8.8.8.8",
"owner": "LEVEL 3 COMMUNICATIONS INC",
"continent_name": "NORTH AMERICA",
"continent_code": "NA",
"country_name": "UNITED STATES",
"country_code": "US",
"region_name": "CALIFORNIA",
"region_code": "CA",
"county_name": "SANTA CLARA",
"city_name": "MOUNTAIN VIEW",
"latitude": "37.3801",
"longitude": "-122.0865",
"timezone": "PST"
},
"languages": {
"language": [
{
"alpha2_code": "EN",
"alpha3_code": "ENG",
"language_name": "ENGLISH",
"native_name": "ENGLISH"
}
]
},
"currencies": {
"currency": [
{
"alpha_code": "USD",
"numeric_code": "840",
"currency_name": "US DOLLAR",
"currency_symbol": "$",
"fractional_unit": "CENT"
}
]
},
"unit_test": {
"elapsed_time": "0.0609",
"memory_usage": "0.76MB"
}
}
}

Sample RAW Response

Propper Request,Success,The following results has been returned,200_1, 8.8.8.8,LEVEL 3 COMMUNICATIONS INC,NORTH AMERICA,NA,UNITED STATES,US,CALIFORNIA,CA,SANTA CLARA,MOUNTAIN VIEW,37.3801,-122.0865,PST, languages,1,EN,ENG,ENGLISH,ENGLISH, currencies,1,USD,840,US DOLLAR,$,CENT, unit_test,0.609,0.76MB

If a request fails, the iplocate API returns an error message. By default, the message is returned as structured XML, but JSON and RAW messages are also available.

<error>
<status>status</status>
<message>message</message>
<notes>notes</notes>
<code>code</code>
<unit_test>
<elapsed_time>time</elapsed_time>
<memory_usage>memory</memory_usage>
</unit_test>
</error>