yente-client documentation¶
The yente-client Python SDK, yente-cli command-line tool, and
yente-mcp MCP server for matching entities against the
OpenSanctions API and on-premise
yente instances.
Start here¶
- Tutorial — a linear walk through the SDK: install, first match, search, fetch, async, errors, and the FollowTheMoney (FtM) data model.
- CLI overview — the
yente-clicommand, when to reach for it, the command list, output formats, exit codes. - MCP server — expose screening to LLM agents: install, run, connect a client, the tool surface.
- API reference — auto-generated from docstrings;
every public symbol re-exported from
yente_client.
Scope¶
These pages cover the matching workflow (the SDK's primary use case) and the search and fetch endpoints that surround it. For broader context (sanctions screening, available datasets, getting an API key), see the OpenSanctions docs.
Regenerating the API reference¶
The api/ tree is generated from docstrings; do not hand-edit. Run
make docs to regenerate after changing public docstrings; CI runs
make docs-check to catch drift.