Housepedia Intelligence for Laravel

Laravel integration for henzeb/housepedia-intelligence, the PHP SDK for the Housepedia Intelligence API. It adds configuration, a facade, container bindings and Laravel Collections for every endpoint that returns a list.

Table of contents

• Installation
• Usage
• Documentation
• Testing this package
• Security
• Credits
• License

Installation

You may install the package via Composer:

composer require henzeb/housepedia-intelligence-laravel

The core SDK is installed with it, and the service provider and the Housepedia facade are registered automatically. Add your API key to .env:

HOUSEPEDIA_API_KEY=hp_...

Usage

use Henzeb\Housepedia\Intelligence\Laravel\Facades\Housepedia;

$address = Housepedia::addresses()
    ->withPostcode('1076LJ', 12, '2')
    ->find();

$suggestions = Housepedia::addresses()
    ->suggest('1076LJ 12-2'); // Collection<int, AddressSuggestion>

$streets = $suggestions->map->street()->filter()->unique();

Documentation

• Configuration
• Usage
• Differences from the core SDK
• Testing your application

Every endpoint, locator, response object and exception is documented in the core SDK documentation.

AI agents

The package ships Laravel Boost guidelines. Run php artisan boost:install (or boost:update) after installing it, and your coding agent knows how to use the Housepedia client.

Testing this package

composer test
composer analyse

Security

If you discover any security-related issues, please email henzeberkheij@gmail.com instead of using the issue tracker.

Credits

• Henze Berkheij

License

The MIT License (MIT). Please see License File for more information.