Load Lishogi data to DuckDB

Lishogi is a free, open-source shogi server that provides a RESTish HTTP/JSON API for interacting with games, users, and bot functionality. Everything needed to build a working Lishogi → DuckDB pipeline is on this page: the API's base URL, authentication, endpoints, pagination and incremental field — plus a prompt that hands the whole job to your coding agent.

---

Build your Lishogi to DuckDB pipeline

Paste this prompt into Claude, Codex, or Cursor. The agent does the rest.

PromptCopy prompt
Run uvx dlthub-init@latest to build a pipeline from Lishogi to DuckDB and run it on dltHub

That scaffolds a dltHub workspace and installs the dltHub AI harness — the project rules, the secrets-management skill, and the dlt MCP server your agent needs to work safely. From there it reads the Lishogi API, proposes the endpoints to load, then writes, runs and validates the pipeline while you review rather than type. Credentials are inspected through MCP tools, so your agent never reads secrets.toml itself. How the LLM-native workflow works →

Prefer to write it yourself? Every fact the agent uses is below.

---

Lishogi API at a glance

These values come from the Lishogi API reference — the authoritative source if anything here looks out of date.

---

How do I authenticate with the Lishogi API?

Lishogi uses OAuth2 and personal access tokens for authentication. Authenticated requests require an 'Authorization' header with the value 'Bearer '.

1. Get your credentials

To obtain an API access token, log in to your account at lishogi.org and navigate to the OAuth token creation page at https://lishogi.org/account/oauth/token/create. From there, select the required scopes (such as 'bot:play' for bot accounts or other permissions as needed), provide a description for the token, and click submit. The system will display your token once; be sure to copy and save it immediately as it will not be shown again.

2. Add them to .dlt/secrets.toml

Copy
[sources.lishogi_source]
api_key = "your_token_here"

dlt reads this file automatically at runtime. With the harness, the setup-secrets skill prompts you for the values and never handles the raw credential in chat. For production, see setting up credentials with dlt.

---

What Lishogi data can I load into DuckDB?

These are the Lishogi endpoints dlt can load into DuckDB:

---

How do I load only new Lishogi records?

The Lishogi API reference does not document a timestamp or sequence field for these endpoints, so there is nothing to advertise here as verified. Pick a field from the endpoints table above that increases with every write, then set it as the cursor_path.

Copy
{"name": "account", "endpoint": {
    "path": "api/account",
    # Replace with a field that increases on every write.
    "incremental": {"cursor_path": "REPLACE_ME", "initial_value": "2024-01-01T00:00:00Z"},
}}

On the first run dlt loads everything from initial_value; on every run after that it requests only what changed and appends with write_disposition="merge" if you set a primary key. See incremental loading.

---

What does the generated Lishogi pipeline look like?

A standard dlt REST API pipeline — the same code you would write by hand, loading /api/account and /api/bot/account/upgrade from the Lishogi API into DuckDB:

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

@dlt.source
def lishogi_source(token=dlt.secrets.value):
    config: RESTAPIConfig = {
        "client": {
            "base_url": "https://lishogi.org",
            "auth": {"type": "bearer", "token": token},
        },
        "resources": [
            {"name": "account", "endpoint": {"path": "api/account"}},
            {"name": "account_preferences", "endpoint": {"path": "api/account/preferences"}}
        ],
    }
    yield from rest_api_resources(config)


def load_lishogi_to_duckdb() -> None:
    pipeline = dlt.pipeline(
        pipeline_name="lishogi_pipeline",
        destination="duckdb",
        dataset_name="lishogi_data",
    )
    load_info = pipeline.run(lishogi_source())
    print(load_info)


if __name__ == "__main__":
    load_lishogi_to_duckdb()

Run it with python lishogi_pipeline.py. The agent iterates on this until it loads cleanly — you review and approve, rather than write it from scratch.

---

How do I query Lishogi data in DuckDB?

dlt creates one table per resource. Query the loaded data with Python or SQL — or ask your agent to, through the MCP server's execute_sql_query tool.

Python (pandas DataFrame):

Copy
import dlt

data = dlt.pipeline("lishogi_pipeline").dataset()
df = data.account.df()
print(df.head())

SQL:

Copy
SELECT * FROM lishogi_data.account LIMIT 10;

See querying your data with dataset and exploring it in marimo notebooks.

---

How do I deploy the Lishogi to DuckDB pipeline in production?

The pipeline runs locally, which is ideal for prototyping and one-off analysis. When you need it on a schedule, monitored on every load, and shared with your team, deploy the same dlt code on the dltHub platform — no infrastructure to maintain. The prompt above already ends with "run it on dltHub", so your agent can take it there directly.

• Deploy & schedule — run the pipeline as a managed job with automatic retries.
• Monitor — observable job queues, alerting, and load metrics for every run.
• Transform — promote raw Lishogi loads into governed, documented models.
• Visualize & share — explore data in notebooks and publish live dashboards instead of static screenshots.

Book a demo →

---

What other destinations can I load Lishogi data to?

dlt loads into any of these — only the destination argument changes:

Set dlt.pipeline(destination="snowflake") and add credentials in .dlt/secrets.toml. On the dltHub platform the same pipeline runs against a managed Iceberg lakehouse. See the full destinations list.

---

Next steps

• Ready for production? Book a demo of the dltHub platform →
• dlt LLM-native workflow docs
• REST API source reference
• Join the dlt community on Slack