Official SDK

Get Started with Lystica Cloud SDK

The official Node.js & TypeScript SDK for the Lystica Cloud API. Access professional contacts, companies, email campaigns, and lists programmatically. Integrate Lystica data into your applications, CRMs, and workflows.

View on npm Get API Key

Installation

Install the package using your preferred package manager:

npmnpm install lystica-cloud

yarnyarn add lystica-cloud

pnpmpnpm add lystica-cloud

Package on npm

https://www.npmjs.com/package/lystica-cloud

Quick Start

Initialize the SDK and fetch your first contacts in seconds:

import { LysticaCloud } from "lystica-cloud";

const lystica = new LysticaCloud({
  apiKey: process.env.LYSTICA_API_KEY!,
});

// Fetch contacts
const { data, meta } = await lystica.contacts.list({
  limit: 50,
  industry: "Technology",
});

console.log(`Found ${meta.total} contacts`);
data.forEach((contact) => {
  console.log(`${contact.fullName} — ${contact.email}`);
});

Getting an API Key

You need an API key to use the SDK. Follow these steps:

Go to Dashboard → API Keys

Click Create API Key

Copy the key immediately (it's only shown once)

Store it securely (environment variable, secrets manager, etc.)

API keys use the format: lys_live_... (production) or lys_test_... (sandbox).

Get API Key

Configuration

Configure the SDK with optional settings:

Option	Type	Default	Description
apiKey	string	—	Required. Your Lystica API key.
baseUrl	string	https://api.lystica.cloud	API base URL.
timeout	number	30000	Request timeout in ms.
maxRetries	number	2	Auto-retries on 5xx / network errors.

Learn How to Use the SDK

Explore the SDK capabilities with practical examples and patterns.

Contacts API

List, search, create, update, and manage contacts.

// List with filters
const { data, meta } = await lystica.contacts.list({
  limit: 100,
  industry: "Finance",
  country: "United States",
  seniority: "Director",
});

// Get by ID
const contact = await lystica.contacts.get("cnt_abc123");

// Create
const newContact = await lystica.contacts.create({
  email: "jane@example.com",
  firstName: "Jane",
  lastName: "Doe",
  company: "Acme Inc",
  tags: ["lead", "enterprise"],
});

// Update
const updated = await lystica.contacts.update("cnt_abc123", {
  jobTitle: "VP of Engineering",
});

Additional Resources

npm Package

View the full package documentation, changelog, and version history on npm.

View on npm

API Keys

Generate and manage API keys for your applications. Required to use the SDK.

Get API Key

Security

Never expose your API key in client-side / browser code. Always call the Lystica API from a server or serverless function.

Ready to Build?

Get your API key and start integrating Lystica Cloud into your applications today.

Get API Access View on npm