Download the PHP package trackstone/immo-data-php-sdk without Composer

On this page you can find all versions of the php package trackstone/immo-data-php-sdk. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of trackstone/immo-data-php-sdk

Informations about the package immo-data-php-sdk

Immo Data PHP SDK

Tests

A PHP SDK for the Immo Data API — French real estate data including property valuation, geocoding, geographic boundaries, and market prices.

Requirements

Installation

Quick Start

Configuration

Resources

The client exposes the following resources:

Resource Method Description
valuation() estimate() Property price estimation
geocode() search() Location search / autocomplete
geo() region(), department(), city(), district(), subdistrict() Geographic data and boundaries
market() priceHistory(), currentPrice(), saleDurationHistory(), currentSaleDuration() Market price and sale-duration data
transactions() search() Real estate transactions (DVF)
dpe() search(), get() Energy Performance Diagnostics (DPE)

Valuation

Estimate the price of a property based on its characteristics.

Required parameters: longitude, latitude, realtyType, nbRooms, livingArea

Optional parameters:

Parameter Type Description
condition ?Condition Property condition (-1 = to renovate, 0 = standard, 1 = excellent)
landArea ?float Land area in m²
bathrooms ?int Number of bathrooms
constructionYear ?int Year of construction
dpe ?Dpe Energy performance rating (A-G)
level ?int Total number of floors in building
floor ?int Floor the property is on
pool ?bool Has swimming pool
cellar ?bool Has cellar
niceView ?bool Has nice view
parking ?bool Has parking
elevator ?bool Has elevator
patio ?bool Has patio/terrace

Geocode

Search for locations by name. Returns structured geographic results with bounding boxes and center coordinates.

GeocodeResult properties:

Property Type Description
geoLevel GeoLevel Geographic level (region, department, city, district, street, address)
regionName ?string Region name
regionCode ?string Region code
departmentName ?string Department name
departmentCode ?string Department code
cityName ?string City name
inseeCode ?string INSEE code
districtCode ?string District (grand quartier) code
subdistrictCode ?string IRIS code
postCode string[] Post codes
streetCode ?string Street code (street/address results)
streetName ?string Street name (street/address results)
streetType ?string Street type, e.g. Rue, Avenue (street/address results)
streetNumber ?string Street number (address results)
streetSuffix ?string Street number suffix, e.g. bis, ter (address results)
addressId ?string Unique address identifier (address results)
parcelIds string[] Cadastral parcel identifiers (address results)
boundingBox ?BoundingBox Bounding box coordinates
center ?Coordinates Center point (longitude, latitude)
label string Human-readable label

Geographic Data

Retrieve geographic entities with their GeoJSON boundaries.

All geographic entities include a boundaries property containing a GeoJsonPolygon with type and coordinates.

Market Data

Retrieve real estate market data at the department, city, or district level.

Market endpoints only support GeoLevel::Department, GeoLevel::City, and GeoLevel::District. Using other levels will throw an InvalidArgumentException.

Sale Duration

Retrieve how long properties take to sell, at the department, city, or district level. Sale duration is aggregated across all property types and is available from January 2022.

Sale-duration endpoints accept the same GeoLevel::Department, GeoLevel::City, and GeoLevel::District levels as the price endpoints. Dates use the YYYY-MM format. currentSaleDuration()->value is null when no data is available.

DPE (Energy Performance Diagnostics)

Search Energy Performance Diagnostics (DPE). Like transactions, DPE search supports either code + geoLevel or latitude + longitude + radius, and is paginated with a searchAfter cursor.

DPE search accepts GeoLevel::City, GeoLevel::District, and GeoLevel::Address. The Dpe enum (A-G) is reused for both dpeRating and gesRating filters.

Enums

Enum Values
RealtyType House, Apartment
GeoLevel Region, Department, City, District, Street, Address
Dpe A, B, C, D, E, F, G
Condition ToRenovate (-1), Standard (0), Excellent (1)
MarketType Sales
Interval Monthly
Metric SqmPrice
DurationUnit Days, Months
DpeSortBy Date, LivingArea, EnergyConsFinal

Error Handling

All API errors throw typed exceptions extending ImmoDataException:

Custom HTTP Client

You can provide your own HTTP client for testing or custom transport by implementing HttpClientInterface:

Code Style

This package uses PHP CS Fixer with the PER Coding Style preset.

Testing

License

MIT

All versions of immo-data-php-sdk with dependencies

PHP Build Version
Package Version
Requires php Version ^8.3
guzzlehttp/guzzle Version ^7.5
ext-json Version *
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package trackstone/immo-data-php-sdk contains the following files

Loading the files please wait ...