Skip to content

opensanctions/yente-client

Repository files navigation

yente-client

Client SDK, command-line tool, and MCP server for the OpenSanctions matching API and self-hosted yente instances. Screen people, companies, and other entities against sanctions lists, politically exposed persons (PEPs), and watchlists.

Documentation: yenteclient.followthemoney.tech

Install

pip install yente-client            # Python SDK
pip install 'yente-client[cli]'     # + the `yente-cli` command-line tool
pip install 'yente-client[mcp]'     # + the `yente-mcp` server for LLM agents

Quickstart

from yente_client import Client, Person

with Client(api_key="...", app_name="MyScreeningApp") as c:
    hits = c.match(
        Person(firstName="Aleksandr", lastName="Zacharov", birthDate="1965"),
        datasets=["sanctions"],
    )
    for match in hits.matches:
        print(match.id, match.caption, match.score)

Matching is query-by-example: describe the entity in as much detail as you can, and the API returns ranked, scored candidates. Use match for any matching task — even with partial input; search is for end-user search boxes, not a fallback for match.

Get an API key at opensanctions.org/account, or point base_url= at a self-hosted yente (no key needed).

Learn more

  • Tutorial — install, first match, search, fetch, async, errors, the FollowTheMoney data model.
  • CLI overviewyente-cli commands, output formats, exit codes.
  • MCP server — connect an LLM agent to the matching API.
  • API reference — every public symbol, rendered from docstrings.

This repository carries the Python package under python/; a TypeScript SDK sharing the same test fixtures is planned under typescript/.

About

Client library, SDK and CLI tooling for yente

Topics

Resources

License

Stars

2 stars

Watchers

0 watching

Forks

Packages

 
 
 

Contributors

Languages