Skip to main content
POST
query_properties

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key
string

Use a unique key per logical call; identical retries within seven days add no charge.

Required string length: 1 - 256

Body

application/json
mode
enum<string>
default:catalog
Available options:
catalog,
values,
rows,
summary
dataset
enum<string>
default:properties
Available options:
properties,
sales,
tax_periods,
buildings
filters
object
field
string
Required string length: 1 - 256
group_by
string
Required string length: 1 - 256
measure
string
Required string length: 1 - 256
location
object
limit
integer
default:20
Required range: 1 <= x <= 50
cursor
string
Required string length: 1 - 4096
projection
string
Allowed value: "report_comparables_v1"
subject_property_ref
string
Required string length: 1 - 512
radius_miles
number
Required range: x <= 100

Response

Completed call

contract_version
any
required
request_id
string
required
operation
string
required
status
enum<string>
required
Available options:
ok,
partial,
error
data
object
required
error
object | null
required
meta
object
required