Solidgate Python API Docs | dltHub

Build a Solidgate-to-database pipeline in Python using dlt with AI harness support for Claude Code, Cursor, and Codex.

Last updated:

Solidgate is a payment gateway API that allows merchants to securely process card payments, manage transactions, and handle alternative payment methods. The REST API base URL is https://pay.solidgate.com/api/v1/ and All requests require merchant and signature headers generated via HMAC-SHA512..

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 Solidgate data in under 10 minutes.


What data can I load from Solidgate?

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

ResourceEndpointMethodData selectorDescription
products/productsGETRetrieve products with filtering and pagination.
product_prices/products/{product_id}/pricesGETRetrieve product prices for a specific product.
product_prices_list/products/prices/listPOSTRetrieve prices in bulk with filtering.
card_orders/card-ordersPOSTRetrieve card orders report.
prevention_alerts/prevention_alerts/report/{report_id}/downloadGETDownload prevention alerts report.

How do I authenticate with the Solidgate API?

Authentication uses HMAC-SHA512. The signature is a base64-encoded string of the hexadecimal representation of the hash, computed using the Secret key and a payload string (publicKey + jsonBody + publicKey).

1. Get your credentials

To obtain API credentials, log in to the Solidgate Hub at https://hub.solidgate.com/. Navigate to the 'Developers' section, then proceed to 'Channel details' (for API v1) or 'API keys' (for API v2) to view and copy your public and secret keys. API v1 keys have prefixes 'api_pk_' (public) and 'api_sk_' (secret). Ensure you distinguish these from webhook-specific keys ('wh_pk_' and 'wh_sk_') used for validating webhook signatures.

2. Add them to .dlt/secrets.toml

[sources.solidgate_source] public_key, secret_key = "REPLACE_ME"

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:

uv init uv add "dlt[hub]"

1. Install the dlt AI harness:

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:

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 Solidgate 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:

uv run python solidgate_pipeline.py

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

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

Inspect your pipeline and data:

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 charge and status from the Solidgate API into DuckDB. It mirrors the endpoint and data selector configuration from the table above:

import dlt from dlt.sources.rest_api import RESTAPIConfig, rest_api_resources @dlt.source def solidgate_source(public_key_secret_key=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "https://pay.solidgate.com/api/v1/", "auth": {"type": "api_key", "api_key": public_key_secret_key, "name": "signature", "location": "header"}, }, "resources": [ {"name": "card_orders", "endpoint": {"path": "card-orders", "data_selector": "data"}}, {"name": "products", "endpoint": {"path": "products", "data_selector": "products"}} ], } yield from rest_api_resources(config) def get_data() -> None: pipeline = dlt.pipeline( pipeline_name="solidgate_pipeline", destination="duckdb", dataset_name="solidgate_data", ) load_info = pipeline.run(solidgate_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):

import dlt data = dlt.pipeline("solidgate_pipeline").dataset() sessions_df = data.card_orders.df() print(sessions_df.head())

SQL (DuckDB example):

SELECT * FROM solidgate_data.card_orders LIMIT 10;

In a marimo or Jupyter notebook:

import dlt data = dlt.pipeline("solidgate_pipeline").dataset() data.card_orders.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 Solidgate data to?

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

DestinationExample value
DuckDB (local, default)"duckdb"
PostgreSQL"postgres"
BigQuery"bigquery"
Snowflake"snowflake"
Redshift"redshift"
Databricks"databricks"
Filesystem (S3, GCS, Azure)"filesystem"

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.
uv run dlthub ai toolkit install data-exploration uv run dlthub ai toolkit install dlthub-platform

Was this page helpful?

Community Hub

Need more dlt context for Solidgate?

Request dlt skills, commands, AGENT.md files, and AI-native context.

Available Pipelines