- Test this endpoint in the playground
- Check out official Python client
Run a search query. This accepts a natural language query as query parameter along with additional settings. It returns a list of profiles that match the query and orders them by relevance.
The query can be a simple search query like "software engineer from Ohio" or a more complex query like "Find me engineers in California speaking at least basic english working in software industry with experience at FAANG with 2+ years of experience and at least 500 followers and at least BS degree".
Use parameters to control tradeoffs between speed and quality. Here are some recipes:
- For highest quality results (1-3 minutes) use pro search with insights and profile scoring enabled:
{"query": "<YOUR QUERY HERE>", "type": "pro", "insights": true, "profile_scoring": true} - If you have "broad" queries where you expect many results (>1000) to be returned, then "fast" search may work well for you and save some costs and time.
{"query": "<YOUR QUERY HERE>", "type": "fast", "insights": true, "profile_scoring": true} - If you want results very fast, then enforce no filtering by passing empty
custom_filtersand turn ofinsightsandprofile_scoring:{"query": "<YOUR QUERY HERE>", "type": "fast", "insights": false, "profile_scoring": false, "custom_filters": {}} - If you want to implement pagination, pass the
thread_idof the previous request to the next request with increasedlimit.
Check out other parameters below to adjust speed vs quality and additional data that can be returned by the endpoint.
Cost: (number of profiles returned) × (sum of credits for each of type, insights, profile_scoring, high_freshness, show_emails, show_phone_numbers)
