ftmq
This library provides methods to query and filter entities formatted as Follow The Money data, either from a json file/stream or using a statement-based store backend from nomenklatura.
It also provides a Query class that can be used in other libraries to work with SQL store queries or api queries.
ftmq.Query is the central query hub of the OpenAleph ecosystem: one backend-agnostic query object that filters FtM streams and stores, translates to SQL, and bridges to the OpenAleph API.
To get familiar with the Follow The Money ecosystem, you can have a look at this pad here.
Installation
Minimum Python version: 3.11
pip install ftmq
Usage
Command line
cat entities.ftm.json | ftmq -q 'filter:schema=Company&filter:properties.country=de&filter:gte:properties.incorporationDate=2023' -o s3://data/entities-filtered.ftm.json
Python Library
from ftmq import Query, M, P, G, smart_read_proxies
# Legal entities in the `companies` dataset that are based in Germany, or in
# Austria and incorporated since 2020, but never the dissolved ones, return the
# 5 most recent incorporated ones:
q = Query().where(
M(dataset="companies"),
M(schemata="LegalEntity"),
G(countries="de") | (G(countries="at") & P(incorporationDate__gte=2020)),
~P(status__ilike="%dissolved%"),
).order_by("incorporationDate", ascending=False)[:5]
for proxy in smart_read_proxies("s3://data/entities.ftm.json"):
if q.apply(proxy):
yield proxy
Full-text search
ftmq.search (formerly the standalone ftmq-search package) indexes entities into simple full-text search stores, backed by SQLite FTS5 or Tantivy (pip install ftmq[search]):
cat entities.ftm.json | ftmq search transform | ftmq search --uri sqlite:///ftmqs.db index
ftmq search --uri sqlite:///ftmqs.db "jane doe"
HTTP API
ftmq.api (formerly the standalone ftmq-api package) exposes a store and its search index as a read-only FastAPI application (pip install ftmq[api]), speaking the Aleph filter grammar:
granian --interface asgi ftmq.api.app:app
curl "localhost:8000/entities?filter:schema=Payment&filter:gte:properties.date=2023"
Documentation
https://docs.investigraph.dev/lib/ftmq
Support
This project is part of investigraph
In 2023, development of ftmq was supported by Media Tech Lab Bayern batch #3
License and Copyright
ftmq, (C) 2023 Simon Wörpel
ftmq, (C) 2024-2025 investigativedata.io
ftmq, (C) 2025 Data and Research Center – DARC
ftmq is licensed under the AGPLv3 or later license.
Prior to version 0.8.0, ftmq was released under the MIT license.
1 maintainer
Metadata
1 maintainer
Release files for ftmq 5.2.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| ftmq-5.2.0.tar.gz | 109.6 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| ftmq-5.2.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 244.8 kB
Release files / ftmq-5.2.0.tar.gz
| Download URL | ftmq-5.2.0.tar.gz |
|---|---|
| Size | 109.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
147dfaa62683bf2100f8795eeccb16390da8c6345bfee0b40659c6cc25148ecc
|
|
BLAKE2b-256 checksum How to use checksums |
ade362e2cdc3435feb58f782f494649d7d6ae47b6be715619c99c3515aff0d05
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.5.1 CPython/3.14.4 Linux/7.0.0-31-generic
|
Release files / ftmq-5.2.0-py3-none-any.whl
| Download URL | ftmq-5.2.0-py3-none-any.whl |
|---|---|
| Size | 135.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
4ee0bdf3bd7045715d78847b5f0522954fb6dd4394aed36cc78bc9419f78155f
|
|
BLAKE2b-256 checksum How to use checksums |
9e63b0db39b3f1a09365c1d5f2b534b9e9c459515b3900e07b52364b5008f886
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.5.1 CPython/3.14.4 Linux/7.0.0-31-generic
|
