opencage-api-client

This repository is an OpenCage Geocoding API client for JavaScript and node.

Continuous integration

Security

Source	Scores
Meterian
FOSSA
Snyk

Tutorial

You can find a comprehensive tutorial for using this module on the OpenCage site.

🔧 Getting started

Signup for a free-trial API Key.

node

The library uses dotenv on node runtime to configure OpenCage Geocoding API key. But using key as an input parameter is always a possiblity.

First install the library with npm or yarn:

$ npm i --save opencage-api-client

or

$ yarn add opencage-api-client

or

$ pnpm add opencage-api-client

Create a .env file with:

OPENCAGE_API_KEY=YOUR-OPENCAGE_DATA_API_KEY

Here is an example:

const opencage = require('opencage-api-client');

opencage
  .geocode({ q: 'lyon' })
  .then((data) => {
    console.log(JSON.stringify(data));
  })
  .catch((error) => {
    console.log('error', error.message);
  });

browser

The browser version is built over the node one, obviously without the dotenv feature.

The library is available with unkpg CDN : https://unpkg.com/opencage-api-client

1- include the library:

<!-- latest version -->
<script src="https://unpkg.com/opencage-api-client"></script>

<!-- specific version -->
<script src="https://unpkg.com/[email protected]/dist/opencage-api.min.js"></script>

2- use it

opencage
  .geocode({ q: 'lyon', key: 'YOUR-API-KEY' })
  .then((data) => {
    console.log(JSON.stringify(data));
  })
  .catch((error) => {
    console.log('Error caught:', error.message);
  });

3- others Examples

Found some examples in the examples folder.

✨ API

geocode

Parameter	Type	Optional?	Description
q	String	mandatory	the query string to be geocoded: a placename, address or coordinates as lat,long
key	String	optional	the key can be omitted when using a proxyURL or when using node with a dedicated environment variable
proxyURL	String	optional	The proxy URL parameter (useful to hide your API key)

Error handling

API can return errors like invalid key, to many requests, daily quota exceeded, etc. Thoses errors are thrown as Javascript Error by the geocode function. The error object contains the same status object as the OpenCage API.

Assuming the catch statment uses error as variable name:

console.log('Error caught:', error.message);

will output for a 429:

Error caught: Too Many Requests

and

console.log(JSON.stringify(error, null, 2));

will output for a 429:

{
  "status": {
    "code": 429,
    "message": "Too Many Requests"
  }
}

Check the examples using the Test API key from OpenCage error handling examples

🔨 Build and test

1. Fork or clone this repository
2. $ cd into the repository folder
3. $ npm install to install all the required dependencies from npm
4. lint and test coverage using $ npm test
5. Build : $ npm run build

🛣 Revision History

Check the CHANGELOG file.

🥂 Contributing

Anyone and everyone is welcome to contribute.

🐞 Issues

Find a bug or want to request a new feature? Please let me know by submitting an issue.

🗝 Licensing

Licensed under the MIT License

A copy of the license is available in the repository's LICENSE file.