.. include:: include_announcement.rst

=================================
web3.js - Ethereum JavaScript API
=================================

web3.js is a collection of libraries which allow you to interact with a local or remote Ethereum node,
using an HTTP, WebSocket or IPC connection.

The following documentation will guide you through :ref:`installing and running web3.js <adding-web3>`,
as well as providing a :ref:`API reference documentation <#id1>` with examples.

Contents:

:ref:`Keyword Index <genindex>`, :ref:`Search Page <search>`

.. toctree::
   :maxdepth: 2
   :caption: User Documentation

   getting-started
   callbacks-promises-events
   glossary


.. toctree::
    :maxdepth: 2
    :caption: API Reference

    web3
    web3-eth
    web3-eth-subscribe
    web3-eth-contract
    web3-eth-accounts
    web3-eth-personal
    web3-eth-ens
    web3-eth-iban
    web3-eth-net
    web3-eth-abi
    web3-net
    web3-bzz
    web3-shh
    web3-utils
    web3-module
    web3-module-contract
    web3-core
    web3-core-method
    web3-core-subscriptions
    web3-eth-admin
    web3-eth-debug
    web3-eth-miner
    web3-eth-txpool