Get user by username
Gets a user by username
Field | Type | Required | options |
---|---|---|---|
username | string | yes | |
platform | string | yes | uplay, xbl, psn |
index.ts
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'
}
}