Skip to main content

Nexla Python SDK

The Nexla Python SDK is a comprehensive, typed client library that enables developers to programmatically interact with the Nexla data platform. Built with modern Python practices, it provides an intuitive interface for building, operating, and monitoring data pipelines at scale.

Key Features​

Complete API Coverage​

  • Resources: Flows, sources, destinations, nexsets, lookups, users, organizations, teams, projects, notifications, and metrics
  • Full CRUD Operations: Create, read, update, and delete operations for all supported resources
  • Bulk Operations: Efficient batch processing capabilities

Developer Experience​

  • Type Safety: Full type hints with Pydantic v2-based models for requests and responses
  • IDE Support: Rich autocomplete and inline documentation
  • Validation: Automatic request/response validation and error handling

Enterprise Ready​

  • Authentication: Service key (recommended) or access token authentication
  • Reliability: Built-in retries, error mapping, and robust HTTP client
  • Observability: Optional OpenTelemetry tracing for monitoring and debugging
  • Python 3.9+: Compatible with modern Python versions

What You Can Build​

  • Data Pipelines: Create and manage complex ETL/ELT workflows
  • Data Integration: Connect disparate data sources and destinations
  • Monitoring & Alerting: Set up notifications and track pipeline metrics
  • Automation: Automate data operations and pipeline management
  • Analytics: Query and analyze pipeline performance data

Quick Start​

Get up and running in minutes with this simple example. The code below shows how to initialize the SDK client and perform basic operations like listing flows and retrieving flow details.

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}")

A more in-depth introduction to the Nexla SDK can be found on the Quickstart page and other pages in the Getting Started section.

Documentation Structure​

Installation​

pip install nexla-sdk

Requirements: Python 3.9+

Next Steps​

Ready to start building? Choose your path: