Skip to main content

Company URL finder

Find the page URL of a company from its name or website. Costs 1 credit per URL found. Pair it with the company scraper to get its full data.

Unlike email searches, the single endpoint answers directly with the result. The bulk endpoint takes up to 50 items per call. See the rate limits.

Find one company URL​

POSThttps://app.icypeas.com/api/url-search/company
Headers
  • Authorizationstringrequired

    Your API key, as is (no Bearer prefix).

  • Content-Typestringrequired

    Always application/json.

Body parameters
  • companyOrDomainstringrequired

    It should contain either the company name or its domain name (or website)

Request example
curl -X POST "https://app.icypeas.com/api/url-search/company" \
-H "Content-Type: application/json" \
-H "Authorization: YOUR_API_KEY" \
-d '{
"companyOrDomain": "nec technologies"
}'
Responses
200SuccessResponse when the company URL is found
Example response · 200
{
"success": true,
"searchId": "#YOUR_SEARCH_ID#",
"status": "FOUND",
"result": "https://www.linkedin.com/company/my-company"
}
Response fields
  • successboolean

    true means that your search succeeded (no error was raised on our side)

  • searchIdstring

    The id of the search item (if you need to fetch the result later using the dedicated route)

  • statusstring

    FOUND because the company has been found

  • resultstring

    The company URL

200SuccessResponse when the company URL is not found
Example response · 200
{
"success": true,
"searchId": "#YOUR_SEARCH_ID#",
"status": "NOT_FOUND",
"result": ""
}
Response fields
  • successboolean

    true means that your search succeeded (no error was raised on our side)

  • searchIdstring

    The id of the search item (if you need to fetch the result later using the dedicated route)

  • statusstring

    NOT_FOUND because the company was not found

  • resultstring

    The field is an empty string

200Validation errorResponse when there are validation errors.

The request reached Icypeas but some fields are wrong. The response lists every problem in validationErrors. See how to read and fix errors.

Example response · 200
{
"validationErrors": [
{
"field": "companyOrDomain",
"message": "validation_string_empty",
"humanReadableMessage": "The string is empty",
"actual": ""
}
],
"success": false
}
TypeFieldsWhen it happens
stringEmpty
validation_string_empty
companyOrDomainError sent when the parameter is missing
required
validation_required
companyOrDomainError sent when the parameter is null or undefined
InsufficientCredits
insufficient_credits
You need more credits than the ones you have to run this search.
UnpaidSubscriptionError
unpaid_subscription_error
Error sent when you have a pending payment and your subscription is therefore not paid
401UnauthorizedResponse when we could not authenticate you.
Example response · 401
{
"message": "Unauthorized access.",
"error": "UnauthorizedAccessError",
"status": 401,
"code": "unauthorized_access_error"
}
Response fields
  • messagestring

    Human-readable message.

  • errorstring

    Error name

  • statusnumber

    HTTP error code

  • codestring

    Error code

429Too many requestsError received when rate limit is exceeded
Example response · 429
{
"message": "You have exceeded the max number of requests per minute.",
"error": "RateLimitExceededError",
"status": 429,
"code": "rate_limit_exceeded_error"
}
Response fields
  • messagestring

    Human-readable message.

  • errorstring

    Error name

  • statusnumber

    HTTP error code

  • codestring

    Error code

Find up to 50 company URLs​

POSThttps://app.icypeas.com/api/url-search
Headers
  • Authorizationstringrequired

    Your API key, as is (no Bearer prefix).

  • Content-Typestringrequired

    Always application/json.

Body parameters
  • typestringrequired

    The type of data

    Rule: should always be 'company'

  • dataarray of objectsrequired

    An array containing the companies' information. Max number of companies per request is 50

    Show item properties (1)
    • companyOrDomainstringrequired

      It should contains either the company name or its domain name (or website)

Request example
curl -X POST "https://app.icypeas.com/api/url-search" \
-H "Content-Type: application/json" \
-H "Authorization: YOUR_API_KEY" \
-d '{
"type": "company",
"data": [
{
"companyOrDomain": "nec technologies"
},
{
"companyOrDomain": "icypessaezeaze"
}
]
}'
Responses
200SuccessResponse when your input does not contain any validation errors
Example response · 200
{
"success": true,
"data": [
{
"searchId": "#YOUR_SEARCH_ID_1#",
"status": "FOUND",
"result": "https://www.linkedin.com/in/nec-technologies"
},
{
"searchId": "#YOUR_SEARCH_ID_2#",
"status": "NOT_FOUND",
"result": ""
}
]
}
Response fields
  • successboolean

    true means that your search succeeded (no error was raised on our side)

  • dataarray of objects
    Show item properties (3)
    • searchIdstring

      The id of each search item (if you need to fetch the result later using the dedicated route)

    • statusstring

      FOUND when the company was found & NOT_FOUND when not

    • resultstring

      The company URL or an empty string is the company page is not found

200Validation errorResponse when there are validation errors.

The request reached Icypeas but some fields are wrong. The response lists every problem in validationErrors. See how to read and fix errors.

Example response · 200
{
"validationErrors": [
{
"field": "url",
"message": "wrong_linkedin_url",
"humanReadableMessage": "All URLs in the data array should be a profile URL. Please check URLs at indices: 1",
"type": "WrongLinkedinUrl",
"expected": null,
"actual": [
"https://www.linkedin.com/company/nec-technologies",
"https://www.linkedin.com/xx/apple/"
]
}
],
"success": false
}
TypeFieldsWhen it happens
stringEmpty
validation_string_empty
urlError sent when the parameter is missing
url
validation_url
urlError sent when the parameter is not a valid URL
WrongLinkedinUrl
wrong_linkedin_url
urlThe URL should be a company URL.
InsufficientCredits
insufficient_credits
You need more credits than the ones you have to run this search.
UnpaidSubscriptionError
unpaid_subscription_error
Error sent when you have a pending payment and your subscription is therefore not paid
401UnauthorizedResponse when we could not authenticate you.
Example response · 401
{
"message": "Unauthorized access.",
"error": "UnauthorizedAccessError",
"status": 401,
"code": "unauthorized_access_error"
}
Response fields
  • messagestring

    Human-readable message.

  • errorstring

    Error name

  • statusnumber

    HTTP error code

  • codestring

    Error code

429Too many requestsError received when rate limit is exceeded
Example response · 429
{
"message": "You have exceeded the max number of requests per minute.",
"error": "RateLimitExceededError",
"status": 429,
"code": "rate_limit_exceeded_error"
}
Response fields
  • messagestring

    Human-readable message.

  • errorstring

    Error name

  • statusnumber

    HTTP error code

  • codestring

    Error code