achievements-app/psn-api

View on GitHub
website/docs/api-docs/data-models/trophy-title.md

Summary

Maintainability
Test Coverage
# TrophyTitle

| Name                  | Type                                                  | Description                                                                                                                                                                                 |
| :-------------------- | :---------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `npServiceName`       | `"trophy"` \| `"trophy2"`                             | `"trophy"` for PS3, PS4, or PS Vita platforms. `"trophy2"` for the PS5 platform.                                                                                                            |
| `npCommunicationId`   | `string`                                              | The unique ID of the title. This is later required for requesting detailed trophy information for the title.                                                                                |
| `trophySetVersion`    | `string`                                              | The current version of the trophy set. Some trophy sets receive updates.                                                                                                                    |
| `trophyTitleName`     | `string`                                              | The game name.                                                                                                                                                                              |
| `trophyTitleIconUrl`  | `string`                                              | URL of the icon for the given title.                                                                                                                                                        |
| `trophyTitlePlatform` | `string`                                              | The platform this title belongs to. Some games have trophy sets which are shared between multiple platforms (ie. PS4,PSVITA). The platforms will be comma-separated.                        |
| `hasTrophyGroups`     | `boolean`                                             | `true` if the title has multiple groups of trophies beyond the `"default"` group.                                                                                                           |
| `definedTrophies`     | [`TrophyCounts`](/api-docs/data-models/trophy-counts) | Number of trophies for the title by type.                                                                                                                                                   |
| `progress`            | `number`                                              | Percentage of trophies earned for the title by the user (ex- `100`, `25`).                                                                                                                  |
| `earnedTrophies`      | [`TrophyCounts`](/api-docs/data-models/trophy-counts) | Number of trophies for the title which have been earned by grade.                                                                                                                           |
| `hiddenFlag`          | `boolean`                                             | `true` if the title has been hidden on the account's trophy list. This applies to the authenticating account only. The title will not be returned if it has been hidden on another account. |
| `lastUpdatedDateTime` | `string`                                              | An ISO 8601 string representing the date the most recent trophy was earned for the title (ex- `"2021-08-15T21:22:08Z"`).                                                                    |
| `trophyTitleDetail`   | `string`                                              | The title description. This is a legacy property that applies to PS3, PS4, and PS Vita titles only.                                                                                         |