IP API

The IP API transforms an IP address into a full company profile.

Attributes

The dot notation indicates that the field is one level deep inside the object. If we can’t find data for an attribute, then we’ll set a null value.

Attribute Description
ip
string
IP address that was requested
type
string
The type of result (business, isp, hosting).
geo
string
A object containing location data for requested IP
geo.city
string
City that this IP is located in
geo.state
string
State that this IP is located in
geo.stateCode
string
State code for this IP’s state
geo.country
string
Country that this IP is located in
geo.countryCode
string
Country code for this IP’s country
geo.continent
string
Continent that this IP is located in
geo.continentCode
string
Continent code for this IP’s continent
geo.isEU
boolean
Whether this IP is located in the European Union (EU)
company
object
The company record associated with the IP. Refer to our Company API documentation for schema information.

Note: If the value is isp or hosting, no company data will be returned.

An example of the JSON response.


{
    "ip": "204.4.143.118",
    "type": "business",
    "geo": {
        "city": "Kensington",
        "state": "England",
        "stateCode": "ENG",
        "country": "United Kingdom",
        "countryCode": "GB",
        "continent": "Europe",
        "continentCode": "EU",
        "isEU": true
    },
    "company": {
        "geo": {
            "lat": null,
            "city": "New York",
            "state": "New York",
            "country": "United States of America",
            "stateCode": "NY",
            "postalCode": "10282",
            "streetName": "West Street",
            "subPremise": null,
            "countryCode": "US",
            "streetNumber": "200"
        },
        "url": "https://www.goldmansachs.com/",
        "logo": "http://logo.bigpicture.io/logo/goldmansachs.com",
        "name": "Goldman Sachs Group",
        "tags": [
            "Investment Banking",
            "Financial Services",
            "Asset Management",
            "Investment Management",
            "Enterprise",
            "B2B",
            "Finance",
            "Consulting & Professional Services",
            "Consumer Electronics",
            "Real Estate"
        ],

        ...
    }
}

Lookup

The IP API is designed to look up a company via their IP address.

Parameter Description
ip
string (required)
The ip to lookup. 

curl 'https://ip.bigpicture.io/v1/companies/ip?ip=167.220.2.238' \
  -H 'Authorization: {API_KEY}'

HTTP Request

When you make a request, the default behavior is to return a 200 status with the data.

Responses

Code Description
200 - OK A match has been found.
404 - Not Found We could not find a match.
500 - Server Error We encountered an error looking up the company.