https://github.com/tarkovtracker-org/tarkov-data-overlay
Data overlay for Tarkov.dev API data.
https://github.com/tarkovtracker-org/tarkov-data-overlay
api data escape-from-tarkov overlay tarkov tarkov-dev
Last synced: 15 days ago
JSON representation
Data overlay for Tarkov.dev API data.
- Host: GitHub
- URL: https://github.com/tarkovtracker-org/tarkov-data-overlay
- Owner: tarkovtracker-org
- License: mit
- Created: 2025-12-19T08:08:38.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2026-05-01T06:57:00.000Z (about 2 months ago)
- Last Synced: 2026-05-01T08:31:01.868Z (about 2 months ago)
- Topics: api, data, escape-from-tarkov, overlay, tarkov, tarkov-dev
- Language: TypeScript
- Homepage: https://monitor.nivmizz7.fr
- Size: 670 KB
- Stars: 4
- Watchers: 0
- Forks: 4
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Contributing: docs/CONTRIBUTING.md
- License: LICENSE
- Agents: AGENTS.md
Awesome Lists containing this project
README
# tarkov-data-overlay
Community-maintained data overlay for [tarkov.dev](https://tarkov.dev) API corrections and additions.
## Why?
The tarkov.dev API is an excellent resource, but game updates sometimes outpace data updates. This overlay provides:
- **Corrections**: Fix incorrect data (task levels, map requirements, etc.)
- **Additions**: New data types not in tarkov.dev (game editions, etc.)
## Usage
Fetch the overlay from jsDelivr CDN:
```
https://cdn.jsdelivr.net/gh/tarkovtracker-org/tarkov-data-overlay@main/dist/overlay.json
```
Then merge it with tarkov.dev responses. See [Integration Guide](docs/INTEGRATION.md) for details.
## Monitor
Browse the hosted monitor at [monitor.nivmizz7.fr](https://monitor.nivmizz7.fr), or run it locally with:
```bash
npm run monitor
```
## Maintenance
The overlay is regularly validated against the tarkov.dev API to ensure corrections are still needed:
```bash
npm run check-overrides
```
This command compares all overrides against current API data and reports:
- ✅ Overrides that are still needed
- 🔄 Corrections that have been fixed upstream (can be removed)
- 🗑️ Tasks that have been removed from the API (can be deleted)
Run this periodically to keep the overlay lean and accurate.
For local checks:
```bash
npm run validate
npm run typecheck
npm test
```
## Contributing
Found incorrect data? See [Contributing Guide](docs/CONTRIBUTING.md).
## Data Governance
- This is **community-maintained, best-effort** data
- All corrections require proof (wiki links, screenshots)
- Not a replacement for tarkov.dev - a bridge during data gaps
- Transparent history via Git
## License
See [LICENSE](LICENSE).