Skip to content

CalumW1/R6StatAPI

BranchesTags

Repository files navigation


shield1 shield2 shield3 shield4

Table of Contents

Installation

npm i r6statapi

Suported Runtimes

  • Node.js (20.13.0+)
  • Bun (1.1.26)

Getting Started

To get started you will need a Ubisoft login, it is best to create a new account and not the account you normally use. Create a new account here

The example below has the email and password variables hardcoded but it would be better to use dotenv to manage environment variables.

import r6statapi from 'r6statapi';
const api = new r6statapi();

// or CommonJS
const { R6StatAPI } = require("r6statapi");
const api = new R6StatAPI();

// replace with your own information
const email = "test@gmail.com"
const password = "Password123"
const usermame = "CaleyW1"
const platform = "uplay"

// login and get token
const token = await api.login(email, password)
console.log(token)

// fetch user by username
const user = await api.getUserByUsername(userName, platform);
console.log(user);

// example response
{
  profileId: 'afc2afec-b9ed-4988-bffa-58e78eedfa93',
  userId: 'afc2afec-b9ed-4988-bffa-58e78eedfa93',
  platformType: 'uplay',
  idOnPlatform: 'AFC2AFEC-B9ED-4988-BFFA-58E78EEDFA93',
  nameOnPlatform: 'CaleyW1'
}

Statistics

Table of Contents

Login

Signs into the Ubisoft a returns a token.

Field Type Required
email string yes
password string yes 
await api.Login(email, password)
Example Response 
ewogICJ2ZXIiOiAiMSIsCiAgImFpZCI6ICJlM2Q1ZWE5ZS01MGJkLTQzYjctODhiZi0zOTc5NGY0ZTNkNDAiLAogICJlbnYiOiAiUHJvZCIsCiAgInNpZCI6ICI2YzVlY2E4MS1jYWI3LTQ0NjItOWUzOC04YjZkODA5OWQ1ZjEiLAogICJ0eXAiOiAiSldFIiwKICAiZW5jIjogIkExMjhDQkMiLAogICJpdiI6ICJPellRVVNkSkswNzJURTFJTXVpdFhnIiwKICAiaW50IjogIkhTMjU2IiwKICAia2lkIjogImFkNWNjMzFhLWI2ZmQtNGYyZS04N2JmLTNjZjRkOTc1OTY2NSIKfQ.-F6ZqzG9mOze0HRYJh3Ub23dQUR9BLR-VM7hMgbisN3tQZ1XLgZFyVH2sFmmX4VMPEKVG9e_PGLnPgrtyBfVkyyQBrjlppeWJXICTQPqj1-gg-0KCX4V3DkEd_o1VYbUAeuiA2QBtUeYIaxFluqxTZ5fr6fcGZvfB8npqMgahHLdcwyzcykp8klKbhOF5L17lUXMai5VgGT33o5N3xxx6wBZL97lXZ_jK1Yd67jPTsL2guB24meGrdR2HBtrB3N6ZR2cZnrFyfDuQzdotf0HsRlX8kATI2wOiADZ8RQS6pRtfRlFXqk-HZ0bsCAdQrs4wOzwL5ZiijfS63rAif_6t1K-KYffiQ3ExXPX6jG2OVK8evkR8fP-vS_aNF1iXE8j4ctrti8PezaOgJUmlRRBwrq29hxJJs5fIsP_EGkg_5rztX4hZtvDNRM9vRsIfAt3aPci5CpyhZs2oAbjLYqA1mEOaY8PODCm4pv3qS8zFBXlPAerCW-8ccYfsAmxEMCrZCxG210BDpZQ5c4JHk_XBij6TqE7yWjg_SO0qR_6eFhRKo5lpLbHAao7EWnfuh03dr_Q210QbiyYE5lCQ4RNapfEug0i5flhlJ55asjlQq6UOt21iJFEHBKHjJLj1vSy7WR347iUlYG8bRtcKHXvL2jD6WP18knlIZIWK7XQtR90TpiYV-WY4hqy7UMqD4yFe4Ah-jP58H8ADYA0F_wzIMGenfuDV4mQ_PyjSQuEynYmycmJyjFGeSFye8N-VvGJvcxozY5NMsYmHUqFLxZ1I6HlZivB_6znSzIK5mzqkfR24tPKQv_3T2VHbTfmN_E-4e5enq3F9tayTOSGNad6sSvP_dBao50w-5JBx86i7xJyK2IRGdjizfTbmzUyBQg5zeDbrRHTrAqnaV8NglOF8I2kS3rbxKH9qfUk1MrNdgi7ZJA34tFfu7XRMvUQN2asmrYhvBC0XlyABCCnn3mPy4abQgstYS9wX-itoVSru0_YS8QCIrffpRZkWANjAIsmERWiOGMXlwE5j2wB50M4_JI_gWGplgmn_9nZrtIeGJBYRUj4j4zl495lowDfTPBOdt3QOLx8OAGrHTwDKj6TOCZ6Nh8e7DjMmgm8c8i3n1WmQu6tkT0f3kOUbt1m3941q93R9kd9MR5H28wQHDH8ffTeGPTbhitgWy9WpsnOujwIm3Nnq72L1hkB5UeJobb7uJ6x8bwMaUUjlP8S6Qpa816YKoFQlFpI-dFPaf0W4gOlxSOafLyS6oewtKQlcADTZ5uwbEx4CPRhm9kZwKdekdol6lcEBk-07z8ppev0pNJl45gztd8zuqg_tqfVQtdSh53-xYqh_7FzzsdieCHCx-I0e9jv4QqAZ_VqAGb5ENNPsYHl9bMQYHdY-4npOfK5A4QgXwConKc2KD9dzhOTuohcz5mTgnP5yCkBOxmoHOXcNqh-HV6eAtg-ayrVpG63BlFND_uxAhJ-hnK0STCID-2JI3bvBr4p6V4L6_RT8X1EU_cCw4Ohr-cO9EqZT8f8qjiVzOAqZY6uPe8DfkANkSBIfmXL6A-duTGYoetHQXmvFxiM_MB10LP6FL1eVI2ZNwCXgJ0HgZkQ-_Ul5iBPEeuEIx3tCXpk6aoq1nIC6wdj_JJx9kTwICF3tOvPbUXI1jczVu_36HFi2fZxM6inuZ1uzC3ewfY_opccdDRLSZknlHs29ZPsOfiAX_hrm0NCGdE7MJMdC9aeGsGdll2ujxGZ90CKFuayH9pJsHgpW5d8Ly8v0xCJFc2qiTGAF-XJq9XCIroOBussSi4mLsJCr97jB9KjAY12zYIb-Pfhlnlba7YqX6otIO8oWG5koYzaj5ipqixOXCrDrXAHKdHFFeAYYq3Ojk1t96o_oRkQh1WBspTmmdRz1UOlUsBbVr4q4a0mj0cgFjKIjhv54Kj2xBnpf5GxmDLV9YEE3bqfMGrCy-rIR45CLGx6mBdRmf999dmb3wOM3iPlbgloF2TDTvFdaokQ4lYX51x4E0io8aFtJIrQX8EoPeFWvG8lea20h4e7TeEFx3n07rnPY22HxAFw26spFDxwBPAc6iLxEt_NoerdANtPE_-wUnqrZJ3-Oblvk6M6HOh_vsj-yJi4QC88sxqHhWiBRhW2vCePfY1RDJvD2Hq66Xc2Engp4drZhX1Drv4PnTPk8nISNVelUxGx89B-2KZtIsBUZiUxrY7bZj6Px2FmC2Ro5dOKIjQwZA6D-uEkAhBFsibp3tOIzWAjQChCR89hJy9IS2O7PMWs31rxINAKdx43jb6llgTRsUGDXYLL1eKYecUd7orY8frlAYXU1xLmDBzBpn6wzbMRNNoFfiI1KG9rUKR8EDPUv26GcfsBzkuSHeFXSi_Xhg.oMj2gpJl_2eOj-pFuYvFyWr_t1JR48zgb2st82KTKWk

Get user by username

Gets a user by username

Field Type Required options
username string yes
platform string yes uplay, xbl, psn 
await api.getUserByUsername(userName, platform);
Example Response 
{
  profileId: 'afc2afec-b9ed-4988-bffa-58e78eedfa93',
  userId: 'afc2afec-b9ed-4988-bffa-58e78eedfa93',
  platformType: 'uplay',
  idOnPlatform: 'AFC2AFEC-B9ED-4988-BFFA-58E78EEDFA93',
  nameOnPlatform: 'CaleyW1',
  avatars: {
    '146': 'https://avatars.ubisoft.com/afc2afec-b9ed-4988-bffa-58e78eedfa93/default_146_146.png?appId=3587dcbb-7f81-457c-9781-0e3f29f6f56a',
    '256': 'https://avatars.ubisoft.com/afc2afec-b9ed-4988-bffa-58e78eedfa93/default_256_256.png?appId=3587dcbb-7f81-457c-9781-0e3f29f6f56a',
    '500': 'https://avatars.ubisoft.com/afc2afec-b9ed-4988-bffa-58e78eedfa93/default_tall.png?appId=3587dcbb-7f81-457c-9781-0e3f29f6f56a'
  }
}

Get user by userId

Gets a user by userId

Field Type Required options
userId string yes
platform string yes uplay, xbl, psn 
await api.getUserById(user.userId, platform);
Example Response 
[
  {
    profileId: 'afc2afec-b9ed-4988-bffa-58e78eedfa93',
    userId: 'afc2afec-b9ed-4988-bffa-58e78eedfa93',
    platformType: 'uplay',
    idOnPlatform: 'afc2afec-b9ed-4988-bffa-58e78eedfa93',
    nameOnPlatform: 'CaleyW1',
    avatars: {
    '146': 'https://avatars.ubisoft.com/afc2afec-b9ed-4988-bffa-58e78eedfa93/default_146_146.png?appId=3587dcbb-7f81-457c-9781-0e3f29f6f56a',
    '256': 'https://avatars.ubisoft.com/afc2afec-b9ed-4988-bffa-58e78eedfa93/default_256_256.png?appId=3587dcbb-7f81-457c-9781-0e3f29f6f56a',
    '500': 'https://avatars.ubisoft.com/afc2afec-b9ed-4988-bffa-58e78eedfa93/default_tall.png?appId=3587dcbb-7f81-457c-9781-0e3f29f6f56a'
  }
  },
  {
    profileId: 'f02cbe10-2411-43d9-b449-5366888201a2',
    userId: 'afc2afec-b9ed-4988-bffa-58e78eedfa93',
    platformType: 'steam',
    idOnPlatform: '76561198172917981',
    nameOnPlatform: '76561198172917983',
    avatars: {
    '146': 'https://avatars.ubisoft.com/afc2afec-b9ed-4988-bffa-58e78eedfa93/default_146_146.png?appId=3587dcbb-7f81-457c-9781-0e3f29f6f56a',
    '256': 'https://avatars.ubisoft.com/afc2afec-b9ed-4988-bffa-58e78eedfa93/default_256_256.png?appId=3587dcbb-7f81-457c-9781-0e3f29f6f56a',
    '500': 'https://avatars.ubisoft.com/afc2afec-b9ed-4988-bffa-58e78eedfa93/default_tall.png?appId=3587dcbb-7f81-457c-9781-0e3f29f6f56a'
  }
  },
  {
    profileId: '91193155-2b57-48f1-b69b-556f5e4ccfea',
    userId: 'afc2afec-b9ed-4988-bffa-58e78eedfa93',
    platformType: 'twitch',
    idOnPlatform: '469658264',
    nameOnPlatform: 'calbob',
    avatars: {
    '146': 'https://avatars.ubisoft.com/afc2afec-b9ed-4988-bffa-58e78eedfa93/default_146_146.png?appId=3587dcbb-7f81-457c-9781-0e3f29f6f56a',
    '256': 'https://avatars.ubisoft.com/afc2afec-b9ed-4988-bffa-58e78eedfa93/default_256_256.png?appId=3587dcbb-7f81-457c-9781-0e3f29f6f56a',
    '500': 'https://avatars.ubisoft.com/afc2afec-b9ed-4988-bffa-58e78eedfa93/default_tall.png?appId=3587dcbb-7f81-457c-9781-0e3f29f6f56a'
  }
  }
]

Get user progression

gets the progression for a user

Field Type Required options
userId string yes
platform string yes uplay, xbl, psn 
await api.getUserProgression(user.userId, platform);
Example Response 
{
  level: 326,
  xp: 129949
}

Get server status

Returns the status of a platform

platforms: pc, xbox, ps4

await api.getServerStatus(platfrom)
Example Response 
{
  MDM: '4075',
  SpaceID: '98a601e5-ca91-4440-b1c5-753f601a2c90',
  Category: 'Instance',
  Name: 'Rainbow Six Siege - XBOXONE - LIVE',
  platform: 'XBOXONE',
  status: 'Online',
  maintenance: null,
  impactedFeatures: []
}

Get user rank

Returns statistics for different gamemodes

Field Type Required options
userId id yes
platform string yes uplay, xbl, psn 
await api.getUserRank(player.userId, platfrom);
Example Response 
{
  casual: {
    profile_board_id: 'casual',
    id: 'casual',
    max_rank: 0,
    max_rank_points: 0,
    platform_family: 'pc',
    rank: 0,
    rank_points: 0,
    rank_name: 'Unranked',
    season_id: 34,
    top_rank_position: 0,
    deaths: 69,
    kills: 164,
    abandons: 0,
    losses: 4,
    wins: 29,
    rankImage: 'https://github.com/CalumW1/R6StatAPI/blob/main/assests/images/ranks/unranked.png'
  },
  event: {
    profile_board_id: 'event',
    id: 'event',
    max_rank: 0,
    max_rank_points: 0,
    platform_family: 'pc',
    rank: 0,
    rank_points: 0,
    rank_name: 'Unranked',
    season_id: 34,
    top_rank_position: 0,
    deaths: 117,
    kills: 241,
    abandons: 0,
    losses: 2,
    wins: 17,
    rankImage: 'https://github.com/CalumW1/R6StatAPI/blob/main/assests/images/ranks/unranked.png'
  },
  warmup: {
    profile_board_id: 'warmup',
    id: 'warmup',
    max_rank: 0,
    max_rank_points: 0,
    platform_family: 'pc',
    rank: 0,
    rank_points: 0,
    rank_name: 'Unranked',
    season_id: 34,
    top_rank_position: 0,
    deaths: 359,
    kills: 1309,
    abandons: 3,
    losses: 4,
    wins: 73,
    rankImage: 'https://github.com/CalumW1/R6StatAPI/blob/main/assests/images/ranks/unranked.png'
  },
  standard: {
    profile_board_id: 'standard',
    id: 'standard',
    max_rank: 0,
    max_rank_points: 0,
    platform_family: 'pc',
    rank: 0,
    rank_points: 0,
    rank_name: 'Unranked',
    season_id: 34,
    top_rank_position: 0,
    deaths: 604,
    kills: 1588,
    abandons: 0,
    losses: 20,
    wins: 239,
    rankImage: 'https://github.com/CalumW1/R6StatAPI/blob/main/assests/images/ranks/unranked.png'
  },
  ranked: {
    profile_board_id: 'ranked',
    id: 'ranked',
    max_rank: 36,
    max_rank_points: 5934,
    platform_family: 'pc',
    rank: 36,
    rank_points: 5912,
    rank_name: 'Champions',
    season_id: 34,
    top_rank_position: 2,
    deaths: 1219,
    kills: 2821,
    abandons: 0,
    losses: 38,
    wins: 544,
    rankImage: 'https://github.com/CalumW1/R6StatAPI/blob/main/assests/images/ranks/champion.png'
  }
}

Get Operator

Gets seasonal operator statistics

Field Type Required options Notes
userId Id Yes
platform string Yes uplay, xbl, psn
view string Yes seasonal
aggregation string Yes operator
gameMode string Yes all, casual, ranked, unranked
team role string Yes Attacker, Defender "Defender" and "Attacker" need to start with capitals.
season string Yes format Y(No.)S(No.) Example Y6S3 
await api.getUserOperators(
  userId,
  platform,
  view,
  aggregation,
  gameMode,
  teamRole,
  season
);

// sample
await api.getUserOperators(
  user.userId,
  "uplay",
  "current",
  "operators",
  "all,ranked,casual,unranked",
  "Defender,Attacker",
  "Y9S2"
);
Example Response 
{
  ranked: {
    attackers: [
      {
        type: 'Generalized',
        statsType: 'operators',
        statsDetail: 'Montagne',
        matchesPlayed: 84,
        roundsPlayed: 114,
        minutesPlayed: 343,
        matchesWon: 81,
        matchesLost: 3,
        roundsWon: 92,
        roundsLost: 22,
        kills: 81,
        assists: 16,
        deaths: 44,
        headshots: 4,
        meleeKills: 51,
        teamKills: 0,
        openingKills: 5,
        trades: 5,
        openingKillTrades: 2,
        openingDeathTrades: 0,
        revives: 1,
        distanceTravelled: 14418,
        winLossRatio: 27,
        killDeathRatio: 1.8409,
        headshotAccuracy: 0.0494,
        killsPerRound: 0.7105,
        roundsWithAKill: 0.7105,
        roundsWithMultiKill: 0.1667,
        roundsWithOpeningKill: 0.0439,
        roundsWithOpeningDeath: 0.0614,
        roundsWithKOST: 0.7544,
        roundsSurvived: 0.614,
        roundsWithAnAce: 0,
        roundsWithClutch: 0.0175,
        timeAlivePerMatch: 109.6905,
        timeDeadPerMatch: 20.1667,
        distancePerRound: 126.4737
      }
    ],
    defenders: []
  },
  unranked: { attackers: [], defenders: [] },
  all: { attackers: [], defenders: [] },
  casual: { attackers: [], defenders: [] }
}

Marketplace APIs

Table of Contents

Basic Search

Basic marketplace search query.

Field Type Required
searchQuery string Yes
limit number yes 
await api.SearchMarketplace(searchQuery, limit);

// Sample
await api.SearchMarketplace("R4-c", 20);
Example Response 
{
  "items": [
    {
      "id": "0d2ae42d-4c27-4cb7-af6c-2099062302bb-aee4bdf2-0b54-4c6d-af93-9fe4848e1f76",
      "assetUrl": "https://ubiservices.cdn.ubi.com/0d2ae42d-4c27-4cb7-af6c-2099062302bb/DeployerAssetsJune2023/bb74359e_3a55_3d28_b3ad_8291964f65f3.png",
      "itemId": "aee4bdf2-0b54-4c6d-af93-9fe4848e1f76",
      "name": "BLACK ICE",
      "tags": [
        "R4-C",
        "Texture",
        "W_AR_RemingtonR4C",
        "Y1S1",
        "sku_china",
        "sku_ww",
        "type_weapon_skins",
        "type_weaponskin",
        "rarity_superrare",
        "lc_classic-edition-v0"
      ],
      "type": "WeaponSkin",
      "marktetData": {
        "id": "0d2ae42d-4c27-4cb7-af6c-2099062302bb-aee4bdf2-0b54-4c6d-af93-9fe4848e1f76",
        "sellStats": {
          "id": "0d2ae42d-4c27-4cb7-af6c-2099062302bb-aee4bdf2-0b54-4c6d-af93-9fe4848e1f76-9ef71262-515b-46e8-b9a8-b6b6ad456c67-sell",
          "paymentItemId": "9ef71262-515b-46e8-b9a8-b6b6ad456c67",
          "lowestPrice": 3150,
          "highestPrice": 1000000,
          "activeCount": 2731
        },
        "buyStats": {
          "id": "0d2ae42d-4c27-4cb7-af6c-2099062302bb-aee4bdf2-0b54-4c6d-af93-9fe4848e1f76-9ef71262-515b-46e8-b9a8-b6b6ad456c67-buy",
          "paymentItemId": "9ef71262-515b-46e8-b9a8-b6b6ad456c67",
          "lowestPrice": 10,
          "highestPrice": 3100,
          "activeCount": 11646
        },
        "lastSoldAt": {
          "id": "0d2ae42d-4c27-4cb7-af6c-2099062302bb-aee4bdf2-0b54-4c6d-af93-9fe4848e1f76-9ef71262-515b-46e8-b9a8-b6b6ad456c67-last",
          "paymentItemId": "9ef71262-515b-46e8-b9a8-b6b6ad456c67",
          "price": 3000,
          "performedAt": "2024-10-06T10:27:59.634Z"
        }
      }
    },
    {
      "id": "0d2ae42d-4c27-4cb7-af6c-2099062302bb-615257b7-9aea-479f-8521-a0054af3a442",
      "assetUrl": "https://ubiservices.cdn.ubi.com/0d2ae42d-4c27-4cb7-af6c-2099062302bb/DeployerAssetsJune2023/b4ba3547_77a7_adcc_7cf7_564039670b34.png",
      "itemId": "615257b7-9aea-479f-8521-a0054af3a442",
      "name": "PIÑA COLADA",
      "tags": [
        "R4-C",
        "Texture",
        "W_AR_RemingtonR4C",
        "Y2S1",
        "sku_china",
        "sku_ww",
        "type_weapon_skins",
        "type_weaponskin",
        "rarity_superrare"
      ],
      "type": "WeaponSkin",
      "marktetData": {
        "id": "0d2ae42d-4c27-4cb7-af6c-2099062302bb-615257b7-9aea-479f-8521-a0054af3a442",
        "sellStats": {
          "id": "0d2ae42d-4c27-4cb7-af6c-2099062302bb-615257b7-9aea-479f-8521-a0054af3a442-9ef71262-515b-46e8-b9a8-b6b6ad456c67-sell",
          "paymentItemId": "9ef71262-515b-46e8-b9a8-b6b6ad456c67",
          "lowestPrice": 770,
          "highestPrice": 1000000,
          "activeCount": 1254
        },
        "buyStats": {
          "id": "0d2ae42d-4c27-4cb7-af6c-2099062302bb-615257b7-9aea-479f-8521-a0054af3a442-9ef71262-515b-46e8-b9a8-b6b6ad456c67-buy",
          "paymentItemId": "9ef71262-515b-46e8-b9a8-b6b6ad456c67",
          "lowestPrice": 10,
          "highestPrice": 666,
          "activeCount": 1198
        },
        "lastSoldAt": {
          "id": "0d2ae42d-4c27-4cb7-af6c-2099062302bb-615257b7-9aea-479f-8521-a0054af3a442-9ef71262-515b-46e8-b9a8-b6b6ad456c67-last",
          "paymentItemId": "9ef71262-515b-46e8-b9a8-b6b6ad456c67",
          "price": 750,
          "performedAt": "2024-10-06T10:25:36.078Z"
        }
      }
    },
    {
      "id": "0d2ae42d-4c27-4cb7-af6c-2099062302bb-8d3ffabe-eb44-0e65-2caf-9be17b443207",
      "assetUrl": "https://ubiservices.cdn.ubi.com/0d2ae42d-4c27-4cb7-af6c-2099062302bb/DeployerAssetsJune2023/22290723_43b4_53ab_f4af_d7bf1daad548.png",
      "itemId": "8d3ffabe-eb44-0e65-2caf-9be17b443207",
      "name": "ACID RAIN",
      "tags": [
        "Pattern",
        "R4-C",
        "Y7S1",
        "sku_china",
        "sku_ww",
        "type_weapon_skins",
        "type_weaponskin",
        "rarity_rare",
        "lc_classic-edition-v17",
        "lc_classic-edition-v18",
        "lc_classic-edition-v19",
        "lc_classic-edition-v20",
        "lc_platinum-edition-v0",
        "lc_classic-edition-v22",
        "lc_classic-edition-v21"
      ],
      "type": "WeaponSkin",
      "marktetData": {
        "id": "0d2ae42d-4c27-4cb7-af6c-2099062302bb-8d3ffabe-eb44-0e65-2caf-9be17b443207",
        "sellStats": {
          "id": "0d2ae42d-4c27-4cb7-af6c-2099062302bb-8d3ffabe-eb44-0e65-2caf-9be17b443207-9ef71262-515b-46e8-b9a8-b6b6ad456c67-sell",
          "paymentItemId": "9ef71262-515b-46e8-b9a8-b6b6ad456c67",
          "lowestPrice": 10,
          "highestPrice": 250000,
          "activeCount": 775
        },
        "buyStats": {
          "id": "",
          "paymentItemId": "",
          "lowestPrice": 0,
          "highestPrice": 0,
          "activeCount": 0
        },
        "lastSoldAt": {
          "id": "0d2ae42d-4c27-4cb7-af6c-2099062302bb-8d3ffabe-eb44-0e65-2caf-9be17b443207-9ef71262-515b-46e8-b9a8-b6b6ad456c67-last",
          "paymentItemId": "9ef71262-515b-46e8-b9a8-b6b6ad456c67",
          "price": 10,
          "performedAt": "2024-10-06T09:06:16.624Z"
        }
      }
    }
  ]
}

Advanced Search

Advanced marketplace search with filters and sorting.

Field Type Required options Notes
searchTerm string Yes
marketPlaceType string Yes 'buy', 'sell'
types Object Yes See types to pass in no options use {}
tags Object Yes See tags to pass in no options use {}
sortBy string Yes See sort by Default for 'buy' is Sale available: high to low. Default for 'sell' is Purchase available: high to low
limit number yes 
await api.advancedMarketplaceSearch(
  searchTerm,
  marketplaceType,
  types,
  tags,
  sortBy,
  limit
);


// Sample

const tags = {
  rarity: ["SuperRare"],
  seasons: [],
  operators: [],
  weapon: [],
  events: [],
  esportsTeams: [],
};

const types = {
  type: ["WeaponSkin"],
};

await api.advancedMarketplaceSearch(
  "Black Ice",
  "sell",
  types,
  tags,
  "Item names: A-Z",
  20
);
Example Response 
{
  "items": [
    {
      "id": "0d2ae42d-4c27-4cb7-af6c-2099062302bb-f4d787a6-a17d-40a5-9a05-22c924066e81",
      "assetUrl": "https://ubiservices.cdn.ubi.com/0d2ae42d-4c27-4cb7-af6c-2099062302bb/DeployerAssetsJune2023/ad2e679b_f8d4_38fc_6f01_1402dbea4ac8.png",
      "itemId": "f4d787a6-a17d-40a5-9a05-22c924066e81",
      "name": "BLACK ICE",
      "tags": [
        "M590A1",
        "Texture",
        "W_SG_591A1",
        "Y1S1",
        "sku_china",
        "sku_ww",
        "type_weapon_skins",
        "type_weaponskin",
        "rarity_superrare",
        "lc_classic-edition-v0",
        "lc_yttrium-edition-v0"
      ],
      "type": "WeaponSkin",
      "marktetData": {
        "id": "0d2ae42d-4c27-4cb7-af6c-2099062302bb-f4d787a6-a17d-40a5-9a05-22c924066e81",
        "sellStats": {
          "id": "0d2ae42d-4c27-4cb7-af6c-2099062302bb-f4d787a6-a17d-40a5-9a05-22c924066e81-9ef71262-515b-46e8-b9a8-b6b6ad456c67-sell",
          "paymentItemId": "9ef71262-515b-46e8-b9a8-b6b6ad456c67",
          "lowestPrice": 400,
          "highestPrice": 1000000,
          "activeCount": 2065
        },
        "buyStats": {
          "id": "0d2ae42d-4c27-4cb7-af6c-2099062302bb-f4d787a6-a17d-40a5-9a05-22c924066e81-9ef71262-515b-46e8-b9a8-b6b6ad456c67-buy",
          "paymentItemId": "9ef71262-515b-46e8-b9a8-b6b6ad456c67",
          "lowestPrice": 10,
          "highestPrice": 330,
          "activeCount": 1928
        },
        "lastSoldAt": {
          "id": "0d2ae42d-4c27-4cb7-af6c-2099062302bb-f4d787a6-a17d-40a5-9a05-22c924066e81-9ef71262-515b-46e8-b9a8-b6b6ad456c67-last",
          "paymentItemId": "9ef71262-515b-46e8-b9a8-b6b6ad456c67",
          "price": 400,
          "performedAt": "2024-10-06T11:06:17.944Z"
        }
      }
    },
    {
      "id": "0d2ae42d-4c27-4cb7-af6c-2099062302bb-f3fde1b4-329c-4dc7-9e22-987cc6c77b04",
      "assetUrl": "https://ubiservices.cdn.ubi.com/0d2ae42d-4c27-4cb7-af6c-2099062302bb/DeployerAssetsJune2023/08f7a0ba_be13_9f01_4ff9_8026b07e5ecd.png",
      "itemId": "f3fde1b4-329c-4dc7-9e22-987cc6c77b04",
      "name": "BLACK ICE",
      "tags": [
        "P226_MK_25",
        "Texture",
        "W_SA_P226",
        "Y1S1",
        "sku_china",
        "sku_ww",
        "type_weapon_skins",
        "type_weaponskin",
        "rarity_superrare",
        "lc_classic-edition-v0"
      ],
      "type": "WeaponSkin",
      "marktetData": {
        "id": "0d2ae42d-4c27-4cb7-af6c-2099062302bb-f3fde1b4-329c-4dc7-9e22-987cc6c77b04",
        "sellStats": {
          "id": "0d2ae42d-4c27-4cb7-af6c-2099062302bb-f3fde1b4-329c-4dc7-9e22-987cc6c77b04-9ef71262-515b-46e8-b9a8-b6b6ad456c67-sell",
          "paymentItemId": "9ef71262-515b-46e8-b9a8-b6b6ad456c67",
          "lowestPrice": 160,
          "highestPrice": 803723,
          "activeCount": 153
        },
        "buyStats": {
          "id": "0d2ae42d-4c27-4cb7-af6c-2099062302bb-f3fde1b4-329c-4dc7-9e22-987cc6c77b04-9ef71262-515b-46e8-b9a8-b6b6ad456c67-buy",
          "paymentItemId": "9ef71262-515b-46e8-b9a8-b6b6ad456c67",
          "lowestPrice": 10,
          "highestPrice": 110,
          "activeCount": 131
        },
        "lastSoldAt": {
          "id": "0d2ae42d-4c27-4cb7-af6c-2099062302bb-f3fde1b4-329c-4dc7-9e22-987cc6c77b04-9ef71262-515b-46e8-b9a8-b6b6ad456c67-last",
          "paymentItemId": "9ef71262-515b-46e8-b9a8-b6b6ad456c67",
          "price": 160,
          "performedAt": "2024-10-06T11:05:49.128Z"
        }
      }
    },
    {
      "id": "0d2ae42d-4c27-4cb7-af6c-2099062302bb-b1cdb343-8ca2-4f7e-b489-af66bfe914cd",
      "assetUrl": "https://ubiservices.cdn.ubi.com/0d2ae42d-4c27-4cb7-af6c-2099062302bb/DeployerAssetsJune2023/dd1d42bd_53ce_0c52_e256_4808fb7667ac.png",
      "itemId": "b1cdb343-8ca2-4f7e-b489-af66bfe914cd",
      "name": "BLACK ICE",
      "tags": [
        "SMG-11",
        "Texture",
        "W_MP_MAC11",
        "Y1S1",
        "sku_china",
        "sku_ww",
        "type_weapon_skins",
        "type_weaponskin",
        "rarity_superrare",
        "lc_classic-edition-v0",
        "lc_platinum-edition-v0"
      ],
      "type": "WeaponSkin",
      "marktetData": {
        "id": "0d2ae42d-4c27-4cb7-af6c-2099062302bb-b1cdb343-8ca2-4f7e-b489-af66bfe914cd",
        "sellStats": {
          "id": "0d2ae42d-4c27-4cb7-af6c-2099062302bb-b1cdb343-8ca2-4f7e-b489-af66bfe914cd-9ef71262-515b-46e8-b9a8-b6b6ad456c67-sell",
          "paymentItemId": "9ef71262-515b-46e8-b9a8-b6b6ad456c67",
          "lowestPrice": 1000,
          "highestPrice": 1000000,
          "activeCount": 1903
        },
        "buyStats": {
          "id": "0d2ae42d-4c27-4cb7-af6c-2099062302bb-b1cdb343-8ca2-4f7e-b489-af66bfe914cd-9ef71262-515b-46e8-b9a8-b6b6ad456c67-buy",
          "paymentItemId": "9ef71262-515b-46e8-b9a8-b6b6ad456c67",
          "lowestPrice": 10,
          "highestPrice": 890,
          "activeCount": 4186
        },
        "lastSoldAt": {
          "id": "0d2ae42d-4c27-4cb7-af6c-2099062302bb-b1cdb343-8ca2-4f7e-b489-af66bfe914cd-9ef71262-515b-46e8-b9a8-b6b6ad456c67-last",
          "paymentItemId": "9ef71262-515b-46e8-b9a8-b6b6ad456c67",
          "price": 1000,
          "performedAt": "2024-10-06T11:05:41.995Z"
        }
      }
    }
  ]
}

Recommended Items

Returns recommended items for a profile

Field Type Required options
profileId id yes profileId is available from either getUserByUsername or getUserByUserId
limit number yes 
  await api.getRecommendedItems(profileId, limit);

  // sample
  await api.getRecommendedItems(user.profileId, 20);
Example Response 
{
  "items": [
    {
      "id": "0d2ae42d-4c27-4cb7-af6c-2099062302bb-e3c5f6cf-b6c9-4df0-b14a-a0f8fd72fad0",
      "assetUrl": "https://ubiservices.cdn.ubi.com/0d2ae42d-4c27-4cb7-af6c-2099062302bb/DeployerAssetsJune2023/f843c6b1_ba62_dc85_9392_a708bd22815d.png",
      "itemId": "e3c5f6cf-b6c9-4df0-b14a-a0f8fd72fad0",
      "name": "BLACK ICE",
      "tags": [
        "F2",
        "Texture",
        "W_AR_FAMASG2",
        "Y1S1",
        "sku_china",
        "sku_ww",
        "type_weapon_skins",
        "type_weaponskin",
        "rarity_superrare",
        "lc_classic-edition-v0",
        "lc_yttrium-edition-v0"
      ],
      "type": "WeaponSkin",
      "marktetData": {
        "id": "0d2ae42d-4c27-4cb7-af6c-2099062302bb-e3c5f6cf-b6c9-4df0-b14a-a0f8fd72fad0",
        "sellStats": {
          "id": "0d2ae42d-4c27-4cb7-af6c-2099062302bb-e3c5f6cf-b6c9-4df0-b14a-a0f8fd72fad0-9ef71262-515b-46e8-b9a8-b6b6ad456c67-sell",
          "paymentItemId": "9ef71262-515b-46e8-b9a8-b6b6ad456c67",
          "lowestPrice": 210,
          "highestPrice": 1000000,
          "activeCount": 2703
        },
        "buyStats": {
          "id": "0d2ae42d-4c27-4cb7-af6c-2099062302bb-e3c5f6cf-b6c9-4df0-b14a-a0f8fd72fad0-9ef71262-515b-46e8-b9a8-b6b6ad456c67-buy",
          "paymentItemId": "9ef71262-515b-46e8-b9a8-b6b6ad456c67",
          "lowestPrice": 10,
          "highestPrice": 180,
          "activeCount": 1174
        },
        "lastSoldAt": {
          "id": "0d2ae42d-4c27-4cb7-af6c-2099062302bb-e3c5f6cf-b6c9-4df0-b14a-a0f8fd72fad0-9ef71262-515b-46e8-b9a8-b6b6ad456c67-last",
          "paymentItemId": "9ef71262-515b-46e8-b9a8-b6b6ad456c67",
          "price": 180,
          "performedAt": "2024-10-06T11:33:09.881Z"
        }
      }
    },
    {
      "id": "0d2ae42d-4c27-4cb7-af6c-2099062302bb-452d6796-8176-4af1-858b-7d87dabad8a5",
      "assetUrl": "https://ubiservices.cdn.ubi.com/0d2ae42d-4c27-4cb7-af6c-2099062302bb/DeployerAssetsJune2023/02143738_7e78_0d62_f5e3_41458fa33730.png",
      "itemId": "452d6796-8176-4af1-858b-7d87dabad8a5",
      "name": "BLACK ICE",
      "tags": [
        "C8-SFW",
        "Texture",
        "W_AR_C8SFW",
        "Y1S1",
        "sku_china",
        "sku_ww",
        "type_weapon_skins",
        "type_weaponskin",
        "rarity_superrare",
        "lc_classic-edition-v0",
        "lc_classic-edition-v17",
        "lc_classic-edition-v18",
        "lc_classic-edition-v19",
        "lc_classic-edition-v20",
        "lc_platinum-edition-v0",
        "lc_classic-edition-v22",
        "lc_classic-edition-v21"
      ],
      "type": "WeaponSkin",
      "marktetData": {
        "id": "0d2ae42d-4c27-4cb7-af6c-2099062302bb-452d6796-8176-4af1-858b-7d87dabad8a5",
        "sellStats": {
          "id": "0d2ae42d-4c27-4cb7-af6c-2099062302bb-452d6796-8176-4af1-858b-7d87dabad8a5-9ef71262-515b-46e8-b9a8-b6b6ad456c67-sell",
          "paymentItemId": "9ef71262-515b-46e8-b9a8-b6b6ad456c67",
          "lowestPrice": 500,
          "highestPrice": 1000000,
          "activeCount": 3565
        },
        "buyStats": {
          "id": "0d2ae42d-4c27-4cb7-af6c-2099062302bb-452d6796-8176-4af1-858b-7d87dabad8a5-9ef71262-515b-46e8-b9a8-b6b6ad456c67-buy",
          "paymentItemId": "9ef71262-515b-46e8-b9a8-b6b6ad456c67",
          "lowestPrice": 10,
          "highestPrice": 461,
          "activeCount": 3560
        },
        "lastSoldAt": {
          "id": "0d2ae42d-4c27-4cb7-af6c-2099062302bb-452d6796-8176-4af1-858b-7d87dabad8a5-9ef71262-515b-46e8-b9a8-b6b6ad456c67-last",
          "paymentItemId": "9ef71262-515b-46e8-b9a8-b6b6ad456c67",
          "price": 510,
          "performedAt": "2024-10-06T11:32:37.031Z"
        }
      }
    },
    {
      "id": "0d2ae42d-4c27-4cb7-af6c-2099062302bb-8b9b75a2-4ed6-49aa-a403-a1f4122c75c6",
      "assetUrl": "https://ubiservices.cdn.ubi.com/0d2ae42d-4c27-4cb7-af6c-2099062302bb/DeployerAssetsJune2023/42fcb009_21d9_4458_02c6_b8e54e9fd453.png",
      "itemId": "8b9b75a2-4ed6-49aa-a403-a1f4122c75c6",
      "name": "BLACK ICE",
      "tags": [
        "416-C_CARBINE",
        "Texture",
        "W_AR_HK416",
        "Y1S1",
        "sku_china",
        "sku_ww",
        "type_weapon_skins",
        "type_weaponskin",
        "rarity_superrare",
        "lc_classic-edition-v0",
        "lc_classic-edition-v17",
        "lc_classic-edition-v18",
        "lc_classic-edition-v19",
        "lc_classic-edition-v20",
        "lc_platinum-edition-v0",
        "lc_classic-edition-v22",
        "lc_classic-edition-v21"
      ],
      "type": "WeaponSkin",
      "marktetData": {
        "id": "0d2ae42d-4c27-4cb7-af6c-2099062302bb-8b9b75a2-4ed6-49aa-a403-a1f4122c75c6",
        "sellStats": {
          "id": "0d2ae42d-4c27-4cb7-af6c-2099062302bb-8b9b75a2-4ed6-49aa-a403-a1f4122c75c6-9ef71262-515b-46e8-b9a8-b6b6ad456c67-sell",
          "paymentItemId": "9ef71262-515b-46e8-b9a8-b6b6ad456c67",
          "lowestPrice": 299,
          "highestPrice": 1000000,
          "activeCount": 4606
        },
        "buyStats": {
          "id": "0d2ae42d-4c27-4cb7-af6c-2099062302bb-8b9b75a2-4ed6-49aa-a403-a1f4122c75c6-9ef71262-515b-46e8-b9a8-b6b6ad456c67-buy",
          "paymentItemId": "9ef71262-515b-46e8-b9a8-b6b6ad456c67",
          "lowestPrice": 10,
          "highestPrice": 267,
          "activeCount": 2642
        },
        "lastSoldAt": {
          "id": "0d2ae42d-4c27-4cb7-af6c-2099062302bb-8b9b75a2-4ed6-49aa-a403-a1f4122c75c6-9ef71262-515b-46e8-b9a8-b6b6ad456c67-last",
          "paymentItemId": "9ef71262-515b-46e8-b9a8-b6b6ad456c67",
          "price": 289,
          "performedAt": "2024-10-06T11:32:29.498Z"
        }
      }
    }
  ]
}

Get Item Details

Returns the details for an item by id.

Field Type Required
itemId id yes 
await api.getItemDetails("aee4bdf2-0b54-4c6d-af93-9fe4848e1f76");

// sample
await api.getItemDetails("aee4bdf2-0b54-4c6d-af93-9fe4848e1f76");
Example Response 
{
  "id": "0d2ae42d-4c27-4cb7-af6c-2099062302bb-aee4bdf2-0b54-4c6d-af93-9fe4848e1f76",
  "assetUrl": "https://ubiservices.cdn.ubi.com/0d2ae42d-4c27-4cb7-af6c-2099062302bb/DeployerAssetsJune2023/bb74359e_3a55_3d28_b3ad_8291964f65f3.png",
  "itemId": "aee4bdf2-0b54-4c6d-af93-9fe4848e1f76",
  "name": "BLACK ICE",
  "tags": [
    "R4-C",
    "Texture",
    "W_AR_RemingtonR4C",
    "Y1S1",
    "sku_china",
    "sku_ww",
    "type_weapon_skins",
    "type_weaponskin",
    "rarity_superrare",
    "lc_classic-edition-v0"
  ],
  "type": "WeaponSkin",
  "marktetData": {
    "id": "0d2ae42d-4c27-4cb7-af6c-2099062302bb-aee4bdf2-0b54-4c6d-af93-9fe4848e1f76",
    "sellStats": {
      "id": "0d2ae42d-4c27-4cb7-af6c-2099062302bb-aee4bdf2-0b54-4c6d-af93-9fe4848e1f76-9ef71262-515b-46e8-b9a8-b6b6ad456c67-sell",
      "paymentItemId": "9ef71262-515b-46e8-b9a8-b6b6ad456c67",
      "lowestPrice": 3000,
      "highestPrice": 1000000,
      "activeCount": 2739
    },
    "buyStats": {
      "id": "0d2ae42d-4c27-4cb7-af6c-2099062302bb-aee4bdf2-0b54-4c6d-af93-9fe4848e1f76-9ef71262-515b-46e8-b9a8-b6b6ad456c67-buy",
      "paymentItemId": "9ef71262-515b-46e8-b9a8-b6b6ad456c67",
      "lowestPrice": 10,
      "highestPrice": 2800,
      "activeCount": 11640
    },
    "lastSoldAt": {
      "id": "0d2ae42d-4c27-4cb7-af6c-2099062302bb-aee4bdf2-0b54-4c6d-af93-9fe4848e1f76-9ef71262-515b-46e8-b9a8-b6b6ad456c67-last",
      "paymentItemId": "9ef71262-515b-46e8-b9a8-b6b6ad456c67",
      "price": 3000,
      "performedAt": "2024-10-06T11:40:28.908Z"
    }
  }
}

Get Transaction History

Returns a list of of all completed transactions.

Field Type Required
profileId id yes
limit number yes 
await api.GetTransactionHistory(profileId, limit);

await api.GetTransactionHistory("91193155-2b57-48f1-b69b-556f5e4ccfea", 20);
Example Response 
{
  "transactions": [
    {
      "id": "0d2ae42d-4c27-4cb7-af6c-2099062302bb-afc2afec-b9ed-4988-bffa-58e78eedfa9d-41fa7384-309a-4992-be82-36decd65e3ba",
      "tradeId": "41fa7384-309a-4992-be82-36decd65e3ba",
      "state": "Succeeded",
      "category": "Sell",
      "createdAt": "2024-10-07T21:07:01.238Z",
      "expiresAt": null,
      "lastModifiedAt": "2024-10-07T21:07:01.653Z",
      "tradeItems": {
        "id": "0d2ae42d-4c27-4cb7-af6c-2099062302bb-02e8b1e8-813a-44d9-8cc3-8d5d484e0b9f",
        "itemId": "02e8b1e8-813a-44d9-8cc3-8d5d484e0b9f",
        "assetUrl": "https://ubiservices.cdn.ubi.com/0d2ae42d-4c27-4cb7-af6c-2099062302bb/MtxAssetsDeployer/72b07709_8297_34ea_7f19_85dbb975b108.png",
        "name": "DOUBLE SUN",
        "tags": [
          "Character.Legacy.THATCHER",
          "Y5S2",
          "sku_china",
          "sku_ww",
          "type_characterheadgear",
          "type_headgears",
          "rarity_superrare"
        ],
        "type": "CharacterHeadgear"
      },
      "paymentOptions": {
        "quantity": 499,
        "price": 90,
        "transactionFee": 9
      },
      "payment": {
        "price": 90,
        "transactionFee": 9
      }
    }
  ]
}

Get Pending Transactions

Returns a list of pending transactions for a profileId.

Field Type Required
profileId id yes
limit number yes 
await api.GetPendingtransactions(profileId, limit);

// sample
await api.GetPendingtransactions("91193155-2b57-48f1-b69b-556f5e4ccfea", 20);
Example Response 
{
  "transactions": [
    {
      "id": "0d2ae42d-4c27-4cb7-af6c-2099062302bb-afc2afec-b9ed-4988-bffa-58e78eedfa9d-f1b694a9-7984-4f7c-bbb4-f5848931775b",
      "tradeId": "f1b694a9-7984-4f7c-bbb4-f5848931775b",
      "state": "Created",
      "category": "Sell",
      "createdAt": "2024-10-07T00:53:16.705Z",
      "expiresAt": "2024-11-06T00:53:16.705Z",
      "lastModifiedAt": "2024-10-07T00:53:16.831Z",
      "tradeItems": {
        "id": "0d2ae42d-4c27-4cb7-af6c-2099062302bb-268cc330-1a65-4a0a-a277-7a9bb7c79cac",
        "itemId": "268cc330-1a65-4a0a-a277-7a9bb7c79cac",
        "assetUrl": "https://ubiservices.cdn.ubi.com/0d2ae42d-4c27-4cb7-af6c-2099062302bb/DeployerAssetsJune2023/65587a79_e7d6_d62a_279c_ac3f46c4333f.png",
        "name": "WIND BASTION",
        "tags": [
          "Character.Legacy.MUTE",
          "Y3S4",
          "sku_china",
          "sku_ww",
          "type_characterheadgear",
          "type_headgears",
          "rarity_uncommon"
        ],
        "type": "CharacterHeadgear"
      },
      "paymentOptions": {
        "quantity": 418,
        "price": 10000,
        "transactionFee": 1000
      }
    },
    {
      "id": "0d2ae42d-4c27-4cb7-af6c-2099062302bb-afc2afec-b9ed-4988-bffa-58e78eedfa9d-367b57de-a74a-49b1-af19-79dc3074c0cc",
      "tradeId": "367b57de-a74a-49b1-af19-79dc3074c0cc",
      "state": "Created",
      "category": "Sell",
      "createdAt": "2024-10-06T22:20:06.459Z",
      "expiresAt": "2024-11-05T22:20:06.459Z",
      "lastModifiedAt": "2024-10-06T22:20:06.568Z",
      "tradeItems": {
        "id": "0d2ae42d-4c27-4cb7-af6c-2099062302bb-ee4ff71e-b8d1-4c68-a5a5-ec0608f8eab9",
        "itemId": "ee4ff71e-b8d1-4c68-a5a5-ec0608f8eab9",
        "assetUrl": "https://ubiservices.cdn.ubi.com/0d2ae42d-4c27-4cb7-af6c-2099062302bb/DeployerAssetsJune2023/1302cd61_b369_5164_31ba_55cd18a16775.png",
        "name": "ACID SCOURGE",
        "tags": [
          "T-5_SMG",
          "Texture",
          "W_SMG_JS9",
          "Y4S3",
          "doktorcurse",
          "sku_china",
          "sku_ww",
          "type_weapon_skins",
          "type_weaponskin",
          "rarity_rare",
          "lc_barium-edition-v0",
          "lc_barium-edition-v1",
          "lc_barium-edition-v2",
          "lc_barium-edition-v3"
        ],
        "type": "WeaponSkin"
      },
      "paymentOptions": {
        "quantity": 418,
        "price": 200000,
        "transactionFee": 20000
      }
    }
  ]
}

Marketplace options

Tags

Rarity

Options 
Legendary
SuperRare
Rare
Uncommon

Seasons

Year 1 season 1 to current season. Format Y(Number)S(Number), Example Y7S3

Operators

Options 
'Ace'
'Alibi'
'Amaru'
'Aruni'
'Ash'
'Azami'
'Bandit'
'Blackbeard'
'Blitz'
'Brava'
'Buck'
'Capitao'
'Castle'
'Caveria'
'Clash'
'Deimos'
'Doc'
'Dokkaebi'
'Echo'
'Ela'
'Fenrir'
'Finka'
'Flores'
'Frost'
'Fuze'
'Glaz'
'Goyo'
'Gridlock'
'Grim'
'Hibana'
'Iana'
'IQ'
'Jackal'
'Jager'
'Kaid'
'Kali'
'Kapkan'
'Lesion'
'Lion'
'Maestro'
'Maverick'
'Melusi'
'Mira'
'Montagne'
'Mozzie
'Mute'
'Nokk'
'Nomad'
'Oryx'
'Osa'
'Pulse'
'Ram'
'Rook'
'Sens',
'Sentry'
'Skopos'
'Sledge'
'Smoke'
'Solis'
'Striker'
'Tachanka'
'Thatcher'
'Thermite'
'Thorn'
'Thunderbird'
'Tubarao'
'Twitch'
'Valkrie'
'Vigil'
'Wamai'
'Warden'
'Ying'
'Zero'
'Zofia'

Weapons

Options 
'.44 Mag Semi-Auto'
'5.7 USG'
'6P41'
'9mm C1'
'9x19VSN'
'416-C CARBINE'
'FourOneSeven'
'552 COMMANDO'
'556XL'
'1911 TACOPS'
'ACS12'
'AK-12'
'AK-74M'
'ALDA 5.56'
'AR-15.50'
'AR33'
'ARX200'
'AUG A2'
'AUG A3'
'Bailiff 410'
'BEARING 9'
'BOSG.12.2'
'C7E'
'C8-SFW'
'C75 Auto'
'CAMRS
'COMMANDO 9'
'CSRX 300'
'D-50'
'DP27'
'F2'
'F90'
'FMG-9'
'FO-12'
'G8A1'
'G36C'
'GONNE-6'
'GSH-18'
'ITA12L'
'ITA12S'
'K1A'
'KERATOS .357'
'L85A2'
'LFP586'
'LMG-E'
'M4'
'M12'
'M45 MEUSOC'
'M249'
'M249 SAW'
'M590A1'
'M762'
'M870'
'M1014'
'Mk 14 EBR'
'MK1 9mm'
'MK17 CQB'
'MP5'
'MP5K'
'MP5SD'
'MP7'
'MPX'
'Mx4 Strom'
'OTs-03'
'P-10C'
'P9'
'P10 RONI'
'P12'
'P90'
'P226 MK 25'
'P229'
'PARA-308'
'PDW9'
'PMM'
'POF-9'
'PRB92'
'Q-929'
'R4-C'
'RG15'
'SASG-12'
'SC3000K'
'SCORPION EVO 3 A1'
'SDP 9mm'
'SG-CQB'
'SIX12'
'SIX12 SD'
'SMG-11'
'SMG-12'
'SPAS-12'
'SPAS-15'
'SPEAR .308'
'SPSMG9'
'SR-25'
'SUPER 90'
'SUPER SHORTY'
'SUPERNOVA'
'T-5 SMG'
'T-95 LSW'
'TCSG12'
'TYPE-89'
'UMP45'
'USP40'
'UZK50GI'
'V308'
'VECTOR .45 ACP'

Events

Options 
'Apocalypse'
'Containment'
'DoktorsCurse'
'FreezeForAll'
'MuteFleshAndMetal'
'Rengoku'
'Showdown'
'SnowBrawl'
'SugarFright'
'TheGrandLarceny'
'TheTeddyConflict'

Esports Teams

Options 
'00Nation'
'Astralis'
'Chaos EC'
'Cloud9'
'Fav Gaming'
'Giants Gaming'
'Guts Gaming'
'Heroic'
'Intz'
'Invictus Gaming'
'Mirage'
'MNM Gaming'
'Natus Vincere'
'Nora Rengo'
'Order'
'Parabellum Esports'
'QConfirm'
'Santos'
'Team Empire'
'Team Vitality'
'The Chiefs'
'Xavier Esports'
'XSet'

Other types

Options 
'Battlepass'
'Seasonal'
'Universal'

Types

Options 
'WeaponSkin'
'CharacterHeadgear'
'CharacterUniform'
'WeaponAttachmentSkinSet'
'Charm'
'OperatorCardPortrait'
'OperatorCardBackground'
'DroneSkin'
'GadgetSkin'

Sort by

Options 
'Purchase available: high to low'
'Purchase available: low to high'
'Sale available: high to low'
'Sale available: low to high'
'Last sale price: high to low'
'Last sale price: low to high'
'Item names: A-Z'
'Item names: Z-A'

Support

For any questions, bugs or feedback, please use our Discord or create an issue on Github

About

API wrapper for Rainbow Six Siege.

www.npmjs.com/package/r6statapi

Topics

nodejs javascript api wrapper marketplace typescript six rainbow api-wrapper rainbow6 rainbowsix rainbow-six r6s rainbow-six-siege rainbowsixsiege rainbow6siege r6-marketplace

Resources

Readme

License

MIT license
Activity

Stars

4 stars

Watchers

1 watching

Forks

1 fork
Report repository

Releases 3

v2.1.0 Latest
Oct 11, 2024
+ 2 releases

Packages

No packages published

Contributors 2

  •  
  •  

Languages