Get Caller Location

Lookup the geographic location of a user based on their IP address.

This API exists for debugging purposes and may not be available in the future.

GET /geolocate

Get Caller Location

cURL

curl --request GET \
  --url https://api.example.com/geolocate

import requests

url = "https://api.example.com/geolocate"

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('https://api.example.com/geolocate', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/geolocate",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/geolocate"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.example.com/geolocate")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/geolocate")

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

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

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

200

{
  "ip": "<string>",
  "location": {
    "file_index": 123,
    "range_start_int": 123,
    "range_end_int": 123,
    "range_start_ip": "<string>",
    "range_end_ip": "<string>",
    "country_code": "<string>",
    "country_name": "<string>"
  },
  "allowed": false
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Query Parameters

ip · string | null

IP address to geolocate, defaults to client IP address

Example:

"1.2.3.4"

Response

200

application/json

Successful Response

ip · string · required

Resolved IP address, useful for debugging

location · Geolocation · object | null

Information about the location of the IP address, None if could not be determined

Show child attributes

allowed · boolean · default: false

Whether the IP address is allowed to be used for inference.