JOpenCage

Java Client for the OpenCage REST API

License

License

GroupId

GroupId

com.byteowls
ArtifactId

ArtifactId

jopencage
Last Version

Last Version

1.4.0
Release Date

Release Date

Type

Type

pom.sha512
Description

Description

JOpenCage
Java Client for the OpenCage REST API
Project URL

Project URL

https://github.com/moberwasserlechner/jopencage
Source Code Management

Source Code Management

https://github.com/moberwasserlechner/jopencage

Download jopencage

Dependencies

runtime (5)

Group / Artifact Type Version
org.slf4j : slf4j-api jar 1.7.25
org.apache.httpcomponents : httpclient jar 4.5.6
com.fasterxml.jackson.core : jackson-databind jar 2.9.7
com.fasterxml.jackson.core : jackson-core jar 2.9.7
com.fasterxml.jackson.core : jackson-annotations jar 2.9.7

Project Modules

There are no modules declared in this project.

JOpenCage

Maven Central Tests Donate

This api provides a java client to the OpenCage geocoding service. https://opencagedata.com/api

Usage

Maven

  <dependency>
    <groupId>com.byteowls</groupId>
    <artifactId>jopencage</artifactId>
    <version>replace.with.version</version>
  </dependency>

Gradle

    implementation "com.byteowls:jopencage:REPLACE.WITH.VERSION"

Example

Forward

// In real live application the JOpenCageGeocoder should be a Singleton
JOpenCageGeocoder jOpenCageGeocoder = new JOpenCageGeocoder(YOUR_API_KEY);

JOpenCageForwardRequest request = new JOpenCageForwardRequest("Graz");
request.setMinConfidence(1);
request.setNoAnnotations(false);
request.setNoDedupe(true);
JOpenCageResponse response = jOpenCageGeocoder.forward(request);

Reverse

// In real live application the JOpenCageGeocoder should be a Singleton
JOpenCageGeocoder jOpenCageGeocoder = new JOpenCageGeocoder(YOUR_API_KEY);

JOpenCageReverseRequest request = new JOpenCageReverseRequest(-22.6792, 14.5272);
request.setNoAnnotations(true);

JOpenCageResponse response = jOpenCageGeocoder.reverse(request);

Libraries

  • JDK 8+
  • Apache Http Client
  • FasterXml Jackson
  • Slf4j

Testing

For running the tests you have to use your OWN OpenCage API Key. Get a free trail key at https://opencagedata.com/dashboard#api-keys

./gradlew -DOPENCAGE_API_KEY=ABCDEFG_YOUR_KEY test

Gradle

./gradlew wrapper --gradle-version 6.8.3

Contribute

See Contribution Guidelines.

Changelog

See CHANGELOG.

License

Apache 2.0. Please see LICENSE.

BYTEOWLS Software & Consulting

This plugin is powered by BYTEOWLS Software & Consulting.

If you need extended support for this project like critical changes or releases ahead of schedule. Feel free to contact us for a consulting offer.

Disclaimer

We have no business relation to OpenCage.

Versions

Version
1.4.0