Skip to navigation

Search people

Search for people using either natural language or structured search criteria. Set mode to ‘natural-language’ and provide search_query to describe people in plain English, or set mode to ‘structured’ and provide person_description with filters for location, giving capacity, net worth, affiliations, education, employment, political donations, and more. Returns paginated results with relevance explanations. Only person search is supported; any nonprofit criteria are ignored. See the Profile Schema guide for details on the person data model.

Cost: 1 credit.

Authentication

x-api-keystring

Your WealthAtlas API key. Contact support@wealthatlas.com to get started.

Request

This endpoint expects an object.
natural-languageobjectRequired

Search for people using a natural language query.

Describe the type of people you are looking for in plain English. The query is parsed by a large language model into structured search criteria

OR
structuredobjectRequired

Search for people using structured filter criteria.

Define filters for location, giving capacity, net worth, affiliations, education, employment, political donations, and more

Response

Successful Response
total_countinteger
Total number of matching people
page_numberinteger
Current page number
page_sizeinteger
Results per page
resultslist of objectsOptional
Page of person results
sentenced_schemastring or nullOptional

Human-readable summary of the search criteria

sort_fieldslist of objects or nullOptional

The order these results are in: the sort you posted, or, when you posted none, the one a ranking query chose (“the wealthiest people in Palm Beach” sorts by its measure, highest first). Null means relevance order. A natural-language query is read afresh on every request, so to keep one order across pages, post the sort this field reports with the next page (an empty list when it is null)

Errors

400
Bad Request Error
402
Payment Required Error
422
Unprocessable Entity Error
503
Service Unavailable Error