Skip to content
This repository was archived by the owner on Feb 14, 2026. It is now read-only.

Nivmizz7/api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Tarkov API Standalone

Independent REST API to serve Escape from Tarkov data. This API provides easy access to game data without depending on Cloudflare or other external services.

Installation

cd api
npm install

Getting Started

Production mode

npm start

Development mode (with auto-reload)

npm run dev

The API starts by default on http://localhost:3000

Endpoints

Root

  • GET / - API information and endpoints list

Health Check

  • GET /health - API status

Items

  • GET /api/items - List all items

    • Query parameters:
      • search - Search by name
      • limit - Number of items per page
      • offset - Offset for pagination
    • Example: /api/items?search=ak&limit=10&offset=0
  • GET /api/items/:id - Get specific item by ID

    • Example: /api/items/619d272b0f9e4513744e7699

Ammunition

  • GET /api/ammunition - List all ammunition

    • Query parameters:
      • caliber - Filter by caliber
      • search - Search by name
      • limit - Number of ammunition per page
      • offset - Offset for pagination
    • Example: /api/ammunition?caliber=Caliber762x39&limit=20
  • GET /api/ammunition/:id - Get specific ammunition by ID

    • Example: /api/ammunition/5e023cf8186a883be655e54f
  • GET /api/ammunition/calibers/list - List all available calibers

Hideout

  • GET /api/hideout - Get all hideout data

  • GET /api/hideout/:moduleId - Get specific hideout module

Quests

  • GET /api/quests - List all quests

    • Query parameters:
      • trader - Filter by trader
      • search - Search by name
      • limit - Number of quests per page
      • offset - Offset for pagination
    • Example: /api/quests?trader=prapor
  • GET /api/quests/:questId - Get specific quest

Traders

  • GET /api/traders - List all traders

  • GET /api/traders/:traderId - Get specific trader

Maps

  • GET /api/maps - List all maps

  • GET /api/maps/:mapId - Get specific map

Item Presets

  • GET /api/item-presets - List all item presets

    • Query parameters:
      • baseId - Filter by base ID
      • search - Search by name
      • limit - Number of presets per page
      • offset - Offset for pagination
  • GET /api/item-presets/:id - Get specific preset

Levels

  • GET /api/levels - Get level information

Storyline

  • GET /api/storyline - List all storylines

    • Query parameters:
      • search - Search by name or description
      • limit - Number of storylines per page
      • offset - Offset for pagination
    • Example: /api/storyline?search=skies
  • GET /api/storyline/:id - Get specific storyline

Usage Examples

Search items

curl "http://localhost:3000/api/items?search=helmet&limit=5"

Get all 7.62x39 ammunition

curl "http://localhost:3000/api/ammunition?caliber=Caliber762x39"

Get specific item

curl "http://localhost:3000/api/items/619d272b0f9e4513744e7699"

List calibers

curl "http://localhost:3000/api/ammunition/calibers/list"

Configuration

Environment variables:

  • PORT - Server listening port (default: 3000)

Example:

PORT=8080 npm start

Project Structure

api/
├── server.js       # Main Express server
├── package.json    # Dependencies and scripts
└── README.md       # Documentation

tarkovdata/
├── items.en.json
├── ammunition.json
├── hideout.json
├── quests.json
├── traders.json
├── maps.json
├── item_presets.json
├── levels.json
└── storyline.json

Features

  • No Cloudflare dependency - Completely independent standalone API
  • RESTful - Simple and standard REST architecture
  • CORS enabled - Usable from any domain
  • Compression - Compressed responses for better performance
  • Security - Security headers with Helmet
  • Search - Text search on items, ammunition and quests
  • Filtering - Filters by caliber, trader, etc.
  • Pagination - Pagination support for large lists
  • In-memory cache - Data loaded at startup for optimal performance

Response Format

All list responses include metadata:

{
  "total": 1234,
  "count": 10,
  "offset": 0,
  "items": [...]
}

Error Handling

  • 404 - Resource not found
  • 500 - Internal server error

Error format:

{
  "error": "Error message"
}

License

ISC

Credits

Data provided by TarkovData

Inspired by Tarkov API but completely independent of Cloudflare.

About

API for TarkovData

Resources

Stars

Watchers

Forks

Contributors