getRelatedProperties
Batch property attributes by id.
Batch property attributes by id (esId): owner of record and mailing address, beds/baths/size, year built, last sale, value, occupancy, county, lat/long, years owned, ownerPortfolioSize (parcels the owner holds).
curl https://server.goliathdata.com/api/v1/call \
-H "Authorization: Bearer $GOLIATH_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"operationId": "getRelatedProperties",
"variables": {
"propertyIds": [
"<propertyIds>"
]
}
}'import { GoliathClient } from '@goliath-data/sdk'
const goliath = new GoliathClient({
apiKey: process.env.GOLIATH_API_KEY!,
baseUrl: 'https://server.goliathdata.com',
})
const result = await goliath.properties.getRelatedProperties({
propertyIds: [
'<propertyIds>'
]
})const res = await fetch('https://server.goliathdata.com/api/v1/call', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.GOLIATH_API_KEY}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
operationId: 'getRelatedProperties',
variables: {
propertyIds: [
'<propertyIds>'
]
}
}),
})
const { data, errors } = await res.json()Variables
The example sends only what the schema requires. Some operations also need one of several optional variables (one filter or another, say); the description above says which.
Response
What comes back under data: a list shows as one entry, and a value as its type.
{
"data": {
"property": {
"fetchRelatedProperties": [
{
"propertyId": "<ID>",
"propertyType": "SINGLE_FAMILY",
"numberOfBedrooms": 0,
"numberOfBathrooms": 0,
"livingAreaSquareFeet": 0,
"yearBuilt": 0,
"lastSaleDate": "2026-01-01T00:00:00.000Z",
"lastSaleAmount": "…",
"estimatedValueDollars": "…",
"ownerOccupied": true,
"mlsStatus": "FOR_RENT",
"spicyLeadScore": 0,
"nameOnDeedUnformatted": "…",
"coOwnerNameOnDeedUnformatted": "…",
"ownerAddressFull": "…",
"addressFull": "…",
"countyFips": "…",
"countyName": "…",
"latitude": 0,
"longitude": 0,
"yearsOfOwnership": 0,
"ownerPortfolioSize": 0
}
]
}
}
}Errors
unknown_variableA variable the operation does not declare. A typo is refused rather than silently dropped.
unauthorizedNo bearer header, or the key is invalid or revoked.
insufficient_scopeThe key lacks the scope the operation requires.
forbiddenA referenced record does not exist, was deleted, or is outside your organization. The gateway cannot tell those apart.
Behaviour
A read. It rejects an Idempotency-Key header with 400 bad_request.