Beta Release
This is pre-release documentation for an API in public beta and is subject to change.
Samples and SDKs

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.

Info Icon

Latest SDK Version: 7.0.0

Installation Permalink Get a link to this section

Option 1: Install using npm: Permalink Get a link to this section

$ npm install square

Option 2: Install using GitHub: Permalink Get a link to this section

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 Permalink Get a link to this section