findProperties
Search properties by (partial) address.
Search properties by (partial) address. Returns address suggestions with the property id (esId) to use in getProperty.
curl https://server.goliathdata.com/api/v1/call \
-H "Authorization: Bearer $GOLIATH_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"operationId": "findProperties",
"variables": {
"addressString": "<String>"
}
}'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.findProperties({
addressString: '<String>'
})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: 'findProperties',
variables: {
addressString: '<String>'
}
}),
})
const { data, errors } = await res.json()limit is clamped to 50.
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.
Default 10.
Default 0.
Response
What comes back under data: a list shows as one entry, and a value as its type.
{
"data": {
"property": {
"autocompleteProperties": {
"results": [
{
"esId": "…",
"fullAddress": "…",
"line1": "…",
"line2": "…",
"city": "…",
"state": "…",
"zipCode": "…",
"parcelId": "…",
"mlsStatus": "FOR_RENT"
}
],
"totalCount": 0,
"hasMore": true
}
}
}
}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.