https://github.com/pdir/immobilienscout-api
Simple API Integration for Immobilienscout24
https://github.com/pdir/immobilienscout-api
Last synced: 9 months ago
JSON representation
Simple API Integration for Immobilienscout24
- Host: GitHub
- URL: https://github.com/pdir/immobilienscout-api
- Owner: pdir
- License: mit
- Created: 2020-11-13T10:12:46.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-03-21T10:53:30.000Z (over 3 years ago)
- Last Synced: 2025-09-02T10:45:01.952Z (11 months ago)
- Language: PHP
- Size: 10.7 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Simple Immobilienscout24 PHP API
## Requirements
PHP: >= 7.2
Extensions: [Composer](https://getcomposer.org/), [PHP-JSON](https://www.php.net/manual/en/book.json.php)
## Install
composer:
`composer require pdir/immoscout-api`
## Usage
Search for the official API Documentation [here](https://api.immobilienscout24.de/api-docs/get-started/introduction/).
You need an *Consumer Key* and *Consumer Secret* - [Get your client credentials](https://api.immobilienscout24.de/api-docs/get-started/get-your-client-credentials/).
Use [IS24 RestAPI playground](https://playground.immobilienscout24.de/rest/playground) for testing and getting the Access Token and Access Secret.
Manual [generate Access Token and Access Secret](https://pdir.de/docs/de/customer/immobileinscout24-api/) (German)
### Basic
```php
// store keys in .env file or use credentials array
$credentials = [
'consumerKey' => 'IS24_CONSUMER_KEY',
'consumerSecret' => 'IS24_CONSUMER_SECRET',
'tokenKey' => 'IS24_TOKEN_KEY',
'tokenSecret' => 'IS24_TOKEN_SECRET',
];
$api = new \Pdir\Immoscout\Api();
or
$api = new \Pdir\Immoscout\Api($credentials);
// get all real estates with details
$estates = $api->getAllRealEstates(true);
// get only active real estates with details
$estates = $api->getAllRealEstates(true, false, true);
// get real estate by id
$estate = $api->getRealEstate('1234567890');
// get attachments by id
$attachments = $api->getAttachments('1234567890');
// get contact by id
$contact = $api->getContact('1234567890');
```