Skip to main content

A simple and fast API service for querying FollowTheMoney data, including OpenSanctions.

Project description

yente

yente is an open source data match-making API. The service provides several HTTP endpoints to search, retrieve or match FollowTheMoney entities, including people, companies or vessels that are subject to international sanctions.

The yente API is built to provide access to OpenSanctions data, it can also be used to search and match other data, such as company registries or custom watchlists.

While yente is the open source core code base for the OpenSanctions API, it can also be run on-premises as a KYC appliance so that no customer data leaves your infrastructure.

Development

yente is implemented in asynchronous, typed Python using the FastAPI framework. We're happy to see any bug fixes, improvements or extensions from the community. To set up a local development environment, use uv:

git clone https://github.com/opensanctions/yente.git
cd yente
# Install runtime and development dependencies
uv sync
# Install pre-commit hooks with useful checks
prek install
# Activate the virtual environment
source .venv/bin/activate

This will install a broad range of dependencies, including numpy, scikit-learn and pyicu, which are binary packages that may require a local build environment. For pyicu in particular, refer to the package documentation.

Running the server

Once you've set the YENTE_INDEX_URL environment variable to point to a running instance of ElasticSearch or OpenSearch, you can run the web server like this:

yente serve

Releasing

bump2version --verbose minor # or patch
git push && git push --tags

License and Support

yente is licensed according to the MIT license terms documented in LICENSE. Using the service in a commercial context may require a data license for OpenSanctions data.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

yente-5.2.0-py3-none-any.whl (79.5 kB view details)

Uploaded Python 3

File details

Details for the file yente-5.2.0-py3-none-any.whl.

File metadata

  • Download URL: yente-5.2.0-py3-none-any.whl
  • Upload date:
  • Size: 79.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for yente-5.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 524ffad1848b8432678a70497685297b97385e7df4f04e0bc4f0fd05c3ea73ae
MD5 b5263c3cc98369b7a6ee737e3458c4a0
BLAKE2b-256 014ff0b667f59886863f2a974094020123b01f1a8f204025ad43b2077b734a21

See more details on using hashes here.

Provenance

The following attestation bundles were made for yente-5.2.0-py3-none-any.whl:

Publisher: build.yml on opensanctions/yente

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page