Spotler Python API Docs | dltHub

Spotler is a marketing & messaging platform suite that provides REST APIs to manage contacts, lists, transactions, configurations, messaging channels and product/item search. The REST API base URL is https://app.spotlerconnect.com/rest/v1 and All Spotler Connect endpoints require an API key passed in the X-API-KEY header; Spotler Message API uses a Bearer token in the Authorization header..

dlt is an open-source Python library that handles authentication, pagination, and schema evolution automatically. dlthub provides AI context files that enable code assistants to generate production-ready pipelines. Install with uv pip install "dlt[workspace]" and start loading Spotler data in under 10 minutes.

---

What data can I load from Spotler?

Here are some of the endpoints you can load from Spotler:

---

How do I authenticate with the Spotler API?

Spotler Connect: include header "X-API-KEY: YOUR_SECRET_TOKEN" on every request. Spotler Message: include header "Authorization: Bearer <API_KEY>". TLS 1.2+ and "application/json" content type are required.

1. Get your credentials

1. Log in to the Spotler platform.
2. Open the Spotler Connect connector configuration screen.
3. Navigate to the Advanced configuration section.
4. Copy the Project key – this is the API key for Spotler Connect.
5. For Spotler Message, open the Eazy.im developer console, locate the API keys section and copy the generated token.
6. Store the key/token securely for use in requests.

2. Add them to .dlt/secrets.toml

Copy
[sources.spotler_source]
api_key = "your_spotler_connect_api_key_here"
# or for message API
# token = "your_spotler_message_bearer_token_here"

dlt reads this automatically at runtime — never hardcode tokens in your pipeline script. For production environments, see setting up credentials with dlt for environment variable and vault-based options.

---

How do I set up and run the pipeline?

Set up a virtual environment and install dlt:

Copy
uv venv && source .venv/bin/activate
uv pip install "dlt[workspace]"

1. Install the dlt AI Workbench:

Copy
dlt ai init --agent <your-agent> # <agent>: claude | cursor | codex

This installs project rules, a secrets management skill, appropriate ignore files, and configures the dlt MCP server for your agent. Learn more →

2. Install the rest-api-pipeline toolkit:

Copy
dlt ai toolkit rest-api-pipeline install

This loads the skills and context about dlt the agent uses to build the pipeline iteratively, efficiently, and safely. The agent uses MCP tools to inspect credentials — it never needs to read your secrets.toml directly. Learn more →

3. Start LLM-assisted coding:

Use /find-source to load data from the Spotler API into DuckDB.

The rest-api-pipeline toolkit takes over from here — it reads relevant API documentation, presents you with options for which endpoints to load, and follows a structured workflow to scaffold, debug, and validate the pipeline step by step.

4. Run the pipeline:

Copy
python spotler_pipeline.py

If everything is configured correctly, you'll see output like this:

Copy
Pipeline spotler_pipeline load step completed in 0.26 seconds
1 load package(s) were loaded to destination duckdb and into dataset spotler_data
The duckdb destination used duckdb:/spotler.duckdb location to store data
Load package 1749667187.541553 is LOADED and contains no failed jobs

Inspect your pipeline and data:

Copy
dlt pipeline spotler_pipeline show

This opens the Pipeline Dashboard where you can verify pipeline state, load metrics, schema (tables, columns, types), and query the loaded data directly.

---

Python pipeline example

This example loads contact_list_members and contact from the Spotler API into DuckDB. It mirrors the endpoint and data selector configuration from the table above:

Copy
import dlt
from dlt.sources.rest_api import RESTAPIConfig, rest_api_resources

@dlt.source
def spotler_source(api_key=dlt.secrets.value):
    config: RESTAPIConfig = {
        "client": {
            "base_url": "https://app.spotlerconnect.com/rest/v1",
            "auth": {
                "type": "api_key",
                "api_key": api_key,
            },
        },
        "resources": [
            {"name": "contact_list_members", "endpoint": {"path": "contact_list/{id}/members", "data_selector": "data"}},
            {"name": "contact", "endpoint": {"path": "contact"}}
        ],
    }
    yield from rest_api_resources(config)


def get_data() -> None:
    pipeline = dlt.pipeline(
        pipeline_name="spotler_pipeline",
        destination="duckdb",
        dataset_name="spotler_data",
    )
    load_info = pipeline.run(spotler_source())
    print(load_info)

To add more endpoints, append entries from the resource table to the "resources" list using the same name, path, and data_selector pattern.

---

How do I query the loaded data?

Once the pipeline runs, dlt creates one table per resource. You can query with Python or SQL.

Python (pandas DataFrame):

Copy
import dlt

data = dlt.pipeline("spotler_pipeline").dataset()
sessions_df = data.contact_list_members.df()
print(sessions_df.head())

SQL (DuckDB example):

Copy
SELECT * FROM spotler_data.contact_list_members LIMIT 10;

In a marimo or Jupyter notebook:

Copy
import dlt

data = dlt.pipeline("spotler_pipeline").dataset()
data.contact_list_members.df().head()

See how to explore your data in marimo Notebooks and how to query your data in Python with dataset.

---

What destinations can I load Spotler data to?

dlt supports loading into any of these destinations — only the destination parameter changes:

Change the destination in dlt.pipeline(destination="snowflake") and add credentials in .dlt/secrets.toml. See the full destinations list.

---

Troubleshooting

Authentication failures

Spotler Connect returns 401 Unauthorized when the X-API-KEY header is missing or invalid. Example curl in the docs shows a 401 response for /configuration/self when the header is omitted.

Pagination

List endpoints (e.g., /contact_list/{id}/members) include a pagination object alongside data. Use query parameters page and size to navigate pages. Pagination fields: current_page, next_page, page_count, page_size, prev_page, total_count, total_pages.

Rate limits and generic errors

The API uses standard HTTP status codes: 400 Bad Request, 401 Unauthorized, 403 Forbidden, 404 Not Found, 500 Internal Server Error, 503 Service Unavailable. The health‑check endpoint returns 200 OK when the service is up and 503 when down.

Ensure that the API key is valid to avoid 401 Unauthorized errors. Also, verify endpoint paths and parameters to avoid 404 Not Found errors.

---

Next steps

Continue your data engineering journey with the other toolkits of the dltHub AI Workbench:

• data-exploration — Build custom notebooks, charts, and dashboards for deeper analysis with marimo notebooks.
• dlthub-runtime — Deploy, schedule, and monitor your pipeline in production.

Copy
dlt ai toolkit data-exploration install
dlt ai toolkit dlthub-runtime install

• How to deploy a pipeline
• How to explore your data in marimo Notebooks
• How to query your data in Python with dataset
• Join the dlt community on Slack