Class Tarkov

Tarkov API Wrapper

Hierarchy

Tarkov

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new Tarkov(hwid?: Hwid): Tarkov

- Defined in src/classes/tarkov.ts:31
Parameters
- Optional hwid: Hwid
Returns Tarkov

Properties

Private api

api: Api

Private hwid

hwid: Hwid

itemsList

itemsList: ItemsList

localization

localization: Localization

profile

profile: Profile

profiles

profiles: ProfileData[] = []

traders

traders: Trader[]

Accessors

gameVersion

get gameVersion(): string

- Defined in src/classes/tarkov.ts:55
Returns string

launcherVersion

get launcherVersion(): string

- Defined in src/classes/tarkov.ts:51
Returns string

session

get session(): { queued: boolean; session: string }
set session(session: { queued: boolean; session: string }): void

- Defined in src/classes/tarkov.ts:59
Returns { queued: boolean; session: string }
- queued: boolean
- session: string
- Defined in src/classes/tarkov.ts:63
Parameters
- session: { queued: boolean; session: string }
  - queued: boolean
  - session: string
Returns void

Methods

Private activateHardware

activateHardware(email: string, twoFactor: string): Promise<void>

- Defined in src/classes/tarkov.ts:452
Activates a new HWID with a 2fa code

Parameters
- email: string
  
  Account Email
- twoFactor: string
  
  2FA Code from email
Returns Promise<void>

collectItem

collectItem(itemId: string, stashId: string, attachmentId: string): Promise<any>

- Defined in src/classes/tarkov.ts:381
Collect an item UNTESTED

async

Parameters
- itemId: string
  
  collect item id
- stashId: string
  
  players stashId. Get it from profile.inventory.stash
- attachmentId: string
  
  attachments id
Returns Promise<any>

Private exchangeAccessToken

exchangeAccessToken(access_token: string): Promise<boolean>

- Defined in src/classes/tarkov.ts:408
Exchanges the access token for a session id

Parameters
- access_token: string
  
  JWT from @login
Returns Promise<boolean>

Private generateHwid

generateHwid(): Hwid

- Defined in src/classes/tarkov.ts:473
Returns Hwid

getI18n

getI18n(language: string): Promise<Localization>

- Defined in src/classes/tarkov.ts:228
get localization table

async

Parameters
- language: string
  
  language code, example: English = en
Returns Promise<Localization>

getItems

getItems(): Promise<ItemsList>

- Defined in src/classes/tarkov.ts:198
Get all items

async

Returns Promise<ItemsList>

getMessageAttachments

getMessageAttachments(id?: undefined | string): Promise<MessageAttachements>

- Defined in src/classes/tarkov.ts:188
Get message attachements

async

Parameters
- Optional id: undefined | string
  
  Message ID to get attachements for
Returns Promise<MessageAttachements>

getMessages

getMessages(type?: undefined | number): Promise<Messages[]>

- Defined in src/classes/tarkov.ts:172
Get all messages

async

Parameters
- Optional type: undefined | number
Returns Promise<Messages[]>

getProfiles

getProfiles(): Promise<ProfileData[]>

- Defined in src/classes/tarkov.ts:131
Get an array of profiles

async

Returns Promise<ProfileData[]>

getTrader

getTrader(id: string): Promise<TraderData>

- Defined in src/classes/tarkov.ts:162
Get a trader by id

async

Parameters
- id: string
  
  The traders ID
Returns Promise<TraderData>

getTraders

getTraders(): Promise<Trader[]>

- Defined in src/classes/tarkov.ts:151
Get all traders

async

Returns Promise<Trader[]>

getWeather

getWeather(): Promise<Weather>

- Defined in src/classes/tarkov.ts:209
Get weather

async

Returns Promise<Weather>

keepAlive

keepAlive(): Promise<any>

- Defined in src/classes/tarkov.ts:218
Keep Alive

async

Returns Promise<any>

login

login(email: string, password: string, twoFactor?: undefined | string): Promise<void | { data: Data; err: number; errmsg: string }>

- Defined in src/classes/tarkov.ts:88
Create a new tarkov session

beta

Parameters
- email: string
  
  Tarkov Account Email
- password: string
  
  Tarkov Account Password
- Optional twoFactor: undefined | string
  
  twoFactor activation code sent to your account email
Returns Promise<void | { data: Data; err: number; errmsg: string }>

moveItem

moveItem(itemId: string, destination: ItemDestination): Promise<any>

- Defined in src/classes/tarkov.ts:356
Move an item UNTESTED

async

Parameters
- itemId: string
  
  collect item id
- destination: ItemDestination
  
  info where to move. {id, container, location:{x,y,r} }
Returns Promise<any>

offerItem

offerItem(items: string[], requirements: { _tpl: string; price: number }, sellAll?: boolean): Promise<any>

- Defined in src/classes/tarkov.ts:302
Offer a list of items

async

Parameters
- items: string[]
  
  Array of item ids
- requirements: { _tpl: string; price: number }
  - _tpl: string
  - price: number
- Default value sellAll: boolean = false
  
  Sell all in one piece. Default false
Returns Promise<any>

searchMarket

searchMarket(page: number, limit: number, filter: MarketFilter): Promise<MarketOffers>

- Defined in src/classes/tarkov.ts:257
Search offers from Flea Market.

async

Parameters
- page: number
  
  starting page, example: start searching from page 0.
- limit: number
  
  limit how many results to show. Example: 15.
- filter: MarketFilter
  
  Market Filter
Returns Promise<MarketOffers>

selectProfile

selectProfile(profile: ProfileData): Promise<Profile>

- Defined in src/classes/tarkov.ts:142
Select a profile

async

Parameters
- profile: ProfileData
Returns Promise<Profile>

stackItem

stackItem(fromId: string, toId: string): Promise<any>

- Defined in src/classes/tarkov.ts:333
Stack an item UNTESTED

async

Parameters
- fromId: string
  
  id of item to move
- toId: string
  
  id of item to move onto
Returns Promise<any>

Generated using TypeDoc