Get started

About the official JavaScript driver

Neo4j provides official drivers for a number of popular programming languages. These drivers are supported by Neo4j.

Community drivers also exist for many languages, but vary greatly in terms of feature sets, maturity, and support. To find more about community drivers, visit

The following languages and frameworks are officially supported by Neo4j:

Table 1. Supported languages and frameworks for the 5.x driver series
Language/framework Versions supported




Java 17.


All LTS versions of Node.JS, specifically the 4.x and 6.x series runtimes.


Python 3.7 and above.

The driver API is intended to be topologically agnostic. This means that the underlying database topology — single instance, Causal Cluster, etc. — can be altered without requiring a corresponding alteration to application code.

In the general case, only the connection URI needs to be modified when changes are made to the topology.

The official drivers do not support HTTP communication. If you need an HTTP driver, choose one of the community drivers.

See also the HTTP API documentation.

Driver versions and installation

Wherever possible, it is recommended to use the latest stable driver release available. This will provide the greatest degree of stability and will ensure that the full set of server functionality is available. The drivers, when used with Neo4j Enterprise Edition, come with full cluster routing support. The drivers make no explicit distinction between Enterprise Edition and Community Edition however, and simply operate with the functionality made available by Neo4j itself.

Example 2. Acquire the driver

To use the JavaScript driver, it is recommended employing npm. To find the latest version of the driver, use:

npm show neo4j-driver@* version


  • Babel/Runtime (^7.5.5)

  • RxJS (^6.5.2)

  • buffer (^6.0.3)

  • string_decoder (^1.3.0)

The JavaScript Reactive API is built and exposed via RxJs. A dependency of RxJs is automatically installed with the driver.

Example 1. Installation via npm

To install the latest version of the driver:

npm install neo4j-driver

It is also an option to install a certain version of the driver.

npm install neo4j-driver@$JAVASCRIPT-DRIVER-VERSION

In the following example, driver version 5.5 is installed.

npm install neo4j-driver@5.5

The release notes for this driver are available here.

A "Hello World" example

The example below shows the minimal configuration necessary to interact with Neo4j through the JavaScript driver.

Example 3. Hello World
const driver = neo4j.driver(uri, neo4j.auth.basic(user, password))
const session = driver.session()

try {
  const result = await session.executeWrite(tx =>
      'CREATE (a:Greeting) SET a.message = $message RETURN a.message + ", from node " + id(a)',
      { message: 'hello, world' }

  const singleRecord = result.records[0]
  const greeting = singleRecord.get(0)

} finally {
  await session.close()

// on application exit:
await driver.close()

Driver API docs

For a comprehensive listing of all driver functionality, please see the /docs/api/javascript-driver/5.5/[JavaScript API reference documentation].