fw4 / omnicasa-api

v1.3.1 2026-10-07 11:32 UTC

Requires

• php: ^8.0
• guzzlehttp/guzzle: ~6.0|~7.0
• ocramius/package-versions: ^2.1

Requires (Dev)

• phpunit/phpunit: ^8.4|^9.0

MIT

• api
• sdk
• omnicasa

Published on Packagist.org on 2026-10-07 11:33 UTC

README

PHP client for the Onmicasa API.

Installation

composer require fw4/omnicasa-api

Usage

$client = new \Omnicasa\Omnicasa('name', 'password');
$properties = $client->getPropertyList([
    'CountryIDs' => [10]
]);
foreach ($properties as $property) var_dump($property->id);

It's also possible to construct requests through objects:

$request = new \Omnicasa\Request\Property\GetPropertyListRequest();
$request->countryIDs = [10];
$request->zips = [1000, 3000];

$client = new \Omnicasa\Omnicasa('name', 'password');
$properties = $client->getPropertyList($request);
foreach ($properties as $property) var_dump($property->id);

Properties on both requests and responses are implemented case insensitively. For more information about available request parameters and response properties, refer to the official API spec.

Pagination

When iterating over a response containing multiple objects, sequential pagination requests will automatically be sent in the background.

To fetch one page explicitly (page numbers start at 1):

$page = $client->getSiteList()->page(page: 1, perPage: 30);

echo count($page);            // Number of sites on this page
echo $page->getPage();        // 1
echo $page->getPageSize();    // 30
echo $page->getTotalCount();  // Number of sites across all pages
echo $page->getPageCount();   // Total number of pages

foreach ($page as $site) echo $site->id;