EAeasybroker
Properties

Retrieve a property

Returns the detailed information of a property linked to your integration

get/properties/{property_id}

Request

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

Response

Successful property request.

public_idstring
titlestring
created_atstring date-time
updated_atstring date-time
urlstring
descriptionstring

The property listing description.

property_typestring
bedroomsinteger nullable
bathroomsinteger nullable
half_bathroomsinteger nullable
parking_spacesinteger nullable
lot_sizenumber nullable

In square meters

construction_sizenumber nullable

In square meters

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.

lot_lengthnumber nullable
lot_widthnumber nullable
floorsinteger nullable

The number of floors in the building.

floorstring nullable

The floor number in which the property is located, useful for apartments. It can be set to a custom value such as 'Penthouse'

agestring nullable

One of "under_construction", "new_construction" or the year the building was built.

agency_idstring
agent_idstring nullable
ad_typestring nullable
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.

tagsstring[]

Tags added by users as private information to classify properties, EasyBroker is not responsible for the content entered. Tags should only be use for filtering purposes, not listing display.

videosstring[]
virtual_tourstring nullable

Example response

{
  "public_id": "EB-XXX123",
  "title": "Fitted kitchen with granite countertops",
  "url": "https://www.easybroker.com/inmueble/john-smith-amazing-house",
  "description": "This property is very well-lit in a lovely neighborhood overlooking a park.",
  "property_type": "Apartment",
  "maintenance_amount": 1500,
  "maintenance_currency": "MXN",
  "floors": 5,
  "floor": "1",
  "age": "2020",
  "agency_id": "1002",
  "agent_id": "25-john",
  "ad_type": "Featured",
  "location": {
    "region": "Ciudad de México",
    "city": "Cuauhtémoc",
    "city_area": "Condesa",
    "street": "Benito Juárez",
    "postal_code": "06700",
    "latitude": 20.676145,
    "longitude": -103.368962,
    "show_exact_location": true
  },
  "operations": [
    {
      "amount": 500000,
      "formatted_amount": "$500,000 USD",
      "currency": "USD"
    }
  ],
  "foreclosure": true,
  "adjudicated": true,
  "features": [
    {
      "id": 324,
      "name": "Pets allowed",
      "name_es": "Mascotas permitidas",
      "name_pt": "Animais de estimação são permitidos",
      "country_id": 150
    }
  ],
  "tags": [
    "premium",
    "exclusive"
  ],
  "images": [
    {
      "url": "https://assets.easybroker.com/property_images/123/456/EB-010101.jpg?s=3f9a1c2e7b6d4a08&version=1713484800",
      "title": "Fitted kitchen with granite countertops"
    }
  ],
  "videos": [
    "https://www.youtube.com/watch?v=zVRu7AktR48"
  ],
  "virtual_tour": "https://my.matterport.com/show/?m=yHsh2roFXnp"
}

Changes

No recorded changes to this operation across all 1 revision of this API.