ftmq-api

Expose followthemoney data via readonly FastAPI. Data is stored in a statement-based store adapted by ftmq from nomenklatura.

An example instance is deployed here: https://api.investigraph.dev

The api features filtering for datasets, entity Schema and Property values, sorting and a search endpoint to query against a full text search via ftmq-search.

Documentation

https://docs.investigraph.dev/lib/ftmq-api

Development

This package is using poetry for packaging and dependencies management, so first install it.

Clone the repository to a local destination.

Within the root directory, run

poetry install --with dev

This installs a few development dependencies, including pre-commit which needs to be registered:

poetry run pre-commit install

Before creating a commit, this checks for correct code formatting (isort, black) and some other useful stuff (see: .pre-commit-config.yaml)

Spin up dev server and populate with fixtures data:

make api

Run test & typing:

make test
make typecheck

supported by

In 2023, developing of this project was supported by Media Tech Lab Bayern batch #3

License and Copyright

ftmq-api is licensed under the AGPLv3 or later license.

Prior to version 3.0.0, ftmq-api was released under the MIT license and was called ftmstore-fastapi.

see NOTICE and LICENSE