Xsolla Python API Docs | dltHub

Xsolla is a payment and commerce platform providing APIs for game developers, including Pay Station, Subscriptions, Login, and Shop Builder services. The REST API base URL is https://api.xsolla.com and API calls typically require either Basic HTTP Authentication or Bearer token-based JWT authentication..

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 add "dlt[hub]" and start loading Xsolla data in under 10 minutes.

---

What data can I load from Xsolla?

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

---

How do I authenticate with the Xsolla API?

Xsolla APIs primarily use Basic HTTP Authentication for server-to-server calls by providing a Base64-encoded 'merchant_id

' or 'project_id' string in the 'Authorization: Basic ' header. Some services alternatively utilize 'Bearer <user_JWT>' or 'X-SERVER-AUTHORIZATION: <server_JWT>' headers depending on the authentication scheme defined for the specific API endpoint.

1. Get your credentials

To obtain your Xsolla API credentials, log in to your Publisher Account at https://publisher.xsolla.com/. Navigate to either 'Company settings > API keys' or 'Project settings > API key'. Click 'Create API key'. Note that the API key is displayed only once at the time of creation; you must store it securely on your server immediately. You will also need your 'merchant_id' (found in Company settings or the URL) or 'project_id' (found next to the project name or in the URL) to form the authorization pair.

2. Add them to .dlt/secrets.toml

Copy
[sources.xsolla_source]
xsolla_merchant_id = "your_merchant_id"
xsolla_project_id = "your_project_id"
xsolla_api_key = "your_api_key_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 init
uv add "dlt[hub]"

1. Install the dlt AI harness:

Copy
uv run dlthub 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
uv run dlthub ai toolkit install rest-api-pipeline

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 Xsolla 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
uv run python xsolla_pipeline.py

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

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

Inspect your pipeline and data:

Copy
uv run dlthub 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 catalog and merchant from the Xsolla 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 xsolla_source(api_key=dlt.secrets.value):
    config: RESTAPIConfig = {
        "client": {
            "base_url": "https://api.xsolla.com",
            "auth": {"type": "http_basic", "username": "REPLACE_ME", "password": api_key},
        },
        "resources": [
            {"name": "virtual_items", "endpoint": {"path": "v2/project/{project_id}/items/virtual_items", "data_selector": "items"}},
            {"name": "orders", "endpoint": {"path": "merchants/{merchant_id}/reports/transactions/simple_search", "data_selector": "orders"}}
        ],
    }
    yield from rest_api_resources(config)


def get_data() -> None:
    pipeline = dlt.pipeline(
        pipeline_name="xsolla_pipeline",
        destination="duckdb",
        dataset_name="xsolla_data",
    )
    load_info = pipeline.run(xsolla_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("xsolla_pipeline").dataset()
sessions_df = data.virtual_items.df()
print(sessions_df.head())

SQL (DuckDB example):

Copy
SELECT * FROM xsolla_data.virtual_items LIMIT 10;

In a marimo or Jupyter notebook:

Copy
import dlt

data = dlt.pipeline("xsolla_pipeline").dataset()
data.virtual_items.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 Xsolla 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.

---

Next steps

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

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

Copy
uv run dlthub ai toolkit install data-exploration
uv run dlthub ai toolkit install dlthub-platform

• 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