Skip to main content
POST
get_property

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
property_refs
string[]
required

Up to five account references; record arrays may be shortened to fit the 256 KiB response ceiling.

Required array length: 1 - 5 elements
Required string length: 1 - 512
sections
enum<string>[]
Maximum array length: 13
Available options:
identity,
assessment,
tax,
delinquency_tax_sale,
special_assessment,
ownership,
transfer,
deed_reference,
permit,
license,
inspection_enforcement,
building,
land
fields
string[]

Reserved; the current property reader returns unavailable (HTTP 422).

Maximum array length: 256
Required string length: 1 - 256
as_of
string

Reserved; historical property reads currently return unavailable (HTTP 422).

Required string length: 1 - 64
publication_id
string

Reserved; publication-pinned property reads currently return unavailable (HTTP 422).

Required string length: 1 - 256
section_limit
integer
default:20
Required range: 1 <= x <= 100
cursors
object

Reserved; section continuation currently returns unavailable (HTTP 422).

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