Skip to main content
Buildify provides a comprehensive API for accessing listings data. In this article, we’ll describe the available endpoints for listings and the details of each one. Below are the available endpoints:

1. Search Listings

The Search Listings endpoint allows you to search for listings based on various parameters such as product id, search string, pagination, facets, and more.

Request Parameters

Here’s a list of request parameters that you can use when requesting the Search Listings endpoint:

Response Payload

Following is an example of a response object based on the parameters defined in the request:
JSON

2. Get A Listing

The Get A Listing endpoint allows you to retrieve a single listing by its unique identifier.

Request Parameters

The Get A Listing endpoint supports the following request parameters:

Response Payload

The response payload with contain the details of the specified listing, as shown in an example below:

3. Get Multiple Listings

The Get Multiple Listings allows you to retrieve multiple listings using a list of unique identifiers.

Request Parameters

The Get Multiple Listings endpoint supports the following request parameters:

Response Payload

The response payload will contain the details of all the listings specified in the request, as shown below.
JSON

5. Get Similar Listings

The Get Similar Listings endpoint retrieves similar listings for the given listing.

Request Parameters

The Get Similar Listings endpoint supports the following request parameters:

Response Payload

Following is a response example:

6. Get Facets Of Listing

The Get Facets Of Listing endpoint retrieves facet information of the given listing.

Request Parameters

The Get Facets Of Listing endpoint supports the following request parameters:

Response Payload

Here’s an example of the ` Get Facets Of Listing endpoint’s response payload:
The Get Trending Listings endpoint is used to retrieve the most trending listings.

Request Parameters

The Get Trending Listings endpoint supports the following request parameters:

Response Payload

Below is a response example for Get Trending Listings endpoint.