Skip to content

Add support for global rank parsing in /users/ batch lookups #36249

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bdach merged 1 commit into from
Jan 9, 2026
Merged

Add support for global rank parsing in /users/ batch lookups #36249

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions osu.Game/Online/API/Requests/LookupUsersRequest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,21 +10,26 @@ namespace osu.Game.Online.API.Requests
/// Looks up users with the given <see cref="UserIds"/>.
/// In comparison to <see cref="GetUsersRequest"/>, the response here does not contain <see cref="APIUser.RulesetsStatistics"/>,
/// but in exchange is subject to less stringent rate limiting, making it suitable for mass user listings.
///
/// Providing a ruleset ID will give `global_rank`s in the response.
/// </summary>
public class LookupUsersRequest : APIRequest<GetUsersResponse>
{
public readonly int[] UserIds;

public readonly int? RulesetId;

private const int max_ids_per_request = 50;

public LookupUsersRequest(int[] userIds)
public LookupUsersRequest(int[] userIds, int? rulesetId = null)
{
if (userIds.Length > max_ids_per_request)
throw new ArgumentException($"{nameof(LookupUsersRequest)} calls only support up to {max_ids_per_request} IDs at once");

UserIds = userIds;
RulesetId = rulesetId;
}

protected override string Target => @"users/lookup/?ids[]=" + string.Join(@"&ids[]=", UserIds);
protected override string Target => @"users/lookup/?ids[]=" + string.Join(@"&ids[]=", UserIds) + (RulesetId != null ? "&ruleset_id=" + RulesetId : "");
}
}
14 changes: 14 additions & 0 deletions osu.Game/Online/API/Requests/Responses/APIUser.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -247,6 +247,20 @@ public UserStatistics Statistics
}
}

// Only provided via /users/ batch lookups. Usually implicitly comes inside `UserStatistics`.
[JsonProperty(@"global_rank")]
[CanBeNull]
public GlobalRank Rank { get; set; }

public class GlobalRank
{
[JsonProperty(@"rank")]
public int? Rank;

[JsonProperty(@"ruleset_id")]
public int RulesetId;
}

[JsonProperty(@"rank_history")]
private APIRankHistory rankHistory
{
Expand Down