https://github.com/squarecloudofc/sdk-api-js
A wrapper written in JavaScript with a focus on using our API.
https://github.com/squarecloudofc/sdk-api-js
javascript nodejs npm-package squarecloud typescript
Last synced: 4 months ago
JSON representation
A wrapper written in JavaScript with a focus on using our API.
- Host: GitHub
- URL: https://github.com/squarecloudofc/sdk-api-js
- Owner: squarecloudofc
- License: mit
- Created: 2022-10-16T02:42:21.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2026-01-19T14:34:00.000Z (5 months ago)
- Last Synced: 2026-01-20T08:25:29.506Z (5 months ago)
- Topics: javascript, nodejs, npm-package, squarecloud, typescript
- Language: TypeScript
- Homepage: https://npmjs.com/@squarecloud/api
- Size: 646 KB
- Stars: 22
- Watchers: 0
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
@squarecloud/api
A NodeJS SDK for consuming the Square Cloud API.
## Installation
```bash
npm install @squarecloud/api
// or
yarn add @squarecloud/api
// or
pnpm add @squarecloud/api
```
## Documentation
Visit our [official documentation](https://docs.squarecloud.app/en/sdks/js/client) for more information about how to use this library.
## Getting Started
```ts
import { SquareCloudAPI } from "@squarecloud/api"
// const { SquareCloudAPI } = require("@squarecloud/api");
const api = new SquareCloudAPI("Your API Key")
const user = await api.users.get()
const application = user.applications.get("Application ID")
```
## Contributing
Feel free to contribute with suggestions or bug reports at our [GitHub repository](https://github.com/squarecloudofc/sdk-api-js).
## Authors
- [@joaotonaco](https://github.com/joaotonaco)
- [@joaootavios](https://github.com/joaootavios)