Ferguson Home Search API
Search Ferguson Home products and capture structured listings in real-time
A GET request to our endpoint /api/getter/?platform="fergusonhome_search"
returns the same rich dataset shoppers see on FergusonHome.com—complete with pricing, variant availability, and merchandising flags.
Example
Here's how you can fetch live listings for "Pedestal Bathroom Sinks" from Ferguson Home.
1 |
|
1 2 3 4 5 |
|
1 2 3 |
|
1 2 3 4 5 6 |
|
1 2 3 4 5 6 |
|
Query Parameters
Search Query
search
Required
The keyword or phrase you want to search on Ferguson Home. Supports product names, collections, categories, brands, and long-tail queries.
page
Optional
Results page to fetch. Defaults to 1. Each page currently returns up to 24 products with full merchandising details.
Required Authentication
platform
Required
Must be set to fergusonhome_search to invoke the Ferguson Home crawler.
api_key
Required
Your Unwrangle API token for authentication and billing. Pass in the query string as shown above or via the Authorization
header.
Response Attributes
Attributes Returned | Data Type | Information Represented |
---|---|---|
id | int | Retailer ID of product listing |
name | string | Name of product listing |
brand | string | Brand name of product |
family_id | int | ID of the product family |
model_no | string | Model number of product |
url | string | URL of product listing |
rating | float | Average rating of product |
total_ratings | int | Total number of ratings received by product |
is_configurable | boolean | Indicates if product has configurable options |
is_square_footage_based | boolean | Indicates if product is priced by square footage |
is_appointment_only_brand | boolean | Indicates if brand requires appointment for purchase |
variant_count | int | Number of variants available for the product |
has_in_stock_variants | boolean | Indicates if any variants are in stock |
all_variants_in_stock | boolean | Indicates if all variants are in stock |
total_inventory_quantity | int | Total inventory quantity across all variants |
in_stock_variant_count | int | Number of variants that are in stock |
all_variants_restricted | boolean | Indicates if all variants have purchase restrictions |
price | float | Current price of product |
price_min | float | Lowest price among variants |
price_max | float | Highest price among variants |
unit_price | float/null | Price per unit (if applicable) |
currency | string | Currency of product price |
price_type | string | Type of pricing (e.g., "STANDARD") |
images | array | Array of image URLs for product |
thumbnail | string | URL of product thumbnail image |
variants[].id | int | ID of variant |
variants[].name | string | Name of variant |
variants[].model_no | string | Model number of variant |
variants[].swatch_color | string | Hex color code for variant swatch |
variants[].url | string | URL of variant |
variants[].is_quick_ship | boolean | Indicates if variant is eligible for quick shipping |
variants[].shipping_info | string | Shipping information for variant |
variants[].has_free_shipping | boolean | Indicates if variant has free shipping |
variants[].price | float | Price of variant |
variants[].unit_price | float/null | Price per unit for variant (if applicable) |
variants[].image | string | URL of variant image |
variants[].thumbnail | string | URL of variant thumbnail image |
variants[].availability_status | string | Availability status of variant |
variants[].in_stock | boolean | Indicates if variant is in stock |
variants[].inventory_quantity | int | Inventory quantity of variant |
variants[].is_product_restricted | boolean | Indicates if variant has purchase restrictions |
features[].name | string | Name of product feature |
features[].value | string | Value of product feature |
collection.name | string | Name of collection the product belongs to |
collection.url | string | URL of the collection |
is_quick_ship | boolean | Indicates if product is eligible for quick shipping |
shipping_info | string | Shipping information for the product |
meta_data.search_engine | string | The Ferguson search engine powering the results (e.g., FUSION ) |
credits_used | float | Credits deducted for the request |
Response Example
{
"success": true,
"platform": "fergusonhome_search",
"search": "Pedestal Bathroom Sinks",
"page": 1,
"total_results": 451,
"no_of_pages": 19,
"result_count": 24,
"results": [
{
"name": "Cimarron Pedestal Bathroom Sink with 8\" Widespread Faucet Holes",
"brand": "Kohler",
"id": 165232,
"family_id": 560423,
"model_no": "K-2362-8",
"url": "https://www.fergusonhome.com/kohler-k-2362-8/s560423?uid=165232",
"rating": 5,
"total_ratings": 4,
"is_configurable": false,
"is_square_footage_based": false,
"is_appointment_only_brand": false,
"variant_count": 3,
"has_in_stock_variants": true,
"all_variants_in_stock": true,
"total_inventory_quantity": 149,
"in_stock_variant_count": 3,
"all_variants_restricted": false,
"price": 366.75,
"price_min": 366.75,
"price_max": 548.06,
"unit_price": null,
"currency": "USD",
"price_type": "STANDARD",
"images": [
"https://www.fergusonhome.com/content/dam/ferguson/product/kohler/kohler-k-2362-8-0-9288141.jpg"
],
"thumbnail": "https://www.fergusonhome.com/content/dam/ferguson/product/kohler/kohler-k-2362-8-0-9288141.jpg",
"variants": [
{
"id": 165219,
"name": "Biscuit",
"model_no": "K-2362-8-96",
"swatch_color": "ded6cc",
"url": "https://www.fergusonhome.com/kohler-k-2362-8/s560423?uid=165219",
"is_quick_ship": false,
"shipping_info": "",
"has_free_shipping": false,
"price": 476.85,
"unit_price": null,
"image": "https://www.fergusonhome.com/content/dam/ferguson/product/kohler/kohler-k-2362-8-96-9288141.jpg",
"thumbnail": "https://www.fergusonhome.com/content/dam/ferguson/product/kohler/kohler-k-2362-8-96-9288141.jpg",
"availability_status": "in_stock",
"in_stock": true,
"inventory_quantity": 0,
"is_product_restricted": false
},
{
"id": 165220,
"name": "Black",
"model_no": "K-2362-8-7",
"swatch_color": "000000",
"url": "https://www.fergusonhome.com/kohler-k-2362-8/s560423?uid=165220",
"is_quick_ship": false,
"shipping_info": "",
"has_free_shipping": false,
"price": 548.06,
"unit_price": null,
"image": "https://www.fergusonhome.com/content/dam/ferguson/product/kohler/kohler-k-2362-8-7-9288141.jpg",
"thumbnail": "https://www.fergusonhome.com/content/dam/ferguson/product/kohler/kohler-k-2362-8-7-9288141.jpg",
"availability_status": "in_stock",
"in_stock": true,
"inventory_quantity": 0,
"is_product_restricted": false
},
{
"id": 165232,
"name": "White",
"model_no": "K-2362-8-0",
"swatch_color": "ffffff",
"url": "https://www.fergusonhome.com/kohler-k-2362-8/s560423?uid=165232",
"is_quick_ship": false,
"shipping_info": "",
"has_free_shipping": false,
"price": 366.75,
"unit_price": null,
"image": "https://www.fergusonhome.com/content/dam/ferguson/product/kohler/kohler-k-2362-8-0-9288141.jpg",
"thumbnail": "https://www.fergusonhome.com/content/dam/ferguson/product/kohler/kohler-k-2362-8-0-9288141.jpg",
"availability_status": "in_stock",
"in_stock": true,
"inventory_quantity": 149,
"is_product_restricted": false
}
],
"features": [
{
"name": "Faucet Holes",
"value": "3"
},
{
"name": "Installation Type",
"value": "Pedestal"
},
{
"name": "Length",
"value": "22.75"
},
{
"name": "Material",
"value": "Vitreous China"
},
{
"name": "Sink Shape",
"value": "Rectangular"
},
{
"name": "Width",
"value": "18.875"
}
],
"collection": {
"name": "Cimarron",
"url": "https://www.fergusonhome.com/collection/Kohler/Cimarron"
},
"is_quick_ship": false,
"shipping_info": ""
},
{
"name": "Ravenna Pedestal Bathroom Sink with Pedestal, Single Faucet Hole, 24-1/4\" Length and Overflow",
"brand": "American Standard",
"id": 3295,
"family_id": 10823,
"model_no": "0268.100",
"url": "https://www.fergusonhome.com/american-standard-0268-100/s10823?uid=3295",
"rating": 4.77,
"total_ratings": 35,
"is_configurable": false,
"is_square_footage_based": false,
"is_appointment_only_brand": false,
"variant_count": 1,
"has_in_stock_variants": true,
"all_variants_in_stock": true,
"total_inventory_quantity": 44,
"in_stock_variant_count": 1,
"all_variants_restricted": false,
"price": 237.9,
"price_min": 237.9,
"price_max": 237.9,
"unit_price": null,
"currency": "USD",
"price_type": "STANDARD",
"images": [
"https://www.fergusonhome.com/content/dam/ferguson/product/americanstandard/0268.100.jpg"
],
"thumbnail": "https://www.fergusonhome.com/content/dam/ferguson/product/americanstandard/0268.100.jpg",
"variants": [
{
"id": 3295,
"name": "White",
"model_no": "268100.02",
"swatch_color": "ffffff",
"url": "https://www.fergusonhome.com/american-standard-0268-100/s10823?uid=3295",
"is_quick_ship": false,
"shipping_info": "",
"has_free_shipping": false,
"price": 237.9,
"unit_price": null,
"image": "https://www.fergusonhome.com/content/dam/ferguson/product/americanstandard/0268.100.jpg",
"thumbnail": "https://www.fergusonhome.com/content/dam/ferguson/product/americanstandard/0268.100.jpg",
"availability_status": "in_stock",
"in_stock": true,
"inventory_quantity": 44,
"is_product_restricted": false
}
],
"features": [
{
"name": "Faucet Holes",
"value": "1"
},
{
"name": "Installation Type",
"value": "Pedestal"
},
{
"name": "Length",
"value": "24.5"
},
{
"name": "Material",
"value": "Vitreous China"
},
{
"name": "Sink Shape",
"value": "Oval"
},
{
"name": "Width",
"value": "20"
}
],
"collection": {
"name": "Ravenna",
"url": "https://www.fergusonhome.com/collection/American%20Standard/Ravenna"
},
"is_quick_ship": false,
"shipping_info": ""
},
{
"name": "Veer 24\" Pedestal Bathroom Sink with Three Holes Drilled and Overflow",
"brand": "Kohler",
"id": 2242345,
"family_id": 881834,
"model_no": "K-5248-4",
"url": "https://www.fergusonhome.com/kohler-k-5248-4/s881834?uid=2242345",
"rating": 5,
"total_ratings": 3,
"is_configurable": true,
"is_square_footage_based": false,
"is_appointment_only_brand": false,
"variant_count": 1,
"has_in_stock_variants": true,
"all_variants_in_stock": true,
"total_inventory_quantity": 57,
"in_stock_variant_count": 1,
"all_variants_restricted": false,
"price": 106.11,
"price_min": 106.11,
"price_max": 106.11,
"unit_price": null,
"currency": "USD",
"price_type": "STANDARD",
"images": [
"https://www.fergusonhome.com/content/dam/ferguson/product/kohler/kohler-k-5248-4-0-9288141.jpg"
],
"thumbnail": "https://www.fergusonhome.com/content/dam/ferguson/product/kohler/kohler-k-5248-4-0-9288141.jpg",
"variants": [
{
"id": 2242345,
"name": "White",
"model_no": "K-5248-4-0",
"swatch_color": "ffffff",
"url": "https://www.fergusonhome.com/kohler-k-5248-4/s881834?uid=2242345",
"is_quick_ship": true,
"shipping_info": "FREE 2-Day Shipping",
"has_free_shipping": false,
"price": 106.11,
"unit_price": null,
"image": "https://www.fergusonhome.com/content/dam/ferguson/product/kohler/kohler-k-5248-4-0-9288141.jpg",
"thumbnail": "https://www.fergusonhome.com/content/dam/ferguson/product/kohler/kohler-k-5248-4-0-9288141.jpg",
"availability_status": "in_stock",
"in_stock": true,
"inventory_quantity": 57,
"is_product_restricted": false
}
],
"features": [
{
"name": "Faucet Holes",
"value": "3"
},
{
"name": "Installation Type",
"value": "Pedestal"
},
{
"name": "Length",
"value": "24"
},
{
"name": "Material",
"value": "Vitreous China"
},
{
"name": "Sink Shape",
"value": "Rectangular"
},
{
"name": "Width",
"value": "18.25"
}
],
"collection": {
"name": "Veer",
"url": "https://www.fergusonhome.com/collection/Kohler/Veer"
},
"is_quick_ship": true,
"shipping_info": "FREE 2-Day Shipping"
},
...,
...,
{
"name": "Promenade 27-1/2\" Pedestal Bathroom Sink with 3 Faucet Holes Drilled and Overflow - Less Pedestal",
"brand": "TOTO",
"id": 181542,
"family_id": 592155,
"model_no": "LT530.8",
"url": "https://www.fergusonhome.com/toto-lt530-8/s592155?uid=181542",
"rating": 4.75,
"total_ratings": 4,
"is_configurable": false,
"is_square_footage_based": false,
"is_appointment_only_brand": false,
"variant_count": 5,
"has_in_stock_variants": true,
"all_variants_in_stock": true,
"total_inventory_quantity": 11,
"in_stock_variant_count": 5,
"all_variants_restricted": false,
"price": 304.38,
"price_min": 304.38,
"price_max": 583.8,
"unit_price": null,
"currency": "USD",
"price_type": "STANDARD",
"images": [
"https://www.fergusonhome.com/content/dam/ferguson/product/toto/toto-lt530-811-210.jpg"
],
"thumbnail": "https://www.fergusonhome.com/content/dam/ferguson/product/toto/toto-lt530-811-210.jpg",
"variants": [
{
"id": 181541,
"name": "Bone",
"model_no": "LT530.8#03",
"swatch_color": "DDD4BB",
"url": "https://www.fergusonhome.com/toto-lt530-8/s592155?uid=181541",
"is_quick_ship": false,
"shipping_info": "",
"has_free_shipping": false,
"price": 400,
"unit_price": null,
"image": "https://www.fergusonhome.com/content/dam/ferguson/product/toto/toto-lt530-803-209.jpg",
"thumbnail": "https://www.fergusonhome.com/content/dam/ferguson/product/toto/toto-lt530-803-209.jpg",
"availability_status": "in_stock",
"in_stock": true,
"inventory_quantity": 0,
"is_product_restricted": false
},
{
"id": 181542,
"name": "Colonial White",
"model_no": "LT530.8#11",
"swatch_color": "FFF5E3",
"url": "https://www.fergusonhome.com/toto-lt530-8/s592155?uid=181542",
"is_quick_ship": false,
"shipping_info": "",
"has_free_shipping": false,
"price": 304.38,
"unit_price": null,
"image": "https://www.fergusonhome.com/content/dam/ferguson/product/toto/toto-lt530-811-210.jpg",
"thumbnail": "https://www.fergusonhome.com/content/dam/ferguson/product/toto/toto-lt530-811-210.jpg",
"availability_status": "in_stock",
"in_stock": true,
"inventory_quantity": 6,
"is_product_restricted": false
},
{
"id": 181543,
"name": "Cotton",
"model_no": "LT530.8#01",
"swatch_color": "DDDAD5",
"url": "https://www.fergusonhome.com/toto-lt530-8/s592155?uid=181543",
"is_quick_ship": false,
"shipping_info": "",
"has_free_shipping": false,
"price": 389.18,
"unit_price": null,
"image": "https://www.fergusonhome.com/content/dam/ferguson/product/toto/toto-lt530-801-211.jpg",
"thumbnail": "https://www.fergusonhome.com/content/dam/ferguson/product/toto/toto-lt530-801-211.jpg",
"availability_status": "in_stock",
"in_stock": true,
"inventory_quantity": 5,
"is_product_restricted": false
},
{
"id": 181544,
"name": "Ebony",
"model_no": "LT530.8#51",
"swatch_color": "000000",
"url": "https://www.fergusonhome.com/toto-lt530-8/s592155?uid=181544",
"is_quick_ship": false,
"shipping_info": "",
"has_free_shipping": false,
"price": 583.8,
"unit_price": null,
"image": "https://www.fergusonhome.com/content/dam/ferguson/product/toto/toto-lt530-851-212.jpg",
"thumbnail": "https://www.fergusonhome.com/content/dam/ferguson/product/toto/toto-lt530-851-212.jpg",
"availability_status": "in_stock",
"in_stock": true,
"inventory_quantity": 0,
"is_product_restricted": false
},
{
"id": 181546,
"name": "Sedona Beige",
"model_no": "LT530.8#12",
"swatch_color": "f2f0e4",
"url": "https://www.fergusonhome.com/toto-lt530-8/s592155?uid=181546",
"is_quick_ship": false,
"shipping_info": "",
"has_free_shipping": false,
"price": 360,
"unit_price": null,
"image": "https://www.fergusonhome.com/content/dam/ferguson/product/toto/toto-lt530-812-213.jpg",
"thumbnail": "https://www.fergusonhome.com/content/dam/ferguson/product/toto/toto-lt530-812-213.jpg",
"availability_status": "in_stock",
"in_stock": true,
"inventory_quantity": 0,
"is_product_restricted": false
}
],
"features": [
{
"name": "Faucet Holes",
"value": "3"
},
{
"name": "Installation Type",
"value": "Pedestal"
},
{
"name": "Length",
"value": "27.5"
},
{
"name": "Material",
"value": "Vitreous China"
},
{
"name": "Sink Shape",
"value": "Rectangular"
},
{
"name": "Width",
"value": "22.25"
}
],
"collection": {
"name": "Promenade",
"url": "https://www.fergusonhome.com/collection/TOTO/Promenade"
},
"is_quick_ship": false,
"shipping_info": ""
}
],
"meta_data": {
"search_id": "CvnETWIcMf",
"search_engine": "FUSION",
"corrected_search_term": null,
"base_category": "Plumbing",
"business_category": "Bathroom Sinks"
},
"credits_used": 10,
"remaining_credits": 9952897.5
}
Request Cost
10 credits are deducted for each successful search request. Batch submissions consume credits per payload inside the batch.
Support
Need help, want to enable batch access, or looking for additional attributes? Reach out to us at support@unwrangle.com