OpenCage Data geocoder API client
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci
__tests__
dist
docs
resources
samples
src
.eslintignore
.eslintrc.js
.gitignore
.prettierignore
.prettierrc
LICENSE.md
README.md
index.js
jest.config.js
package-lock.json
package.json
webpack.config.js

README.md

opencage-api-client

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

CircleCI codecov code style: prettier

Getting started

Signup for a free API Key.

node

The library uses dotenv on node runtime to configure OpenCage Data API key.

First install the library with npm or yarn:

$ npm i --save opencage-api-client

or

$ yarn add opencage-api-client

Create a .env file with:

OCD_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@0.3.0/dist/opencage-api.min.js

1- include the library:

<script src="https://unpkg.com/opencage-api-client@0.3.0/dist/opencage-api.min.js"></script>

2- use it

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

API

geocode

Parameter Type Optional? Description
q String mandatory the query string to be geocoded; a placename or lat+long. This must be URL encoded.
key String optional the key can be omitted when using a proxyURL and when using node with a dedicated environment variable
proxyURL String optional The proxy URL parameter (useful to hide your API key)

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 using $ npm test
  5. coverage $ npm run coverage
  6. Build : $ npm run build

Revision History

Version Date Description
v0.3.0 28/08/2018 adding readme documentation and upgrade dependencies
v0.2.0 17/07/2018 Allow a proxy URL to use instead of official API endpoint
v0.1.1 21/06/2018 Open Cage website URL has changed
v0.1.0 04/03/2018 first release

Nb Using European Date Format 😄 Sorry 🇺🇸

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.