Reference Guide

Reference Guide#

Introduction #

The Global IP Cloud API takes in an IP address and returns its location, a powerful background process that utilizes 20+ unique dynamic techniques to accurately geolocate over 99% of global IPv4 addresses, while also identifying TOR endpoints and proxies.

Base URL #

https://globalip.melissadata.net

New to Melissa Cloud Services?#

We highly recommend first time users of our web services to review our Using Melissa Cloud APIs section. It will cover critical topics like:

Endpoints #

/V4/WEB/IPLocation/doIPLocation #

Introduction #

Use this endpoint to validate IP numbers

Try It Now #

GET JSON
POST JSON

curl -X GET "https://globalip.melissadata.net/v4/WEB/iplocation/doiplocation?\
&t=\
&id={{customerId}}\
&ip="216.231.3.166"\
&format=JSON" \
-H "Content-Type:application/json" \
-H "Accept:application/json"

curl -X POST "https://globalip.melissadata.net/v4/web/iplocation/doiplocation" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
    "CustomerID":{{customerId}},
    "TransmissionReference":"",
    "Columns":"",
    "Records":
       [
          {
             "RecordID":"1",
             "IPAddress":"216.231.3.166"
          },
          {
             "RecordID":"2",
             "IPAddress":"10.10.10.1"
          }
       ]
    }'

Request Parameters #

GET JSON
POST JSON

Code	Description
`cols`	Optional. Specify what domain information to return.
`id`	Required. The License Key issued by Melissa.
`ip`	Required. The IP Address to verify.
`t`	Optional. Value passed through unchanged to the response for identification or any other purpose.

Code	Description
`Columns`	Optional. Specify what domain information to return.
`CustomerID`	Required. The License Key issued by Melissa.
`IPAddress`	Required. The IP Address to verify.
`RecordID`	Optional. A unique identifier for the current record. Use this to match the record submitted with the record returned.
`TransmissionReference`	Optional. Value passed through unchanged to the response for identification or any other purpose.

Headers #

GET JSON
POST JSON

 Content-Type: application/json
 Accept: application/json

 Content-Type: application/json
 Accept: application/json

Response #

GET JSON
POST JSON

{
    "Version": "6.2.0.1122",
    "TransmissionReference": "IP Locator Test",
    "TransmissionResults": "",
    "Records": [
        {
            "City": "Rancho Santa Margarita",
            "ConnectionSpeed": "broadband",
            "ConnectionType": "wifi",
            "Continent": "North America",
            "CountryAbbreviation": "US",
            "CountryName": "United States",
            "DomainAddress1":"DomainsByProxy.com2155 E Warner Rd",
            "DomainAdministrativeArea": "Arizona",
            "DomainAgeEstimated": "8172",
            "DomainAvailability": "UNAVAILABLE",
            "DomainCountry": "UNITED STATES",
            "DomainCountryCode": "US",
            "DomainCreatedDate": "2000-10-16T20:48:37",
            "DomainEmail": " ",
            "DomainExpirationDate": "2023-10-16T20:48:36",
            "DomainLocality": "Tempe",
            "DomainName": "melissadata.com",
            "DomainOrganization": "Domains By Proxy, LLC",
            "DomainPostalCode": "85284",
            "DomainPrivateProxy": "1",
            "DomainUpdatedDate": "2022-10-17T07:46:22",
            "DST": "Y",
            "IPAddress": "12.203.219.6",
            "ISPName": "Att Services Inc.",
            "Latitude": "33.650000",
            "Longitude": "-117.590000",
            "PostalCode": "92688",
            "ProxyDescription": "att",
            "ProxyType": " ",
            "RecordID": "1",
            "Region": "California",
            "Result": "IS01",
            "TimeZoneCode": "PST",
            "TimeZoneName": "Pacific Standard Time",
            "UTC": "-08:00"
        }
    ]
}

{
    "Version": "6.2.0.1122",
    "TransmissionReference": "",
    "TransmissionResults": "",
    "Records": [
        {
            "City": "Newport Beach",
            "ConnectionSpeed": "cable",
            "ConnectionType": "wifi",
            "Continent": "North America",
            "CountryAbbreviation": "US",
            "CountryName": "United States",
            "DomainName": "melissadata.com",
            "DST": "Y",
            "IPAddress": "216.231.3.166",
            "ISPName": "Cox Communications Inc.",
            "Latitude": "33.630000",
            "Longitude": "-117.870000",
            "PostalCode": "92660",
            "ProxyDescription": "cox communications",
            "ProxyType": " ",
            "RecordID": "1",
            "Region": "California",
            "Result": "IS01",
            "TimeZoneCode": "PST",
            "TimeZoneName": "Pacific Standard Time",
            "UTC": "-08:00"
        },
        {
            "City": "Private",
            "ConnectionSpeed": "broadband",
            "ConnectionType": "wired",
            "Continent": " ",
            "CountryAbbreviation": " ",
            "CountryName": "Reserved/Private",
            "DomainName": "?",
            "DST": "N",
            "IPAddress": "10.10.10.1",
            "ISPName": " ",
            "Latitude": "0.000000",
            "Longitude": "0.000000",
            "PostalCode": "0",
            "ProxyDescription": "internet assigned numbers",
            "ProxyType": " ",
            "RecordID": "2",
            "Region": "Reserved/Private",
            "Result": "IS01",
            "TimeZoneCode": " ",
            "TimeZoneName": " ",
            "UTC": " "
        }
    ]
}

Service Level Response Fields #

Output Name	Description
Version	The current service version number.
TransmissionReference	Optional. Serves as a unique request identifier.
TransmissionResults	Lists error codes from any errors caused by the most recent request as a whole.

Record Level Response Fields #

Output Name	Description
Results	Comma delimited status, error codes, and change codes for the record.
City	The city where the IP address is located.
ConnectionSpeed	The connection speed associated with this IP address.
ConnectionType	The type of connection used by this IP address.
Continent	The continent where the IP address is located.
CountryAbbreviation	The alpha-2 country code of the country where the IP address is located.
CountryName	The full name of the country where the IP address is located.
DomainAddress1	The Physical Address associated with the domain.
DomainAdministrativeArea	The State or most common geographic data element associated with the domain.
DomainAgeEstimated	How long the domain has existed since it’s creation.
DomainAvailability	Status whether domain is available or unavailable.
DomainCountry	The full name of the country associated with the domain.
DomainCountryCode	The two character code for the country associated with the domain.
DomainCreatedDate	The Created Date of the domain.
DomainEmail	The email associated with the domain.
DomainExpirationDate	The expiration date of the domain.
DomainLocality	The City or most common population center associated with the domain.
DomainName	The domain name associated with the IP address.
DomainOrganization	The Organization associated with the domain.
DomainPostalCode	The Postal Code associated with the domain.
DomainPrivateProxy	The Private Proxy associated with the domain.
DomainUpdateDate	The last time the domain was updated.
DST	Daylight Savings Time
IPAddress	The IP Address being looked up
ISPName	The name of the Internet Service Provider.
Latitude	The latitude for the IP address.
Longitude	The longitude for the IP address.
PostalCode	The postal code where the IP address is located.
ProxyDescription	Additional Details for the Proxy Type returned.
ProxyType	The type of proxy for an IP Address
RecordID	ID of each input record
Region	The region where the IP address is located
Result	A comma delimited string that provides more information from the service.
TimeZoneCode	The time zone code where the IP address is located.
TimeZoneName	The time zone name where the IP address is located.
UTC	The GMT offset for the area where the IP address is located.

Result Codes #

Melissa Data’s products use a result code system to indicate data quality; the status and any errors. These result codes are four-character codes (two letters followed by two numbers), delimited by commas. Result code definitions are shared among Melissa Data products.

Understanding the Code #

To fully understand result codes, you need to know them. Knowing what codes are possible and what they indicate will be key in building an effective application. It is useful to know all the codes, but this does not necessarily mean you will use them all. Just because you have a toolbox, doesn’t mean you will also try to use a screwdriver along with a hammer on a nail.

Interpreting Results #

It is important to understand these result codes in order for you to make a determination of good vs bad data and how you would want to use it.

Code	Description	Recommendation
`IS01`	The IP Address was found in the database.	Good
`IS02`	The IP Address was not found.	Bad
`IS03`	The IP Address is a proxy.	Good
`IS04`	The IP Address entered is in the IPv6 Format.	Good
`IE##`	Results that begin with IE are an indication of an IP error.	Bad
`IC##`	Results that begin with IC are changes to the input IP.	Medium

Common Transmission Errors #

The SE## and GE## codes (Transmission Service Error and General Transmission Error) are used to signify more general errors, and are returned under the key TransmissionResults in the outermost level of our responses.

Record Level Result Codes #

Please visit Result Codes - Global IP for the full list of result codes returned by Global IP.

Reference Guide

Contents

Reference Guide#