wilwade / geocoder-extra

Geocoder extra features.

Geocoder Extra

This repository hosts Geocoder extra features that do not belong to the core but can be nonetheless interesting to share with other developers. It mostly contains providers.

Installation

The recommended way to install this package is through Composer:

{
    "require": {
        "geocoder-php/geocoder-extra": "@stable"
    }
}

Protip: you should browse the geocoder-php/geocoder-extra page to choose a stable version to use, avoid the @stable meta constraint.

Usage

Please, read the Geocoder's documentation.

Providers

Provider	Address?	IPv4?	IPv6?	Reverse?	SSL Support?	Coverage	Terms
OGD Vienna	yes	no	no	no	no	Vienna / Austria
Naver	yes	no	no	no	no	South Korea
Geocodio	yes	no	no	yes	no	USA
IpInfo	no	yes	yes	no	no
Here	yes	no	no	yes	no
IpGeoBase	no	yes	no	yes	no	Russia
Telize	no	yes	yes	no	no
Baidu	yes	no	no	yes	no	China	API key required
DataScienceToolkit	yes	yes	no	no	no	USA, Canada
GeoCoder.ca	yes	no	no	yes	yes	USA, Canada	Optional API key can be provided. $1 CAD for 400 lookups
GeoCoder.us	yes	no	no	no	no	USA	Free throttled service. $50 USD for 20000 requests for paid service
OIORest	yes	no	no	yes	no	Denmark
IGN OpenLS	yes	no	no	no	no	France	API key required

Contributing

See Geocoder's CONTRIBUTING file.

Unit Tests

To run unit tests, you'll need cURL and a set of dependencies you can install using Composer:

composer install --dev

Once installed, run the following command:

phpunit

You'll obtain some skipped unit tests due to the need of API keys.

Rename the phpunit.xml.dist file to phpunit.xml, then uncomment the following lines and add your own API keys:

<php>
    <!-- <server name="BAIDU_API_KEY" value="YOUR_API_KEY" /> -->
    <!-- <server name="IGN_WEB_API_KEY" value="YOUR_API_KEY" /> -->
</php>

You're done!

Contributor Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

License

geocoder-extra is released under the MIT License. See the bundled LICENSE file for details.