ziptastic/ziptastic

PHP SDK for the Ziptastic Lookup API

Ziptastic PHP

, _(*1)

This library is a simple interface for the Ziptastic API., _(*2)

Using Ziptastic requires an API key., _(*3)

Installing

Ziptastic PHP can be installed via composer:, _(*4)

composer require ziptastic/ziptastic

Ziptastic PHP relies on HTTPlug to make API requests. HTTPlug is an abstraction which allows you to choose from any one of a large number of HTTP clients, including the client you might already have installed., _(*5)

For more information on getting started with HTTPlug, please refer to the HTTPlug for library users documentation., _(*6)

To just get moving right now, install a couple common dependencies:, _(*7)

composer require php-http/curl-client guzzlehttp/psr7 php-http/message

Usage

<?php

include "vendor/autoload.php";

use Ziptastic\Client;

$z = Client::create(getenv('ZIPTASTIC_API_KEY'));

Ziptastic provides two API methods: Lookup by a postal code (forward lookup), and lookup by latitude and longitude (reverse lookup)., _(*8)

$result = $z->forward(48038);
$result = $z->reverse(42.331427, -83.0457538, 1000);

Results are returned as a list of arrays:, _(*9)

<?php

$lookup = current($result);
echo $lookup['county']; // Macomb
echo $lookup['city']; // Clinton Township
echo $lookup['state']; // Michigan
echo $lookup['state_short']; // MI
echo $lookup['postal_code']; // 48038
echo $lookup['latitude']; // 42.5868882
echo $lookup['longitude']; // -82.9195514

// Timezones are represented by an instance of \DateTimeZone
echo $lookup['timezone']->getName(); // America/Detroit

PHP 5

If you require PHP 5 compatibility, please use Ziptastic-PHP version 1., _(*10)

License

Ziptastic PHP is licensed under the MIT license., _(*11)