Search Companies

Endpoint Overview

The Search Companies endpoint retrieves an array of company object models based on specific filters.

• URL: https://api.profileapi.com/2024-03-01/companies
• HTTP Method: POST

Request

Parameters

Utilize the following parameters to refine your search and retrieve tailored company information

Expression

• Key: expression
• Data Type: object
• Description: Enables advanced filtering by specifying conditions that must be met. Use the all field to list conditions that must all be satisfied (with optional exclusions) and the any field to list conditions where at least one must be met.
• Structure:
  • all: An array of conditions that must all be satisfied. Conditions can also include an exclude flag.
  • any: An array of conditions where at least one must be satisfied.
• Example:

{
  "all": [
    {
      "categoryKey": "country",
      "name": "United States"
    },
    {
      "categoryKey": "usState",
      "name": "CA",
      "exclude": true
    }
  ],
  "any": [
    { "categoryKey": "businessModels", "name": "Subscription" },
    { "categoryKey": "businessModels", "name": "Freemium" }
  ]
}

Limit

• Key: limit
• Data Type: number
• Description: Specifies the maximum number of results to return. The default value is 10, with a maximum allowed value of 1000.
• Example: 100

Fields To Return

• Key: fieldsToReturn
• Data Type: string
• Description: Specifies which fields should be returned in the response.
• Options:

Name	Default	Credits (Per Record)	Description
idOnly	false	0	Return only company IDs.
basic	true	1	Return basic company information such as Name, Website, Links, and Headquarters Locations.
premium	false	4	Return premium company information, including Website Elements, Niches, Funding, Website Traffic, and more.

Please refer to the company object model for a complete list of basic vs. premium fields.

Example

{
  "expression": {
    "all": [
      {
        "categoryKey": "country",
        "name": "United States"
      },
      {
        "categoryKey": "usState",
        "name": "CA",
        "exclude": true
      }
    ],
    "any": [
      { "categoryKey": "businessModels", "name": "Subscription" },
      { "categoryKey": "businessModels", "name": "Freemium" }
    ]
  },
  "limit": 100,
  "fieldsToReturn": "idOnly"
}

Response

The response returns an array of company object models, along with pagination information.

Example

{
  "data": {
    "results": [
      {
        "id": "9e6a55b258ef11edb8780242ac120002",
        "name": "Acme Corporation",
        "logoUrl": "https://d1hbpr09pwz0sk.cloudfront.net/logo_url/607a654e",
        "headcount": 35,
        "operatingStatus": "Active",
        "purposeCategory": "For Profile",
        "stockSymbol": "ACME",
        "foundedAt": 2015,
        "website": "https://acmecorp.com",
        "angellistUrl": "https://angel.co/acmecorp",
        "crunchbaseUrl": "https://www.crunchbase.com/organization/acmecorp",
        "facebookUrl": "https://facebook.com/acmecorp",
        "githubUrl": "https://github.com/acmecorp",
        "linkedInUrl": "https://linkedin.com/company/acmecorp",
        "xUrl": "https://twitter.com/acmecorp",
        "youtubeUrl": "https://youtube.com/user/acmecorp",
        "industry": "Technology",
        "niche": "Cloud Computing",
        "unitedStatesHeadquartersStateCodes": ["NY"],
        "headquartersCountryCodes": ["US"],
        "unitedStatesHeadquartersRegions": ["East Coast"],
        "headquartersWorldRegions": ["North America"],
        "websiteExternalDomainCategories": ["Solar Energy"],
        "websiteExternalDomains": ["https://solarenergy.com"],
        "websitePages": ["Products", "Pricing"],
        "websiteHomePageTopics": ["Commercial Solar Projects", "Concentrated Solar Power (CSP)"],
        "websitePricingPageTopics": ["Subscription", "Enterprise"],
        "websiteTrafficGlobalRank": 1005234,
        "fundingAmount": 5000000,
        "fundingLastRoundAt": "2021-05-20",
        "spendingItTotalAmount": 2500000
      }
    ],
    "pagination": {
      "nextStart": [
        {
          "id": "9e6a55b258ef11edb8780242ac121233",
          "score": 0.92
        }
      ]
    }
  }
}