---
title: "Returns com.precisely.geolocation for an IP address"
method: GET
path: "/v1/geolocation/ip-address"
tags: ["Geolocation"]
---

# Returns com.precisely.geolocation for an IP address

`GET /v1/geolocation/ip-address`

## Request

- Base URL: `https://api.cloud.precisely.com`
- URL: `https://api.cloud.precisely.com/v1/geolocation/ip-address`
- Auth: one of:
  - HTTP bearer
  - API key in header `Authorization`

The Geolocation Ip Address end point provides the com.precisely.geolocation details.

## Query parameters

- `ipAddress` string, required

## Headers

- `X-Request-Id` string

## Response `200`

IP address com.precisely.geolocation fetched successfully

- GeolocationIPApiResponse: Response object containing the status and result of the IP-based com.precisely.geolocation
  - `response` GeolocationIPResponse: The response object containing the status and the IP-based com.precisely.geolocation result
    - `status` 'OK' | 'ZERO_RESULTS', required: Represents the status of a response
    - `result` IpLocationResponseResult: The result object containing IP-based com.precisely.geolocation details and IP information
      - `geometry` Geometry: Geometric information containing accuracy and coordinates data
        - `accuracy` Accuracy: Represents the accuracy of the location data in terms of units and value.
          - `unit` string, required: The unit of measurement for the accuracy, typically in 'meters'.
          - `value` string, required: The value of the accuracy, representing the radius within which the location is accurate.
        - `coordinates` number[]: List of latitude and longitude coordinates
      - `ipInfo` IpInfoResult: IP Information containing details about the IP address, proxy, network, and location.
        - `coordinateFormat` string: Format of the geographic coordinates (e.g., Decimal, DMS)
        - `ipAddress` string: The IP address being analyzed
        - `ipType` string: The type of IP address (e.g., Public, Mapped)
        - `anonymizerStatus` string: Anonymizer status for the IP address (e.g., active, inactive)
        - `proxy` ProxyResult: Details of the proxy server associated with the IP address
          - `description` string: Description of the proxy server's function or nature (e.g., hosting-cloud, anonymizer)
          - `lastDetected` string: The last detected date and time the proxy was observed in action (ISO 8601 format)
          - `level` string: The level of the proxy server (e.g., elite, transparent)
          - `name` string: The name of the proxy server or service provider
          - `provider` string: The organization or company providing the proxy service
          - `type` string: The type of proxy service (e.g., service, residential, corporate)
        - `network` Network: Details about the network associated with the IP address
          - `organization` string: The name of the organization owning or managing the IP address
          - `organizationData` OrganizationData: Additional data about the organization associated with the IP address
            - `home` string: Indicates whether the organization is a home-based entity
            - `organizationType` string: Type of organization, such as 'commercial', 'non-profit', or 'unknown'
            - `naicsCode` string: North American Industry Classification System (NAICS) code representing the industry of the organization
            - `isicCode` string: International Standard Industrial Classification (ISIC) code representing the industry of the organization
          - `carrier` string: The carrier or service provider associated with the IP address
          - `asn` integer: Autonomous System Number (ASN) associated with the IP address
          - `connectionType` string: Type of network connection (e.g., broadband, mobile)
          - `lineSpeed` string: Line speed classification (e.g., high, medium, low)
          - `ipRouteType` string: Type of IP routing (e.g., domestic, international proxy)
          - `hostingFacility` string: Indicates if the IP address is associated with a hosting facility
          - `domainName` string: The domain name associated with the IP address
        - `location` LocationResult: Location information for the com.precisely.geolocation IP response
          - `city` CityResult: Detailed information about the city associated with the IP address
            - `areaCode` string: The area code of the city
            - `name` string: The name of the city
            - `confidence` integer: Confidence score indicating the accuracy of the city information
            - `postalCode` string: Postal code for the city
            - `postalCodeConfidence` integer: Confidence score indicating the accuracy of the postal code
            - `timeZone` number, double: Time zone offset from UTC in hours
          - `consistencyCode` integer: Code indicating consistency of the location data
          - `continent` string: The continent where the IP address is located
          - `country` CountryResult: Details about the country associated with the IP address
            - `name` string: The full name of the country
            - `confidence` integer: Confidence score indicating the accuracy of the country information
            - `code` string: Two-letter country code according to ISO 3166-1 alpha-2
            - `region` string: Region within the country
          - `dma` integer: Designated Market Area (DMA) code
          - `msa` integer: Metropolitan Statistical Area (MSA) code
          - `state` StateResult: Details about the state or region within a country associated with the IP address
            - `county` string: The county within the state or region
            - `name` string: The full name of the state or region
            - `confidence` integer: Confidence score indicating the accuracy of the state or region information
            - `code` string: The two-letter state code, if applicable

## Other responses

- `400`: Invalid request
- `401`: Unauthorized: Invalid token
- `403`: Forbidden
- `429`: Too many requests
- `500`: Internal server error
- `503`: Service unavailable

---

[API](https://skmtc.dev/precisely/apis/third-party-api-service.md) · [All operations](https://skmtc.dev/precisely/apis/third-party-api-service/llms.txt) · [OpenAPI document](https://skmtc.dev/precisely/apis/third-party-api-service/revisions/cf792ff5cabd?raw)
