GET
/
addresses
/
{geo_id}
/
residents
Get Residents
curl --request GET \
  --url https://api.shovels.ai/v2/addresses/{geo_id}/residents \
  --header 'X-API-Key: <api-key>'
{
  "items": [
    {
      "name": "John Doe",
      "email": "john.doe@example.com",
      "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",
      "email": "jane.doe@example.com",
      "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",
  "pagination_type": "cursor"
}

Authorizations

X-API-Key
string
header
required

Path Parameters

geo_id
string
required

Address geo ID

Query Parameters

cursor
string | null

Cursor for pagination

page
integer | null

Page number for offset-based pagination (only used if cursor is not provided)

Required range: x >= 1
size
integer
default:50

Number of items per page

Required range: 1 <= x <= 100

Response

Residents for a given address geo ID

Paginated response for residents.

items
ResidentsRead · object[]
required

The list of items returned in the response following given criteria.

page
integer
required

The page number of the response.

size
integer
required

The number of items returned in the response.

next_page
integer | null
required

The next page number of the response.

pagination_type
string
default:offset
Allowed value: "offset"