the-hideout / tarkov-api

Community made GraphQL API with real-time data for everything in the Escape from Tarkov game!

Tarkov API (Escape from Tarkov) 💻

This is the main API for tarkov.dev, and was forked from kokarn's Tarkov Tools API.

It's a simple GraphQL API running on Cloudflare workers.

This API powers all of tarkov.dev and other notable projects as well:

• stash
• ratscanner
• errbot
• thehideout

What is this? 💡

A community made GraphQL API for Escape from Tarkov

• 🆓 Free
• 🔨 Easy to use
• 📖 Open source
• 🧑‍🤝‍🧑 Community driven
• ⚡ Ultra fast
• ⏰ Data is constantly updated in real-time

What can I do with this API? ⭐

• View the prices of items
• Get detailed ammo, armor, and weapon information
• Fetch flea market data
• View item weight, slots, etc
• Calculate barter and hideout profit
• Determine ergo, armor class, durability, etc for an item
• Fetch detailed quest information and unlocks
• View info about crafts and their requirements
• Find information about in-game bosses
• Detailed info on medicines, stims, and in-game healing
• So much more (it would take up this entire page to list everything 😸)

This API does almost everything you would ever want for EFT!

API Playground 🎾

There is a GraphQL playground for you to use and test out

Link: api.tarkov.dev/

Example Query:

query {
  items {
      id
      name
      shortName
      wikiLink
      iconLink
      updated
  }
}

More examples can be found in our graphql example docs 📚

Even more examples can be found on our api page on tarkov.dev (includes many programming languages too)

Development 🔨

Prerequisites:

• Install Wrangler
• Run wrangler login - (needed for k/v store and secrets)

Start the API server:

• Start the dev environment by running npm run dev
• Then open up the playground on localhost:8787/___graphql

Deployment 🚀

If you wish to deploy locally and have permissions to do so, run the following command:

wrangler publish

We don't do this often and generally use GitHub actions to do all of our deployments for us