Documentation

Everything you need to build with Locus

Guides, API reference, and integration tutorials. From first listing to production deployment.

Quick Start — install & first call

$ npm install @locus/sdk

import Locus from "@locus/sdk";

const client = new Locus({ apiKey: process.env.LOCUS_API_KEY });

// Create a property listing
const property = await client.properties.create({
  address: "1240 Skyline Drive, Unit 42A",
  city: "San Francisco",
  state: "CA",
  bedrooms: 3,
  bathrooms: 3,
  monthlyRent: 4200,
});

logger.info(property.id); // "prop_abc123"

Start here

Quick Start

Create your first property listing and invite a tenant in under 5 minutes.

API Reference

Full reference for properties, tenants, leases, payments, and maintenance endpoints.

Integrations

Connect Locus to listing feeds, accounting, document signing, billing, and 50+ other tools.

Security & Compliance

SOC 2, GDPR, CCPA, data residency options, encryption, and audit logging.

Guides

Step-by-step tutorials for common property management workflows.

Support

Can't find what you need? Reach our team directly.

Base URL: https://api.locusprop.app/v1