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
type
string
The type of result (business, isp, hosting).
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.


{
  "type": "business",
  "company": {
    "name": "Wal-Mart Stores",
    "legalName": "Wal-Mart Stores, Inc.",
    "domain": "walmart.com",
    "tags": [
      "Retail",
      "Consumer Electronics",
      "Apparel & Footwear",
      "Jewelry, Watches & Luxury Goods",
      "Toys",
      "Pets",
      "Supermarkets",
      "E-commerce",
      "B2C",
      "Pharmacy",
      "Health Care"
    ],
    "category": {
      "sector": "Consumer Services",
      "industryGroup": "Retail",
      "industry": "General Retailers",
      "subIndustry": "Broadline Retailers"
    },
    ...

  }
}

    

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.