The OpenSanctions API server is based on an open source software package. By installing that software on your own infrastructure, you can control scaling, save costs and protect your customers' privacy.
The idea is simple: in addition to offering the hosted OpenSanctions API, we've made it easy to run the system by yourself. The API server application,
yente, is simple to install and will update itself with the latest OpenSanctions data in regular intervals.
We recommend you take the following steps:
opensanctions/yenteinside your infrastructure (guide). The service will automatically import OpenSanctions data unless configured otherwise.
The OpenSanctions API software,
yente, ships as a set of two Docker containers (the application itself, and an ElasticSearch search index). Docker containers are easy to run across different platforms (Linux, Mac, Windows) and computing environments (e.g. Amazon AWS, Google Compute or Microsoft Azure). While we suggest running a simple setup based on
docker-compose as a starting point, the software also works well on Kubernetes.
Hardware specifications: 4GB RAM, 1vCPU, 4GB hard drive. For improved performance, consider allocating 8GB RAM and housing the search index on an SSD-backed disk.
By default, the service will check for updated data every 30 minutes and download OpenSanctions bulk data whenever a new release is found. Releases are published at least once a day, but usually several times each day.
While the OpenSanctions team will have no visibility into your self-hosted service, we are happy to offer consultation services to discuss the use of the software and work out a deployment strategy for your use case.