https://github.com/geocodefarm/geocodefarm-java
Java SDK for the Geocode.Farm API
https://github.com/geocodefarm/geocodefarm-java
geocode geocode-api geocode-farm geocodefarm geocoder-api geocoder-library geocoder-provider geocoding geocoding-api geocoding-service geocoding-services java java-geopackage java-jar-client java-sdk
Last synced: 13 days ago
JSON representation
Java SDK for the Geocode.Farm API
- Host: GitHub
- URL: https://github.com/geocodefarm/geocodefarm-java
- Owner: geocodefarm
- License: unlicense
- Created: 2025-04-05T16:30:44.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2025-04-05T18:07:15.000Z (3 months ago)
- Last Synced: 2025-05-30T19:17:59.667Z (26 days ago)
- Topics: geocode, geocode-api, geocode-farm, geocodefarm, geocoder-api, geocoder-library, geocoder-provider, geocoding, geocoding-api, geocoding-service, geocoding-services, java, java-geopackage, java-jar-client, java-sdk
- Language: Java
- Homepage: https://geocode.farm
- Size: 14.6 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 Java SDK
The official Java SDK for integrating with the Geocode.Farm API. This SDK provides methods for forward and reverse geocoding, allowing easy access to geolocation data from Geocode.Farm.
## Features
- **Forward Geocoding**: Convert an address into latitude and longitude.
- **Reverse Geocoding**: Convert latitude and longitude into a human-readable address.
- **Error Handling**: Handles errors gracefully, returning informative messages for easy debugging.
## Installation
To use the SDK in your Java project, you can either download the `.jar` file (see Releases) or clone the repository and build it yourself.
### Gradle
```gradle
dependencies {
implementation 'com.geocodefarm:geocodefarm-java:4.0'
}
```
### Maven
```xml
com.geocodefarm
geocodefarm-java
4.0
```
## Setup
1. Clone the repository:
```bash
git clone https://github.com/geocodefarm/geocodefarm-java.git
```
2. Build the SDK (using your preferred method, such as Gradle or Maven).
3. Initialize the GeocodeFarm client with your API key:
```java
GeocodeFarm geocodeFarm = new GeocodeFarm("your-api-key");
```
## Usage
### Forward Geocoding
Use the `forward()` method to convert an address into latitude and longitude.
```java
GeocodeFarm geocodeFarm = new GeocodeFarm("your-api-key");
GeocodeFarm.GeocodeResponse response = geocodeFarm.forward("1600 Pennsylvania Ave NW, Washington, DC");
if (response.isSuccess()) {
System.out.println("Latitude: " + response.getAccuracy());
System.out.println("Longitude: " + response.getFullAddress());
} else {
System.out.println("Error: " + response.getError());
}
```
### Reverse Geocoding
Use the `reverse()` method to convert latitude and longitude into a human-readable address.
```java
GeocodeFarm geocodeFarm = new GeocodeFarm("your-api-key");
GeocodeFarm.GeocodeResponse response = geocodeFarm.reverse(38.8977, -77.0365);
if (response.isSuccess()) {
System.out.println("Address: " + response.getFullAddress());
} else {
System.out.println("Error: " + response.getError());
}
```
## Contributing
We are open to contributions! If you find any bugs or would like to add new features, feel free to submit a pull request.
## License
This project is licensed under the [The Unlicense](http://unlicense.org/).
## Contact
For support, please reach out to us at [[email protected]](mailto:[email protected]).