# gramps-web-api

> Self-hosted REST API for Gramps family trees with DNA analysis, AI assistant, and Gramps Desktop sync.

- **Category:** Research
- **Licence:** AGPL-3.0
- **Latest version:** v3.24.0
- **Open source:** oss
- **Languages:** Python
- **Platforms:** Docker Compose
- **Tags:** REST API, Docker, Open Source, Hacktoberfest, Python, Flask, Self Hosted, Genealogy, Family tree, Gramps

## Description

Gramps Web API is a Python REST API that gives programmatic access to family tree databases built with Gramps genealogy software. It acts as the backend for Gramps Web, a collaborative web-based genealogy application, but can also be used on its own. The API lets you query and modify people, families, events, places, sources, citations, media, and notes. It includes DNA match analysis with a chromosome browser and Y-DNA haplogroup determination, an AI-powered chat assistant for querying the family tree, full revision history with undo, privacy controls, and two-way synchronization with Gramps Desktop. Deployment uses Docker Compose with Redis for background tasks, and optionally PostgreSQL for multi-tree setups and S3-compatible storage for media. Licensed under AGPL-3.0.

## Links

- [Homepage](https://github.com/gramps-project/gramps-web-api)
- [Website](https://www.grampsweb.org)
- [Docker](ghcr.io/gramps-project/grampsweb)
- [Demo](https://demo.grampsweb.org/)
- [GitHub Repository](https://github.com/gramps-project/gramps-web-api)
- [API Documentation](https://gramps-project.github.io/gramps-web-api/)

---
Source: https://selfhost.directory/project/gramps-web-api