Practical overview
When it fits
Use it as a backend component when an application needs read-only Stellar account activity, heuristic screening results, Soroban event data, or network dependency checks.
Who it is for
- Developers integrating Stellar account screening into an application.
- Teams building Soroban contract-event monitoring dashboards.
- Operators who need API-based checks of Stellar Horizon and Soroban RPC health.
Documented uses
- Submit a classic or muxed Stellar account identifier for activity-based heuristic screening.
- Retrieve paginated, normalized Horizon operations and their asset-specific amounts.
- Read and retain Soroban contract events while the service is running.
- Check service liveness and whether configured Horizon and Soroban RPC dependencies are reachable.
Requirements & limits
The repository is public and lists an MIT license. Local setup requires Python 3.11 or newer. The documented example configuration targets Stellar Testnet.
- The backend uses Horizon for account activity and Stellar RPC for Soroban events and network status; those settings should target the same network.
- Risk scores are heuristic signals and are explicitly not proof of fraud or financial or compliance advice.
- The events route requires a contract ID on the configured network; without it, the route returns HTTP 503.
- A private deployment can protect business API routes with a configured bearer-token API key, while health checks, documentation, and CORS preflight remain accessible.
- Operation pagination is limited to 1–100 results per page, and the next-page cursor is opaque.
Check current requirements in the official documentation. Source-based guidance does not mean OpenViST has run or independently tested this project.
Set up Sentinel Backend locally
Prepare and start the documented development API server.
Before you start
- Python 3.11 or newer
- The sentinel-backend repository
- Matching Horizon, Soroban RPC, and network passphrase settings for the intended Stellar network
Steps
Create and activate a Python virtual environment.
Install dependencies with the command below.
pip install -r requirements.txtCopy
.env.exampleto.envand configure the network settings.Start the development server with
uvicorn app.main:app --reload.
Expected outcome
The local API server runs with its interactive documentation available at `/docs`.
Guide limitations
- This is a setup and server-start guide; it does not configure a frontend.
- For private deployments, configure an API key and send it as a bearer token to business routes.
- The events route needs a deployed contract ID on the configured network.
Sources & review
Source record details
- Source availability
- Active
- Sources checked
- 11 October 2026
- Original website title
- Stellar-Sentinel/sentinel-backend · Official homepage title · retained in its source language

