Download the PHP package lanos/laravel-property-data without Composer
On this page you can find all versions of the php package lanos/laravel-property-data. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download lanos/laravel-property-data
More information about lanos/laravel-property-data
Files in lanos/laravel-property-data
Package laravel-property-data
Short Description A Laravel package for handling UK property data
License MIT
Homepage https://github.com/l4nos/laravel-property-data
Informations about the package laravel-property-data
Laravel Property Data
A comprehensive Laravel package for integrating with the PropertyData UK property data API. This package provides a clean, intuitive interface for accessing UK property market data, valuations, planning information, and area analytics.
📋 Table of Contents
- About PropertyData API
- Features
- Requirements
- Installation
- Configuration
- Quick Start
- Available Methods
- Usage Examples
- Error Handling
- Testing
- Changelog
- Contributing
- Security
- Credits
- License
- Disclaimer
About PropertyData API
This package integrates with the PropertyData API - a comprehensive UK property data service.
⚠️ Important: You need an API key to use this package.
👉 Get your API key at: https://propertydata.co.uk
📚 API Documentation: https://propertydata.co.uk/api/documentation
PropertyData provides access to:
- Property valuations and market analytics
- Planning applications and building regulations
- Area demographics and statistics
- Crime data and school information
- Development feasibility calculations
- And much more...
Features
✨ Key Features:
- 🏠 Comprehensive Property Data: Access sold prices, valuations, rental yields, and market trends
- 📍 Location Intelligence: Area demographics, crime statistics, school ratings, and amenities
- 🏗️ Development Tools: Development calculators, GDV estimates, build costs, and feasibility analysis
- 📋 Planning Data: Planning applications, conservation areas, green belt checks, and listed buildings
- 🔍 Property Search: UPRN lookups, address matching, and title searches
- 💰 Financial Calculators: Mortgage calculators, stamp duty, and rebuild cost estimates
- 🔄 Automatic Retry Logic: Built-in retry mechanism for transient failures
- ✅ Input Validation: Comprehensive validation for all API parameters
- 🎯 Type Safety: PHP 8.1+ enums for constrained values
- 📝 Full Laravel Integration: Service provider, facade, and configuration publishing
Requirements
- PHP 8.1 or higher
- Laravel 10.x or 11.x
- Composer
- PropertyData API key (get one at propertydata.co.uk)
Installation
Step 1: Install via Composer
Step 2: Publish Configuration (Optional)
The package will auto-register its service provider through Laravel's package discovery. To publish the configuration file:
This will create a config/property-data.php configuration file.
Step 3: Add API Key to Environment
Add your PropertyData API key to your .env file:
You can also configure optional settings:
Configuration
The configuration file (config/property-data.php) contains:
Quick Start
Using the Facade
Using Dependency Injection
Available Methods
📍 Address & UPRN Methods
💰 Market Data Methods
🏠 Valuation Methods
🏗️ Development Methods
📋 Planning & Regulatory Methods
📊 Area Information Methods
🏪 Amenities Methods
📄 Document Methods
💳 Financial Calculators
🔧 Account Methods
Usage Examples
Example 1: Property Investment Analysis
Example 2: Property Due Diligence
Example 3: Location-Based Search
Error Handling
The package includes comprehensive error handling with specific exception types:
Exception Types
PropertyDataApiException- Base exception for all API errorsPropertyDataAuthenticationException- Invalid API key or authentication failedPropertyDataConnectionException- Network connection issuesPropertyDataServerException- API server errors (5xx responses)PropertyDataRateLimitException- Rate limit exceeded (currently unused as API has no rate limits)
Handling Exceptions
Input Validation
The package validates all inputs before making API calls:
Automatic Retry Logic
The package automatically retries failed requests for transient errors:
- Connection failures
- Server errors (5xx responses)
- Uses exponential backoff (1s, 2s, 4s...)
- Maximum 3 attempts by default
- Configurable via environment variables
Testing
Running Tests
Test Coverage
Static Analysis
Code Formatting
Changelog
Please see CHANGELOG for more information on what has changed recently.
Contributing
Please see CONTRIBUTING for details on how to contribute to this package.
Development Setup
- Fork the repository
- Clone your fork
- Install dependencies:
composer install - Create a feature branch:
git checkout -b feature/my-feature - Make your changes
- Run tests:
composer test - Submit a pull request
Security
If you discover any security-related issues, please email [email protected] instead of using the issue tracker.
Credits
- L4nos
- All Contributors
License
The MIT License (MIT). Please see License File for more information.
Disclaimer
⚠️ IMPORTANT NOTICE
This package is an independent integration library for the PropertyData API. We are not affiliated with, endorsed by, or connected to PropertyData or its parent company.
- This package serves solely as a client interface to integrate with the PropertyData API
- We do not own, operate, or have any control over the PropertyData API
- All property data, valuations, and information are provided by PropertyData
- We are not responsible for the accuracy, completeness, or reliability of data returned by the API
- Users must obtain their own API key directly from PropertyData
For official API documentation and support, please visit https://propertydata.co.uk
Data Usage
Please ensure you comply with PropertyData's terms of service and data usage policies when using this package. The package authors assume no responsibility for how you use the data obtained through the API.
No Warranty
This package is provided "as is" without warranty of any kind, either expressed or implied. See the LICENSE file for full disclaimer of warranties.
All versions of laravel-property-data with dependencies
guzzlehttp/guzzle Version ^7.0
illuminate/contracts Version ^10.0|^11.0
illuminate/support Version ^10.0|^11.0