Node.js SDK

Start developing with Square in a matter of minutes. The Square Node.js SDK (beta) supports Square APIs in a language-idiomatic way that reduces complexity without sacrificing API functionality. The single downloadable package contains all the code and documentation you need to get started.

For information about the current Connect Node.js SDK (deprecated), including migration information, see the Connect SDK README.

Installation

Option 1: Install using npm:

$ npm install square

Option 2: Install using GitHub:

First, clone the repo:

git clone https://github.com/square/square-nodejs-sdk.git

Then, build the SDK:

$ cd square-nodejs-sdk
$ npm link

Lastly, run the following in the directory that contains your code:

$ npm link square

Additional resources

• Learn more about the latest SDK in the Release Notes.

• Connect with other developers in one of our forums.

• Get support using Slack and email.

• Stay up to date with our releases by signing up for our Newsletter.

• Check out our other SDKs on our Square SDKs page.