forward-force/estated-api-sdk

PHP Wrapper around Estated API

1.2 2021-04-27 13:01 UTC

Requires

• php: ^7.4|^8.0
• ext-json: *
• guzzlehttp/guzzle: ^7.0.1

Requires (Dev)

• phpmd/phpmd: ^2.9
• phpunit/phpunit: ^9.5
• squizlabs/php_codesniffer: ^3.5
• vimeo/psalm: ^4.5

MIT

• Teodor Talov

• api
• estated
• forwardforce

README

Installation

Install via composer as follows:

composer require forward-force/estated-api-sdk

Usage

Authentication

Fetch by address:

$estated = new Estated($token);

try {
    $property = $estated->property('151 Battle Green Dr', 'Rochester', 'NY', '14624');
    var_dump($property);
} catch (GuzzleException $e) {
    var_dump($e->getMessage());
}

Contributions

To run locally, you can use the docker container provided here. You can run it like so:

docker-compose up

There is auto-generated documentation as to how to run this library on local, please take a look at phpdocker/README.md

If you find an issue, have a question, or a suggestion, please don't hesitate to open a github issue.

Acknowledgments

Thank you to phpdocker.io for making getting PHP environments effortless!