NAV
php

Introduction

Welcome to the Homeyou website API documentation.

This documentation provides comprehensive information about the Homeyou website API endpoints.

States

This is the states data retrieve service.

List

To get the states list data:

<?php
$url = "http://api.homeyou.com/state/list?token=TOKEN";

$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_POST, false);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($ch);
$err = curl_error($ch);
curl_close($ch);

echo $response; 
?>

Example response:

[
    {
        "abbreviation_state": "AK",
        "nm_state": "Alaska",
        "url_state": "alaska"
    },
    {
        "abbreviation_state": "AL",
        "nm_state": "Alabama",
        "url_state": "alabama"
    },
    {
        "abbreviation_state": "AR",
        "nm_state": "Arkansas",
        "url_state": "arkansas"
    }
    ...
]

Retrieve information about the currently authenticated user.

HTTP Request

GET /state/list?token=TOKEN

Token url query param

Parameter Description
token API token

Costs

This is the costs data retrieve service. The endpoints in this area allow us to retrieve information about all costs pages data.

Index

To get the costs index page data:

<?php
$url = "http://api.homeyou.com/costs?token=TOKEN";

$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_POST, false);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($ch);
$err = curl_error($ch);
curl_close($ch);

echo $response; 
?>

Example response:

{
    "seoTitle": "2025 Home Improvement Service Cost Guides | homeyou",
    "seoDescription": "The homeyou Cost Guides help you estimate the cost of home improvement projects in your city. Get accurate estimates home repair and remodeling projects.",
    "topServices": [
        {
            "title": "Painting",
            "imageUrl": "https://www.homeyou.com/images/directory/popular/painting.jpg",
            "url": "https://www.homeyou.com/costs/painting",
            "slug": "painting"
        },
        {
            "title": "Landscaping",
            "imageUrl": "https://www.homeyou.com/images/directory/popular/landscaping.jpg",
            "url": "https://www.homeyou.com/costs/landscaping",
            "slug": "landscaping"
        }
        ...
    ],
    "services": {
        "Additions and Remodels": {
            "title": "Additions and Remodels",
            "url": "https://www.homeyou.com/additions-and-remodels-cost",
            "slug": "additions-and-remodels",
            "services": [
                {
                    "title": "Basement Remodeling",
                    "url": "https://www.homeyou.com/costs/basement-remodeling",
                    "slug": "basement-remodeling"
                },
                {
                    "title": "Custom Garages",
                    "url": "https://www.homeyou.com/costs/custom-garages",
                    "slug": "custom-garages"
                },
                {
                    "title": "Garage Remodeling",
                    "url": "https://www.homeyou.com/costs/garage-remodeling",
                    "slug": "garage-remodeling"
                }
                ...
            ]
        },
        "Appliances": {
            "title": "Appliances",
            "url": "https://www.homeyou.com/appliances-cost",
            "slug": "appliances",
            "services": [
                {
                    "title": "Appliance Repair",
                    "url": "https://www.homeyou.com/costs/appliance-repair",
                    "slug": "appliance-repair"
                },
                {
                    "title": "Commercial Refrigeration Repair",
                    "url": "https://www.homeyou.com/costs/commercial-refrigeration-repair",
                    "slug": "commercial-refrigeration-repair"
                },
                {
                    "title": "Dryer Repair",
                    "url": "https://www.homeyou.com/costs/dryer-repair",
                    "slug": "dryer-repair"
                },
                {
                    "title": "Oven Repair",
                    "url": "https://www.homeyou.com/costs/oven-repair",
                    "slug": "oven-repair"
                },
                {
                    "title": "Refrigerator Repair",
                    "url": "https://www.homeyou.com/costs/refrigerator-repair",
                    "slug": "refrigerator-repair"
                }
                ...
            ]
        }
        ...
    },
    "servicesList": [
        {
            "id": "",
            "title": "HVAC",
            "children": [
                {
                    "id": "%7B%22category%22%3A%228%22%2C%22service%22%3A%22234%22%7D",
                    "title": "AC Companies"
                },
                {
                    "id": "%7B%22category%22%3A%228%22%2C%22service%22%3A%22233%22%7D",
                    "title": "AC Installation"
                },
                ...
            ]
        },
        {
            "id": "",
            "title": "Siding",
            "children": [
                {
                    "id": "%7B%22category%22%3A%2221%22%2C%22service%22%3A%22337%22%7D",
                    "title": "Aluminum Siding Repair"
                },
                {
                    "id": "%7B%22category%22%3A%2221%22%2C%22service%22%3A%22354%22%7D",
                    "title": "Fiber Cement Siding"
                },
                ...
            ]
        }
        ...
    ]
}

HTTP Request

GET /costs?token=TOKEN

Token url query param

Parameter Description
token API token

States By Service

To get the costs states by service page data:

<?php
$url = "http://api.homeyou.com/costs/states-by-service/<service_slug>?token=TOKEN";

$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_POST, false);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($ch);
$err = curl_error($ch);
curl_close($ch);

echo $response; 
?>

Example response:

{
    "title": "AC Companies",
    "states": [
        {
            "title": "Alaska",
            "url": "https://www.homeyou.com/costs/ac-companies/ak",
            "prefix_state": "AK"
        },
        {
            "title": "Alabama",
            "url": "https://www.homeyou.com/costs/ac-companies/al",
            "prefix_state": "AL"
        },
        {
            "title": "Arkansas",
            "url": "https://www.homeyou.com/costs/ac-companies/ar",
            "prefix_state": "AR"
        },
        {
            "title": "Arizona",
            "url": "https://www.homeyou.com/costs/ac-companies/az",
            "prefix_state": "AZ"
        }
        ...
    ],
    "seoTitle": "2025 AC Companies Cost | How Much to hire an AC company - homeyou",
    "seoDescription": "The homeyou AC Companies cost guides help you estimate the cost to hire an AC company in your city. Get accurate estimates on AC Companies, as reported by homeyou customers."
}

HTTP Request

GET /costs/states-by-service/<service_slug>?token=TOKEN

Path params

Parameter Description
service_slug Service Slug

Url query param

Parameter Description
token API token

Cities by State and Service

To get the costs cities by state and service page data:

<?php
$url = "http://api.homeyou.com/costs/cities-by-state-and-service/<state_prefix>/<service_slug>?token=TOKEN";

$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_POST, false);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($ch);
$err = curl_error($ch);
curl_close($ch);

echo $response; 
?>

Example response:

{
    "seoTitle": "2025 Alaska AC Companies Costs | How Much to hire an AC company - homeyou",
    "seoDescription": "The homeyou Alaska AC Companies cost guides help you estimate the cost to hire an AC company in Alaska. Get accurate estimates on AC Companies, as reported by homeyou customers.",
    "title": "2025 Alaska AC Companies Cost Guides",
    "serviceName": "AC Companies",
    "topCities": [
        {
            "title": "Anchorage",
            "url": "https://www.homeyou.com/ak/ac-companies-anchorage-costs",
            "slug": "ak-ac-companies-anchorage-costs"
        },
        {
            "title": "Fairbanks",
            "url": "https://www.homeyou.com/ak/ac-companies-fairbanks-costs",
            "slug": "ak-ac-companies-fairbanks-costs"
        },
        {
            "title": "Juneau",
            "url": "https://www.homeyou.com/ak/ac-companies-juneau-costs",
            "slug": "ak-ac-companies-juneau-costs"
        }
        ...
    ],
    "additionalCities": [
        {
            "title": "Eielson Afb",
            "url": "https://www.homeyou.com/ak/ac-companies-eielson-afb-costs",
            "slug": "ak-ac-companies-eielson-afb-costs"
        },
        {
            "title": "Sterling",
            "url": "https://www.homeyou.com/ak/ac-companies-sterling-costs",
            "slug": "ak-ac-companies-sterling-costs"
        },
        {
            "title": "Kodiak",
            "url": "https://www.homeyou.com/ak/ac-companies-kodiak-costs",
            "slug": "ak-ac-companies-kodiak-costs"
        }
    ]
}

HTTP Request

GET /costs/cities-by-state-and-service/<state_prefix>/<service_slug>?token=TOKEN

Path params

Parameter Description
service_slug Service Slug
state_prefix State Prefix

Url query param

Parameter Description
token API token

Service Landing Page

To get the costs service landing page data:

<?php
$url = "http://api.homeyou.com/costs/service-landing-page/<service_slug>?token=TOKEN";

$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_POST, false);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($ch);
$err = curl_error($ch);
curl_close($ch);

echo $response; 
?>

Example response:

{
    "seoTitle": "AC Companies in Anchorage, AK - Costs 05 / 2025 - homeyou",
    "seoDescription": "AC Companies Cost Guide offers cost estimates on AC Companies in Anchorage. Get accurate prices to AC Companies in Anchorage for 2025, as reported by homeyou customers.",
    "title": "How Much Does it Cost to Hire an AC Company in Anchorage?",
    "category": "8",
    "serviceName": "AC Companies",
    "serviceSlug": "ac-companies",
    "categoryName": "HVAC",
    "categorySlug": "hvac",
    "cityName": "Anchorage",
    "stateCode": "AK",
    "zipCode": "99501",
    "phoneTitle": "1-844-HOMEYOU",
    "phoneNumber": "+12123456789",
    "relatedQuestionsTitle": "What type of project is this?",
    "firstParagraphText": "<p>First paragraph text.</p>",
    "costSnippetsText": "Cost snippet text.",
    "costParagraphsText": "Cost paragraph text;",
    "chartImage": "https://www.homeyou.com/costs/i/MzA2NzozMzQz/ak-ac-companies-anchorage-costs.png",
    "lastUpdated": "Mar 31, 2017",
    "bulletText1": "Experienced AC Companies in Anchorage, AK",
    "bulletText2": "Residential & Commercial Service",
    "bulletText3": "Same Day Consultations Available in Alaska",
    "quotesUrl": "https://quotes.homeyou.com/?funnel=13&buttons=btn-primary&phone=1-844-HOMEYOU&step1_title=",
    "signupUrl": "https://signup.homeyou.com",
    "attributes": [
        {
            "title": "Central AC",
            "value": "%7B%22category%22%3A%228%22%2C%22service_code%22%3A%22HVAC_CENTRAL_AC%22%7D"
        },
        ...
    ],
    "definitionDate": "06/27/2017",
    "customPriceCalculatorUrl": "https://www.homeyou.com/costs/c/ak-ac-companies-anchorage-costs",
    "datasource": {
        "avgrangemincost": 1000,
        "avgrangemaxcost": 1000,
        "mincost": 1000,
        "avgcost": 1000,
        "maxcost": 1000,
        "s1": "$1,000.00",
        "s2": "$1,000.00",
        "s3": "$1,000.00",
        "s4": "$1,000.00",
        "has_full_costs": true,
        "has_return_amount": true,
        "return_amount": "1,000",
        "type-costs": {
            "Materials": "1,000",
            ...
        },
        "items": [
            {
                "title": "Air Conditioning Unit Cost",
                "description": "Non-discounted retail cost for common, mid-grade air conditioning unit.",
                "quantity": "1 Unit",
                "low": 1000.0,
                "high": 1000.0,
                "avg": 1000.0
            }
            ...
        ],
        "unit_cost": 1000.0,
        "unit_cost_low": 1000.0,
        "unit_cost_high": 1000.0,
        "total_cost": 1000.0,
        "total_cost_low": 1000.0,
        "total_cost_high": 1000.0,
        "uv_singular": "Unit",
        "uv": "units",
        "quantity": "1 Unit",
        "name_verb": "Install Air Conditioning",
        "local_cost": "1,000",
        "national_cost": "1,000",
        "low_labor": 1000.0,
        "high_labor": 1000.0
    },
    "bannerJobDone": [
        {
            "title": "When do you need the job done?",
            "url": "https://quotes.homeyou.com/?funnel=13&buttons=btn-primary&phone=1-844-HOMEYOU&step1_title=&attributes=%7B%22request_completed%22%3A%22Timing+is+Flexible%22%7D"
        }
        ...
    ],
    "costsWidget": [
        {
            "title": "Materials",
            "cost": "1,000"
        }
        ...
    ],
    "faqWidget": [
        {
            "question": "FAQ Question?",
            "answer": "FAQ Answer."
        }
        ...
    ],
    "relatedServicesWidget": [
        {
            "title": "Heating Repair",
            "url": "https://www.homeyou.com/ak/heating-repair-anchorage-costs",
            "slug": "ak-heating-repair-anchorage-costs"
        }
        ...
    ],
    "leadsWidget": [
        {
            "title": "Central AC",
            "name": "Graham B.",
            "city": "Anchorage, AK",
            "description": "Description"
        }
        ...
    ],
    "topCitiesWidget": {
        "title": "AC Companies in Alaska",
        "topCities": [
            {
                "title": "Fairbanks",
                "url": "https://www.homeyou.com/ak/ac-companies-fairbanks-costs",
                "state_code": "AK",
                "slug": "ak-ac-companies-fairbanks-costs"
            }
            ...
        ]
    },
    "zipCodesWeServiceWidget": [
        {
            "label": "99623",
            "slug": "ak-ac-companies-wasilla-costs"
        }
    ],
    "contractorsWidget": [
        {
            "id_business": CompanyId,
            "nm_company": "Company Name",
            "address_company": "Company Address",
            "city_company": "Company City",
            "state_company": "Company State Prefix (AK..;)",
            "zip_code_company": "Company Zipcode",
            "phone_company": "Company Phone",
            "rating": 57,
            "lat": 60.0,
            "lon": -150.0,
            "claimed": false,
            "slug": "",
            "logo": "contractors/7333/4641-juneau-st-ak-anchorage-99503.jpg",
            "is_open": true,
            "hours_company": {
                "Sun": "Closed",
                "Mon": "8:00 am - 6:00 pm",
                "Tue": "8:00 am - 6:00 pm",
                "Wed": "8:00 am - 6:00 pm",
                "Thu": "8:00 am - 6:00 pm",
                "Fri": "8:00 am - 6:00 pm",
                "Sat": "Closed"
            },
            "license": [],
            "categories": [
                {
                    "cd_category": "1",
                    "nm_category": "Plumbing"
                }
                ...
            ]
        }
        ...
    ],
    "chartUrlMobile": "https://www.homeyou.com/costs/cim/c8nr1u/ak-hardwood-flooring-refinishing-anchorage-costs.png",
    "chartUrlDesktop": "https://www.homeyou.com/costs/ci/c8nr1u/ak-hardwood-flooring-refinishing-anchorage-costs-lg.png"
}

HTTP Request

GET /costs/service-landing-page/<service_slug>?token=TOKEN

Path params

Parameter Description
service_slug Service Slug

Url query param

Parameter Description
token API token

Category Landing Page

To get the costs category landing page data:

<?php
$url = "http://api.homeyou.com/costs/category-landing-page/<category_or_service_slug>?token=TOKEN";

$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_POST, false);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($ch);
$err = curl_error($ch);
curl_close($ch);

echo $response; 
?>

Example response:

{
    "isService": true,
    "seoTitle": "True Cost to Build a Garage in 2025 | homeyou",
    "seoDescription": "Use homeyou's guide to understand the cost to build a garage in 2025, details on pricing, factors affecting costs, and tips for hiring the right contractor.",
    "sourceId": 699,
    "sourceName": "Garage Building",
    "sourceSlug": "garage-building",
    "categoryId": 8,
    "categorySlug": "hvac",
    "categoryName": "HVAC",
    "h1": "What Is the Average Cost of Garage Building?",
    "excerpt": "The price to build a garage in 2025 can range from **$9,781** to **$72,818**, with an average of **$29,473**.",
    "phoneTitle": "1-844-HOMEYOU",
    "phoneNumber": "+18444663968",
    "costGuideContent": "<p>Cost guide content</p>",
    "costGuideContentPublished": 1762922337,
    "costGuideContentUpdated": 1763042846,
    "readMoreArticles": [
        {
            "title": "6 Reasons Why You Should Hire a Landscaping Contractor",
            "url": "https://www.homeyou.com/hire-landscaping-contractor",
            "imageUrl": "http://images.homeyou.com/website/website/base/59e/9a8/f5a/cover-landscape-contractor.jpg"
        },
        ...
    ],
    "services": [
        {
            "title": "AC Companies",
            "slug": "ac-companies",
            "attributes": "%7B%22category%22%3A%228%22%2C%22service_code%22%3A%22HVAC_CENTRAL_AC%22%7D"
        },
        {
            "title": "AC Installation",
            "slug": "ac-installation",
            "attributes": "%7B%22category%22%3A%228%22%2C%22service_code%22%3A%22HVAC_CENTRAL_AC%22%7D"
        }
        ...
    ],

    "industryCategory": "HVAC",

    "relatedServices": [
        {
            "title": "AC Repair",
            "slug": "ac-repair",
            "fakeProjectQuantity": 24853,
            "avgCost": "385"
        },
        {
            "title": "Air Conditioning Repair",
            "slug": "air-conditioning-repair",
            "fakeProjectQuantity": 20721,
            "avgCost": "365"
        }
    ],
    "featuredProsWidget": {
        "categoryName": "HVAC",
        "pros": [
            {
                "title": "WC Heating & Air Conditioning Inc.",
                "url": "https://www.homeyou.com/wc-heating-air-conditioning-inc-murrieta-ca",
                "imageUrl": "https://www.homeyou.com/@web/images/directory/business.png",
                "city": "Murrieta",
                "state": "CA"
            },
            {
                "title": "RCF Service, LLC",
                "url": "https://www.homeyou.com/rcf-service-llc-farmington-nm-5054070466",
                "imageUrl": "https://www.homeyou.com/@web/images/directory/business.png",
                "city": "Farmington",
                "state": "NM"
            },
            {
                "title": "Mojo Mechanical Heating & Cooling",
                "url": "https://www.homeyou.com/mojo-mechanical-heating-cooling-tucson-az",
                "imageUrl": "https://www.homeyou.com/@web/images/directory/business.png",
                "city": "Tucson",
                "state": "AZ"
            }
        ]
    },
    "topCitiesDirectory": [
        {
            "nmCity": "Ontario",
            "nmCategory": "HVAC",
            "title": "Ontario, CA",
            "categorySlug": "hvac",
            "stateSlug": "california",
            "citySlug": "ontario"
        },
        {
            "nmCity": "Pasadena",
            "nmCategory": "HVAC",
            "title": "Pasadena, CA",
            "categorySlug": "hvac",
            "stateSlug": "california",
            "citySlug": "pasadena"
        },
        ...
    ],
    "statesWeCover": [
        {
            "title": "Alabama",
            "slug": "alabama",
            "categoryName": "HVAC"
        },
        {
            "title": "Alaska",
            "slug": "alaska",
            "categoryName": "HVAC"
        }
        ...
    ],
    "topCitiesRatings": [
        {
            "title": "Atlanta, GA",
            "slugCity": "atlanta",
            "slugState": "GA"
        },
        {
            "title": "Boise, ID",
            "slugCity": "boise",
            "slugState": "ID"
        }
        ...
    ],
    "servicesNotFromCategory": [
        {
            "url": "https://www.homeyou.com/ak/plumbing-anchorage-costs",
            "title": "Plumbing",
            "slug": "ak-plumbing-anchorage-costs"
        },
        {
            "url": "https://www.homeyou.com/ak/house-painting-anchorage-costs",
            "title": "House Painting",
            "slug": "ak-house-painting-anchorage-costs"
        }
        ...
    ],
    "averageCosts": {
        "min": 1000.00,
        "average": 1500.00,
        "max": 2000.00,
        "unit": "Unit"
    },
    "relatedServicesCost": [
        {
            "nm_service": "Finish Basement",
            "slug": "finish-basement-cost"
        },
        {
            "nm_service": "Garage Conversion",
            "slug": "garage-conversion-cost"
        },
        {
            "nm_service": "Garage Remodel",
            "slug": "garage-remodel-cost"
        },
        {
            "nm_service": "Garage Addition",
            "slug": "garage-addition-cost"
        },
        ...
    ],
    "categoriesList": {
        "Additions and Remodels": {
            "title": "Additions and Remodels",
            "url": "https://www.homeyou.com/additions-and-remodels-cost",
            "slug": "additions-and-remodels",
        },
        ...
    ],
    "faq": [
        {
            "question": "What is the average cost of garage building?",
            "answer": "The price to build a garage in 2025 can range from **$9,781** to **$72,818**, with an average of **$29,473**."
        },
        ...
    ]
}

HTTP Request

GET /costs/category-landing-page/<category_or_service_slug>?token=TOKEN

Path params

Parameter Description
category_or_service_slug Category or Service Slug

Url query param

Parameter Description
token API token

Cost Guide URL

To get the costs cost guide url:

<?php
$url = "http://api.homeyou.com/costs/cost-guide-url/<zipcode>/<service>?token=TOKEN";

$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_POST, false);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($ch);
$err = curl_error($ch);
curl_close($ch);

echo $response; 
?>

Example response:

{
    "success": true,
    "url": "https://www.homeyou.com/ak/concrete-anchorage-costs"
}

HTTP Request

GET /costs/cost-guide-url/<zipcode>/<service>?token=TOKEN

Path params

Parameter Description
zipcode Zip Code
service Id Wl Service

Url query param

Parameter Description
token API token

Costs Calculator

To get the costs calculator page data:

<?php
$url = "http://api.homeyou.com/costs/calculator/<slug>/<value>?token=TOKEN";

$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_POST, false);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($ch);
$err = curl_error($ch);
curl_close($ch);

echo $response; 
?>

Example response:

{
    "avgrangemincost": 1000.0,
    "avgrangemaxcost": 1000,
    "mincost": 1000,
    "avgcost": 1000,
    "maxcost": 1000,
    "s1": "$1,000.00",
    "s2": "$1,000.00",
    "s3": "$1,000.00",
    "s4": "$1,000.00",
    "has_full_costs": true,
    "has_return_amount": true,
    "return_amount": "1,000",
    "type-costs": {
        "Materials": "1,000",
        "Labor": "1,000",
        "Supplies": "1,000",
        "Equipment": "1,000"
    },
    "items": [
        {
            "title": "Air Conditioning Unit Cost",
            "description": "Non-discounted retail cost for common, mid-grade air conditioning unit.",
            "quantity": "3 Units",
            "low": 6326.898032,
            "high": 8560.454448,
            "avg": 7443.676240000001
        },
        {
            "title": "Air Conditioning Unit Labor",
            "description": "Direct labor expenses to install air conditioning.",
            "quantity": "18.9 Hours",
            "low": 1326.855712,
            "high": 1437.041424,
            "avg": 1381.948568
        }
        ...
    ],
    "unit_cost": 1000.00,
    "unit_cost_low": 1000.00,
    "unit_cost_high": 1000.00,
    "total_cost": 1000.00,
    "total_cost_low": 1000.00,
    "total_cost_high": 1000.00,
    "uv_singular": "Unit",
    "uv": "units",
    "quantity": "3 Units",
    "name_verb": "Install Air Conditioning",
    "local_cost": "1,000",
    "national_cost": "1,000",
    "low_labor": 1000.00,
    "high_labor": 1000.00,
    "seoTitle": "What is the price for AC Companies in Anchorage, AK?"
}

HTTP Request

GET /costs/calculator/<slug>/<value>?token=TOKEN

Path params

Parameter Description
slug Service Slug
value Units Quantity

Url query param

Parameter Description
token API token

Site

This is the subnav data retrieve service.

To get the subnav list data:

<?php
$url = "http://api.homeyou.com/subnav?token=TOKEN";

$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_POST, false);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($ch);
$err = curl_error($ch);
curl_close($ch);

echo $response; 
?>

Example response:

{
    "popularProjects": [
        {
            "url_slug_category": "plumbing-tasks",
            "nm_category": "Plumbing Tasks",
            "attributes": "%7B%22category%22%3A%221%22%2C%22service_code%22%3A%22PLUMBING%22%7D"
        },
        {
            "url_slug_category": "handyman-tasks",
            "nm_category": "Handyman Tasks",
            "attributes": "%7B%22category%22%3A%229%22%2C%22service_code%22%3A%22HANDYMAN%22%7D"
        },
        ...
    ],
    "servicesNearYou": [
        {
            "slug": "plumbing",
            "label": "Plumbing",
            "category": "1",
            "servicesNearYou": [
                {
                    "id_question": "5",
                    "display_category": "1",
                    "cd_category": "1",
                    "display_answer": "Drain Cleaning",
                    "service_code": "DRAIN_CLEANING",
                    "attribute_answer": "",
                    "criteria_answer": "",
                    "order_answer": "5",
                    "attributes_json": "%7B%22category%22%3A%221%22%2C%22service_code%22%3A%22DRAIN_CLEANING%22%7D"
                },
                {
                    "id_question": "6",
                    "display_category": "1",
                    "cd_category": "1",
                    "display_answer": "Septic System Repair",
                    "service_code": "SEPTIC_SEWER_REPAIR",
                    "attribute_answer": "",
                    "criteria_answer": "",
                    "order_answer": "6",
                    "attributes_json": "%7B%22category%22%3A%221%22%2C%22service_code%22%3A%22SEPTIC_SEWER_REPAIR%22%7D"
                },
                ...
            ],
            "popularServices": [
                {
                    "id_question": "1",
                    "display_category": "1",
                    "cd_category": "1",
                    "display_answer": "Septic System Installation",
                    "service_code": "SEPTIC_SEWER",
                    "attribute_answer": "",
                    "criteria_answer": "",
                    "order_answer": "1",
                    "attributes_json": "%7B%22category%22%3A%221%22%2C%22service_code%22%3A%22SEPTIC_SEWER%22%7D"
                },
                {
                    "id_question": "2",
                    "display_category": "1",
                    "cd_category": "1",
                    "display_answer": "Septic System Replacement",
                    "service_code": "SEPTIC_SEWER",
                    "attribute_answer": "",
                    "criteria_answer": "",
                    "order_answer": "2",
                    "attributes_json": "%7B%22category%22%3A%221%22%2C%22service_code%22%3A%22SEPTIC_SEWER%22%7D"
                },
                ...
            ]
        },
        {
            "slug": "handyman",
            "label": "Handyman",
            "category": "9",
            "servicesNearYou": [
                {
                    "id_question": "44",
                    "display_category": "9",
                    "cd_category": "9",
                    "display_answer": "Glass Installation or Repair",
                    "service_code": "GLASS_REPAIR",
                    "attribute_answer": "",
                    "criteria_answer": "",
                    "order_answer": "5",
                    "attributes_json": "%7B%22category%22%3A%229%22%2C%22service_code%22%3A%22GLASS_REPAIR%22%7D"
                },
                {
                    "id_question": "45",
                    "display_category": "9",
                    "cd_category": "9",
                    "display_answer": "Bathroom Repair",
                    "service_code": "HANDYMAN_BATHROOM",
                    "attribute_answer": "",
                    "criteria_answer": "",
                    "order_answer": "6",
                    "attributes_json": "%7B%22category%22%3A%229%22%2C%22service_code%22%3A%22HANDYMAN_BATHROOM%22%7D"
                },
                ...
            ],
            "popularServices": [
                {
                    "id_question": "40",
                    "display_category": "9",
                    "cd_category": "9",
                    "display_answer": "Handyman Tasks",
                    "service_code": "HANDYMAN",
                    "attribute_answer": "",
                    "criteria_answer": "",
                    "order_answer": "1",
                    "attributes_json": "%7B%22category%22%3A%229%22%2C%22service_code%22%3A%22HANDYMAN%22%7D"
                },
                {
                    "id_question": "41",
                    "display_category": "9",
                    "cd_category": "9",
                    "display_answer": "Plumbing Tasks",
                    "service_code": "HANDYMAN_PLUMBING",
                    "attribute_answer": "",
                    "criteria_answer": "",
                    "order_answer": "2",
                    "attributes_json": "%7B%22category%22%3A%229%22%2C%22service_code%22%3A%22HANDYMAN_PLUMBING%22%7D"
                },
                ...
            ]
        },
        ...
    ]
}

Retrieve information about the currently authenticated user.

HTTP Request

GET /subnav?token=TOKEN

Token url query param

Parameter Description
token API token

Leads

This is the leads data retrieve service.

Lead Intel

To post a lead metadata:

<?php
$url = "http://api.homeyou.com/leads/intel";

$data = [
    'lead_id' => 1,
    'request_id' => 1,
    'status' => 'pending',
    'data' => [
        'images' => [
            'https://datahand-image.desenvox.com/datahand/dev/0267e008-e423-4a7f-b96c-60a7e6aa5d2a/staticmap',
        ],
        'address' => '240 MAIN ST, WOBURN, MA',
        'latitude' => 42.475204,
        'longitude' => -71.15027,
        'insights' => [
            'Condo • 1108 sqft',
            '2 bedrooms • 2.5 bathrooms',
            'Built in 2007',
            'Estimated price: $574,000',
        ],
    ],
];

$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Authorization: Bearer {YOUR_TOKEN}',
    'Content-Type: application/json'
]);


$response = curl_exec($ch);
$err = curl_error($ch);
curl_close($ch);

echo $response; 
?>

Example success response:

{
    "success": true
}

Example error response:

{
    "success": true,
    "error": "Failed to save lead metadata: Lead ID and data are required"
}

Post a lead metadata.

HTTP Request

POST /leads/intel

Request body

Parameter Type Description
lead_id integer Lead ID
request_id string Request ID
status string Status
data array Data

Lead Info

To get the lead info:

<?php
$url = "http://api.homeyou.com/leads/info/<hashId>";

$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_POST, false);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Authorization: Bearer {YOUR_TOKEN}'
]);


$response = curl_exec($ch);
$err = curl_error($ch);
curl_close($ch);

echo $response; 
?>

Example success response:

{
    "createdAt": 1762188897,
    "address": "1st Main Street",
    "city": "Woburn",
    "state": "MA",
    "zipcode": "01801",
    "firstName": "Jeser",
    "lastName": "Mota",
    "email": "jeser@homeyou.com",
    "phone": "7777777788",
    "propertyType": "Home",
    "projectStatus": "Ready to Hire",
    "timeframe": "Timing is Flexible",
    "ownhome": "Yes",
    "description": "Teste",
    "cdCategory": "7",
    "categorySlug": "additions-and-remodels",
    "categoryName": "Additions and Remodels",
    "service": null,
    "notes": null,
    "leadIntel": {
        "formattedAddress": "1st Main Street, Woburn, MA • 01801",
        "images": [
            "https://datahand-image.desenvox.com/datahand/dev/0267e008-e423-4a7f-b96c-60a7e6aa5d2a/staticmap"
        ],
        "latitude": 42.475204,
        "longitude": -71.15027,
        "insights": [
            "Condo • 1108 sqft",
            "2 bedrooms • 2.5 bathrooms",
            "Built in 2007",
            "Estimated price: $574,000"
        ]
    },
    "upsells": [
        {
            "category": "",
            "slug": "painting",
            "categoryName": "Painting",
            "title": "Painting",
            "description": "",
            "pills": [],
            "badge": "",
            "ctaText": ""
        },
        {
            "category": 15,
            "slug": "roofing",
            "categoryName": "Roofing",
            "title": "Roofing",
            "description": "",
            "pills": [],
            "badge": "",
            "ctaText": ""
        },
        ...
    ],
    "campaign": {
        "code": "campaign-code",
        "token": "campaign-token"
    }
}

Get a lead info.

HTTP Request

GET /leads/info/<hashId>

Request body

Parameter Type Description
hashId string Hash project
php