Get one property

Retrieve the current canonical property view by Placekey or platform property identifier

Use the canonical property endpoint when you know the platform identity for a real-world property and need one current, entitlement-filtered property view. It is not a listing-history endpoint.

Which identifier should I use?

A resolved property uses its Placekey as data.id. A record that has not resolved yet may temporarily use a prov:<ULID> platform identifier. ListingKey, ListingId, and UniversalPropertyId identify listing records; query those through listing search or the OData collection.

One property can have many listings

A Placekey groups records that describe the same physical property. That group can include active and historical listings, sale and rental listings, and records from multiple originating systems. Choose the endpoint based on the shape you need:

Current canonical property

GET /v1/properties/{placekey} returns one merged current property view.

Every listing for a Placekey

GET /reso/odata/Property?placekey={placekey} returns the entitled listing records linked to that property.

curl --get \
  --url "https://api.example.invalid/reso/odata/Property" \
  --header "x-api-key: $REALTY_API_KEY" \
  --data-urlencode "placekey=223-227@5vg-82n-pgk" \
  --data-urlencode '$orderby=ModificationTimestamp desc'

Request

curl --request GET \
  --url "https://api.example.invalid/v1/properties/223-227@5vg-82n-pgk" \
  --header "x-api-key: $REALTY_API_KEY"

The path parameter is URL-safe text between 1 and 256 characters. The endpoint returns 404 not_found when the identity does not exist or is outside your entitlement; the response never reveals which case occurred.

Response anatomy

{
  "data": {
    "id": "223-227@5vg-82n-pgk",
    "domain": "listing",
    "version": "01J8F3ZK9Q7W2C4E6G8H0M1N3P",
    "attributes": {
      "status": "Active",
      "list_price": 1295000,
      "bedrooms": 3,
      "bathrooms": 2,
      "osn": "ExampleMLS"
    }
  },
  "meta": { "entitlement_version": "ent_2026-07-01_r3" }
}

Prop

Type

Errors

Status	Code	Meaning
`400`	`invalid_property_id`	The identifier is empty, too long, or contains control characters.
`404`	`not_found`	No visible property resolves to this identifier.
`503`	`service_unavailable`	The service could not prove the response was safely filtered and failed closed.

Interactive endpoint reference

Try the request, inspect schemas, and review every response code.