Skip to main content
POST
search_properties

Authorizations

Authorization
string
header
required

Send Authorization: Bearer qk_… using an API key created in the Quoin Developer Portal.

Headers

Idempotency-Key
string

Unique key for one logical POST. Reuse is replay-safe or returns a conflict.

Required string length: 1 - 256

Body

application/json
area_uid
string
required
Required string length: 1 - 128
subject_kind
enum<string>
required
Available options:
property,
tax_account,
parcel,
address,
building,
unit,
land_interest
sort
object
required
area_relation
enum<string>
Available options:
located_in,
taxed_in,
assessed_in,
served_by,
permitted_by
filters
object[]
Maximum array length: 100
projection
enum<string>
default:identity_summary
Available options:
identity_summary,
fact_summary
limit
integer
default:20
Required range: 1 <= x <= 100
cursor
string
Required string length: 1 - 4096

Response

Canonical response envelope.

contract_version
string
required
Allowed value: "quoin-v2"
request_id
string
required
Required string length: 1 - 512
operation
string
required
Required string length: 1 - 256
status
enum<string>
required
Available options:
ok,
partial,
error
data
object | null
required
error
object | null
required
meta
object
required
provenance
object | null