IPGeolocation API Portfolio

https://ipgeolocation.io/documentation.html
Admin
IPGeolocation provides a suite of APIs including IP Geolocation, IP Security, ASN, Abuse Contact,...
Tokens:3,405
Snippets:21
Trust Score:9.2
Update:1 year ago
Show doc for...
Tokens:
Raw
### Get XML Response using Accept Header

Source: https://ipgeolocation.io/documentation.html/index

This snippet shows how to request an XML response by setting the `Accept` HTTP header to `text/xml`. It includes a cURL example for the request and the corresponding XML response.

```bash
curl -X GET 'https://api.ipgeolocation.io/v2/ipgeo?apiKey=API_KEY&ip=1.1.1.1&fields=currency' \
-H 'Accept: text/xml'
```

--------------------------------

### Get XML Response using URL Parameter

Source: https://ipgeolocation.io/documentation.html/index

This snippet demonstrates how to retrieve API data in XML format by appending `output=xml` to the API request URL. It shows a cURL example for making the request and the expected XML response structure.

```bash
curl -X GET 'https://api.ipgeolocation.io/v2/ipgeo?apiKey=API_KEY&ip=1.1.1.1&fields=location.city&output=xml'
```

--------------------------------

### Get Client IP Address in Ruby

Source: https://ipgeolocation.io/documentation.html/index

This Ruby snippet shows how to fetch the client's IP address using the 'getip' endpoint with the `net/http` and `json` libraries. It makes a GET request, parses the JSON response, and prints the IP address. No authentication is required for this endpoint.

```ruby
require 'net/http'
require 'uri'
require 'json'

uri = URI.parse("https://api.ipgeolocation.io/getip")

response = Net::HTTP.get_response(uri)

if response.is_a?(Net::HTTPSuccess)
  data = JSON.parse(response.body)
  puts "Your IP Address is: #{data['ip']}"
else
  puts "Error fetching IP: #{response.code} #{response.message}"
end
```

--------------------------------

### Get Client IP Address in jQuery

Source: https://ipgeolocation.io/documentation.html/index

This jQuery snippet shows how to use AJAX to make a GET request to the 'getip' endpoint and retrieve the client's IP address. The IP address is then displayed using an alert. No authentication is needed for this endpoint.

```javascript
$.ajax({
    url: "https://api.ipgeolocation.io/getip",
    type: "GET",
    success: function(result) {
        alert("Your IP Address is: " + result.ip);
    },
    error: function(error) {
        console.error("Error fetching IP: ", error);
    }
});
```

--------------------------------

### Get Client IP Address in Go

Source: https://ipgeolocation.io/documentation.html/index

This Go code snippet shows how to make a GET request to the 'getip' endpoint to retrieve the client's IP address. It parses the JSON response to extract the IP address. This endpoint does not require authentication.

```go
package main

import (
	"encoding/json"
	"fmt"
	"io/ioutil"
	"net/http"
)

func main() {
	resp, err := http.Get("https://api.ipgeolocation.io/getip")
	if err != nil {
		fmt.Printf("Error making request: %s\n", err)
		return
	}

	defer resp.Body.Close()

	body, err := ioutil.ReadAll(resp.Body)
	if err != nil {
		fmt.Printf("Error reading response body: %s\n", err)
		return
	}

	var result map[string]interface{}
	err = json.Unmarshal(body, &result)
	if err != nil {
		fmt.Printf("Error unmarshalling JSON: %s\n", err)
		return
	}

	ipAddress := result["ip"]
	fmt.Printf("Your IP Address is: %s\n", ipAddress)
}
```

--------------------------------

### Response Formats: JSON and XML

Source: https://ipgeolocation.io/documentation.html/index

The ipgeolocation API supports both JSON and XML response formats. JSON is the default. To get an XML response, you can either pass `output=xml` as a URL parameter or set the `Accept` HTTP header to `application/xml` or `text/xml`.

```APIDOC
## JSON and XML Response Formats

All endpoints of the ipgeolocation API can respond in JSON (default) and XML formats.

### Requesting XML Format

**Option 1: URL Parameter**
Pass `output=xml` as a URL parameter.

**Option 2: HTTP Header**
Set the `Accept` HTTP header to `application/xml` or `text/xml`.

### Example 1: Using URL Parameter

```bash
curl -X GET 'https://api.ipgeolocation.io/v2/ipgeo?apiKey=API_KEY&ip=1.1.1.1&fields=location.city&output=xml'
```

**Response Example (XML):**

```xml
<LinkedHashMap>
  <ip>1.1.1.1</ip>
  <location>
    <city>South Brisbane</city>
  </location>
</LinkedHashMap>
```

### Example 2: Using HTTP Header

```bash
curl -X GET 'https://api.ipgeolocation.io/v2/ipgeo?apiKey=API_KEY&ip=1.1.1.1&fields=currency' \
  -H 'Accept: text/xml'
```

**Response Example (XML):**

```xml
<LinkedHashMap>
  <ip>1.1.1.1</ip>
  <currency>
    <code>AUD</code>
    <name>Australian Dollar</name>
    <symbol>A$</symbol>
  </currency>
</LinkedHashMap>
```

*Note: If neither the `output` URL parameter nor the `Accept` header is specified, the API will default to a JSON response.*
```

--------------------------------

### Get Client IP Address in Python

Source: https://ipgeolocation.io/documentation.html/index

This Python snippet utilizes the 'requests' library to make a GET request to the 'getip' endpoint and retrieve the client's IP address. It then parses the JSON response and prints the IP address. No authentication is needed for this endpoint.

```python
import requests

url = "https://api.ipgeolocation.io/getip"
try:
    response = requests.get(url)
    response.raise_for_status()  # Raise an exception for bad status codes
    data = response.json()
    print(f"Your IP Address is: {data['ip']}")
except requests.exceptions.RequestException as e:
    print(f"Error fetching IP: {e}")
```

--------------------------------

### Get Client IP Address in PHP

Source: https://ipgeolocation.io/documentation.html/index

This PHP snippet shows how to fetch the client's IP address using the 'getip' endpoint. It uses `file_get_contents` to make the request and `json_decode` to parse the JSON response. This endpoint does not require authentication.

```php
<?php

$response = file_get_contents('https://api.ipgeolocation.io/getip');
$data = json_decode($response, true);

if ($data && isset($data['ip'])) {
    echo "Your IP Address is: " . $data['ip'] . "\n";
} else {
    echo "Error fetching IP address.";
}

?>
```

--------------------------------

### Get Client IP Address in JavaScript

Source: https://ipgeolocation.io/documentation.html/index

This JavaScript snippet demonstrates fetching the client's IP address using the Fetch API to call the 'getip' endpoint. It asynchronously retrieves the data, parses the JSON response, and logs the IP address to the console. This endpoint does not require authentication.

```javascript
fetch('https://api.ipgeolocation.io/getip')
  .then(response => response.json())
  .then(data => {
    console.log('Your IP Address is:', data.ip);
  })
  .catch(error => {
    console.error('Error fetching IP:', error);
  });
```

--------------------------------

### GET /getip

Source: https://ipgeolocation.io/documentation.html/index

Retrieves the client's IP address from where the request is made. This endpoint does not require authentication.

```APIDOC
## GET /getip

### Description
Get IP endpoint returns the IP address of the client from where it's called. This endpoint does not require any authentication.

### Method
GET

### Endpoint
`https://api.ipgeolocation.io/getip`

### Parameters
None

### Request Example
```bash
curl -X GET 'https://api.ipgeolocation.io/getip'
```

### Response
#### Success Response (200)
- **ip** (string) - The IP address of the client.

#### Response Example
```json
{
  "ip": "1.1.1.1"
}
```
```

--------------------------------

### Get Client IP Address in Node.js

Source: https://ipgeolocation.io/documentation.html/index

This Node.js snippet uses the built-in 'https' module to make a GET request to the 'getip' endpoint and retrieve the client's IP address. It handles the response data and parses the JSON to log the IP address to the console. No authentication is required.

```javascript
const https = require('https');

https.get('https://api.ipgeolocation.io/getip', (resp) => {
  let data = '';

  // A chunk of data has been received.
  resp.on('data', (chunk) => {
    data += chunk;
  });

  // The whole response has been received.
  resp.on('end', () => {
    try {
      const result = JSON.parse(data);
      console.log('Your IP Address is:', result.ip);
    } catch (e) {
      console.error('Error parsing JSON:', e);
    }
  });

}).on('error', (err) => {
  console.error('Error: ' + err.message);
});
```

--------------------------------

### Get Client IP Address in Java

Source: https://ipgeolocation.io/documentation.html/index

This Java code snippet demonstrates how to fetch the client's IP address using the 'getip' endpoint. It utilizes the `HttpClient` to make the request and `ObjectMapper` from Jackson library to parse the JSON response. Authentication is not required for this endpoint.

```java
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.util.Map;

import com.fasterxml.jackson.databind.ObjectMapper;
public class GetIpAddress {

    public static void main(String[] args) {
        HttpClient client = HttpClient.newHttpClient();
        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://api.ipgeolocation.io/getip"))
                .build();

        try {
            HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
            ObjectMapper mapper = new ObjectMapper();
            Map<String, String> result = mapper.readValue(response.body(), Map.class);
            System.out.println("Your IP Address is: " + result.get("ip"));
        } catch (IOException | InterruptedException e) {
            e.printStackTrace();
        }
    }
}
```

--------------------------------

### Get Client IP Address in Swift

Source: https://ipgeolocation.io/documentation.html/index

This Swift code snippet demonstrates how to retrieve the client's IP address using the 'getip' endpoint. It employs `URLSession` to perform the network request and decodes the JSON response into a dictionary. This endpoint does not require authentication.

```swift
import Foundation

func getIpAddress() {
    guard let url = URL(string: "https://api.ipgeolocation.io/getip") else {
        print("Invalid URL")
        return
    }

    let task = URLSession.shared.dataTask(with: url) { data, response, error in
        if let error = error {
            print("Error fetching IP: \(error.localizedDescription)")
            return
        }

        guard let httpResponse = response as? HTTPURLResponse,
              (200...299).contains(httpResponse.statusCode) else {
            print("Invalid response")
            return
        }

        if let data = data, let json = try? JSONSerialization.jsonObject(with: data, options: []) as? [String: Any] {
            if let ipAddress = json["ip"] as? String {
                DispatchQueue.main.async {
                    print("Your IP Address is: \(ipAddress)")
                }
            }
        }
    }
    task.resume()
}

getIpAddress()
```

--------------------------------

### Get Client IP Address using cURL

Source: https://ipgeolocation.io/documentation.html/index

This snippet demonstrates how to retrieve the client's IP address using the 'getip' endpoint via a cURL command. This method does not require authentication. The response is a JSON object containing the IP address.

```shell
curl -X GET 'https://api.ipgeolocation.io/getip'
```

--------------------------------

### API SDKs

Source: https://ipgeolocation.io/documentation.html/index

ipgeolocation.io provides SDKs for various programming languages to simplify API integration. Links to detailed documentation and GitHub repositories are available.

```APIDOC
## API SDKs

To facilitate developers, we offer SDKs for various programming languages. Detailed documentation for each SDK is available on their respective pages. All SDKs are also available on GitHub.

**Available SDKs:**

* IP Geolocation API Java SDK
* IP Geolocation API C-Sharp dotNet SDK
* IP Geolocation API PHP SDK
* IP Geolocation API Typescript SDK
* IP Geolocation API Javascript SDK
* IP Geolocation API JQuery SDK
* Astronomy API Javascript SDK
```

--------------------------------

### IP Geolocation API Portfolio

Source: https://ipgeolocation.io/documentation.html/index

This section provides an overview of the different APIs offered by ipgeolocation.io, including their primary functions.

```APIDOC
## IP Geolocation API Portfolio

### Overview
ipgeolocation provides following APIs:

*   **IP Geolocation API**: Provides location information for any IPv4/IPv6 address or domain name.
*   **IP Security API**: Helps detect and block suspicious IP addresses by providing real-time threat intelligence, identifying proxies, VPNs, TOR nodes, bots, spam sources, or cloud provider IPs, along with a threat score.
*   **ASN API**: Provides detailed information about the Autonomous System Number (ASN) associated with an IP address, including IP ranges, network relationships, and owning organization.
*   **Abuse Contact API**: Provides the abuse contact information for any IPv4/IPv6 address to report abuse or security incidents.
*   **Timezone API**: Provides date, time, and timezone information from a timezone name, IP address, or location coordinates.
*   **User-Agent API**: Provides accurate browser, device, and operating system details from a device user agent string.
*   **Astronomy API**: Provides sun rise/set time, moon rise/set time, and the current position, angle, and distance of the Sun and the Moon for a given date.
```

--------------------------------

### Authorization Methods

Source: https://ipgeolocation.io/documentation.html/index

Details on how to authorize API requests using either an API Key or Request Origin (CORS).

```APIDOC
## Authorization

We provide two ways of authorization:

### 1. API Key

You can make authorized requests by passing your API key as a query parameter. Obtain your API key from the API console. It is strongly discouraged to use the API key in client-side JavaScript as it will expose your API key to the public.

### 2. Request Origin (CORS)

This feature is available for paid plans only. It allows you to call the API from client-side JavaScript without using your API key. Configure allowed request origins in the application console.
```

--------------------------------

### Rate Limits

Source: https://ipgeolocation.io/documentation.html/index

The Free plan has a hard limit of 500 requests per day. Paid plans do not have daily, hourly, or monthly rate limits, but exceeding monthly quotas may incur surcharges.

```APIDOC
## Rate Limits

- **Free Plan:** A hard limit of 500 requests per day.
- **Paid Plans:** No daily, hourly, or monthly rate limits are imposed. However, exceeding your monthly quota may result in a surcharge, the rate of which varies by plan. Please refer to our pricing page for details.
```

--------------------------------

### Database Documents

Source: https://ipgeolocation.io/documentation.html/index

ipgeolocation.io offers comprehensive, daily-updated databases for IP intelligence and geolocation. These databases can be integrated independently or with the API and come with SDKs for multiple languages.

```APIDOC
## Database Documents

We offer several comprehensive databases, updated daily, designed for applications requiring precise geolocation and IP intelligence. These databases can be integrated independently into applications or seamlessly with our API. SDKs for multiple programming languages are available to aid implementation. Detailed documentation can be found in our SDK documentation.
```

--------------------------------

### API Key Limits

Source: https://ipgeolocation.io/documentation.html/index

Information regarding the limits on the number of extra API keys and request origins based on the user's plan.

```APIDOC
## API Key Limits

The number of extra API keys and request origins is limited based on the user's plan.

| Plan Name                     | No. of Extra API Keys + Request Origins |
| ----------------------------- | ------------------------------------- |
| IPGeolocation Advanced API III | 2                                     |
| IPGeolocation Advanced API IV  | 2                                     |
| IPGeolocation Advanced API V   | 3                                     |

Additional API keys or request origins can be added at a cost of $2.5 per month per item.
```

--------------------------------

### Security / SSL

Source: https://ipgeolocation.io/documentation.html/index

All API endpoints are served over a secure HTTPS connection to ensure data security for all users, including those on the free plan.

```APIDOC
## Security / SSL

All of our API endpoints are served over a secure HTTPS connection. This applies to all users, including those on the free plan.
```
Tokens:
Raw