Skip to main content

Quick Start

More Examples

For comprehensive examples and ready-to-run code snippets, see the Quickstart Guide page in our Nexla SDK guides, which includes copy-paste examples for common tasks like listing resources, monitoring flows, and building dashboards.

Get up and running in minutes with this simple example:

Basic SDK Usage
from nexla_sdk import NexlaClient

# Initialize client (reads NEXLA_SERVICE_KEY from environment)
client = NexlaClient()

# List all your data flows
flows = client.flows.list()
print(f"Found {len(flows)} flows")

# Get flow details
flow = client.flows.get(flow_id="your-flow-id")
print(f"Flow '{flow.name}' status: {flow.status}")

Your First Request​

Let's start with a simple example to verify everything is working:

First API Call
from nexla_sdk import NexlaClient

# Initialize the client
client = NexlaClient()

try:
    # List all flows in your account
    flows = client.flows.list()
    print(f"✅ Successfully connected! Found {len(flows)} flows")
    
    # Display flow information
    for flow in flows[:3]:  # Show first 3 flows
        print(f"  - Flow: {flow.name} (ID: {flow.id})")
        print(f"    Status: {flow.status}")
        print(f"    Created: {flow.created_time}")
        print()
        
except Exception as e:
    print(f"❌ Connection failed: {e}")

Exploring Resources​

The SDK provides access to all major Nexla resources. Here are some common operations:

Working with Sources​

List Data Sources
# List all data sources
sources = client.sources.list()
print(f"Found {len(sources)} data sources")

# Get a specific source
if sources:
    source = client.sources.get(sources[0].id)
    print(f"Source: {source.name} ({source.type})")

Working with Destinations​

List Destinations
# List all destinations
destinations = client.destinations.list()
print(f"Found {len(destinations)} destinations")

# Get destination details
if destinations:
    dest = client.destinations.get(destinations[0].id)
    print(f"Destination: {dest.name} ({dest.type})")

Working with Projects​

List Projects
# List all projects
projects = client.projects.list()
print(f"Found {len(projects)} projects")

# Get current project info
if projects:
    project = client.projects.get(projects[0].id)
    print(f"Project: {project.name}")
    print(f"Description: {project.description}")

Next Steps​

Now that you have the SDK set up and working, explore these areas:

Quick Actions​

Common Use Cases​