Available Methods

You can retrieve details of a property by using the Rela Property NID (nid) or by using an External ID that you have provided.

Retrieve a Property using Rela ID (nid)

GET https://www.relahq.com/api/v1/object/property/{nid}

Path Parameters

Name	Type	Description
nid*	Integer	The Rela ID for the Property

Headers

Name	Type	Description
API-KEY*	String	Your API Key
TOKEN*	String	Your API Token
content-type*	String	application/json

200: OK Success

{
    "nid": "96034456",
    "uid": "86",
    "street": "1521 Dorothy Ln",
    "premise": "",
    "city": "Newport Beach",
    "state": "CA",
    "zip": "92660",
    "country": "US",
    "title": "1521 Dorothy Lane",
    "description": "<p>Enjoy the Newport Beach lifestyle in this fabulous 4 bedroom, 3 bath home. Built in 2022 with a clean and well-planned 2929 sqft floorplan. This beautiful home will sell fast! Send an inquiry in the form below.</p>",
    "amenities": "Beamed Ceilings,Built-in Features,Ceiling Fan(s),High Ceilings,Open Floorplan,Pantry,Quartz Counters,Recessed Lighting,Flooring: Stone,Wood,Window Features: Custom Covering,Double Pane Windows",
    "list_price": "1500000",
    "display_price": null,
    "square_feet": "2929",
    "lot_size": "9,300",
    "lot_size_units": "sf",
    "stories": "1",
    "bedrooms": "4",
    "baths": "3",
    "half_baths": "1",
    "garage": "2",
    "parking_spaces": null,
    "listing_status": null,
    "property_type": "SingleFamily",
    "year_built": "2022",
    "open_houses": null,
    "subdomain": "1521dorothylane",
    "custom_domain": null,
    "mls_id": null,
    "template": "mak",
    "api_author": null,
    "main_image": "96767677",
    "edit_access": "3871566",
    "show_on_property": "3871566",
    "logo": "96767676",
    "external_id": null,
    "skip_zlookup": null,
    "intent": "media_only_converted",
    "sns_id": null,
    "listtrack_property_id": null,
    "website_url": "https://123ekostreet.com",
    "virtual_tours": {
        "9348727": {
            "nid": 96767760,
            "title": "Main House",
            "vtour_url": "https://matterport.com/model/12356"  
        }   
    },
    "property_videos": {
        "96767760": {
            "nid": 96767760,
            "title": "1521 Dorothy Lane",
            "video_url": "https://vimeo.com/722869543/f270de1b6b"
        }
    },
    "floorplans": {
        "96767657": {
            "nid": "96767657",
            "title": "Floor 1",
            "floorplan_url": "https://rela-s3-e-dev.s3.amazonaws.com/public/property-docs/prop-nid-96034456/floor-1.png"
        },
        "96767658": {
            "nid": "96767658",
            "title": "Floor 2",
            "floorplan_url": "https://rela-s3-e-dev.s3.amazonaws.com/public/property-docs/prop-nid-96034456/floor-2.png"
        }
    }
}

Retrieve a Property using external ID (external-id)

GET https://www.relahq.com /api/v1/object/external-property/{external-id}

Path Parameters

Name	Type	Description
external-id*		The external ID for the Property

Headers

Name	Type	Description
API-KEY*	String	Your API Key
TOKEN*	String	Your API Token
content-type*	String	application/json

200: OK Success

{
    "nid": "96034456",
    "uid": "86",
    "street": "1521 Dorothy Ln",
    "premise": "",
    "city": "Newport Beach",
    "state": "CA",
    "zip": "92660",
    "country": "US",
    "title": "1521 Dorothy Lane",
    "description": "<p>Enjoy the Newport Beach lifestyle in this fabulous 4 bedroom, 3 bath home. Built in 2022 with a clean and well-planned 2929 sqft floorplan. This beautiful home will sell fast! Send an inquiry in the form below.</p>",
    "amenities": "Beamed Ceilings,Built-in Features,Ceiling Fan(s),High Ceilings,Open Floorplan,Pantry,Quartz Counters,Recessed Lighting,Flooring: Stone,Wood,Window Features: Custom Covering,Double Pane Windows",
    "list_price": "1500000",
    "display_price": null,
    "square_feet": "2929",
    "lot_size": "9,300",
    "lot_size_units": "sf",
    "stories": "1",
    "bedrooms": "4",
    "baths": "3",
    "half_baths": "1",
    "garage": "2",
    "parking_spaces": null,
    "listing_status": null,
    "property_type": "SingleFamily",
    "year_built": "2022",
    "open_houses": null,
    "subdomain": "1521dorothylane",
    "custom_domain": null,
    "mls_id": null,
    "template": "mak",
    "api_author": null,
    "main_image": "96767677",
    "edit_access": "3871566",
    "show_on_property": "3871566",
    "logo": "96767676",
    "external_id": null,
    "skip_zlookup": null,
    "intent": "media_only_converted",
    "sns_id": null,
    "listtrack_property_id": null,
    "website_url": "https://123ekostreet.com",
    "virtual_tours": [],
    "property_videos": {
        "96767760": {
            "nid": 96767760,
            "title": "1521 Dorothy Lane",
            "video_url": "https://vimeo.com/722869543/f270de1b6b"
        }
    },
    "floorplans": {
        "96767657": {
            "nid": "96767657",
            "title": "Floor 1",
            "floorplan_url": "https://rela-s3-e-dev.s3.amazonaws.com/public/property-docs/prop-nid-96034456/floor-1.png"
        },
        "96767658": {
            "nid": "96767658",
            "title": "Floor 2",
            "floorplan_url": "https://rela-s3-e-dev.s3.amazonaws.com/public/property-docs/prop-nid-96034456/floor-2.png"
        }
    }
}

Create a Property

POST https://www.relahq.com/api/v1/object/property

Headers

Name	Type	Description
TOKEN*		Your API Token
API-KEY*		Your API Key
content-type*	String	application/json

Request Body

Name	Type	Description
street*	String	Property number and street name
city*	String	City of the property
state*	String	2 character state abbreviation
zip*	String	Zip/Postal code of the property
square feet	Integer	Square footage of the property
bedrooms	Integer	Number of bedrooms in the property
baths	Integer	Number of bathrooms in the property
list_price	Integer	Current list price of the property
garage	String	Available options are: "Attached", "Detached", or "None". Note: case sensitive
stories	Integer	Number of stories for the property
lot_size	String	Size of the lot for the property
parking_spaces	Integer	Number of parking spaces included with the property
description	String	Description of the property
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"
year_built	Integer	The year the property was built
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"

200: OK Success

HTTP/1.1 200 OK 
#Example Response
{
    "nid": "1234",
    "uri": "https://www.relahq.com/relaautologin/a83523c3d71f593d7e9c003dsd0c451c8b41dc79602d612fe812883safsa34"
}

Edit a Property

PUT https://www.relahq.com/api/v1/object/property/{nid}

Example request for editing street, premise, city and state.

Path Parameters

Name	Type	Description
nid*	Integer	The Rela ID for the Property

Headers

Name	Type	Description
content-type*	String	application/json
API-KEY*	String	Your API Key
TOKEN*	String	Your API Token

Request Body

Name	Type	Description
field name	String	Include any of the field names that you would like to update.

200: OK Success

HTTP/1.1 200 OK 
#Example Response
{
    "nid": "1234",
    "uri": "https://www.relahq.com/relaautologin/a83523c3d71f593d7e9c003dsd0c451c8b41dc79602d612fe812883safsa34"
}

To get multiple properties using your Rela given user ID (uid):

Get multiple Properties

GET https://www.relahq.com /api/v1/object/properties/{uid}

Path Parameters

Name	Type	Description
uid*	Integer	Your Rela user ID

Headers

Name	Type	Description
API-KEY*	String	Your API Key
TOKEN*	String	Your API Token
content-type*	String	application/json

200: OK Success

HTTP/1.1 200 OK 
#Example Response
{
  [
    {
      "nid": "12976",
      "published": "1",
      "title": "1448 Galaxy Dr.",
      "external_id": "abc-123"
    }
  …
  … 99

  ]
}