Properties

Retrieve a property

Changed on

Returns the detailed information of a property from your EasyBroker account.

get/properties/{property_id}

Request

  • Base URL
    https://api.easybroker.com/v1
  • URL
    https://api.easybroker.com/v1/properties/{property_id}
  • Auth
    API key in header X-Authorization

Response

Successful single property request

public_idstring
titlestring
foreclosureboolean

Indicates whether the property is up for auction. This option is available only to agencies in Mexico.

adjudicatedboolean

Indicates whether the property has been legally awarded to a creditor. This option is available only to agencies in Mexico.

descriptionstring
bedroomsinteger nullable
bathroomsinteger nullable
half_bathroomsinteger nullable
parking_spacesinteger nullable
lot_sizenumber nullable

In square meters

construction_sizenumber nullable

In square meters

lot_lengthnumber nullable
lot_widthnumber nullable
covered_spacenumber nullable

In square meters. Not Available in Mexico.

uncovered_spacenumber nullable

In square meters. Only available in Mexico and Argentina.

floorsinteger nullable
floorstring nullable
conservation_state'new' | 'excellent' | 'good' | 'regular' | 'bad' | 'to_remodel' nullable

The condition of the property, or null when unspecified.

internal_idstring nullable

A user defined property ID

rental_maintenance_includedboolean nullable

Indicates whether monthly maintenance is included in the rental price. Required when rental is active and maintenance_amount is provided; otherwise it is null when rental is inactive.

maintenance_amountinteger nullable

Monthly maintenance amount. When rental is active, rental_maintenance_included must be specified; the amount is required when that field is false.

maintenance_currencystring

Currency of the maintenance amount. Defaults to the operation currency (rental, sale or temporary rental, in that order) when no maintenance currency has been set.

property_typestring
created_atstring date-time
updated_atstring date-time
published_atstring date-time nullable
public_urlstring
collaboration_notesstring nullable
property_filesstring[]
videosstring[]
virtual_tourstring nullable
exclusiveboolean nullable

Indicates whether the listing is exclusive. Set to null if not specified.

shared_commission_percentagenumber nullable

Indicates the percentage of the agency fee that is shared. At the moment, it can only contain 50% or null if not specified.

private_descriptionstring nullable
tagsstring[]
show_pricesboolean
share_commissionboolean

Example response

{
  "public_id": "EB-XXX123",
  "title": "Beautiful property in Condesa",
  "foreclosure": true,
  "adjudicated": true,
  "images": [
    {
      "url": "https://assets.easybroker.com/property_images/123/456/EB-010101.jpg?s=3f9a1c2e7b6d4a08&version=1713484800",
      "title": "Fitted kitchen with granite countertops"
    }
  ],
  "description": "This property is very well-lit in a lovely neighborhood overlooking a park.",
  "conservation_state": "good",
  "internal_id": "custom-id-001",
  "maintenance_amount": 1500,
  "maintenance_currency": "MXN",
  "property_type": "Apartment",
  "agent": {
    "id": 1234,
    "name": "John Smith",
    "full_name": "John Smith Doe",
    "mobile_phone": "5555550000",
    "profile_image_url": "https://www.easybroker.com/assets/product/logo-be4da843987ccd1c05e26f8703f1787847471b36d08bdb1ec8a91ce4007b0e98.svg",
    "email": "john@smith.com"
  },
  "features": [
    {
      "name": "Pets allowed",
      "category": "General"
    }
  ],
  "public_url": "https://www.easybroker.com/inmueble/john-smith-amazing-house",
  "collaboration_notes": "25% per referral",
  "property_files": [
    "https://www.easybroker.com/assets/product/logo-be4da843987ccd1c05e26f8703f1787847471b36d08bdb1ec8a91ce4007b0e98.svg"
  ],
  "videos": [
    "https://www.youtube.com/watch?v=zVRu7AktR48"
  ],
  "virtual_tour": "https://my.matterport.com/show/?m=yHsh2roFXnp",
  "shared_commission_percentage": 50,
  "private_description": "Selling this property is our top priority and we are willing to offer a discount.",
  "location": {
    "name": "Condesa, Cuauhtemoc, Ciudad de México",
    "latitude": 20.676145,
    "longitude": -103.368962,
    "street": "Av. México",
    "postal_code": "06700",
    "show_exact_location": true,
    "exterior_number": "21A",
    "interior_number": "304"
  },
  "tags": [
    "premium",
    "exclusive"
  ],
  "show_prices": true,
  "share_commission": true,
  "operations": [
    {
      "amount": 500000,
      "formatted_amount": "$500,000 USD",
      "currency": "USD",
      "commission": {
        "type": "amount",
        "value": 10000,
        "currency": "USD"
      }
    }
  ]
}

Changes

    • breaking

      the response property //// became nullable for the status

    • breaking

      the response property //// became nullable for the status

    • breaking

      the response property //// became nullable for the status

    • breaking

      the response property //// became nullable for the status

    • breaking

      the response property //// became nullable for the status

    • breaking

      the response property //// became nullable for the status

    • breaking

      the response property //// became nullable for the status

    • breaking

      the response property //// became nullable for the status

    • breaking

      the response property ////// became nullable for the status

    • breaking

      the response property //// became nullable for the status

    • breaking

      the response property //// became nullable for the status

    • breaking

      the response property //// became nullable for the status

    • breaking

      the response property //// became nullable for the status

    • breaking

      the response property //// became nullable for the status

    • breaking

      the response property //// became nullable for the status

    • breaking

      the response property //// became nullable for the status

    • breaking

      the response property //// became nullable for the status

    • breaking

      the response property ////// became nullable for the status

    • breaking

      the response property ////// became nullable for the status

    • breaking

      the response property ////// became nullable for the status

    • breaking

      the response property ////// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      response property allOf[PropertySingleBase]/age list-of-types was widened by adding types integer to media type application/json of response 200

    • breaking

      the //// response's property type changed from integer to string for status

    • breaking

      the //// response's property type changed from integer to number for status

    • breaking

      the //// response's property type changed from integer to number for status

    • warning

      removed the optional property //// from the response with the status

    • warning

      removed the optional property //// from the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property ////// to the response with the status