Grin Python API Docs | dltHub

Grin is a privacy-focused cryptocurrency implementation of the MimbleWimble protocol providing node and wallet JSON-RPC/REST APIs for querying blockchain state and managing wallets. The REST API base URL is Node/Wallet local default: http://127.0.0.1:3413 (node APIs) — Owner API usually at /v2/owner and Foreign API at /v2/foreign for v2 JSON-RPC; v1 REST endpoints are under the node listener root (localhost:3413). and basic authentication for node HTTP APIs; wallet owner/foreign APIs use secrets or shared keys and wallet token for JSON-RPC calls..

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

---

What data can I load from Grin?

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

---

How do I authenticate with the Grin API?

Node HTTP APIs use HTTP Basic Auth (username: "grin", password from .api_secret or .foreign_api_secret). Wallet Owner/Foreign APIs (v2) require a shared secret for encrypting JSON-RPC payloads and a wallet token returned by open_wallet; many wallet RPC calls include a token parameter.

1. Get your credentials

1. Run Grin node/wallet API locally. 2) Locate .api_secret in the node data dir (e.g. ~/.grin/main/.api_secret) for Owner API and .foreign_api_secret for Foreign API; these files contain the password used for basic auth. 3) For wallet Owner API, compute or obtain the shared_secret (e.g. via provided scripts) and call open_wallet (jsonrpc method) with wallet password to receive the wallet token.

2. Add them to .dlt/secrets.toml

Copy
[sources.grin_source]
api_secret = "your_node_api_secret_here"
wallet_shared_secret = "your_wallet_shared_secret_here"
wallet_token = "your_wallet_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 Grin 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 grin_pipeline.py

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

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

Inspect your pipeline and data:

Copy
dlt pipeline grin_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 accounts and retrieve_summary_info from the Grin 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 grin_source(api_secret=dlt.secrets.value):
    config: RESTAPIConfig = {
        "client": {
            "base_url": "Node/Wallet local default: http://127.0.0.1:3413 (node APIs) — Owner API usually at /v2/owner and Foreign API at /v2/foreign for v2 JSON-RPC; v1 REST endpoints are under the node listener root (localhost:3413).",
            "auth": {
                "type": "http_basic",
                "password": api_secret,
            },
        },
        "resources": [
            {"name": "wallet_accounts", "endpoint": {"path": "v2/owner"}},
            {"name": "retrieve_summary_info", "endpoint": {"path": "v2/owner", "data_selector": "[1]"}}
        ],
    }
    yield from rest_api_resources(config)


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

SQL (DuckDB example):

Copy
SELECT * FROM grin_data.retrieve_summary_info LIMIT 10;

In a marimo or Jupyter notebook:

Copy
import dlt

data = dlt.pipeline("grin_pipeline").dataset()
data.retrieve_summary_info.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 Grin 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

Node APIs use HTTP Basic auth (username 'grin'); ensure the password in .api_secret or .foreign_api_secret is present and used as the HTTP basic password. Wallet Owner API requires computing/loading the shared_secret and using the wallet token from open_wallet for token-parameterized calls.

JSON-RPC and API errors

v2 uses JSON-RPC 2.0. Malformed requests produce JSON-RPC errors (e.g. code -32602 WrongNumberOfArgs). API result errors are returned inside the JSON-RPC result (e.g. {"result": {"Err": "NotFound"}} or {"Err": {"Internal": "ban peer error: PeerNotFound"}}).

Pagination and response shapes

v1 REST endpoints return lists under keys such as "blocks", "peers", "headers", or top-level arrays; wallet JSON-RPC methods often return arrays or nested objects (e.g. retrieve_summary_info returns [bool, {summary}]). Always inspect the method's sample response; when using dlt selectors prefer exact keys like 'blocks', 'peers', 'outputs', or JSON-RPC result index access.

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