Official Elasticsearch client library for Node.js and the browser
jbudz [ping()] determine ping timeout at runtime (#679)
* [ping()] determine ping timeout at runtime

* generate

* single line

* remove pingTimeout param

* [docs] Add note about pingTimeout priority

* remove default ping requestTimeout test

* add test
Latest commit 277d337 Sep 24, 2018

elasticsearch.js 15.1.1

The official low-level Elasticsearch client for Node.js and the browser.

Coverage Status Dependencies up to date


  • One-to-one mapping with REST API and the other official clients
  • Generalized, pluggable architecture. See Extending Core Components
  • Configurable, automatic discovery of cluster nodes
  • Persistent, Keep-Alive connections
  • Load balancing (with pluggable selection strategy) across all available nodes.

Use in Node.js

npm install elasticsearch

NPM Stats

Use in the Browser

Check out the Browser Builds doc page for help downloading and setting up the client for use in the browser.



You can probably find help in #kibana on freenode.

Supported Elasticsearch Versions

Elasticsearch.js provides support for, and is regularly tested against, Elasticsearch releases 0.90.12 and greater. We also test against the latest changes in several branches in the Elasticsearch repository. To tell the client which version of Elastisearch you are using, and therefore the API it should provide, set the apiVersion config param. More info


Create a client instance

var elasticsearch = require('elasticsearch');
var client = new elasticsearch.Client({
  host: 'localhost:9200',
  log: 'trace'

Send a HEAD request to / and allow up to 1 second for it to complete.{
  // ping usually has a 3000ms timeout
  requestTimeout: 1000
}, function (error) {
  if (error) {
    console.trace('elasticsearch cluster is down!');
  } else {
    console.log('All is well');

Skip the callback to get a promise back

try {
  const response = await{
    q: 'pants'
} catch (error) {

Find tweets that have "elasticsearch" in their body field

const response = await{
  index: 'twitter',
  type: 'tweets',
  body: {
    query: {
      match: {
        body: 'elasticsearch'

for (const tweet of response.hits.hits) {
  console.log('tweet:', tweet);

More examples and detailed information about each method are available here


This software is licensed under the Apache 2 license, quoted below.

Copyright (c) 2014 Elasticsearch <>

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
See the License for the specific language governing permissions and
limitations under the License.