> ## Documentation Index
> Fetch the complete documentation index at: https://devdocs.xbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# PFLeaderboardsGetLeaderboardAroundEntityRequest

> PFLeaderboardsGetLeaderboardAroundEntityRequest data model. Request to load a section of a leaderboard centered on a specific entity.

PFLeaderboardsGetLeaderboardAroundEntityRequest data model. Request to load a section of a leaderboard centered on a specific entity.

## Syntax

```cpp theme={null}
typedef struct PFLeaderboardsGetLeaderboardAroundEntityRequest {  
    PFStringDictionaryEntry const* customTags;  
    uint32_t customTagsCount;  
    PFEntityKey const* entity;  
    const char* leaderboardName;  
    uint32_t maxSurroundingEntries;  
    uint32_t const* version;  
} PFLeaderboardsGetLeaderboardAroundEntityRequest;  
```

### Members

**`customTags`**   [PFStringDictionaryEntry](/services/playfab/api-references/c/pftypes/structs/pfstringdictionaryentry) const\*<br />*may be nullptr*

(Optional) The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

**`customTagsCount`**   uint32\_t

Count of customTags

**`entity`**   [PFEntityKey](/services/playfab/api-references/c/pftypes/structs/pfentitykey-c) const\*<br />*may be nullptr*

(Optional) The optional entity to perform this action on. Defaults to the currently logged in entity.

**`leaderboardName`**   const char\*<br />*is null-terminated*

Name of the leaderboard.

**`maxSurroundingEntries`**   uint32\_t

Number of surrounding entries to return (in addition to specified entity). In general, the number of ranks above and below will be split into half. For example, if the specified value is 10, 5 ranks above and 5 ranks below will be retrieved. However, the numbers will get skewed in either direction when the specified entity is towards the top or bottom of the leaderboard. Also, the number of entries returned can be lower than the value specified for entries at the bottom of the leaderboard.

**`version`**   uint32\_t const\*<br />*may be nullptr*

(Optional) Optional version of the leaderboard, defaults to current.

## Requirements

**Header:** PFLeaderboardsTypes.h

## See also

[PFLeaderboardsTypes members](/services/playfab/api-references/c/pfleaderboardstypes/pfleaderboardstypes_members)


## Related topics

- [PFLeaderboardsGetLeaderboardAroundEntityAsync](/services/playfab/api-references/c/pfleaderboards/functions/pfleaderboardsgetleaderboardaroundentityasync.md)
- [Services C API overview - PFLeaderboardsTypes.h](/services/playfab/api-references/c/pfleaderboardstypes/pfleaderboardstypes_members.md)
- [PFLeaderboardsGetLeaderboardAroundEntityGetResult](/services/playfab/api-references/c/pfleaderboards/functions/pfleaderboardsgetleaderboardaroundentitygetresult.md)
- [PFLeaderboardsGetLeaderboardAroundEntityGetResultSize](/services/playfab/api-references/c/pfleaderboards/functions/pfleaderboardsgetleaderboardaroundentitygetresultsize.md)
- [Doing with more leaderboards](/services/playfab/community/leaderboards/doing-more-with-leaderboards.md)