Legacy Leadfeeder IP-Enrich API v1
Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
Welcome to the legacy Leadfeeder IP-Enrich API documentation, which allows you to uncover company information associated with an IPv4 or IPv6 address.
For new integrations, we recommend using the new Leadfeeder API, which provides a more unified and flexible way to work with Leadfeeder data.
The new API offers:
- A unified platform API
Access platform capabilities through a single, consistent interface - Richer company and contact data
Access a broader set of company and contact data points through the new API, including detailed company records, financials, signals, tags, lists, CRM-related relationships, and richer contact details through a unified interface - Improved structure and more comprehensive documentation
Designed to make implementation, scaling, and maintenance easier for developers
For more details on the transition from the legacy API, refer to our Help Center
Still using this API?
This documentation is available for maintaining existing integrations only.
The base URL for this API you should use https://api.lf-discover.com
Authentication
The legacy IP Enrich API uses an API key for authentication. All requests must include X-API-KEY parameter and key in the header.
X-API-KEY: yourapikey
Don't forget to replace yourapikey with your API key.
Using an existing API key
If you already have an API key from a previous integration, you can continue using it to authenticate your requests.
⚠️ New API keys are not issued for the legacy IP Enrich API. For new integrations, please use the new Leadfeeder API documentation.
Companies
get__companies
Code samples
# You can also use wget
curl -X GET /companies?ip=string \
-H 'Accept: application/json' \
-H 'X-API-KEY: API_KEY'
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'X-API-KEY' => 'API_KEY'
}
result = RestClient.get '/companies',
params: {
'ip' => 'string'
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'X-API-KEY': 'API_KEY'
}
r = requests.get('/companies', params={
'ip': 'string'
}, headers = headers)
print(r.json())
const headers = {
'Accept':'application/json',
'X-API-KEY':'API_KEY'
};
fetch('/companies?ip=string',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET /companies
Returns company information based on the IP parameter.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| ip | query | string | true | A valid IPv4 or IPv6 address, e.g. 185.70.216.139 or 2620:0:862:ed1a::1. |
Detailed descriptions
ip: A valid IPv4 or IPv6 address, e.g. 185.70.216.139 or 2620:0:862:ed1a::1.
The IP parameter in the URL should not be quoted (surrounded by " or '). For IPv6, shortened notation is supported, but literal addresses as a part of URI are not. I.e. 2620:0:862:ed1a::1 will succeed, but [2620:0:862:ed1a::1] will return an error response with HTTP status code 400.
Example responses
200 Response
{
"id": "beb6f4e2-52c1-11e8-9800-2f635e37af1b",
"ip_address": "185.70.216.139",
"company": {
"revenue": {
"year": "2018",
"amount": "2588745.28"
},
"business_ids": [
{
"country_code": "FI",
"key": "business_id",
"value": "2457101-9"
}
],
"social": {
"twitter": "https://twitter.com/leadfeederapp",
"facebook": "https://facebook.com/Leadfeeder",
"linkedin": "https://linkedin.com/company/3833060"
},
"domain": "leadfeeder.com",
"logo_url": "https://logos.leadfeeder.com/200/beb6f4e2-52c1-11e8-9800-2f635e37af1b-2019-03-18-104839.png",
"industries": {
"name": "Internet",
"sic": [
"7374"
],
"naics": [
"string"
]
},
"name": "Leadfeeder",
"employees_range": {
"min": "51",
"max": "200"
}
},
"location": {
"city": "Písek",
"region": "Jihocesky Kraj",
"country_code": "CZ"
},
"confidence_score": "very high"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | Company |
| 400 | Bad Request | The request contains wrong or incorrectly formatted arguments. | Error |
| 401 | Unauthorized | The incoming request could not be authenticated. | Error |
| 403 | Forbidden | The client whose API key is used does not have the required privileges to perform the request, or the key is no longer valid. | Error |
| 404 | Not Found | The company information tied to this IP address was not found. | Error |
| 429 | Too Many Requests | The limit of the number of requests per minute has been exceeded, or the quota associated with the given API key has been exhausted. | Error |
| 500 | Internal Server Error | There was an error processing the request. | Error |
| 502 | Bad Gateway | Bad gateway error. There was a problem connecting to the backend.. | Error |
| 504 | Gateway Time-out | Gateway timeout error. The backend did not respond within the time out limit. | Error |
Schemas
Company
{
"id": "beb6f4e2-52c1-11e8-9800-2f635e37af1b",
"ip_address": "185.70.216.139",
"company": {
"revenue": {
"year": "2018",
"amount": "2588745.28"
},
"business_ids": [
{
"country_code": "FI",
"key": "business_id",
"value": "2457101-9"
}
],
"social": {
"twitter": "https://twitter.com/leadfeederapp",
"facebook": "https://facebook.com/Leadfeeder",
"linkedin": "https://linkedin.com/company/3833060"
},
"domain": "leadfeeder.com",
"logo_url": "https://logos.leadfeeder.com/200/beb6f4e2-52c1-11e8-9800-2f635e37af1b-2019-03-18-104839.png",
"industries": {
"name": "Internet",
"sic": [
"7374"
],
"naics": [
"string"
]
},
"name": "Leadfeeder",
"employees_range": {
"min": "51",
"max": "200"
}
},
"location": {
"city": "Písek",
"region": "Jihocesky Kraj",
"country_code": "CZ"
},
"confidence_score": "very high"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string | false | none | none |
| ip_address | string | false | none | none |
| company | object | false | none | Company profile information. |
| » revenue | object | false | none | Latest available company revenue information. |
| »» year | string¦null | false | none | Year when the revenue was reported. |
| »» amount | string¦null | false | none | Amount in USD. |
| » business_ids | [object] | false | none | Company business IDs. Can have multiple entries If the company is registered in more countries. |
| »» country_code | string | false | none | An ISO 3166-1 alpha-2 country code. |
| »» key | string | false | none | A short, country-specific business ID identifier. |
| »» value | string | false | none | A business ID in the company registry in the specified country. |
| » social | object | false | none | Company's social media URLs. |
| string¦null | false | none | none | |
| string¦null | false | none | none | |
| string¦null | false | none | none | |
| » domain | string | false | none | none |
| » logo_url | string | false | none | none |
| » industries | object | false | none | none |
| »» name | string¦null | false | none | Industry name. A complete list is available in the reference table. |
| »» sic | [string] | false | none | SIC industry codes. The list of valid codes is available here. |
| »» naics | [string] | false | none | NAICS industry classification codes. The list of valid codes is available here. |
| » name | string | false | none | none |
| » employees_range | object | false | none | Latest available employee count information. Valid ranges: * null - null* 1 - 1* 2 - 10* 11 - 50* 51 - 200* 201 - 500* 501 - 1000* 1001 - 5001* 5001 - 10000* 10001 - nullA min value of 10_001, and max value being null means that the company has more than 10001 employees. Both min and max equal to null signify there is currently no available employee count information. |
| »» min | string¦null | false | none | none |
| »» max | string¦null | false | none | none |
| location | object | false | none | Geographic location of the IP address. |
| » city | string | false | none | none |
| » region | string | false | none | none |
| » country_code | string | false | none | A two-letter country code, possible values are ISO 3166-1 alpha-2 codes. |
| confidence_score | string | false | none | Represents the confidence level in associating an IP address with a specific company. Very High: Indicates highly reliable data based on recent, consistent traffic observations using multiple sources that strongly link the IP address to the specified company. In addition public IP address records verified by our data quality processes. High: Indicates reliable identification over a sustained period, with a low margin of error (less than a few percent). Medium: Represents IP address connections where the ownership of the IP address has been changing more frequently or where there is a chance of multiple companies sharing the same IP address. Low: Connections with a higher margin of error due to lack of most recent data points. Public data that has not been fully verified through Dealfront's data quality processes also receives a low score. |
Enumerated Values
| Property | Value |
|---|---|
| confidence_score | very high |
| confidence_score | high |
| confidence_score | medium |
| confidence_score | low |
Error
{
"message": "Unauthorized."
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| message | string | false | none | A human-readable error description. |
API Versioning
As the API is being rapidly developed, there are no versioning or backwards-compatibility guarantees right now, although we try to avoid introducing breaking changes unless absolutely necessary.
We will notify our clients about upcoming changes in a timely manner and also publish a list of significant changes and new development in the changelog.
Changelog
- 2021/02/07 - Initial release.
Industry names reference
This is a list of industry names, as returned by the API.
| Name |
|---|
| Accounting |
| Airlines/Aviation |
| Alternative Dispute Resolution |
| Alternative Medicine |
| Animation |
| Apparel & Fashion |
| Architecture & Planning |
| Arts and Crafts |
| Automotive |
| Aviation & Aerospace |
| Banking |
| Biotechnology |
| Broadcast Media |
| Building Materials |
| Business Supplies and Equipment |
| Capital Markets |
| Chemicals |
| Civic & Social Organization |
| Civil Engineering |
| Commercial Real Estate |
| Computer & Network Security |
| Computer Games |
| Computer Hardware |
| Computer Networking |
| Computer Software |
| Construction |
| Consumer Electronics |
| Consumer Goods |
| Consumer Services |
| Cosmetics |
| Dairy |
| Defense & Space |
| Design |
| Education Management |
| E-Learning |
| Electrical/Electronic Manufacturing |
| Entertainment |
| Environmental Services |
| Events Services |
| Executive Office |
| Facilities Services |
| Farming |
| Financial Services |
| Fine Art |
| Fishery |
| Food & Beverages |
| Food Production |
| Fund-Raising |
| Furniture |
| Gambling & Casinos |
| Glass, Ceramics & Concrete |
| Government Administration |
| Government Relations |
| Graphic Design |
| Health, Wellness and Fitness |
| Higher Education |
| Hospital & Health Care |
| Hospitality |
| Human Resources |
| Import and Export |
| Individual & Family Services |
| Industrial Automation |
| Information Services |
| Information Technology and Services |
| Insurance |
| International Affairs |
| International Trade and Development |
| Internet |
| Investment Banking |
| Investment Management |
| Judiciary |
| Law Enforcement |
| Law Practice |
| Legal Services |
| Legislative Office |
| Leisure, Travel & Tourism |
| Libraries |
| Logistics and Supply Chain |
| Luxury Goods & Jewelry |
| Machinery |
| Management Consulting |
| Maritime |
| Market Research |
| Marketing and Advertising |
| Mechanical or Industrial Engineering |
| Media Production |
| Medical Devices |
| Medical Practice |
| Mental Health Care |
| Military |
| Mining & Metals |
| Motion Pictures and Film |
| Museums and Institutions |
| Music |
| Nanotechnology |
| Newspapers |
| Non-Profit Organization Management |
| Oil & Energy |
| Online Media |
| Outsourcing/Offshoring |
| Package/Freight Delivery |
| Packaging and Containers |
| Paper & Forest Products |
| Performing Arts |
| Pharmaceuticals |
| Philanthropy |
| Photography |
| Plastics |
| Political Organization |
| Primary/Secondary Education |
| Printing |
| Professional Training & Coaching |
| Program Development |
| Public Policy |
| Public Relations and Communications |
| Public Safety |
| Publishing |
| Railroad Manufacture |
| Ranching |
| Real Estate |
| Recreational Facilities and Services |
| Religious Institutions |
| Renewables & Environment |
| Research |
| Restaurants |
| Retail |
| Security and Investigations |
| Semiconductors |
| Shipbuilding |
| Sporting Goods |
| Sports |
| Staffing and Recruiting |
| Supermarkets |
| Telecommunications |
| Textiles |
| Think Tanks |
| Tobacco |
| Translation and Localization |
| Transportation/Trucking/Railroad |
| Utilities |
| Venture Capital & Private Equity |
| Veterinary |
| Warehousing |
| Wholesale |
| Wine and Spirits |
| Wireless |
| Writing and Editing |