Product Catalog Home Listings

Updated: Mar 19, 2025

Copy for LLM

Reading

Endpoint that return the home listings that were added to the catalog

Select language

GET /v25.0/{product-catalog-id}/home_listings HTTP/1.1
Host: graph.facebook.com

If you want to learn how to use the Graph API, read our Using Graph API guide

Parameter	Description
`bulk_pagination` boolean	Used for iterating over the edge in large chunks
`filter` A JSON-encoded rule	JSON-encoded WCA rule expression representing the filter to be applied for the edge

Reading from this edge will return a JSON formatted result:

{
"data": [],
"paging": {},
"summary": {}
}

A list of HomeListing nodes.

For more details about pagination, see the Graph API guide.

Aggregated information about the edge, such as counts. Specify the fields to fetch in the summary param (like summary=total_count).

Field	Description
`total_count` unsigned int32	Total number of home listings returned by the query

Error Code	Description
100	Invalid parameter

You can make a POST request to home_listings edge from the following paths:

When posting to this edge, a HomeListing will be created.

Parameter	Description
`address` Object	The address of the home listing required `city` string required `country` string required `latitude` float required `longitude` float required `neighborhoods` list<string> `postal_code` string `region` string required `street_address` string required Show child parameters
`availability` string	The availability of the home listing required
`currency` ISO 4217 Currency Code	Currency for the listing required
`description` string	Description of the home listing
`home_listing_id` string	ID of the home listing required
`images` list<Object>	Links to home listing images. Please note that carousel format utilizes a square 1:1 aspect ratio images (recommended size - 600x600px) while single hotel ad uses 1.91:1 aspect ratio image(recommended size - 1200x630px). Please provide at least one image. required `image_url` URL required `tags` list<string> Show child parameters
`listing_type` string	Listing type of the property
`name` string	Name of the home listing required
`num_baths` float	Number of baths for the home listing
`num_beds` float	Number of beds for the home listing
`num_units` float	Number of units for the home listing
`price` float	The price for this home listing required
`property_type` string	Property type of the home listing
`url` URL	Link to the external site where you can view the listing required
`year_built` int64	Year built required

This endpoint supports read-after-write and will read the node represented by id in the return type.

Struct  {
id: numeric string,
}

Error Code	Description
10800	Duplicate retailer_id when attempting to create a store collection
100	Invalid parameter

You can't perform this operation on this endpoint.

You can't perform this operation on this endpoint.