Content
JSON
Retrieve a property
Documentation Index
Fetch the complete documentation index at: https://easybroker-staging.readme.io/llms.txt
Use this file to discover all available pages before exploring further.
Retrieve a property
Returns the detailed information of a property from your EasyBroker account.
OpenAPI definition
{
"openapi": "3.0.0",
"info": {
"version": "1.0",
"title": "EasyBroker API",
"description": "API for accessing and working with EasyBroker accounts. To get started click the Authorize button below and enter your API key."
},
"externalDocs": {
"description": "View the getting started guide in Spanish",
"url": "https://dev.easybroker.com/docs/api-de-easybroker"
},
"security": [
{
"ApiKeyAuth": []
}
],
"servers": [
{
"url": "https://api.stagingeb.com/v1",
"description": "API URL"
}
],
"paths": {
"/properties/{property_id}": {
"parameters": [
{
"name": "property_id",
"in": "path",
"required": true,
"description": "The public or internal ID of the specified property",
"schema": {
"type": "string"
}
}
],
"get": {
"tags": [
"Properties"
],
"summary": "Retrieve a property",
"description": "Returns the detailed information of a property from your EasyBroker account.",
"responses": {
"200": {
"description": "Successful single property request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PropertySingle"
}
}
}
},
"401": {
"$ref": "#/components/responses/UnauthorizedError"
},
"404": {
"$ref": "#/components/responses/property_not_found"
}
}
}
}
},
"components": {
"responses": {
"property_not_found": {
"description": "No property was found with the provided ID",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"example": "The property couldn't be found"
}
}
}
}
}
},
"UnauthorizedError": {
"description": "API key is missing or invalid",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"example": "Your API key is invalid"
}
}
}
}
}
}
},
"schemas": {
"PropertySingleBase": {
"properties": {
"public_id": {
"type": "string",
"example": "EB-XXX123"
},
"title": {
"type": "string",
"example": "Beautiful property in Condesa"
},
"foreclosure": {
"type": "boolean",
"example": true,
"description": "Indicates whether the property is up for auction. This option is available only to agencies in Mexico."
},
"property_images": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PropertyImage"
},
"description": "Note: Images are processed asynchronously and might take some time to appear in your listing. Deprecated, you should use the \"images\" attribute instead.",
"deprecated": true
},
"images": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PropertyImage"
},
"description": "Note: Images are processed asynchronously and might take some time to appear in your listing."
},
"description": {
"type": "string",
"example": "This property is very well-lit in a lovely neighborhood overlooking a park."
},
"bedrooms": {
"type": "integer"
},
"bathrooms": {
"type": "integer"
},
"half_bathrooms": {
"type": "integer"
},
"parking_spaces": {
"type": "integer"
},
"lot_size": {
"type": "number",
"description": "In square meters"
},
"construction_size": {
"type": "number",
"description": "In square meters"
},
"lot_length": {
"type": "integer"
},
"lot_width": {
"type": "integer"
},
"covered_space": {
"type": "number",
"description": "In square meters. Not Available in Mexico."
},
"uncovered_space": {
"type": "number",
"description": "In square meters. Only available in Mexico and Argentina."
},
"floors": {
"type": "integer"
},
"floor": {
"type": "integer"
},
"age": {
"type": "string",
"example": 2020,
"description": "One of \"under_construction\", \"new\" or the year the building was built"
},
"internal_id": {
"type": "string",
"example": "custom-id-001",
"description": "A user defined property ID"
},
"expenses": {
"type": "string",
"example": "$100 USD"
},
"property_type": {
"type": "string",
"example": "Apartment"
},
"agent": {
"$ref": "#/components/schemas/Agent"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"updated_at": {
"type": "string",
"format": "date-time"
},
"published_at": {
"type": "string",
"format": "date-time"
},
"features": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PropertyFeature"
}
},
"public_url": {
"type": "string",
"example": "https://www.easybroker.com/mx/inmueble/john-smith-amazing-house"
},
"collaboration_notes": {
"type": "string",
"example": "25% per referral"
},
"property_files": {
"type": "array",
"items": {
"type": "string",
"example": "https://www.easybroker.com/assets/product/logo-be4da843987ccd1c05e26f8703f1787847471b36d08bdb1ec8a91ce4007b0e98.svg"
}
},
"videos": {
"type": "array",
"items": {
"type": "string",
"example": "https://www.youtube.com/watch?v=zVRu7AktR48"
}
},
"virtual_tour": {
"type": "string",
"example": "https://my.matterport.com/show/?m=yHsh2roFXnp"
},
"exclusive": {
"type": "boolean",
"nullable": true,
"example": false,
"description": "Indicates whether the listing is exclusive. Set to `null` if not specified."
},
"shared_commission_percentage": {
"type": "number",
"nullable": true,
"example": 50,
"description": "Indicates the percentage of the agency fee that is shared. At the moment, it can only contain 50% or `null` if not specified."
}
}
},
"PropertySingle": {
"allOf": [
{
"$ref": "#/components/schemas/PropertySingleBase"
},
{
"properties": {
"private_description": {
"type": "string",
"example": "Selling this property is our top priority and we are willing to offer a discount."
},
"location": {
"$ref": "#/components/schemas/PropertyLocation"
},
"tags": {
"type": "array",
"example": [
"premium",
"exclusive"
],
"items": {
"type": "string"
}
},
"show_prices": {
"type": "boolean",
"example": true
},
"share_commission": {
"type": "boolean",
"example": true
},
"operations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PropertyOperationWithCommission"
}
}
}
}
]
},
"PropertyOperationWithCommission": {
"oneOf": [
{
"$ref": "#/components/schemas/PropertyOperationSaleOrRentalWithCommission"
},
{
"$ref": "#/components/schemas/PropertyOperationTemporaryRental"
}
]
},
"PropertyOperationSaleOrRentalWithCommission": {
"properties": {
"type": {
"type": "string",
"enum": [
"sale",
"rental"
]
},
"amount": {
"type": "number",
"format": "double",
"example": 500000
},
"formatted_amount": {
"type": "string",
"example": "$500,000 USD"
},
"currency": {
"type": "string",
"example": "USD"
},
"unit": {
"type": "string",
"enum": [
"total",
"square_meter",
"hectare"
],
"description": "Some properties, like warehouses, are sold and rented per square meter. Some terrains are rented per hectare."
},
"commission": {
"$ref": "#/components/schemas/PropertyCommission"
}
}
},
"PropertyCommission": {
"properties": {
"type": {
"type": "string",
"enum": [
"percentage",
"months",
"amount"
],
"example": "amount",
"description": "Months type only applies for rental operation."
},
"value": {
"type": "number",
"format": "double",
"example": 10000
},
"currency": {
"type": "string",
"example": "USD"
}
}
},
"PropertyOperationTemporaryRental": {
"required": [
"type",
"currency"
],
"properties": {
"type": {
"type": "string",
"example": "temporary_rental"
},
"amount": {
"type": "number",
"format": "double",
"example": 500
},
"formatted_amount": {
"type": "string",
"example": "$500 USD"
},
"currency": {
"type": "string",
"example": "USD"
},
"period": {
"type": "string",
"enum": [
"monthly",
"weekly",
"daily"
],
"description": "Used for temporary rentals"
}
}
},
"PropertyImage": {
"properties": {
"url": {
"type": "string",
"example": "https://www.easybroker.com/assets/product/logo-be4da843987ccd1c05e26f8703f1787847471b36d08bdb1ec8a91ce4007b0e98.svg"
},
"title": {
"type": "string",
"example": "Fitted kitchen with granite countertops"
}
}
},
"PropertyFeature": {
"properties": {
"name": {
"type": "string",
"example": "Pets allowed"
},
"category": {
"type": "string",
"example": "General"
}
}
},
"PropertyLocationBase": {
"required": [
"name",
"show_exact_location"
],
"properties": {
"name": {
"type": "string",
"example": "Condesa, Cuauhtemoc, Ciudad de México"
},
"latitude": {
"type": "number",
"example": 20.676145
},
"longitude": {
"type": "number",
"example": -103.368962
},
"street": {
"type": "string",
"example": "Av. México"
},
"postal_code": {
"type": "string",
"example": "06700"
},
"show_exact_location": {
"type": "boolean",
"example": true
}
}
},
"PropertyLocation": {
"allOf": [
{
"$ref": "#/components/schemas/PropertyLocationBase"
},
{
"properties": {
"exterior_number": {
"type": "string",
"example": "21A",
"description": "The property address exterior number."
},
"interior_number": {
"type": "string",
"example": "304",
"description": "The property address interior number."
}
}
}
]
},
"Agent": {
"properties": {
"id": {
"type": "integer",
"example": 1234
},
"name": {
"type": "string",
"example": "John Smith"
},
"full_name": {
"type": "string",
"example": "John Smith Doe"
},
"mobile_phone": {
"type": "string",
"example": "5555550000"
},
"profile_image_url": {
"type": "string",
"example": "https://www.easybroker.com/assets/product/logo-be4da843987ccd1c05e26f8703f1787847471b36d08bdb1ec8a91ce4007b0e98.svg"
},
"email": {
"type": "string",
"example": "john@smith.com"
}
}
}
},
"securitySchemes": {
"ApiKeyAuth": {
"type": "apiKey",
"in": "header",
"name": "X-Authorization",
"description": "You can find your API key in the general settings section of your EasyBroker account. It's only accessible for account administrators."
}
}
},
"x-readme": {
"explorer-enabled": true,
"proxy-enabled": true
},
"_id": {
"buffer": {
"0": 99,
"1": 142,
"2": 110,
"3": 111,
"4": 217,
"5": 194,
"6": 135,
"7": 0,
"8": 24,
"9": 185,
"10": 196,
"11": 37
}
}
}