Official SDKs for JavaScript, Python and Go

Choose your SDK

All SDKs are open source and available on GitHub. They have zero runtime dependencies and return the API’s own data, field names included.

JavaScript

@squarecloud/api v6. Apps, databases, workspaces, deploys, network, realtime, snapshots and AI, on Node.js, Deno, Bun and edge runtimes.

Python

squarecloud-api v5. The same coverage, with a sync and an async client, using only the standard library.

Go

sdk-api-go v3. The same coverage, with context on every call and one error type.

Blob Storage (JavaScript)

@squarecloud/blob v4. Uploads up to 10 GiB, private objects, links, shares, rules and the S3 gateway, on Node.js and in the browser.

At a glance

SDK	Package	Version	Runtime	Install
JavaScript	`@squarecloud/api`	6.0.0	Node.js 22+, Deno, Bun, edge	`npm install @squarecloud/api`
Python	`squarecloud-api` (import `squarecloud`)	5.0.0	Python 3.11+	`pip install squarecloud-api`
Go	`github.com/squarecloudofc/sdk-api-go/v3`	3.0.0	Go 1.22+	`go get github.com/squarecloudofc/sdk-api-go/v3`
Blob Storage	`@squarecloud/blob`	4.0.0	Node.js 20+ and browsers	`npm install @squarecloud/blob`

Quickstart

Make your first call in a few minutes. Each program below prints your account name and how many apps your API key can see.

Create an API key

Create a key in your account security settings. Treat it like a password: keep it out of your source code.

Set the SQUARECLOUD_API_KEY environment variable

The examples read the key from SQUARECLOUD_API_KEY. Set it in the terminal where you run them:

macOS / Linux
Windows (PowerShell)

export SQUARECLOUD_API_KEY="your-api-key"

$env:SQUARECLOUD_API_KEY = "your-api-key"

Install the SDK and make your first call

JavaScript
Python
Go

npm install @squarecloud/api

index.mjs

import { SquareCloudAPI } from "@squarecloud/api";

const api = new SquareCloudAPI(process.env.SQUARECLOUD_API_KEY);
const { user, applications } = await api.account.me();

console.log(`Hi ${user.name}, you have ${applications.length} apps`);

node index.mjs

pip install squarecloud-api

main.py

import os

from squarecloud import SquareCloud

with SquareCloud(os.environ["SQUARECLOUD_API_KEY"]) as client:
    me = client.account.me()
    print(f"Hi {me['user']['name']}, you have {len(me['applications'])} apps")

python main.py

go mod init example.com/hello
go get github.com/squarecloudofc/sdk-api-go/v3

main.go

package main

import (
	"context"
	"fmt"
	"log"
	"os"

	"github.com/squarecloudofc/sdk-api-go/v3"
)

func main() {
	c := squarecloud.New(os.Getenv("SQUARECLOUD_API_KEY"))

	me, err := c.Account.Me(context.Background())
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("Hi %s, you have %d apps\n", me.User.Name, len(me.Applications))
}

go run .

Check the output

The program prints your account name and the number of apps the key can see:

Hi Jane, you have 3 apps

A 401 ACCESS_DENIED error means the key is wrong, revoked or expired. If the variable is not set, the program stops before sending anything.

What each SDK covers

The JavaScript, Python and Go SDKs cover the whole Square Cloud API: the same 67 operations, plus downloading snapshot files. They share the same page structure, the same examples and the same behavior:

one error class, with the HTTP status and the API’s error code;
a 30-second timeout, and at least 120 seconds for calls the server holds open;
retries only for failures that are safe to repeat, never for a 429;
<appId>-<workspaceId> ids to act on apps shared through a workspace.

The Blob Storage SDK covers the Blob API and the S3 gateway. It is a separate package with its own client, credentials and error codes.

Error references

Each SDK page on errors covers its error class, retries and rate limits. The error codes themselves come from the API: the API error reference lists every one, and the Blob API errors reference lists the Blob Storage codes.

SDK	Errors, retries and rate limits
JavaScript	`SquareCloudAPIError`
Python	`SquareCloudAPIError`
Go	`*APIError`
Blob Storage	`SquareCloudBlobError`

Upgrading

Every API SDK release above is a rewrite. See the migration guides: JavaScript v5 → v6, Python v4 → v5, Go v2 → v3 and Blob v3 → v4. Square Cloud keeps improving its SDKs and adding new languages. If yours is missing, let us know.

Next steps

API introduction

Call the REST API directly, with curl.

CLI quickstart

Deploy and manage apps from the terminal.

Blob API quickstart

Upload a file to Blob Storage with curl.

​Choose your SDK

JavaScript

Python

Go

Blob Storage (JavaScript)

​At a glance

​Quickstart

​What each SDK covers

​Error references

​Upgrading

​Next steps