# Available widgets

Endpoint:

GET /api/rest/portal/home-featured-listings

This endpoint will return a non-paginated collection of the listings to be displayed on the home page.

It allows the optional QueryString parameter size (default value is 6) to specify the maximum number of listings to return.

All responses are JSON encoded, and when the request is correct, the object will contain a unique field data, with the collection of listing details, using the same object structure as the ones returned by the search.

# Similar listings

Endpoint:

GET /api/rest/portal/listings/{id}/similar

This endpoint will return a non-paginated collection of the listings that are more alike the listing referenced by the id.

It allows the optional QueryString parameter size (default value is 3) to specify the maximum number of listings to return.

All responses are JSON encoded, and when the request is correct, the object will contain a unique field data, with the collection of listing details, using the same object structure as the ones returned by the search.

# Alternative endpoint

There exists an alternative endpoints when you use friendly urls and don't expose the id of the listings, but their slug.

GET /api/rest/portal/listings/slug/{slug}/similar

Where slug is the listing slug field returned in any of its resources.