https://github.com/geocodefarm/geocodefarm-php
Geocode.Farm SDK for PHP
https://github.com/geocodefarm/geocodefarm-php
composer composer-library composer-package geocode geocode-api geocode-farm geocodefarm geocoder geocoder-php geocoder-provider geocoding geocoding-api geocoding-library geocoding-service geocoding-services php php-library php-sdk php7 php8
Last synced: 7 months ago
JSON representation
Geocode.Farm SDK for PHP
- Host: GitHub
- URL: https://github.com/geocodefarm/geocodefarm-php
- Owner: geocodefarm
- License: unlicense
- Created: 2025-04-04T20:21:39.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2025-04-05T15:27:37.000Z (9 months ago)
- Last Synced: 2025-05-08T00:13:16.358Z (8 months ago)
- Topics: composer, composer-library, composer-package, geocode, geocode-api, geocode-farm, geocodefarm, geocoder, geocoder-php, geocoder-provider, geocoding, geocoding-api, geocoding-library, geocoding-service, geocoding-services, php, php-library, php-sdk, php7, php8
- Language: PHP
- Homepage:
- Size: 37.1 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Geocode.Farm PHP SDK
A lightweight, dependency-free PHP SDK for interacting with the [Geocode.Farm](https://geocode.farm) geocoding API.
This SDK allows developers to easily perform **forward** (address to coordinates) and **reverse** (coordinates to address) geocoding using a simple object-oriented interface.
---
## 📦 Installation
You can install the SDK via [Composer](https://getcomposer.org):
```bash
composer require geocodefarm/geocodefarm-php
```
---
## 🚀 Quick Start
```php
forward('30 N Gould St, Sheridan, WY');
print_r($response);
// Reverse geocoding: lat/lon to address
$response = $client->reverse(44.797773, -106.954918);
print_r($response);
```
---
## ✅ Response Format
Both methods (`forward()` and `reverse()`) return an array like this on success:
```php
[
'success' => true,
'status_code' => 200,
'lat' => 44.797773,
'lon' => -106.954918,
'accuracy' => 'EXACT_MATCH',
'full_address' => '30 N Gould St, Sheridan, WY 82801',
'result' => [
'house_number' => '30',
'street_name' => 'N Gould St',
'locality' => 'Sheridan',
'admin_2' => 'Sheridan County',
'admin_1' => 'WY',
'country' => 'United States',
'postal_code' => '82801',
'formatted_address' => '30 N Gould St, Sheridan, WY 82801',
'latitude' => 44.797773,
'longitude' => -106.954918,
'accuracy' => 'EXACT_MATCH'
]
]
```
If an error occurs:
```php
[
'success' => false,
'status_code' => 403,
'error' => 'API returned failure: INVALID_KEY'
]
```
---
## 📝 License
This SDK is released under [The Unlicense](https://unlicense.org/) — public domain. Use it freely.
---
## 🤝 Contributing
Pull requests and issues are welcome!
---
## 🌐 About
For more information about the geocoding API, visit [https://geocode.farm](https://geocode.farm).