Skip to main content

​
Welcome to Inspatial Cloud Client SDK

The Inspatial Cloud Client SDK provides a powerful TypeScript/JavaScript interface to interact with Inspatial Cloud APIs. Build real-time applications with REST and WebSocket support.

REST API Client

Full-featured HTTP client for CRUD operations, file uploads, and data queries

Real-time Client

WebSocket-based client for live data synchronization and event streaming

Type Safety

Built with TypeScript for complete type safety and excellent IDE support

Utilities

MIME type detection, currency helpers, and field type definitions

​
InCloudClient

The REST API client for interacting with Inspatial Cloud backend services. Key Features:
  • Entry management (create, read, update, delete)
  • File upload with progress tracking
  • Authentication handling
  • Settings management
  • ORM-style queries with filters
  • Custom error and notification handling

​
InLiveClient

The real-time WebSocket client for live data synchronization. Key Features:
  • Subscribe to entry changes by type and ID
  • Listen to entry type events (create, update, delete)
  • Monitor settings changes
  • Room-based event system
  • Automatic reconnection handling
  • Connection status monitoring

​
Getting Started

1

Install the SDK

Install the package using your preferred package manager
npm install @inspatial/cloud-client
2

Initialize Clients

Set up the REST and/or WebSocket clients
import { InCloudClient, InLiveClient } from '@inspatial/cloud-client';

const cloudClient = new InCloudClient('/api');
const liveClient = new InLiveClient('wss://your-host.com');
3

Start Building

Check out the Quickstart Guide for a complete working example

​
Next Steps

Installation

Detailed installation instructions for all environments

Quickstart

Get up and running with a working example in minutes

Build docs developers (and LLMs) love

Get started for freeTalk to us