API documentation

HTTPS/SSL

Our Company API is only available over secure HTTPS connection and all requests must include https:// to make them secure.

Versioning

OrgInfo handles inevitable changes in API with URI versioning, with the API version embedded in the URL path. Our APIs are prefixed with `/data/`.

The current version of our API is v1.

A new version of the API will be released when changes are backwards incompatible. We strongly recommend that you test the APIs well with the latest version when you upgrade.

Authentication

Your API key is used to authenticate you as a valid user and must be provided for all API calls using the key URL parameter. To get a valid API key, please sign up as a OrgInfo user and your key is displayed on your dashboard.

Query parameters

Apart from the API key, a single, valid IP address or website domain must be provided as an input parameter. IP address can be in IPv4 or IPv6 format

https://api.orginfo.io/data/v1/org/company?key=$KEY&ip=$IP_ADDRESS

or

https://api.orginfo.io/data/v1/org/company?key=$KEY&domain=$DOMAIN

Status codes

Status codes indicate whether a specific request has been successfully completed.

• 200: Success
• 400: Invalid IP address / domain
• 422: Bogon IP address

Response

A JSON response is provided, with the following fields:

• type: Type of organization. Available for IP address to company only. Possible values are:
  • business
  • education
  • hosting
  • isp
  • place
  • security
  • seo
• name: Name of the company
• website: Website of the company
• industry: Industry associated with the company
  (provided only for business/place types)
• naicsIndustry: Industry associated with the company as per North American Industry Classification System (NAICS)
  (provided only for business/place types)
• linkedinURL: URL of Linkedin page of the company
  (provided only for business/place types)
• employeeCount: Size of company in terms of employee count ranges. Possible values are:
  • 0-1 employees
  • 2-10 employees
  • 11-50 employees
  • 51-200 employees
  • 201-500 employees
  • 501-1000 employees
  • 1001-5000 employees
  • 5001-10000 employees
  • 10,001+ employees
• headquarterAddress: Address of company’s headquarter location (provided only for businesss/place types)
• headquarterCity: City where company’s headquarter is located (provided only for businesss/place types)
• headquarterRegion: Region/state/province where company’s headquarter is located (provided only for businesss/place types)
• headquarterCountry: Country where company’s headquarter is located (provided only for businesss/place types)

Usage count

Only APIs that return a response will be counted towards your free/monthly quota.

Rate/quota limit

If your API usage exceeds the free quota or monthly limits associated with your paid subscription, the API will return 429 HTTP status code.

Sample queries & responses

Query using IP address belonging to a business: https://api.orginfo.io/data/v1/org/company?key=XXXXXXXXXX&ip=199.66.9.12

Status code: 200
Response:

{
      type: “business”,
      name: "Tesla Inc.",
      website: "https://www.tesla.com",
      industry: “Automotive",
      linkedinURL:  “https://www.linkedin.com/company/tesla-motors",
      employeeCount: “10,001+ employees",
      headquarterAddress: "3500 Deer Creek Road, Palo Alto, CA 94304",
      headquarterCity: “Palo Alto",
      headquarterRegion: “California",
      headquarterCountry: “United States”,
      naicsIndustry: “5415:Computer Systems Design and Related Services“
}

Query using website domain: https://api.orginfo.io/data/v1/org/company?key=XXXXXXXXXX&domain=ibm.com

Status code: 200
Response:

{
      name: "IBM",
      website: "https://www.ibm.com",
      industry: "Information Technology and Services",
      linkedinURL: "https://www.linkedin.com/company/ibm",
      employeeCount: "10,001+ employees",
      headquarterAddress: "New Orchard Road, Armonk, New York, NY 10504",
      headquarterCity: "Armonk",
      headquarterRegion: "New York",
      headquarterCountry: "United States",
      naicsIndustry: “3361:Motor Vehicle Manufacturing“
}

Query using IP address belonging to an ISP: https://api.orginfo.io/data/v1/org/company?key=XXXXXXXXXX&ip=64.137.157.0

Status code: 200
Response:

{
      type: "isp",
      name: "Beanfield Metroconnect"
}

Query with IP address / domain not in our database: https://api.orginfo.io/data/v1/org/company?key=XXXXXXXXXX&ip=180.210.91.23

Status code: 200
Response:

{
  status: "error",
  error: {
    message: "Data not found",
  }
}

Query with bogon IP address: https://api.orginfo.io/data/v1/org/company?key=XXXXXXXXXX&ip=10.109.0.23

Status code: 422
Response:

{
  status: "error",
  error: {
    message: "Bogon IP address",
  }
}

Query with invalid IP address: https://api.orginfo.io/data/v1/org/company?key=XXXXXXXXXX&ip=88:223:23

Status code: 400
Response:

{
  status: "error",
  error: {
    title: "Wrong ip",
    message: "Please provide a valid IP address"
  }
}