cURL
curl --request GET \ --url https://api.shovels.ai/v2/addresses/{geo_id}/residents \ --header 'X-API-Key: <api-key>'
{ "items": [ { "name": "John Doe", "personal_emails": "[email protected]", "phone": "(978) 314-5196", "linkedin_url": "https://www.linkedin.com/in/john-doe/", "net_worth": "$750,000 to $999,999", "income_range": "$150,000 to $299,999", "is_homeowner": true, "street_no": "123", "street": "Main St", "city": "New York", "state": "NY", "zip_code": "10001" }, { "name": "Jane Doe", "personal_emails": "[email protected]", "phone": "(310) 555-7890", "linkedin_url": "https://www.linkedin.com/in/jane-doe/", "net_worth": "$500,000 to $749,999", "income_range": "$100,000 to $149,999", "is_homeowner": false, "street_no": "456", "street": "Ocean Ave", "city": "Los Angeles", "state": "CA", "zip_code": "90001", "zip_code_ext": "1234" } ], "size": 2, "next_cursor": "aGVsbG8ad77" }
Return residents for a given address geo ID. Results are paginated using cursor-based pagination.
Address geo ID
Cursor for pagination
1 <= x <= 100
Residents for a given address geo ID
Paginated response for residents.
The list of items returned in the response following given criteria.
Show child attributes
The number of items returned in the response.
The cursor for retrieving the next page of results.
Was this page helpful?