Skip to content

Commit d921f58

Browse files
committed
Updated api and usage example
1 parent 0f7fd56 commit d921f58

2 files changed

Lines changed: 15 additions & 12 deletions

File tree

API.cs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ public static Validate ValidateUser(string username, Platform platform)
3434
}
3535

3636
/// <summary>
37-
/// Get user's profile stats
37+
/// Get user's profile stats for the specified mode
3838
/// </summary>
3939
/// <param name="username">Username of the user</param>
4040
/// <param name="platform">Platform the user is on</param>
@@ -63,7 +63,7 @@ public static object GetProfile(string username, Platform platform, Mode mode)
6363
}
6464

6565
/// <summary>
66-
/// Get user's profile stats
66+
/// Get user's profile stats for the specified mode
6767
/// </summary>
6868
/// <param name="username">Username of the user</param>
6969
/// <param name="userid">Id the user</param>
@@ -93,7 +93,7 @@ public static object GetProfile(string username, long userid, Platform platform,
9393
}
9494

9595
/// <summary>
96-
/// Get user's recent matches
96+
/// Get user's last 20 matches for the specified mode
9797
/// </summary>
9898
/// <param name="rows">Number of rows to fetch</param>
9999
/// <returns>Recent matches data</returns>
@@ -123,7 +123,7 @@ public static object GetUserMatches(string username, Platform platform, Mode mod
123123
}
124124

125125
/// <summary>
126-
/// Get recent matches being played
126+
/// Get up to the last 100 recent matches played
127127
/// </summary>
128128
/// <param name="rows">Number of rows to fetch</param>
129129
/// <returns>Recent matches data</returns>

README.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -56,8 +56,7 @@ var users = await Task.Run(() => API.GetUserById(327154, 396158));
5656

5757
foreach (var user in users)
5858
{
59-
Console.WriteLine(user.uid);
60-
Console.WriteLine(user.uid);
59+
Console.WriteLine("User Id: " + user.uid);
6160
}
6261
//...
6362
```
@@ -75,9 +74,9 @@ __Tip:__ You can provide the *userId* for a much faster response, which can be f
7574
```csharp
7675
var profile = await Task.Run(() => API.GetProfile("YOUTUBE__Kor3aYn", 323487, Platform.PS4, Mode.Multiplayer));
7776

78-
Console.WriteLine(profile.user.username);
79-
Console.WriteLine(profile.user.stats.prestige);
80-
Console.WriteLine(profile.user.stats.level);
77+
Console.WriteLine("Username: " + profile.user.username);
78+
Console.WriteLine("Prestige: " + profile.user.stats.prestige);
79+
Console.WriteLine("Level: " + profile.user.stats.level);
8180
//...
8281
8382
#### Data Example
@@ -204,9 +203,13 @@ Console.WriteLine(profile.user.stats.level);
204203
```csharp
205204
var matches = await Task.Run(() => API.GetUserMatches("YOUTUBE__Kor3aYn", Platform.PS4, Mode.Multiplayer));
206205

207-
Console.WriteLine(profile.user.username);
208-
Console.WriteLine(profile.user.stats.prestige);
209-
Console.WriteLine(profile.user.stats.level);
206+
foreach (var match in matches.entries)
207+
{
208+
Console.WriteLine("Map Name: " + match.mapName);
209+
210+
Console.WriteLine("Kills: " + match.stats.kills);
211+
Console.WriteLine("Deaths: " + match.stats.deaths);
212+
}
210213
//...
211214
```
212215

0 commit comments

Comments
 (0)