@openeo/js-client 1.0.0-rc.2


JavaScript client for the openEO API.

Build Status

The version of this client is 1.0.0-rc.2 and supports openEO API versions 1.0.x. Legacy versions are available as releases.


This library can run in node.js or any recent browser supporting ECMAScript 2017. This excludes Internet Explorer, but includes Edge >= 15.

Browser environment

To use it in a browser environment simply add the following code to your HTML file:

<script src="https://cdn.jsdelivr.net/npm/axios@0.19/dist/axios.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/oidc-client@1/lib/oidc-client.min.js"></script> <!-- Only required if you'd like to enable authentication via OpenID Connect -->
<script src="https://cdn.jsdelivr.net/npm/@openeo/js-client@latest/openeo.min.js"></script>

NodeJS environment

To install it in a NodeJS environment run: npm install @openeo/js-client

Afterwards, you can import the package: const { OpenEO } = require('@openeo/js-client');


More information can be found in the JS client documentation.

Advanced options

Generate a build: npm run build (generates openeo.js and openeo.min.js)

Generate the documentation to the docs/ folder: npm run docs

Check against the coding guidelines: npm run compat

Run tests:

  • npm test (all tests)
  • npm test browser (browser tests)
  • npm test node (node tests)
  • npm test builder (tests only the process builder)
  • npm test earthengine (full test suite using the Google Earth Engine back-end as server)

Interactive JS Editor

There is an experimental interactive web-based editor for coding using the openEO API, which is based on the JavaScript client. See https://github.com/Open-EO/openeo-web-editor for more details.