Community Forum

Get User's Device Location

How to get location of a user’s device from its ip address
  1. Overview
  2. Optional parameters
  3. Geolocation example
  4. Response
  5. Your IP address Example
  6. Usage limits

Overview

Woosmap Geolocation API can provide the location of your users thanks to IP address of their devices. You can query the API using a public or a private key according to your use case and calls origins.

Client-side requests

For client-side requests, use your public key (parameter key) related to your project. The IP address to geocode is the public IP from the user device.

Server-side requests

For server-side requests, get the position of a specific ip address using a private_key in your requests and parameter ip_address to geolocate.

Optional parameters

        https://api.woosmap.com/geolocation/position/?private_key={PRIVATE_API_KEY}&cc_format=alpha2

cc_format

To specify the country code format returned in the response. Default is alpha2.

Available cc_format values are alpha2 or alpha3.

Geolocation example

The following example requests the geolocation of a specific IP address 173.79.254.254 on the server-side:

Geolocation call
        https://api.woosmap.com/geolocation/position
  ?ip_address=173.79.254.254
  &private_key=YOUR_PRIVATE_API_KEY
    
        curl -L -X GET 'https://api.woosmap.com/geolocation/position?private_key=YOUR_PRIVATE_API_KEY&ip_address=173.79.254.254'

    
        var requestOptions = {
  method: 'GET',
  redirect: 'follow'
};

fetch("https://api.woosmap.com/geolocation/position?private_key=YOUR_PRIVATE_API_KEY&ip_address=173.79.254.254", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

    
        var axios = require('axios');

var config = {
  method: 'get',
  url: 'https://api.woosmap.com/geolocation/position?private_key=YOUR_PRIVATE_API_KEY&ip_address=173.79.254.254',
  headers: { }
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});


    
        import requests

url = "https://api.woosmap.com/geolocation/position?private_key=YOUR_PRIVATE_API_KEY&ip_address=173.79.254.254"

payload={}
headers = {}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)


    
        OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
  .url("https://api.woosmap.com/geolocation/position?private_key=YOUR_PRIVATE_API_KEY&ip_address=173.79.254.254")
  .method("GET", body)
  .build();
Response response = client.newCall(request).execute();

    
        require "uri"
require "net/http"

url = URI("https://api.woosmap.com/geolocation/position?private_key=YOUR_PRIVATE_API_KEY&ip_address=173.79.254.254")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)

response = https.request(request)
puts response.read_body

Response

For a provided location, the response is a formatted JSON containing the keys:

country_code ISO 3166-1 Alpha-2 or Alpha-3 compatible country code
country_name country name (string value)
continent continent name (string value)
region_state region name when available (string value)
city city name (string value) when available
postal_code a postal code close to the user’s location, when available
timezone the time zone associated with location, as specified by the IANA Time Zone Database
latitude longitude approximate latitude and longitude of the geographical area associated with the IP address
accuracy radius in kilometers around the specified location where the IP address is likely to be
viewport geographic bounds (northeast latlng and southwest latlng) build from latitude, longitude and accuracy values, to help center a map

According to IP data relevance and accuracy some keys may eventually not be provided.

Geolocation Position Response
JSON
        {
  "country_code": "US",
  "country_name": "United States",
  "continent": "North America",
  "latitude": 38.7304,
  "longitude": -77.0634,
  "accuracy": 5,
  "viewport":
    {
      "northeast": { "lat": 38.77531576420598, "lng": -77.00582296106178 },
      "southwest": { "lat": 38.68548423579403, "lng": -77.12097703893822 },
    },
  "city": "Alexandria",
  "region_state": "Virginia",
  "postal_code": "22308",
  "timezone": "America/New_York",
}

Your IP address Example

Here is a sample of a Geolocation API call using Javascript. The fetched location is used to generate a Google static map.

Usage limits

The following usage limits are in place for the location endpoint of Geolocation API:

‹ Configuration Stores Nearby Geolocation ›
Was this article helpful?
Have more questions? Submit a request