Mapaprop
PROD

Returns the properties the customer marked as featured for their website, in the order they arranged.

Resource information
AuthenticationRequired (API Token, Bearer)
Scopeexpress-base
HTTP methodGET
ResponseJSON
Version1

Resource URL

https://mapaprop.app/api/action/express-v1/featureds

Example request

GET /api/action/express-v1/featureds HTTP/1.1
Host: mapaprop.app
Authorization: Bearer {access_token}

Parameters

NameTypeRequiredDescription
fromintnoWhich featured property to start from. Defaults to 0. Use it to ask for the second page, the third, and so on.
sizeintnoHow many featured properties to return. Defaults to 20, which is also the maximum; above that the service answers with an error.

Response

A JSON document with the same shape as GET /api/action/express-v1/properties: the customer's choice is a filter and an order, not a different kind of object, so the properties arrive with the same fields and can be rendered with the same code.

🔴 The order matters and it is the one the customer set in their panel. The list arrives already sorted: do not re-sort it.

A featured property that is not published —sold, suspended or unpublished— simply does not appear. Featuring decides what is shown first, not whether it may be shown.

If the customer marked no featured properties, the response is the empty list, with the same shape.

If there are more than 20

The total field says how many featured properties the site has in total, not how many this response carries. If total is greater than the properties you received, ask for the next page with from:

GET /api/action/express-v1/featureds?from=0&size=20
GET /api/action/express-v1/featureds?from=20&size=20

A from past the last featured property returns the empty list with the real total, not an error.

⚠️ A page may carry fewer properties than the size you asked for: featured properties that are not published do not come back (see above). That is why you page by total, instead of expecting every page to come back full.

Example response

{
  "took": 3,
  "total": 9,
  "properties": [
    {
      "propertyId": 2603801,
      "code": "1-AB1234",
      "title": "...",
      "propertyOperation": "...",
      "propertyType": "...",
      "price": 185000,
      "currency": "USD",
      "photos": ["https://images.mapaprop.app/photos/1/2603801/3025164.jpg"]
    }
  ]
}