Object Model
* indicates required field
Attribute | Type | Description | Read only |
---|---|---|---|
nid | int | The Rela ID of the property | true |
title | string | The title of the property (defaults to street address) | false |
street* | string | Property number and street name | false |
premise | string | Apartment or suite | false |
city* | string | City of the property | false |
state* | string | 2 character state abbreviation | false |
zip* | string | Zip/Postal code of the property | false |
country* | string | 2 character country abbreviation | false |
square_feet | int | Square footage of the property | false |
bedrooms | int | Number of bedrooms in the property | false |
baths | int | Number of bathrooms in the property | false |
list_price | int | Current list price of the property | false |
garage | string | Available options are: "Attached", "Detached", or "None". Note: case sensitive | false |
lot_size | string | Size of the lot for the property | false |
stories | int | Number of stories for the property | false |
description | string | Description of the property | false |
parking_spaces | int | Number of parking spaces included with the property | false |
property_type |
string | Available case sensitive options are: "Single Family", "Duplex", "Triplex", "Quad-Plex", "Condo", "Co-op", "Mobile Home", "Multi Family", "Multi Family", "Timeshare", "Town House", "Miscellaneous", "Residential Land". Note: | false |
year_built | int | The year the property was built | false |
template | string | Available options are: "mak", "kit", "mot", "lnd", "karr", "stak", "north", "icon", "lux", "ryne", "dax", "bren", "eko", "rubik_v2", "arlo", "pipeline", "cobi", "focal", "rubik", "air", "saren"
You can also pull a current list of available templates from https://www.relahq.com/api/v1/object/template_base | false |
main_image | int | The NID of the Property Image to set as main image | false |
edit_access | array | Array of Agent NIDs to give edit access to | false |
show_on_property | array | Array of Agent NIDs to show on property website | false |
domain | string | The custom domain for the property (e.g. www.123Relastreet) | false |
Last updated