API Docs for version 1.3.1803

Circuit JavaScript SDK

The Circuit JavaScript SDK can be used client-side in a browser, or server-side in Node.js as a Bot for example.

If you don't have a developer account yet, get one for free. You need an account to use the SDK.

You also need to register an OAuth 2.0 app via the form on circuit.github.io.

The entry point for the SDK documentation is the module Circuit with its main class Client.

Quick Start

See README on github.


Client-side (browser)


Node.js example apps are on github. E.g.

Runkit allows playing with Node.js modules live, similar to jsbin or jsfiddle on the client. Try it on runkit

See README on github.com/circuit/circuit-sdk for more info.

Change Log