Code Monkey home page Code Monkey logo

tarkov's Introduction

Tarkov

Crates.io Documentation Crates.io

An unofficial client library for the Escape from Tarkov (EFT) API.

This library is currently in alpha. Everything may change significantly in future releases.

Features

  • Authentication
  • Flea market
  • Traders
  • Hideout
  • Inventory management (equip, move, delete, etc)
  • Messenger
  • Quests

Getting Started

Comprehensive examples can be found in the examples directory.

Usage

Add this to your Cargo.toml:

[dependencies]
tarkov = "0.1"

Authentication

Authentication flowchart There are three ways to authenticate your EFT account for tarkov:

  1. Email & password is the easiest way to authenticate your account. However, a captcha and 2FA code may be required. Read the HWID section for more details.
  2. Access token or Bearer token can be found by sniffing EFT launcher traffic. HWID from the launcher is required.
  3. Session is a cookie called PHPSESSID, it can be found by sniffing EFT game traffic. HWID is not required for this method.

Your PMC character profile must be selected with select_profile to complete the authentication.

Hardware ID

Hardware ID (HWID) may be required on authentication, it can either be sniffed from the EFT launcher or generated. It's recommended to save the HWID in a persistent store and reuse it after the first successful authentication.

Using a fresh HWID means both captcha and 2FA code will be required on your first login attempt. This can be avoid by using the HWID generated by the EFT launcher or authenticating with your session cookie.

Captcha

This library does not attempt to solve captchas for you, the g-recaptcha-response token from reCAPTCHA may be required on authentication.

reCAPTCHA can be solved externally using tools like captcha-harvester.

Rust Version

tarkov has a minimum version requirement of 1.40.

"Unofficial"

I should emphasize that this library is unofficial. EFT does not have a public API, everything in this repo was reversed from the game.

The API is clearly designed for internal use. It contains numerous spelling mistakes, inconsistent conventions, and tons of bad practice JSON. The developers may push breaking changes without prior warning.

License

MIT

tarkov's People

Contributors

dank avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.