> For the complete documentation index, see [llms.txt](https://dynamicpixels.gitbook.io/dynamicpixels-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://dynamicpixels.gitbook.io/dynamicpixels-docs/leaderboard.md).

# Leaderboard

Explore the list of API functions available in TypeScript for managing leaderboards and player scores, including detailed descriptions and usage examples.

{% hint style="warning" %}
To use service functions, first ensure that the service is activated before. You can see services by opening "Service Hub" From the game's dashboard header. 
{% endhint %}

### Get Available Leaderboards[​](https://docs.dynamicpixels.dev/leaderboards/plugin#get-available-leaderboards) <a href="#get-available-leaderboards" id="get-available-leaderboards"></a>

Retrieves a list of leaderboards based on the provided parameters.

```typescript
DynamicPixels.Services.Leaderboards.GetLeaderboards(): Promise<Leaderboard[]>
```

### Get Users Scores[​](https://docs.dynamicpixels.dev/leaderboards/plugin#get-users-scores) <a href="#get-users-scores" id="get-users-scores"></a>

Obtains scores for individual users as specified by the input parameters.

```typescript
DynamicPixels.Services.Leaderboards.GetUsersScores(input: GetScoresParams): Promise<UserScore[]>
```

### Get Parties Scores[​](https://docs.dynamicpixels.dev/leaderboards/plugin#get-parties-scores) <a href="#get-parties-scores" id="get-parties-scores"></a>

Fetches scores for different parties (e.g., teams or groups) according to the given parameters.

```typescript
DynamicPixels.Services.Leaderboards.GetPartiesScores(input: GetScoresParams): Promise<PartyScore[]>
```

### Get Friends Scores[​](https://docs.dynamicpixels.dev/leaderboards/plugin#get-friends-scores) <a href="#get-friends-scores" id="get-friends-scores"></a>

Gathers scores specifically for friends of the current user.

```typescript
DynamicPixels.Services.Leaderboards.GetFriendsScores(input: GetMyFriendsScoresParams): Promise<UserScore[]>
```

### Get My Score[​](https://docs.dynamicpixels.dev/leaderboards/plugin#get-my-score) <a href="#get-my-score" id="get-my-score"></a>

Retrieves the score of the current user based on the input parameters.

```typescript
DynamicPixels.Services.Leaderboards.GetMyScore(input: GetMyScoreParams): Promise<UserScore>
```

### Submit New Score[​](https://docs.dynamicpixels.dev/leaderboards/plugin#submit-new-score) <a href="#submit-new-score" id="submit-new-score"></a>

Submits a user's score and returns the result.

```typescript
DynamicPixels.Services.Leaderboards.SubmitScore(input: SubmitScoreParams): Promise<Score>
```