About this project

tarkov-data-overlay is a community-maintained overlay of data corrections and additions for the tarkov.dev API. The stated motivation is that game updates can outpace data updates, so the project fills the gap in two ways: fixing incorrect values such as task levels or map requirements, and adding data types the upstream API does not carry, such as game editions. Usage The overlay is published as a JSON file and fetched from the jsDelivr CDN. Consumers merge it with tarkov.dev responses. The README advises pinning an immutable release tag or commit for production use, since a branch URL tracks rolling repository state; the embedded digest can detect corruption or stale data but does not prove the authenticity of a CDN response. Integration details live in an integration guide, with separate documents covering task availability and unlock-state tracking and a counter data contract; an evaluateTaskProgression helper is referenced for verified progress-based counters and explicit unknown results. Monitor A hosted monitor is available, and the same monitor can be run locally via an npm script. It is read-only by default. A local "Update overlay" action requires explicit opt-in with a rebuild token, and rebuilds always require a non-empty token passed in an Authorization Bearer header. The server binds to loopback by default; binding elsewhere is recommended only behind a trusted reverse proxy or network boundary. When HTTPS is terminated by a trusted proxy, a separate flag enables rebuilds, and in that mode per-client event-stream quotas use the first valid X-Forwarded-For address, so the proxy must overwrite that header. Rebuilds target the default overlay output path; custom local and HTTP(S) overlay targets stay read-only. Maintenance A check-overrides command compares all overrides against current API data and reports which are still needed, which corrections have been fixed upstream and can be removed, which tasks disappeared from the API, and upstream data-quality regressions. Reporting is the default; three opt-in gates control failure behavior, with distinct exit codes for strict inconsistency checks, stale data that upstream now supplies (the gate run in CI), and upstream regressions. The upstream gate is deliberately excluded from CI because such problems originate in tarkov.dev data and cannot be cleared from this repository. Local validation, type checking and tests are run through separate npm scripts. Governance and contributing Contributing and triage guides are provided. The project describes itself as community-maintained and best-effort, requires proof such as wiki links or screenshots for corrections, presents itself as a bridge during data gaps rather than a replacement for tarkov.dev, and keeps a transparent history through Git. License terms are in the repository LICENSE file.