pdir/immobilienscout-api

Simple API Integration for Immobilienscout24

1.2.0 2023-03-21 10:53 UTC

Requires

• php: ^7.2 || ^8.0
• ext-curl: *
• ext-json: *
• guzzlehttp/guzzle: ^6.3
• guzzlehttp/oauth-subscriber: 0.4.*
• psr/cache: ^1.0

Requires (Dev)

• fzaninotto/faker: ^1.9.1
• phpunit/phpunit: ^8.5
• symfony/cache: ^5.1

MIT

• rest
• api
• immobilienscout

README

Requirements

PHP: >= 7.2
Extensions: Composer, PHP-JSON

Install

composer:
composer require pdir/immoscout-api

Usage

Search for the official API Documentation here.
You need an Consumer Key and Consumer Secret - Get your client credentials.

Use IS24 RestAPI playground for testing and getting the Access Token and Access Secret.

Manual generate Access Token and Access Secret (German)

Basic

// 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');