LogoLogo
  • Welcome
  • Web Services Documentation
    • Overview
    • Rate Limiting
    • Request method and parameters
    • Response Format
    • Query result status code
  • Database Documentation
    • Getting Started
    • Database Type
      • Free IP to Country
      • Free IP to ASN
      • Free IP to Country+IP to ASN
      • IP Geolocation Database
      • IP Risk Database
      • ASN Database
      • Usage Type Database
      • Mobile Carrier Database
      • Hosted Domains Database
    • Offline library parsing code
      • IPv4
        • DAT format access code
      • IPv6
        • DAT format access code
Powered by GitBook
On this page
  1. Web Services Documentation

Response Format

The REST API returns the following fields and values.

Name
Type
Description

code

String

Query result status code

message

String

If the request is successful, the content is success

data

JsonObject

The returned data field. If the request fails, please refer to the status code.

data Response

Name
Description

country

Country name.

country_code

Two-character country code based on ISO 3166.

region

Region or state name.

city

City name.

latitude

City latitude. Defaults to capital city latitude if city is unknown.

longitude

City longitude. Defaults to capital city longitude if city is unknown.

isp

Internet Service Provider or company's name.

time_zone

Current region's time zone.

area_code

A varying length number assigned to geographic areas for calls between cities.

postal

ZIP/Postal code.

weather_station_code

The special code to identify the nearest weather observation station.

elevation

Average height of city above sea level in meters (m).

currency

Currency of the country.

eu_member

Whether it belongs to the European Union.

country_capital

The name of the current country's capital.

radius

The current query positioning radius.

is_proxy

Whether it is a proxy IP.

risk_label

Possible risky behavior labels.

risk_score

The security score of the IP address, the higher the score, the more dangerous it is.

risk_level

The risk level is defined based on the risk score.

ip_usage_type

IP address usage types, including: Data center(IDC) Home broadband (ISP) Commercial(GTW) Government(GOV) Education(EDU) Content distribution(CDN) Mobile network(MOB) Reserved(BOGON)

asn

Autonomous system number (ASN).

asn_domain

The domain name associated with the Autonomous System Number (ASN).

asn_organization

Autonomous System Number (ASN) Owner.

asn_type

Autonomous System Number (ASN) usage types: Home broadband (ISP) Hosting(IDC) Education(EDU) Government(GOV) Commercial(GTW)

asn_country

Autonomous System Number (ASN) Country.

carrier_mcc

Mobile Country Codes (MCC) as defined in ITU E.212 for use in identifying mobile stations in wireless telephone networks, particularly GSM and UMTS networks.

carrier_mnc

Mobile Network Code (MNC) is used in combination with a Mobile Country Code (MCC) to uniquely identify a mobile phone operator or carrier.

carrier_name

The name of the mobile operator.

domains_total

The number of domain names associated with the IP.

domains_name

The domain name associated with the IP.

Code example
{
    "code": 200,
    "data": {
        "ip_info": {
            "ip": "63.105.0.0",
            "version": "V4",
            "country_code": "US",
            "country": "United States",
            "region": "New York",
            "city": "New York City",
            "isp": "Verizon Business",
            "longitude": "-74.005970",
            "latitude": "40.714270",
            "time_zone": "America/New_York",
            "area_code": "+1",
            "postal": "10001",
            "weather_station_code": "usw00094728",
            "elevation": "﹢10",
            "currency": "US",
            "eu_member": "true",
            "country_capital": "Washington, D.C",
            "radius": "7",
            "asn": "AS701",
            "asn_domain": "verizon.com",
            "asn_organization": "Verizon Business",
            "asn_type": "DYN",
            "asn_country": "US",
            "risk_level": "low",
            "is_proxy": "false",
            "risk_score": "0",
            "risk_label": "-",
            "ip_usage_type": "Fixed Line ISP",
            "carrier_mcc": "310",
            "carrier_mnc": "004",
            "carrier_name": "Verizon Business",
            "domains_total": "",
            "domains_name": ""
        },
        "search_count": 0
    },
    "msg": "success"
}

PreviousRequest method and parametersNextQuery result status code

Last updated 23 days ago