> ## Documentation Index
> Fetch the complete documentation index at: https://docs.realtycrawl.dev/llms.txt
> Use this file to discover all available pages before exploring further.
# Get Property
> Proposed interface. Enable only for documented and verified source/country capabilities. Property identity and records
This operation is defined in the API contract but is not currently enabled.
Check [live capabilities](https://realtycrawl.dev/v1/meta/capabilities) before calling this operation. A documented contract does not imply active coverage for every source or country.
## OpenAPI
````yaml GET /v1/properties/{property_id}
openapi: 3.1.0
info:
title: RealtyCrawl proposed unified API
version: 0.1.0
description: >-
Research draft dated 2026-10-13. No production server or enabled platform
coverage is implied. Country and operation capabilities must be checked.
servers:
- url: https://realtycrawl.dev
security:
- ApiKeyAuth: []
externalDocs:
url: https://docs.realtycrawl.dev
paths:
/v1/properties/{property_id}:
get:
tags:
- properties
summary: getProperty
description: >-
Proposed interface. Enable only for documented and verified
source/country capabilities. Property identity and records
operationId: getProperty
parameters:
- name: property_id
in: path
required: true
schema:
type: string
minLength: 1
responses:
'200':
description: Successful response; meta discloses source completeness
content:
application/json:
schema:
$ref: '#/components/schemas/getPropertyResponse'
default:
description: Typed error response
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
components:
schemas:
getPropertyResponse:
type: object
properties:
data:
$ref: '#/components/schemas/Property'
meta:
$ref: '#/components/schemas/Meta'
required:
- data
- meta
additionalProperties: false
ErrorResponse:
type: object
properties:
error:
type: object
properties:
code:
type: string
message:
type: string
retryable:
type: boolean
details:
type: array
items:
$ref: '#/components/schemas/SourceOutcome'
required:
- code
- message
- retryable
additionalProperties: false
request_id:
type: string
required:
- error
- request_id
additionalProperties: false
Property:
type: object
properties:
id:
type: string
summary:
$ref: '#/components/schemas/PropertySummary'
references:
type: array
items:
type: object
properties:
namespace:
type: string
value:
type: string
jurisdiction:
anyOf:
- type: string
- type: 'null'
required:
- namespace
- value
additionalProperties: false
sources:
type: array
items:
$ref: '#/components/schemas/Source'
required:
- id
- summary
- sources
additionalProperties: false
Meta:
type: object
properties:
request_id:
type: string
schema_version:
type: string
generated_at:
type: string
format: date-time
completeness:
type: string
enum:
- complete
- partial
- unknown
sources:
type: array
items:
$ref: '#/components/schemas/SourceOutcome'
warnings:
type: array
items:
type: object
properties:
code:
type: string
message:
type: string
field:
type: string
required:
- code
- message
additionalProperties: false
pagination:
type: object
properties:
next_cursor:
anyOf:
- type: string
- type: 'null'
has_more:
type: boolean
returned:
type: integer
total:
anyOf:
- type: integer
- type: 'null'
total_relation:
type: string
enum:
- exact
- lower_bound
- unknown
required:
- next_cursor
- has_more
- returned
- total
- total_relation
additionalProperties: false
property_groups:
type: array
items:
$ref: '#/components/schemas/PropertyGroup'
required:
- request_id
- schema_version
- generated_at
- completeness
- sources
additionalProperties: false
SourceOutcome:
type: object
properties:
platform:
type: string
provider:
anyOf:
- type: string
- type: 'null'
status:
type: string
enum:
- success
- partial
- failed
- unsupported
error_code:
anyOf:
- type: string
- type: 'null'
truncated:
type: boolean
observed_at:
anyOf:
- type: string
format: date-time
- type: 'null'
required:
- platform
- status
additionalProperties: false
PropertySummary:
type: object
properties:
id:
anyOf:
- type: string
- type: 'null'
address:
$ref: '#/components/schemas/Address'
geometry:
anyOf:
- $ref: '#/components/schemas/Geometry'
- type: 'null'
property_type:
type: string
bedrooms:
anyOf:
- type: number
- type: 'null'
rooms:
anyOf:
- type: number
- type: 'null'
bathrooms:
anyOf:
- type: number
- type: 'null'
areas:
type: array
items:
$ref: '#/components/schemas/Area'
layout:
anyOf:
- type: string
- type: 'null'
year_built:
anyOf:
- type: integer
- type: 'null'
required:
- id
- address
- property_type
additionalProperties: false
Source:
type: object
properties:
platform:
type: string
country:
type: string
native_id:
anyOf:
- type: string
- type: 'null'
url:
anyOf:
- type: string
format: uri
- type: 'null'
provider:
type: string
observed_at:
type: string
format: date-time
source_updated_at:
anyOf:
- type: string
format: date-time
- type: 'null'
access_class:
type: string
enum:
- public_portal
- licensed_feed
- public_record
- modeled
retrieved_at:
type: string
format: date-time
required:
- platform
- provider
- observed_at
- access_class
additionalProperties: false
PropertyGroup:
type: object
properties:
property_id:
anyOf:
- type: string
- type: 'null'
listing_ids:
type: array
items:
type: string
match_method:
type: string
confidence:
anyOf:
- type: number
- type: 'null'
status:
type: string
enum:
- matched
- ambiguous
required:
- property_id
- listing_ids
- match_method
- status
additionalProperties: false
Address:
type: object
properties:
formatted:
anyOf:
- type: string
- type: 'null'
line1:
anyOf:
- type: string
- type: 'null'
unit:
anyOf:
- type: string
- type: 'null'
city:
anyOf:
- type: string
- type: 'null'
region:
anyOf:
- type: string
- type: 'null'
postal_code:
anyOf:
- type: string
- type: 'null'
country:
type: string
pattern: ^[A-Z]{2}$
original_text:
anyOf:
- type: string
- type: 'null'
required:
- country
additionalProperties: false
Geometry:
type: object
properties:
latitude:
type: number
minimum: -90
maximum: 90
longitude:
type: number
minimum: -180
maximum: 180
precision:
type: string
enum:
- exact
- approximate
- centroid
- obfuscated
- unknown
crs:
type: string
const: EPSG:4326
required:
- latitude
- longitude
- precision
- crs
additionalProperties: false
Area:
type: object
properties:
value:
type: number
unit:
type: string
enum:
- sqm
- sqft
- acre
- hectare
- ping
- tsubo
- other
basis:
type: string
enum:
- living
- built
- gross
- carpet
- saleable
- land
- unknown
original_text:
anyOf:
- type: string
- type: 'null'
normalized_sqm:
anyOf:
- type: number
- type: 'null'
required:
- value
- unit
- basis
additionalProperties: false
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: x-api-key
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.