A handy npm package to extract data from Ubisoft services by reverse-engineering their public web APIs.
Before using this package, you should know that Ubisoft does not provide any official API for developers to design and develop their own third-party applications directly.
So, where exactly do I get the data from?
The answer is simple; I fetch data by reverse-engineering Ubisoft web APIs (Which obviously don't have any documentation), format, and restructure the responses and eventually return the new data to the user.
To access this data, you must provide some Ubisoft accounts (at least one account) which contains email and password to authenticate and work with their APIs.
Remember that two-step verification of the accounts must be disabled. Otherwise, this package won't work.
Do not use your primary Ubisoft account.
If you improperly use API calls, your account might get a temporary penalty or permanent ban.
We strongly recommend that you create a new fake account.
We take no responsibility for anything that might happen to the provided accounts in the future.
The Ubisoft APIs that we use in this package are not stable. Your application might suddenly break if Ubisoft changes something in the future, so you must always keep your application up-to-date.
There are multiple third-party non-open source websites/services out there that provide APIs related to Ubisoft services. For several reasons, we advise you not to use them:
- It is wrong to build an application that relies heavily on many third-party services.
- To get data, they all use the same method I described above.
- They are not trustworthy, and it's hard to trust them.
- You will never know what they do with the data.
- They always have the power to manipulate the data before delivering it to you.
- Includes TypeScript definitions
- Supports multiple Ubisoft accounts (multiple sessions)
- Supports HTTP or HTTPS proxy for outgoing requests
- Search Ubisoft profiles (by username, profile id, user id, etc...)
- Check Ubisoft username availability
- Get users profile picture in different sizes
- Tom Clancy's Rainbow Six: Siege (Work in progress...)
Using npm:
npm install ubisoft-apiUsing yarn:
yarn add ubisoft-apiWe highly recommend you to use TypeScript instead of CommonJS.
CommonJS:
const { Database } = require('ubisoft-api/database')
const { Ubisoft } = require('ubisoft-api/ubisoft');
const db = new Database(__dirname + '/sessions.json');
db.init().then(() => {
const ubisoft = new Ubisoft({
accounts: [
{
email: '...',
password: '...',
},
],
database: db,
// proxy: ''
});
// Start coding here!
})ES6:
import { Database } from 'ubisoft-api/database';
import { Ubisoft } from 'ubisoft-api';
const db = new Database(__dirname + '/sessions.json');
// Init database for storing sessions
db.init().then(() => {
const ubisoft = new Ubisoft({
accounts: [
{
email: '...',
password: '...'
},
// Optional: Add more Ubisoft accounts...
],
// Pass the initiated db
database: db,
/**
* Optional:
* Pass HTTP or HTTPS proxy server for outgoing requests
*
* Example:
* http(s)://user:pass@host:port
*/
// proxy: '',
});
// Start coding here!
})You can search up to 50 Ubisoft profiles in a single call.
This restriction is set by Ubisoft and may change in the future.
/**
* ===========================
* Search profiles by username
* ===========================
*/
ubisoft
.searchByUsername('uplay', 'Sub.Script')
// .searchByUsername('uplay', ['Sub.Script', 'Beaulo.TSM'])
.then((profiles) => {
console.log(profiles.toArray());
})
/**
* =============================
* Search profiles by profile id
* =============================
*/
ubisoft
.searchByProfileId('4503086f-112e-41b6-bdbf-1c682596bab3')
/*
.searchByProfileId('uplay', [
'4503086f-112e-41b6-bdbf-1c682596bab3' // Sub.Script
'3cc51897-49c4-45f6-af9d-66507b8ef0e1' // Beaulo.TSM
'36e684d7-5a57-42df-9b00-1c60e7c91f28' // Achieved.TSM
])
*/
.then((profiles) => {
console.log(profiles.toArray());
})Output:
[
{
"id": "4503086f-112e-41b6-bdbf-1c682596bab3",
"userId": "4503086f-112e-41b6-bdbf-1c682596bab3",
"name": "Sub.Script",
"platform": "uplay",
"platformId": "4503086f-112e-41b6-bdbf-1c682596bab3"
}
]Search profiles by user id
Note: By using this method, we will return an optional "connections" property.
If the user has linked other third-party platforms (like Steam) to its Ubisoft account, this property will contain all the information about those platforms.
In the example below, you can see that Fabian and I connected our Steam account to our Ubisoft account.
ubisoft
.searchByUserId([
'4503086f-112e-41b6-bdbf-1c682596bab3', // Sub.Script
'9cf4d4a1-e328-49f8-be77-c255d6efefaa', // Fabian.Vitality
])
.then((profiles) => {
console.log(profiles.toArray());
})Output:
[
{
"id": "4503086f-112e-41b6-bdbf-1c682596bab3",
"userId": "4503086f-112e-41b6-bdbf-1c682596bab3",
"name": "Sub.Script",
"platform": "uplay",
"platformId": "4503086f-112e-41b6-bdbf-1c682596bab3",
"connections": [
{
"id": "76561198421424406",
"userId": "4503086f-112e-41b6-bdbf-1c682596bab3",
"name": "76561198421424406",
"platform": "steam",
"platformId": "76561198421424406"
}
]
},
{
"id": "9cf4d4a1-e328-49f8-be77-c255d6efefaa",
"userId": "9cf4d4a1-e328-49f8-be77-c255d6efefaa",
"name": "Fabian.Vitality",
"platform": "uplay",
"platformId": "9cf4d4a1-e328-49f8-be77-c255d6efefaa",
"connections": [
{
"id": "76561197989637130",
"userId": "9cf4d4a1-e328-49f8-be77-c255d6efefaa",
"name": "76561197989637130",
"platform": "steam",
"platformId": "76561197989637130"
}
]
}
]Just because you got some results after searching profiles, it does not mean that you will always receive "game stats" for all the available games.
In fact, if the profiles don't own the game or have never played the game before, most likely Ubisoft will return an empty response then you will get an error.
For example:
If you request to get Siege information for a profile, you'll likely receive an error or an empty response if that profile does not own the Siege or has never played it before.
So, I highly recommend you to validate the responses after each call.
Siege Progress:
ubisoft.searchByUsername('uplay', 'Sub.Script')
.then((profiles) => {
profiles.siege.progress().then(data => {
console.log(data.first());
})
})Output:
{
"profile": {
"id": "4503086f-112e-41b6-bdbf-1c682596bab3",
"userId": "4503086f-112e-41b6-bdbf-1c682596bab3",
"name": "Sub.Script",
"platform": "uplay",
"platformId": "4503086f-112e-41b6-bdbf-1c682596bab3"
},
"progress": {
"alphapack": 4.6,
"xp": {
"level": 564,
"current": 58656,
"max": 273500,
"percentage": 21.45
}
}
}- Rainbow Six: Siege operator icons - Github
- Ubisoft account for creating new Ubisoft account(s).
If you have any questions regarding this package, feel free to be in touch with me!
Twitter: @Skr1p7