v1

latestOpenAPI 3.0.02026-07-26155147.1 KB

Properties

Retrieve a property

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

get/properties/{property_id}

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.

descriptionstring

bedroomsinteger

bathroomsinteger

half_bathroomsinteger

parking_spacesinteger

lot_sizenumber

In square meters

construction_sizenumber

In square meters

lot_lengthinteger

lot_widthinteger

covered_spacenumber

In square meters. Not Available in Mexico.

uncovered_spacenumber

In square meters. Only available in Mexico and Argentina.

floorsinteger

floorinteger

agestring

One of "under_construction", "new" or the year the building was built

internal_idstring

A user defined property ID

expensesstring

property_typestring

created_atstring date-time

updated_atstring date-time

published_atstring date-time

public_urlstring

collaboration_notesstring

property_filesstring[]

videosstring[]

virtual_tourstring

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

tagsstring[]

show_pricesboolean

share_commissionboolean

Example response

{
  "public_id": "EB-XXX123",
  "title": "Beautiful property in Condesa",
  "foreclosure": true,
  "property_images": [
    {
      "url": "https://www.easybroker.com/assets/product/logo-be4da843987ccd1c05e26f8703f1787847471b36d08bdb1ec8a91ce4007b0e98.svg",
      "title": "Fitted kitchen with granite countertops"
    }
  ],
  "images": [
    {
      "url": "https://www.easybroker.com/assets/product/logo-be4da843987ccd1c05e26f8703f1787847471b36d08bdb1ec8a91ce4007b0e98.svg",
      "title": "Fitted kitchen with granite countertops"
    }
  ],
  "description": "This property is very well-lit in a lovely neighborhood overlooking a park.",
  "internal_id": "custom-id-001",
  "expenses": "$100 USD",
  "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/mx/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"
      }
    }
  ]
}