HomePulse | Apiosk Gateway

Method	Path	Description	Cost
GET	/api/home/contractor	How to vet and hire a contractor: licensing and insurance checks, contractor red flags, and a contract checklist by trade (roofing, electrical, general contractor, and more). For homeowner and renovation agents. Returns license/registration-board lookup guidance, insurance requirements, payment-schedule guidance, and red flags, localized by location and country/jurisdiction when provided.	$0.12 default	View details
GET	/api/home/energy	Home energy efficiency upgrades ranked by payback period: heat pump, insulation, windows, and more, with country-correct incentives applied (US IRA 30% federal tax credits, UK ECO4/Boiler Upgrade Scheme, EU/DE BEG grants, Canada Greener Homes, Australia state rebates). For homeowner and energy agents. Returns cost estimates, annual energy-bill savings, and climate-zone guidance by home type, location, country, age, and square footage.	$0.12 default	View details
GET	/api/home/improve	Home improvement cost and ROI estimate for any project (kitchen remodel, deck addition, bathroom remodel, and more), in any country: project cost, resale value added, DIY-vs-contractor guidance, permit/planning-permission guidance, and a parts/materials list. For homeowner and renovation agents. Takes a project, optional home value, and optional location/country.	$0.12 default	View details
GET	/api/home/maintain	Seasonal home maintenance checklist for the current season (spring, summer, fall, winter): preventive home tasks, priorities, costs, and a supplies/tools list. For homeowner and DIY agents worldwide. Region- and country-aware; returns the right home-care tasks for the time of year and jurisdiction (note: seasons are reversed in the Southern Hemisphere).	$0.09 default	View details
GET	/api/home/maintenance	Personalized home maintenance schedule and calendar for any country: seasonal tasks tailored by region, home age, and features (pool, fireplace, deck, basement). For homeowner and DIY agents. Returns a preventive maintenance calendar with cost estimates and DIY-vs-pro guidance; filter by season or get the full year.	$0.09 default	View details
GET	/api/home/neighborhood	Neighborhood analysis for any area worldwide: schools, safety/crime, walkability, neighborhood character, and cost of living. For homebuyer and relocation agents. Takes a location (postal code and/or city) plus optional state/province and country; returns a livability profile to compare areas before buying or moving.	$0.12 default	View details
GET	/api/home/rent	Rental market analysis / how much is rent for any country: price ranges, rent trends, and official government fair-market-rent benchmarks where available (US HUD FMR). For renter and real-estate agents. Takes a location (postal code and/or city) plus optional bedrooms, state/province, and country; returns local rent ranges, market direction, and official benchmarks when the jurisdiction has one.	$0.09 default	View details
GET	/api/home/roi	Home improvement resale ROI and cost-vs-value by project, region, and country: how much a kitchen remodel, bathroom addition, garage door, and other projects return at resale. For homeowner and real-estate agents. Uses NAR Cost vs Value data for the US; for other countries uses the closest available local renovation-ROI benchmark and says so. Returns resale value added, recouped percentage, DIY-vs-contractor savings, and comparable projects.	$0.12 default	View details
GET	/api/home/smart	Smart home device recommendations and ecosystem advice for any country: Matter compatibility, ecosystem fit (Alexa, Google Home, Apple HomeKit), device picks by room and budget, and local plug/voltage/availability notes. For homeowner and smart-home agents. Returns recommended devices with Matter certification status and practical setup guidance.	$0.09 default	View details
GET	/api/home/value	Home value estimate / what is my house worth: an AVM-style value estimate with comparable sales and market-trend analysis. For homeowner and real-estate agents in any country. Takes an address and/or location (postal code or city) plus optional country; returns an estimated value range, recent comps, and local housing-market direction.	$0.12 default	View details

Endpoint documentation

GET/api/home/contractor

$0.12 default

Description

How to vet and hire a contractor: licensing and insurance checks, contractor red flags, and a contract checklist by trade (roofing, electrical, general contractor, and more). For homeowner and renovation agents. Returns license/registration-board lookup guidance, insurance requirements, payment-schedule guidance, and red flags, localized by location and country/jurisdiction when provided.

Documentation

Contractor vetting guide

Licensing/registration authority, insurance requirements, red flags, and contract checklist by trade, for any country's regulatory regime.

**Price:** $0.1 USDC per call

Calls go directly to PulseNetwork. Paid routes use the live x402 challenge; Apiosk never rewrites payTo or settles the payment.

Pricing

$0.12 default

Authentication

No account or API key. Pay PulseNetwork directly using the live x402 challenge. The challenge is authoritative for price, network, asset and payTo.

Parameters

{
  "properties": {
    "country": {
      "description": "Country/jurisdiction (e.g. US, UK, CA, DE, AU) — determines the correct licensing authority",
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    },
    "lang": {
      "description": "Response language (default en)",
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    },
    "location": {
      "description": "Postal code or city (e.g. 90210, M5V 2T6, SW1A, Berlin)",
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    },
    "trade": {
      "description": "Trade (plumber, electrician, roofer, etc.)",
      "required": true,
      "type": "string",
      "x-parameter-location": "query"
    },
    "zip": {
      "description": "Legacy alias for location (ZIP/postal code)",
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    }
  },
  "required": [
    "trade"
  ],
  "type": "object"
}

Links

External documentation ↗OpenAPI / Swagger ↗

GET/api/home/energy

$0.12 default

Description

Home energy efficiency upgrades ranked by payback period: heat pump, insulation, windows, and more, with country-correct incentives applied (US IRA 30% federal tax credits, UK ECO4/Boiler Upgrade Scheme, EU/DE BEG grants, Canada Greener Homes, Australia state rebates). For homeowner and energy agents. Returns cost estimates, annual energy-bill savings, and climate-zone guidance by home type, location, country, age, and square footage.

Documentation

Home energy efficiency

Improvements ranked by payback period with the country-correct incentive program applied (US IRA 30% tax credits, UK ECO4/Boiler Upgrade Scheme, DE BEG grants, CA Greener Homes, AU state rebates).

**Price:** $0.1 USDC per call

Calls go directly to PulseNetwork. Paid routes use the live x402 challenge; Apiosk never rewrites payTo or settles the payment.

Pricing

$0.12 default

Authentication

No account or API key. Pay PulseNetwork directly using the live x402 challenge. The challenge is authoritative for price, network, asset and payTo.

Parameters

{
  "properties": {
    "age": {
      "description": "Home age (years)",
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    },
    "country": {
      "description": "Country (e.g. US, UK, CA, DE, AU) — determines which incentive programs apply",
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    },
    "home_type": {
      "description": "Home type (single-family, condo, etc.)",
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    },
    "lang": {
      "description": "Response language (default en)",
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    },
    "location": {
      "description": "Postal code or city (e.g. 90210, M5V 2T6, SW1A, Berlin)",
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    },
    "sqft": {
      "description": "Square footage (or square meters — state units)",
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    },
    "zip": {
      "description": "Legacy alias for location (ZIP/postal code)",
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    }
  },
  "required": [],
  "type": "object"
}

Links

External documentation ↗OpenAPI / Swagger ↗

GET/api/home/improve

$0.12 default

Description

Home improvement cost and ROI estimate for any project (kitchen remodel, deck addition, bathroom remodel, and more), in any country: project cost, resale value added, DIY-vs-contractor guidance, permit/planning-permission guidance, and a parts/materials list. For homeowner and renovation agents. Takes a project, optional home value, and optional location/country.

Documentation

Home improvement ROI analysis

ROI summary (cost, value added, recoup rating), best-for analysis (selling/staying/both), DIY vs contractor breakdown, permit/planning-permission guidance, and materials list with Amazon links, for any country.

**Price:** $0.1 USDC per call

Calls go directly to PulseNetwork. Paid routes use the live x402 challenge; Apiosk never rewrites payTo or settles the payment.

Pricing

$0.12 default

Authentication

No account or API key. Pay PulseNetwork directly using the live x402 challenge. The challenge is authoritative for price, network, asset and payTo.

Parameters

{
  "properties": {
    "country": {
      "description": "Country (e.g. US, UK, CA, DE, AU) — sets currency and permit/planning-permission terminology",
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    },
    "home_value": {
      "description": "Current estimated home value, in local currency",
      "required": false,
      "type": "integer",
      "x-parameter-location": "query"
    },
    "lang": {
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    },
    "location": {
      "description": "Postal code or city (e.g. 90210, M5V 2T6, SW1A, Berlin)",
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    },
    "project": {
      "description": "Project type (e.g. kitchen-remodel, deck-addition, new-roof)",
      "required": true,
      "type": "string",
      "x-parameter-location": "query"
    },
    "zip": {
      "description": "Legacy alias for location (ZIP/postal code)",
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    }
  },
  "required": [
    "project"
  ],
  "type": "object"
}

Links

External documentation ↗OpenAPI / Swagger ↗

GET/api/home/maintain

$0.09 default

Description

Seasonal home maintenance checklist for the current season (spring, summer, fall, winter): preventive home tasks, priorities, costs, and a supplies/tools list. For homeowner and DIY agents worldwide. Region- and country-aware; returns the right home-care tasks for the time of year and jurisdiction (note: seasons are reversed in the Southern Hemisphere).

Documentation

Seasonal maintenance checklist

Prioritized task list (urgent/high/medium/low) with cost estimates, DIY feasibility, time estimates, tools/supplies with Amazon links, and total season cost range. Pass country for correct hemisphere/season handling (seasons run six months opposite in the Southern Hemisphere) and local currency.

**Price:** $0.08 USDC per call

Calls go directly to PulseNetwork. Paid routes use the live x402 challenge; Apiosk never rewrites payTo or settles the payment.

Pricing

$0.09 default

Authentication

No account or API key. Pay PulseNetwork directly using the live x402 challenge. The challenge is authoritative for price, network, asset and payTo.

Parameters

{
  "properties": {
    "country": {
      "description": "Country (e.g. US, UK, CA, DE, AU) — corrects season/hemisphere and local terminology",
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    },
    "lang": {
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    },
    "region": {
      "description": "Region or state/province (e.g. Northeast, Pacific Northwest, Bavaria, New South Wales)",
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    },
    "season": {
      "description": "Defaults to current season (hemisphere-corrected when country is given)",
      "enum": [
        "spring",
        "summer",
        "fall",
        "winter"
      ],
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    }
  },
  "required": [],
  "type": "object"
}

Links

External documentation ↗OpenAPI / Swagger ↗

GET/api/home/maintenance

$0.09 default

Description

Personalized home maintenance schedule and calendar for any country: seasonal tasks tailored by region, home age, and features (pool, fireplace, deck, basement). For homeowner and DIY agents. Returns a preventive maintenance calendar with cost estimates and DIY-vs-pro guidance; filter by season or get the full year.

Documentation

Personalized home maintenance calendar

Seasonal maintenance schedule by region, home age, and features, for any country (hemisphere-corrected seasons).

**Price:** $0.08 USDC per call

Calls go directly to PulseNetwork. Paid routes use the live x402 challenge; Apiosk never rewrites payTo or settles the payment.

Pricing

$0.09 default

Authentication

No account or API key. Pay PulseNetwork directly using the live x402 challenge. The challenge is authoritative for price, network, asset and payTo.

Parameters

{
  "properties": {
    "country": {
      "description": "Country (e.g. US, UK, CA, DE, AU) — corrects hemisphere/season and terminology",
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    },
    "features": {
      "description": "Home features (pool, well, etc.)",
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    },
    "home_age": {
      "description": "Home age (years)",
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    },
    "lang": {
      "description": "Response language (default en)",
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    },
    "region": {
      "description": "Region or state/province (e.g. Northeast, Bavaria, New South Wales)",
      "required": true,
      "type": "string",
      "x-parameter-location": "query"
    },
    "season": {
      "description": "Season (spring, summer, fall, winter, all)",
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    }
  },
  "required": [
    "region"
  ],
  "type": "object"
}

Links

External documentation ↗OpenAPI / Swagger ↗

GET/api/home/neighborhood

$0.12 default

Description

Neighborhood analysis for any area worldwide: schools, safety/crime, walkability, neighborhood character, and cost of living. For homebuyer and relocation agents. Takes a location (postal code and/or city) plus optional state/province and country; returns a livability profile to compare areas before buying or moving.

Documentation

Neighborhood analysis

School ratings, relative safety, walkability score, neighborhood character, and best-for/not-ideal-for breakdown, for any country. Pass country to get the right local terminology (HOA-equivalent, flood-risk authority, school-rating source).

**Price:** $0.1 USDC per call

Calls go directly to PulseNetwork. Paid routes use the live x402 challenge; Apiosk never rewrites payTo or settles the payment.

Pricing

$0.12 default

Authentication

No account or API key. Pay PulseNetwork directly using the live x402 challenge. The challenge is authoritative for price, network, asset and payTo.

Parameters

{
  "properties": {
    "city": {
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    },
    "country": {
      "description": "Country (e.g. US, UK, CA, DE, AU)",
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    },
    "lang": {
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    },
    "location": {
      "description": "Postal code or area (e.g. 90210, M5V 2T6, SW1A)",
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    },
    "state": {
      "description": "State/province/region",
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    },
    "zip": {
      "description": "Legacy alias for location (ZIP/postal code)",
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    }
  },
  "required": [],
  "type": "object"
}

Links

External documentation ↗OpenAPI / Swagger ↗

GET/api/home/rent

$0.09 default

Description

Rental market analysis / how much is rent for any country: price ranges, rent trends, and official government fair-market-rent benchmarks where available (US HUD FMR). For renter and real-estate agents. Takes a location (postal code and/or city) plus optional bedrooms, state/province, and country; returns local rent ranges, market direction, and official benchmarks when the jurisdiction has one.

Documentation

Rental market analysis

Rent ranges by bedroom count, market trend, official government fair-market-rent data where available (US HUD FMR), best neighborhoods to rent, and renting vs buying comparison, for any country.

**Price:** $0.08 USDC per call

Calls go directly to PulseNetwork. Paid routes use the live x402 challenge; Apiosk never rewrites payTo or settles the payment.

Pricing

$0.09 default

Authentication

No account or API key. Pay PulseNetwork directly using the live x402 challenge. The challenge is authoritative for price, network, asset and payTo.

Parameters

{
  "properties": {
    "bedrooms": {
      "required": false,
      "type": "integer",
      "x-parameter-location": "query"
    },
    "city": {
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    },
    "country": {
      "description": "Country (e.g. US, UK, CA, DE, AU) — HUD FMR only applies when country is US/unspecified",
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    },
    "county": {
      "description": "County name hint for HUD FMR matching (US only)",
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    },
    "lang": {
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    },
    "location": {
      "description": "Postal code or city (e.g. 90210, M5V 2T6, SW1A)",
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    },
    "state": {
      "description": "State/province; 2-letter US state code required for HUD FMR data",
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    },
    "zip": {
      "description": "Legacy alias for location (ZIP/postal code)",
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    }
  },
  "required": [],
  "type": "object"
}

Links

External documentation ↗OpenAPI / Swagger ↗

GET/api/home/roi

$0.12 default

Description

Home improvement resale ROI and cost-vs-value by project, region, and country: how much a kitchen remodel, bathroom addition, garage door, and other projects return at resale. For homeowner and real-estate agents. Uses NAR Cost vs Value data for the US; for other countries uses the closest available local renovation-ROI benchmark and says so. Returns resale value added, recouped percentage, DIY-vs-contractor savings, and comparable projects.

Documentation

Home improvement resale ROI

Cost-vs-value resale return by project, region, and country. Uses NAR Cost vs Value data for the US; for other countries uses the closest available local benchmark and states its data basis.

**Price:** $0.1 USDC per call

Calls go directly to PulseNetwork. Paid routes use the live x402 challenge; Apiosk never rewrites payTo or settles the payment.

Pricing

$0.12 default

Authentication

No account or API key. Pay PulseNetwork directly using the live x402 challenge. The challenge is authoritative for price, network, asset and payTo.

Parameters

{
  "properties": {
    "country": {
      "description": "Country (e.g. US, UK, CA, DE, AU) — NAR Cost vs Value is a US-specific benchmark; other countries get local guidance",
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    },
    "home_value": {
      "description": "Current home value, in local currency",
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    },
    "lang": {
      "description": "Response language (default en)",
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    },
    "project": {
      "description": "Project (kitchen remodel, deck, etc.)",
      "required": true,
      "type": "string",
      "x-parameter-location": "query"
    },
    "region": {
      "description": "Region",
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    }
  },
  "required": [
    "project"
  ],
  "type": "object"
}

Links

External documentation ↗OpenAPI / Swagger ↗

GET/api/home/smart

$0.09 default

Description

Smart home device recommendations and ecosystem advice for any country: Matter compatibility, ecosystem fit (Alexa, Google Home, Apple HomeKit), device picks by room and budget, and local plug/voltage/availability notes. For homeowner and smart-home agents. Returns recommended devices with Matter certification status and practical setup guidance.

Documentation

Smart home ecosystem advisor

Matter compatibility, device recommendations, ecosystem fit, and local plug/voltage/availability notes, for any country.

**Price:** $0.08 USDC per call

Calls go directly to PulseNetwork. Paid routes use the live x402 challenge; Apiosk never rewrites payTo or settles the payment.

Pricing

$0.09 default

Authentication

No account or API key. Pay PulseNetwork directly using the live x402 challenge. The challenge is authoritative for price, network, asset and payTo.

Parameters

{
  "properties": {
    "budget": {
      "description": "Budget, in local currency",
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    },
    "country": {
      "description": "Country (e.g. US, UK, CA, DE, AU) — affects plug type/voltage, currency, and regional device availability",
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    },
    "ecosystem": {
      "description": "Ecosystem (Alexa, HomeKit, Google Home)",
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    },
    "lang": {
      "description": "Response language (default en)",
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    },
    "room": {
      "description": "Room",
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    }
  },
  "required": [],
  "type": "object"
}

Links

External documentation ↗OpenAPI / Swagger ↗

GET/api/home/value

$0.12 default

Description

Home value estimate / what is my house worth: an AVM-style value estimate with comparable sales and market-trend analysis. For homeowner and real-estate agents in any country. Takes an address and/or location (postal code or city) plus optional country; returns an estimated value range, recent comps, and local housing-market direction.

Documentation

Home value estimate

Estimated market value range (low/mid/high) with confidence rating, comparable sales, market trend, and best time to act. Works for any country — pass country to get the right currency and local property portals.

**Price:** $0.1 USDC per call

Calls go directly to PulseNetwork. Paid routes use the live x402 challenge; Apiosk never rewrites payTo or settles the payment.

Pricing

$0.12 default

Authentication

No account or API key. Pay PulseNetwork directly using the live x402 challenge. The challenge is authoritative for price, network, asset and payTo.

Parameters

{
  "properties": {
    "address": {
      "description": "Street address",
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    },
    "country": {
      "description": "Country (e.g. US, UK, CA, DE, AU) — selects local currency and property portals",
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    },
    "lang": {
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    },
    "location": {
      "description": "Postal code or city (e.g. 90210, M5V 2T6, SW1A)",
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    },
    "zip": {
      "description": "Legacy alias for location (ZIP/postal code)",
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    }
  },
  "required": [],
  "type": "object"
}

Links

External documentation ↗OpenAPI / Swagger ↗