Skip to content
AlterEstate

Create a property

POSThttps://secure.alterestate.com/api/v1/properties/create/

Creates a property in your agency’s inventory.


Authentication

Send Authorization: Token your_api_key_here. Account token. Keep it on your server.


Body parameters

FieldTypeDescription
namerequiredstringPublic property name. Example: Modern apartment in Naco.
categoryrequirednumberCategory ID. See List properties. Example: 1.
listing_typerequirednumber1 for sale, 2 for rent. Example: 1.
sale_pricenumberSale price. Example: 185000.
currency_salestringSale price currency. Example: USD.
citynumberCity ID. Example: 156.
sectornumberSector ID. Example: 2234.
roomnumberBedrooms. Example: 2.
bathroomnumberBathrooms. Example: 2.
parkinglotnumberParking spaces. Example: 1.
property_areanumberBuilt area. Example: 110.
descriptionstringLong description. Stored text may be rendered as HTML later, so send plain text or HTML you trust. Example: Bright apartment with a balcony..

Example request

POST
curl --request POST \
  --url 'https://secure.alterestate.com/api/v1/properties/create/' \
  --header 'Authorization: Token your_api_key_here' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Modern apartment in Naco",
  "category": 1,
  "listing_type": 1,
  "sale_price": 185000,
  "currency_sale": "USD",
  "city": 156,
  "sector": 2234,
  "room": 2,
  "bathroom": 2,
  "parkinglot": 1,
  "property_area": 110,
  "description": "Bright apartment with a balcony."
}'

Example response

201 Created
{
  "uid": "JSORJ9S5AY",
  "cid": 292960,
  "slug": "modern-apartment-in-naco-292960",
  "name": "Modern apartment in Naco",
  "sale_price": 185000,
  "currency_sale": "USD"
}
400 Bad Request
{
  "name": [
    "This field is required."
  ]
}

Last updated . Questions? Emailengineering@alterestate.com.