Search people | WealthAtlas Partners API

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.

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](/guides/profile) 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

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

Errors

400

Bad Request Error

402

Payment Required Error

422

Unprocessable Entity Error

503

Service Unavailable Error

$	curl -X POST https://api.wealthatlas.com/v1/partners/search \
>	-H "x-api-key: <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"search_query": "wealthy people in New York who give to education"
>	}'

1	{
2	"total_count": 1,
3	"page_number": 1,
4	"page_size": 1,
5	"results": [
6	{
7	"id": "string",
8	"name": "",
9	"bio": "",
10	"city": "",
11	"state": "",
12	"giving_capacity": 1,
13	"net_worth_min": 1,
14	"net_worth_max": 1,
15	"liquidity_min": 1,
16	"liquidity_max": 1,
17	"primary_photo": "string",
18	"explanation": [
19	"string"
20	]
21	}
22	],
23	"sentenced_schema": "string"
24	}