PSNAWP

https://psnawp.readthedocs.io/en/stable/
Admin
PSNAWP is a Python API wrapper for retrieving user information, trophies, game, and store data from...
Tokens:63,751
Snippets:434
Trust Score:9.6
Update:6 months ago
Show doc for...
Tokens:
Raw
### Install PSNAWP

Source: https://psnawp.readthedocs.io/en/stable/additional_resources/README.html

Use pip to install the library.

```bash
pip install PSNAWP
```

--------------------------------

### Example Device Information Structure

Source: https://psnawp.readthedocs.io/en/stable/generated/psnawp_api.models.client.html

This is an example structure of the dictionary returned by `get_account_devices()`, showing typical fields like deviceId, deviceType, and activationDate.

```json
[
  {
    "deviceId": "[Redacted]",
    "deviceType": "PS4",
    "activationType": "PSN_GAME_V3",
    "activationDate": "2021-02-05T20:11:27.815Z",
    "accountDeviceVector": "[Redacted]"
  }
]
```

--------------------------------

### Example Presence Information Structure

Source: https://psnawp.readthedocs.io/en/stable/generated/psnawp_api.models.client.html

This is an example structure of the dictionary returned by `get_presences()`, illustrating basic presence and primary platform information.

```json
{
  "basicPresences": [
    {
      "accountId": "5361973517281706660",
      "availability": "unavailable",
      "lastAvailableDate": "2025-04-06T18:36:00.377Z",
      "primaryPlatformInfo": {
        "onlineStatus": "offline",
        "platform": "PS5",
        "lastOnlineDate": "2025-04-06T18:36:00.377Z"
      }
    },
    {
      "accountId": "940512162723934331",
      "availability": "availableToPlay",
      "primaryPlatformInfo": {
        "onlineStatus": "online",
        "platform": "PS5"
      },
      "gameTitleInfoList": [
        {
          "npTitleId": "CUSA14296_00",
          "titleName": "Rust",
          "format": "PS4",
          "launchPlatform": "PS5",
          "gameStatus": "Surviving on the server: Chasm HM [Monthly]"
        }
      ]
    },
    {
      "accountId": "4273405838384737823",
      "availability": "unavailable",
      "lastAvailableDate": "2025-03-02T18:08:15.635Z",
      "primaryPlatformInfo": {
        "onlineStatus": "offline",
        "platform": "PS4",

```

--------------------------------

### GET /available-to-play

Source: https://psnawp.readthedocs.io/en/stable/_modules/psnawp_api/models/client.html

Retrieves the list of users on the 'Notify when available' subscription list.

```APIDOC
## GET /available-to-play

### Description
Gets the list of users on your 'Notify when available' subscription list.

### Method
GET

### Endpoint
/available-to-play
```

--------------------------------

### GET Request Method

Source: https://psnawp.readthedocs.io/en/stable/generated/psnawp_api.core.authenticator.html

Performs a GET request with automatic Bearer token authorization.

```APIDOC
## GET Request

### Description
Simplifies making GET requests by automatically adding the necessary Authorization header with a Bearer token.

### Parameters
#### Request Body
- **kwargs** (dict) - Optional - Additional arguments to be forwarded to the underlying request builder's get method.

### Response
- **Response** (object) - The response from the GET request.

### Errors
- **PSNAWPAuthenticationError**: Token missing.
- **PSNAWPBadRequestError**: 400 status code.
- **PSNAWPUnauthorizedError**: 401 status code.
- **PSNAWPForbiddenError**: 403 status code.
- **PSNAWPNotFoundError**: 404 status code.
- **PSNAWPNotAllowedError**: 405 status code.
- **PSNAWPTooManyRequestsError**: 429 status code.
- **PSNAWPClientError**: Other 4xx status codes.
- **PSNAWPServerError**: 500+ status codes.
```

--------------------------------

### Initialize and Use PSNAWP

Source: https://psnawp.readthedocs.io/en/stable/additional_resources/README.html

Comprehensive example demonstrating authentication, account information retrieval, friend lists, trophy data, and messaging interactions.

```python
from os import getenv

from dotenv import load_dotenv

from psnawp_api import PSNAWP
from psnawp_api.models.search import SearchDomain
from psnawp_api.models.trophies import PlatformType

load_dotenv()


psnawp = PSNAWP(getenv("NPSSO_CODE", "NPSSO_CODE"))

# Your Personal Account Info
client = psnawp.me()
print(f"Online ID: {client.online_id}")
print(f"Account ID: {client.account_id}")
print(f"Region: {client.get_region()}")
print(f"Profile: {client.get_profile_legacy()} \n")

# Your Registered Devices
devices = client.get_account_devices()
for device in devices:
    print(f"Device: {device} \n")

# Your Friends List
friends_list = client.friends_list()
for friend in friends_list:
    print(f"Friend: {friend} \n")

# Your Players Blocked List
blocked_list = client.blocked_list()
for blocked_user in blocked_list:
    print(f"Blocked User: {blocked_user} \n")

# Your Friends in "Notify when available" List
available_to_play = client.available_to_play()
for user in available_to_play:
    print(f"Available to Play: {user} \n")

# Your trophies (PS4)
for trophy in client.trophies("NPWR22810_00", PlatformType.PS4):
    print(trophy)

# Your Chat Groups
groups = client.get_groups()
first_group_id = None  # This will be used later to test group methods
for id, group in enumerate(groups):
    if id == 0:  # Get the first group ID
        first_group_id = group.group_id

    group_info = group.get_group_information()
    print(f"Group {id}: {group_info} \n")

# Your Playing time (PS4, PS5 above only)
titles_with_stats = client.title_stats()
for title in titles_with_stats:
    print(
        f" \
        Game: {title.name} - \
        Play Count: {title.play_count} - \
        Play Duration: {title.play_duration} \n"
    )


# Other User's
example_user_1 = psnawp.user(online_id="VaultTec-Co")  # Get a PSN player by their Online ID
print(f"User 1 Online ID: {example_user_1.online_id}")
print(f"User 1 Account ID: {example_user_1.account_id}")
print(f"User 1 Region: {example_user_1.get_region()}")

print(example_user_1.profile())
print(example_user_1.prev_online_id)
print(example_user_1.get_presence())
print(example_user_1.friendship())
print(example_user_1.is_blocked())

# Example of getting a user by their account ID
user_account_id = psnawp.user(account_id="9122947611907501295")
print(f"User Account ID: {user_account_id.online_id}")


# Messaging and Groups Interaction
group = psnawp.group(group_id=first_group_id)  # This is the first group ID we got earlier - i.e. the first group in your groups list
print(group.get_group_information())
print(group.get_conversation(10))  # Get the last 10 messages in the group
group.send_message("Hello World")
group.change_name("API Testing 3")
group.leave_group()
```

--------------------------------

### Retrieve game details structure

Source: https://psnawp.readthedocs.io/en/stable/generated/psnawp_api.models.game_title.html

Example of the JSON structure returned by the get_details method.

```json
[
  {
    "id": 201930,
    "name": "Grand Theft Auto V (PlayStation®5)",
    "nameEn": "Grand Theft Auto V (PlayStation®5)",
    "publisherName": "Rockstar Games",
    "media": {
    },
    "descriptions": [],
    "categorizedProducts": [],
    "titleIds": [],
    "country": "US",
    "language": "en",
    "type": "GAME",
    "localizedName": {},
    "localizedDescriptions": {},
    "localizedPublisherName": {},
    "defaultProduct": {},
    "genres": [],
    "localizedGenres": [],
    "subGenres": [],
    "localizedSubGenres": [],
    "minimumAge": 17,
    "releaseDate": {},
    "isRecommendableOnStore": true,
    "isSearchableOnStore": true,
    "storeFronts": [],
    "supportedStoreFronts": [],
    "marketingStories": [],
    "compatibilityNotices": [],
    "localizedMedia": {},
    "revisionIds": {},
    "contentRating": {}
  }
]
```

--------------------------------

### Initialize PSNAWP and get authenticated client

Source: https://psnawp.readthedocs.io/en/stable/generated/psnawp_api.psnawp.html

Instantiate the PSNAWP client using your NPSSO code and retrieve a client object for the authenticated user.

```python
from psnawp_api import PSNAWP

psnawp = PSNAWP("<64 character npsso code>")
client = psnawp.me()

```

--------------------------------

### User Presence Data Structure

Source: https://psnawp.readthedocs.io/en/stable/generated/psnawp_api.models.user.html

Example of the dictionary structure returned by the get_presence method.

```json
{
  "basicPresence": {
    "availability": "availableToPlay",
    "gameTitleInfoList": [
      {
        "format": "PS4",
        "gameStatus": "Surviving on the server: Chasm HM [Monthly]",
        "launchPlatform": "PS5",
        "npTitleIconUrl": "http://gs2-sec.ww.prod.dl.playstation.net/gs2-sec/appkgo/prod/CUSA14296_00/5/i_2a5430eced065f2c08f1beec578f3990d4dbcba726e70653ac98baf88d73a7f9/i/icon0.png",
        "npTitleId": "CUSA14296_00",
        "titleName": "Rust"
      }
    ],
    "primaryPlatformInfo": {
      "onlineStatus": "online",
      "platform": "PS5"
    }
  }
}
```

--------------------------------

### Legacy Profile Data Structure

Source: https://psnawp.readthedocs.io/en/stable/generated/psnawp_api.models.user.html

Example of the dictionary structure returned by the get_profile_legacy method.

```json
{
  "profile": {
    "onlineId": "VaultTec_Trading",
    "accountId": "8520698476712646544",
    "npId": "VmF1bHRUZWNfVHJhZGluZ0BiNi51cw==",
    "avatarUrls": [
      {
        "size": "l",
        "avatarUrl": "[Redacted]"
      }
    ],
    "plus": 0,
    "aboutMe": "r/Fallout76Marketplace Moderator",
    "languagesUsed": [
      "en"
    ],
    "trophySummary": {
      "level": 1,
      "progress": 0,
      "earnedTrophies": {
        "platinum": 0,
        "gold": 0,
        "silver": 0,
        "bronze": 0
      }
    },
    "isOfficiallyVerified": false,
    "personalDetail": {
      "firstName": "VaultTec",
      "lastName": "TradingCo",
      "profilePictureUrls": [
        {
          "size": "xl",
          "profilePictureUrl": "[Redacted]"
        }
      ]
    },
    "personalDetailSharing": "no"
```

--------------------------------

### Get Account Devices

Source: https://psnawp.readthedocs.io/en/stable/generated/psnawp_api.models.client.html

Retrieve a list of devices the client is currently logged into. The returned list contains dictionaries with device information.

```python
client = psnawp.me()
print(client.get_account_devices())
```

--------------------------------

### HTTP Method Wrappers

Source: https://psnawp.readthedocs.io/en/stable/_modules/psnawp_api/core/request_builder.html

Convenience methods for performing GET, PATCH, and POST requests.

```APIDOC
## GET/PATCH/POST [URL]

### Description
Convenience methods that wrap the core request handler for specific HTTP verbs.

### Parameters
#### Request Options
- **kwargs** (Unpack[RequestOptions]) - Optional - Options for the specific HTTP request.

### Response
- **Response** (requests.Response) - The Request Response Object.
```

--------------------------------

### Retrieve Game Title Details JSON Structure

Source: https://psnawp.readthedocs.io/en/stable/_modules/psnawp_api/models/game_title.html

Example of the JSON structure returned when fetching game title details.

```json
../examples/game_title/get_details.json
```

--------------------------------

### GET /game/details

Source: https://psnawp.readthedocs.io/en/stable/_modules/psnawp_api/models/game_title.html

Retrieves detailed information about a game title, including its name, description, genre, and associated media.

```APIDOC
## GET /game/details

### Description
Retrieves game details such as full name, description, genre, promotional videos, and images.

### Method
GET

### Parameters
#### Query Parameters
- **country** (str) - Optional - The country code for the request. If not provided, defaults from authenticator headers are used.
- **language** (str) - Optional - The language code for the request. If not provided, defaults from authenticator headers are used.

### Response
#### Success Response (200)
- **details** (list[dict[str, Any]]) - A list of dictionaries containing the game's metadata.
```

--------------------------------

### Get Game Details

Source: https://psnawp.readthedocs.io/en/stable/generated/psnawp_api.models.game_title.html

Retrieves detailed information about a game, such as its name, description, genre, and media.

```APIDOC
## GET /game_details

### Description
Get game details such as full name, description, genre, promotional videos/images, etc. If country or language is not provided, defaults will be used from the authenticator headers.

### Method
GET

### Endpoint
This is a method within the `GameTitle` class, not a direct HTTP endpoint.

### Parameters
- **country** (str, optional) - The country code used to retrieve localized content, in ISO 3166-1 alpha-2 format (e.g., “US”, “JP”).
- **language** (str, optional) - The language code used to retrieve localized content, using the IETF BCP 47 format (e.g., “en-US”, “fr-FR”).

### Response
#### Success Response (200)
- **list[dict[str, Any]]**: A list of dictionaries containing game details. Example structure:
```json
[
  {
    "id": 201930,
    "name": "Grand Theft Auto V (PlayStation®5)",
    "nameEn": "Grand Theft Auto V (PlayStation®5)",
    "publisherName": "Rockstar Games",
    "media": {},
    "descriptions": [],
    "categorizedProducts": [],
    "titleIds": [],
    "country": "US",
    "language": "en",
    "type": "GAME",
    "localizedName": {},
    "localizedDescriptions": {},
    "localizedPublisherName": {},
    "defaultProduct": {},
    "genres": [],
    "localizedGenres": [],
    "subGenres": [],
    "localizedSubGenres": [],
    "minimumAge": 17,
    "releaseDate": {},
    "isRecommendableOnStore": true,
    "isSearchableOnStore": true,
    "storeFronts": [],
    "supportedStoreFronts": [],
    "marketingStories": [],
    "compatibilityNotices": [],
    "localizedMedia": {},
    "revisionIds": {},
    "contentRating": {}
  }
]
```
```

--------------------------------

### Get User Profile (Legacy)

Source: https://psnawp.readthedocs.io/en/stable/generated/psnawp_api.models.user.html

Retrieves the legacy profile information for a specified user. Requires the user object to be initialized with an online ID.

```python
user_example = psnawp.user(online_id="VaultTec_Trading")
print(user_example.get_profile_legacy())
```

--------------------------------

### Get User Presences

Source: https://psnawp.readthedocs.io/en/stable/generated/psnawp_api.models.client.html

Retrieves the online presence status for the logged-in user. Requires the psnawp library to be initialized.

```python
client = psnawp.me()
print(client.get_presences())
```

--------------------------------

### Get User Presences

Source: https://psnawp.readthedocs.io/en/stable/generated/psnawp_api.models.client.html

Fetch the presence information for a list of specified account IDs. The result is a dictionary containing presence details for each account.

```python
client = psnawp.me()
print(client.get_presences(account_ids=['some_account_id']))
```

--------------------------------

### Get Users on 'Notify when available' List

Source: https://psnawp.readthedocs.io/en/stable/generated/psnawp_api.models.client.html

Fetch a generator of users subscribed to the 'Notify when available' list. Iterate through the generator to access each user object.

```python
client = psnawp.me()
available_to_play = client.available_to_play()

for user in available_to_play:
    ...
```

--------------------------------

### Get Shareable Profile Link

Source: https://psnawp.readthedocs.io/en/stable/generated/psnawp_api.models.client.html

Obtains a shareable link and QR code for the PlayStation profile.

```APIDOC
## GET /api/user/profile/share

### Description
Gets the shareable link and QR code for the PlayStation profile. This method fetches the URL that can be used to easily share the user’s PlayStation profile. Additionally, it provides a QR code image URL that corresponds to the shareable URL.

### Method
GET

### Endpoint
/api/user/profile/share

### Returns
- **shareUrl** (string) - The shareable URL for the PlayStation profile.
- **shareImageUrl** (string) - The URL for the QR code image of the shareable profile.
- **shareImageUrlDestination** (string) - The destination URL for the shareable image.

### Request Example
```python
client = psnawp.me()
print(client.get_shareable_profile_link())
```

### Response Example
```json
{
    "shareUrl": "https://profile.playstation.com/VaultTec-Co",
    "shareImageUrl": "https://d18lxmvkmz0olj.cloudfront.net/profile-VaultTec-Co?Expires=1738389804&Signature=rpk9Ycblv96cT~qYe0LZgOntA1S88k0rW4vRTUgJOFwk3RyqeBWxM7rXXkUIrwtmKsWSxrP~zSG34w0bHYpeQHZRyA6AQtyMcVMSLTBBYyyYZohSKIEMFlNo5aXnjyEM587uWXzn69eqF4QOIig546hqWweFuva89UfbdbZhJLiff50-lYtOiQE1jWEjjBsYA2q6zG-psaA-VnvB1v48c35avbaK5mDk0qDfKAVpPg79-ziOYwLg~pykcqUW02Fu8MRn65m67qxUqzn3hBzNyPb6NGLmmBiqE-39HYRAOYxeAKWcYf4NW3DA265DNHWAMWVI~dh96mhrAA5e8-mAQQ__&Key-Pair-Id=K2SHBT8E7OQNQU",
    "shareImageUrlDestination": "https://profile.playstation.com/share/VaultTec-Co"
}
```
```

--------------------------------

### GET Request with Bearer Token

Source: https://psnawp.readthedocs.io/en/stable/_modules/psnawp_api/core/authenticator.html

Makes a GET request with automatic Bearer token authorization. It forwards additional arguments to the underlying request builder's get method.

```APIDOC
## GET /api/resource

### Description
This endpoint makes a GET request with automatic Bearer token authorization. It simplifies making GET requests by automatically adding the necessary Authorization header with a Bearer token. Additional arguments or keyword arguments can be passed, which will be forwarded to the underlying request builder's ``get`` method.

### Method
GET

### Endpoint
/api/resource

### Parameters
#### Query Parameters
- **kwargs** (dict) - Optional - Additional arguments to be forwarded to the ``get`` method of the request builder.

### Request Example
```python
# Example usage (assuming 'client' is an instance of the Authenticator class)
response = client.get(params={'query': 'example'})
```

### Response
#### Success Response (200)
- **Response** (Response) - The response from the GET request.

#### Error Responses
- **PSNAWPAuthenticationError**: If the token response is None.
- **PSNAWPBadRequestError**: If the HTTP response status code is 400.
- **PSNAWPUnauthorizedError**: If the HTTP response status code is 401.
- **PSNAWPForbiddenError**: If the HTTP response status code is 403.
- **PSNAWPNotFoundError**: If the HTTP response status code is 404.
- **PSNAWPNotAllowedError**: If the HTTP response status code is 405.
- **PSNAWPTooManyRequestsError**: If the HTTP response status code is 429.
- **PSNAWPClientError**: If the HTTP response status code is in the 4xx range (excluding those listed above).
- **PSNAWPServerError**: If the HTTP response status code is 500 or above.
```

--------------------------------

### GET /gameEntitlements

Source: https://psnawp.readthedocs.io/en/stable/_modules/psnawp_api/models/game_entitlements.html

Fetches a paginated list of game entitlements for the authenticated user, with optional filtering by title IDs.

```APIDOC
## GET /gameEntitlements

### Description
Retrieves the authenticated user's game entitlements (owned games). Note that this is limited to PS4 and PS5 platforms.

### Method
GET

### Query Parameters
- **entitlementType** (string) - Required - Comma-separated list of entitlement types (e.g., "1,2,3,4,5").
- **fields** (string) - Required - Fields to include in the response (e.g., "titleMeta,gameMeta,conceptMeta,rewardMeta").
- **gameMetaPackageType** (string) - Required - Filter for package types (e.g., "PSGD,PS4GD").
- **titleId** (string) - Optional - Comma-separated string of title IDs to filter results.

### Response
#### Success Response (200)
- **entitlements** (array) - List of GameEntitlement objects.
- **totalResults** (int) - Total count of available entitlements.
```

--------------------------------

### Initialize Request Limiter and Session

Source: https://psnawp.readthedocs.io/en/stable/_modules/psnawp_api/core/request_builder.html

Sets up the SQLite-based rate limiter and the HTTP session with common headers.

```python
db_path = get_temp_db_path()

sqlite_bucket = SQLiteBucket.init_from_file([rate_limit], db_path=str(db_path))
self.limiter = Limiter(sqlite_bucket)

self.session = Session()
self.session.headers.update(self.common_headers)
```

--------------------------------

### Get Profile Legacy

Source: https://psnawp.readthedocs.io/en/stable/generated/psnawp_api.models.client.html

Fetches profile information from the legacy API endpoint, useful for older console presence data.

```APIDOC
## GET /api/user/profile/legacy

### Description
Gets the profile info from legacy api endpoint. Useful for legacy console (PS3, PS4) presence.

### Method
GET

### Endpoint
/api/user/profile/legacy

### Request Example
```python
client = psnawp.me()
print(client.get_profile_legacy())
```

### Response
#### Success Response (200)
- **profile** (dict) - A dictionary containing profile information.
  - **onlineId** (string) - The user's online ID.
  - **accountId** (string) - The user's account ID.
  - **npId** (string) - The user's NP ID.
  - **avatarUrls** (list) - A list of avatar image URLs.
  - **plus** (integer) - Indicates PlayStation Plus status (0 for no, 1 for yes).
  - **aboutMe** (string) - The user's 'about me' description.
  - **languagesUsed** (list) - A list of languages used by the user.
  - **trophySummary** (dict) - Summary of the user's trophy statistics.
  - **isOfficiallyVerified** (boolean) - Whether the profile is officially verified.
  - **personalDetail** (dict) - Personal details of the user.
  - **personalDetailSharing** (string) - Sharing status for personal details.
  - **personalDetailSharingRequestMessageFlag** (boolean) - Flag for personal detail sharing request messages.
  - **primaryOnlineStatus** (string) - The primary online status of the user.
  - **presences** (list) - A list of presence objects.
  - **friendRelation** (string) - The relationship status with the current user.
  - **requestMessageFlag** (boolean) - Flag for request messages.
  - **blocking** (boolean) - Whether the user is blocked.
  - **following** (boolean) - Whether the current user is following this user.
  - **consoleAvailability** (dict) - Information about console availability.

#### Response Example
```json
{
  "profile": {
    "onlineId": "VaultTec_Trading",
    "accountId": "8520698476712646544",
    "npId": "VmF1bHRUZWNfVHJhZGluZ0BiNi51cw==",
    "avatarUrls": [
      {
        "size": "l",
        "avatarUrl": "[Redacted]"
      }
    ],
    "plus": 0,
    "aboutMe": "r/Fallout76Marketplace Moderator",
    "languagesUsed": [
      "en"
    ],
    "trophySummary": {
      "level": 1,
      "progress": 0,
      "earnedTrophies": {
        "platinum": 0,
        "gold": 0,
        "silver": 0,
        "bronze": 0
      }
    },
    "isOfficiallyVerified": false,
    "personalDetail": {
      "firstName": "VaultTec",
      "lastName": "TradingCo",
      "profilePictureUrls": [
        {
          "size": "xl",
          "profilePictureUrl": "[Redacted]"
        }
      ]
    },
    "personalDetailSharing": "no",
    "personalDetailSharingRequestMessageFlag": false,
    "primaryOnlineStatus": "offline",
    "presences": [
      {
        "onlineStatus": "offline",
        "hasBroadcastData": false,
        "lastOnlineDate": "2021-02-05T20:14:45Z"
      }
    ],
    "friendRelation": "no",
    "requestMessageFlag": false,
    "blocking": false,
    "following": false,
    "consoleAvailability": {
      "availabilityStatus": "offline"
    }
  }
}
```
```

--------------------------------

### Perform Authenticated GET Request

Source: https://psnawp.readthedocs.io/en/stable/_modules/psnawp_api/core/authenticator.html

Executes a GET request with an automatically injected Bearer token in the Authorization header. Requires the @pre_request_processing decorator to ensure token validity.

```python
    @pre_request_processing
    def get(self, **kwargs: Unpack[RequestOptions]) -> Response:
        """Make a GET request with automatic Bearer token authorization.

        This method simplifies making GET requests by automatically adding the necessary Authorization header with a
        Bearer token. You can pass any additional arguments or keyword arguments, which will be forwarded to the
        underlying request builder's ``get`` method.

        :param kwargs: Additional arguments to be forwarded to the ``get`` method of the request builder.

        :returns: The response from the GET request.

        :raises PSNAWPAuthenticationError: If the :py:attr:`Authenticator.token_response` is ``None``, indicating that
            an attempt to make an HTTP request was made without an access token.
        :raises PSNAWPBadRequestError: If the HTTP response status code is 400.
        :raises PSNAWPUnauthorizedError: If the HTTP response status code is 401.
        :raises PSNAWPForbiddenError: If the HTTP response status code is 403.
        :raises PSNAWPNotFoundError: If the HTTP response status code is 404.
        :raises PSNAWPNotAllowedError: If the HTTP response status code is 405.
        :raises PSNAWPTooManyRequestsError: If the HTTP response status code is 429.
        :raises PSNAWPClientError: If the HTTP response status code is in the 4xx range (excluding those listed above).
        :raises PSNAWPServerError: If the HTTP response status code is 500 or above.

        .. note::

            The :py:func:`~psnawp_api.core.authenticator.pre_request_processing` decorator ensures that
            :py:attr:`Authenticator.token_response` is usually set correctly. The check for ``self.token_response is
            None`` is a safeguard in case of unexpected issues.

        """
        if self.token_response is None:
            raise PSNAWPAuthenticationError(
                "Attempt to make HTTP Request without access_token.",
            )

        if "headers" not in kwargs:
            kwargs["headers"] = {}
        kwargs["headers"]["Authorization"] = f"Bearer {self.token_response['access_token']}"

        return self.request_builder.get(**kwargs)
```

--------------------------------

### Create a new group with users

Source: https://psnawp.readthedocs.io/en/stable/additional_resources/README.html

Initializes a new group by providing a list of user objects to the group constructor.

```python
example_user_2 = psnawp.user(online_id="test")
new_group = psnawp.group(users_list=[example_user_1, example_user_2])
print(new_group.get_group_information())
```

--------------------------------

### GET Request Handling

Source: https://psnawp.readthedocs.io/en/stable/generated/psnawp_api.core.request_builder.html

Handles GET requests to the PSN API and returns the response object. Includes detailed error handling for various HTTP status codes.

```APIDOC
## GET Request

### Description

Handles the GET requests and returns the requests.Response object.

### Method

GET

### Parameters

#### Request Body

**kwargs** – The options for the GET request.

### Returns

The Request Response Object.

### Raises

* **PSNAWPBadRequestError** – If the HTTP response status code is 400.
* **PSNAWPUnauthorizedError** – If the HTTP response status code is 401.
* **PSNAWPForbiddenError** – If the HTTP response status code is 403.
* **PSNAWPNotFoundError** – If the HTTP response status code is 404.
* **PSNAWPNotAllowedError** – If the HTTP response status code is 405.
* **PSNAWPTooManyRequestsError** – If the HTTP response status code is 429.
* **PSNAWPClientError** – If the HTTP response status code is in the 4xx range (excluding those listed above).
* **PSNAWPServerError** – If the HTTP response status code is 500 or above.
```

--------------------------------

### Get Legacy Profile Information

Source: https://psnawp.readthedocs.io/en/stable/generated/psnawp_api.models.client.html

Fetches profile information using the legacy API endpoint, which is useful for older console presence data (PS3, PS4).

```python
client = psnawp.me()
print(client.get_profile_legacy())
```

--------------------------------

### Initialize Entitlements Class

Source: https://psnawp.readthedocs.io/en/stable/_modules/psnawp_api/models/game_entitlements.html

Constructs the class instance using the mobile base URL and entitlements API path.

```python
        url = f"{BASE_PATH['psn_np_mobile_base_url']}{API_PATH['entitlements']}"
        return cls(
            authenticator=authenticator,
            url=url,
            pagination_args=pagination_args,
            title_ids=title_ids,
        )
```

--------------------------------

### GET /my_groups

Source: https://psnawp.readthedocs.io/en/stable/_modules/psnawp_api/models/client.html

Retrieves a list of groups the user has participated in.

```APIDOC
## GET /my_groups

### Description
Gets all the groups the user has participated in.

### Method
GET

### Endpoint
/my_groups

### Parameters
#### Query Parameters
- **limit** (int) - Optional - The number of groups to receive (default: 200).
- **offset** (int) - Optional - The number of groups to skip (default: 0).

### Response
#### Success Response (200)
- **groups** (Generator) - A generator of Group objects.
```

--------------------------------

### PSNAWP.me()

Source: https://psnawp.readthedocs.io/en/stable/generated/psnawp_api.psnawp.html

Retrieve a Client instance for the authenticated user. This object represents the currently logged-in user and provides methods for user-centric operations.

```APIDOC
## GET /api/me

### Description
Retrieve a Client instance for the authenticated user. The returned Client object represents the currently logged-in user and provides methods to perform user-centric operations, including fetching trophies, managing friend requests, sending/receiving messages, and more.

### Method
GET

### Endpoint
/api/me

### Response
#### Success Response (200)
- **Client Object** (object) - A Client object bound to your account, ready to manage the authenticated user’s data and interactions.

### Request Example
```python
from psnawp_api import PSNAWP

psnawp = PSNAWP("<64 character npsso code>")
client = psnawp.me()
```
```

--------------------------------

### Get Region

Source: https://psnawp.readthedocs.io/en/stable/generated/psnawp_api.models.client.html

Retrieves the region of the client logged in the API.

```APIDOC
## GET /api/user/region

### Description
Gets the region of the client logged in the api.

### Method
GET

### Endpoint
/api/user/region

### Returns
- **Country** (object) - Country object from Pycountry for the logged-in user, or None if not found.

### Request Example
```python
client = psnawp.me()
print(client.get_region())
```

### Note
See pycountry/pycountry for more info on Country object.
```

--------------------------------

### GameTitle Class Initialization

Source: https://psnawp.readthedocs.io/en/stable/generated/psnawp_api.models.game_title.html

Information on how to initialize the GameTitle class, including constructor parameters and a class method for initialization using only the title_id.

```APIDOC
## GameTitle Class

### Description
The `GameTitle` class provides the information and methods for retrieving Game details and trophies. It is used for fetching game details and trophies for titles that the client does not own.

### Constructor
```python
GameTitle(_authenticator: Authenticator, _title_id: str, _platform: PlatformType, _np_communication_id: str)
```

**Parameters:**
- **authenticator** (Authenticator) - The Authenticator instance used for making authenticated requests to the API.
- **title_id** (str) - Unique identifier for the game.
- **platform** (PlatformType) - The platform this title belongs to.
- **np_communication_id** (str) - Unique ID of a game title used to request trophy information.

### Class Method: `from_title_id`
```python
@classmethod
from_title_id(_authenticator: Authenticator, _title_id: str, _platform: PlatformType, _account_id: str)
```

**Description:**
Initializes an instance of the `GameTitle` class from just the `title_id`. During construction, an additional call is made to get the `np_communication_id`, which is important for getting trophy data. You can avoid this additional HTTP request by using the `with_np_communication_id()` class method.

**Parameters:**
- **authenticator** (Authenticator) - The Authenticator instance used for making authenticated requests to the API.
- **title_id** (str) - Unique identifier for the game.
- **platform** (PlatformType) - The platform this title belongs to.

**Returns:**
Instance of `GameTitle`

**Raises:**
- **PSNAWPNotFoundError**: If the user does not have any trophies for that game or the game doesn’t exist.
```

--------------------------------

### Get Presences

Source: https://psnawp.readthedocs.io/en/stable/generated/psnawp_api.models.client.html

Retrieves the presence information for the logged-in user.

```APIDOC
## GET /api/user/presences

### Description
Retrieves the presence information for the logged-in user.

### Method
GET

### Endpoint
/api/user/presences

### Request Example
```python
client = psnawp.me()
print(client.get_presences())
```

### Response
#### Success Response (200)
- **presences** (list) - A list of presence objects.
  - **onlineStatus** (string) - The online status of the user.
  - **hasBroadcastData** (boolean) - Indicates if broadcast data is available.
  - **lastOnlineDate** (string) - The date and time of the last online activity.

#### Response Example
```json
{
  "presences": [
    {
      "onlineStatus": "offline",
      "hasBroadcastData": false,
      "lastOnlineDate": "2025-03-02T18:08:15.635Z"
    }
  ]
}
```
```

--------------------------------

### GET /trophy_summary

Source: https://psnawp.readthedocs.io/en/stable/_modules/psnawp_api/models/client.html

Retrieves an overall summary of trophies earned by the user.

```APIDOC
## GET /trophy_summary

### Description
Retrieve an overall summary of the number of trophies earned for a user, including type, overall level, progress, and current tier.

### Method
GET

### Endpoint
/trophy_summary

### Response
#### Success Response (200)
- **TrophySummary** (Object) - Object containing trophy summary information.
```

--------------------------------

### User Class Constructor

Source: https://psnawp.readthedocs.io/en/stable/generated/psnawp_api.models.user.html

Initializes a User object with authenticator, online ID, and account ID.

```APIDOC
## User Class Constructor

### Description
Initializes a User object with the provided Authenticator instance, online ID, and account ID.

### Parameters
* **authenticator** (Authenticator) - The Authenticator instance used for making authenticated requests to the API.
* **online_id** (str) - Online ID (GamerTag) of the user.
* **account_id** (str) - Account ID of the user.
```

--------------------------------

### PSNAWP.search()

Source: https://psnawp.readthedocs.io/en/stable/generated/psnawp_api.psnawp.html

Creates a new search object based on `search_domain` that can be used to search for games, game add-ons, and users.

```APIDOC
## GET /api/search

### Description
Creates a new search object based on `search_domain` that can be used to search for games, game add-ons, and users.

### Method
GET

### Endpoint
/api/search

### Parameters
#### Query Parameters
- **search_query** (str) - Required - The search query string, used to specify the terms or keywords to search for.
- **search_domain** (Literal[SearchDomain.USERS, SearchDomain.FULL_GAMES, SearchDomain.ADD_ONS]) - Required - Specifies the domain to search within, such as games, add-ons, or users.
- **limit** (int) - Optional - Total number of items to receive. `None` means no limit.
- **offset** (int) - Optional - Specifies the offset for the paginator. Defaults to 0.
- **page_size** (int) - Optional - The number of items to receive per API request. Defaults to 20.

### Response
#### Success Response (200)
- **Search Iterator object** (generator) - An iterator object to iterate over search results.

### Response Example
```python
# Example for searching users
users_iterator = psnawp.search(search_query="some_user", search_domain=SearchDomain.USERS)
for user_item in users_iterator:
    print(user_item)

# Example for searching games
games_iterator = psnawp.search(search_query="some_game", search_domain=SearchDomain.FULL_GAMES)
for game_item in games_iterator:
    print(game_item)
```
```

--------------------------------

### GET /share_profile

Source: https://psnawp.readthedocs.io/en/stable/_modules/psnawp_api/models/client.html

Retrieves a shareable link for the user's profile.

```APIDOC
## GET /share_profile

### Description
Retrieves a shareable profile link for the authenticated account.

### Method
GET

### Endpoint
/share_profile

### Response
#### Success Response (200)
- **response** (dict) - A dictionary containing the shareable profile link.
```

--------------------------------

### GET /blocked-list

Source: https://psnawp.readthedocs.io/en/stable/_modules/psnawp_api/models/client.html

Retrieves the list of blocked users for the authenticated account.

```APIDOC
## GET /blocked-list

### Description
Gets the blocked list and returns their account IDs.

### Method
GET

### Endpoint
/blocked-list
```

--------------------------------

### GET /friends

Source: https://psnawp.readthedocs.io/en/stable/_modules/psnawp_api/models/client.html

Retrieves the authenticated user's friends list.

```APIDOC
## GET /friends

### Description
Gets the friends list and returns an iterator of User objects.

### Method
GET

### Endpoint
/friends

### Parameters
#### Query Parameters
- **limit** (int) - Optional - The number of items to return (max 1000).
```

--------------------------------

### Retrieve Game Details

Source: https://psnawp.readthedocs.io/en/stable/_modules/psnawp_api/models/game_title.html

Fetches metadata such as name, description, and genre. Defaults to authenticator headers if country or language are omitted.

```python
def get_details(self, country: str | None = None, language: str | None = None) -> list[dict[str, Any]]:
    """Get game details such as full name, description, genre, promotional videos/images, etc...

    If `country` or `language` is not provided, defaults will be used from the authenticator headers.
```

--------------------------------

### Get User Presence

Source: https://psnawp.readthedocs.io/en/stable/generated/psnawp_api.models.user.html

Retrieve the current online presence status of a user.

```python
user_example = psnawp.user(online_id="VaultTec_Trading")
print(user_example.get_presence())
```

--------------------------------

### POST /group/create

Source: https://psnawp.readthedocs.io/en/stable/_modules/psnawp_api/models/group/group.html

Invites users to join a group.

```APIDOC
## POST /group/create

### Description
Invites users to join the group. Users who have blocked the requester are skipped.

### Method
POST

### Endpoint
/group/create

### Request Body
- **invitees** (array) - Required - List of objects containing accountId.
```

--------------------------------

### Get Friendship Status

Source: https://psnawp.readthedocs.io/en/stable/generated/psnawp_api.models.user.html

Retrieve the friendship status and statistics for a specific user.

```python
user_example = psnawp.user(online_id="VaultTec_Trading")
print(user_example.friendship())
```

--------------------------------

### Initialize GameTitle Class

Source: https://psnawp.readthedocs.io/en/stable/_modules/psnawp_api/models/game_title.html

The GameTitle class is typically instantiated via the PSNAWP client. It requires an Authenticator, title_id, platform, and np_communication_id.

```python
class GameTitle:
    """The GameTitle class provides the information and methods for retrieving Game details and trophies.

    Used for fetching game details and trophies for title that client doesn't own.

    :var Authenticator authenticator: An instance of :py:class:`~psnawp_api.core.authenticator.Authenticator` used to
        authenticate and make HTTPS requests.
    :var str title_id: Unique identifier for the game, used across PSN services except for trophy data, which requires
        the np_communication_id. However, the title_id is used to fetch the np_communication_id.
    :var PlatformType platform: The platform this title belongs to.
    :var str np_communication_id: Unique identifier associated with a game's trophy set, essential for accessing trophy
        data.

    .. note::

        This class is intended to be used via PSNAWP. See :py:meth:`psnawp_api.psnawp.PSNAWP.game_title`.

    """

    HMAC_SHA1_KEY: ClassVar[bytes] = bytes.fromhex(
        "F5DE66D2680E255B2DF79E74F890EBF349262F618BCAE2A9ACCDEE5156CE8DF2CDF2D48C71173CDC2594465B87405D197CF1AED3B7E9671EEB56CA6753C2E6B0"
    )

    def __init__(
        self,
        authenticator: Authenticator,
        title_id: str,
        platform: PlatformType,
        np_communication_id: str,
    ) -> None:
        """The GameTitle class constructor.

        :param authenticator: The Authenticator instance used for making authenticated requests to the API.
        :param title_id: unique id of game.
        :param platform: The platform this title belongs to.
        :param np_communication_id: Unique ID of a game title used to request trophy information.

        """
        self.authenticator = authenticator
        self.title_id = title_id
        self.platform = platform
        self.np_communication_id = np_communication_id
```

--------------------------------

### GET /title_stats

Source: https://psnawp.readthedocs.io/en/stable/_modules/psnawp_api/models/client.html

Retrieves an iterator for user title statistics for PS4 games and above.

```APIDOC
## GET /title_stats

### Description
Returns an iterator class for TitleStats, providing data for PS4 games and above.

### Parameters
#### Query Parameters
- **limit** (int) - Optional - Limit of titles returned.
- **offset** (int) - Optional - Specifies the offset for paginator.
- **page_size** (int) - Optional - The number of items to receive per api request.

### Request Example
```python
user_example = psnawp.client()
titles = list(user_example.title_stats())
```
```

--------------------------------

### GET trophy_titles_for_title

Source: https://psnawp.readthedocs.io/en/stable/generated/psnawp_api.models.client.html

Retrieves a summary of the trophies earned by a user for specific titles.

```APIDOC
## GET trophy_titles_for_title

### Description
Retrieve a summary of the trophies earned by a user for specific titles.

### Parameters
#### Request Body
- **title_ids** (list[str]) - Required - Unique ID of the title.

### Response
#### Success Response (200)
- **TrophyTitleIterator** (object) - Generator object with TrophyTitle objects.

### Errors
- **PSNAWPForbiddenError** - If the user’s profile is private.
```

--------------------------------

### GET /trophy_titles_for_title

Source: https://psnawp.readthedocs.io/en/stable/_modules/psnawp_api/models/client.html

Retrieves a summary of trophies earned by a user for specific titles.

```APIDOC
## GET /trophy_titles_for_title

### Description
Retrieve a summary of the trophies earned by a user for specific titles.

### Method
GET

### Endpoint
/trophy_titles_for_title

### Parameters
#### Request Body
- **title_ids** (list[str]) - Required - Unique IDs of the titles.

### Response
#### Success Response (200)
- **TrophyTitleIterator** (Generator) - Generator object with TrophyTitle objects.
```

--------------------------------

### Authenticator Class Initialization for PSNAWP

Source: https://psnawp.readthedocs.io/en/stable/_modules/psnawp_api/core/authenticator.html

Initializes the Authenticator with NPSSO cookie, common headers, and rate limiting. Manages authentication state and token responses.

```python
def __init__(
        self,
        npsso_cookie: str,
        common_headers: RequestBuilderHeaders,
        rate_limit: Rate,
    ) -> None:
        """Represents a single authentication to PSN API.

        :param npsso_cookie: The Network Platform Single Sign-On (NPSSO) cookie, obtained after signing into PlayStation
            Network.
        :param common_headers: Common headers that will be added to all HTTP request.
        :param rate_limit: Controls pacing of HTTP requests to avoid service throttling.

        """
        self.npsso_cookie = npsso_cookie
        self.common_headers = common_headers
        self.request_builder = RequestBuilder(common_headers, rate_limit)
        self.token_response: TokenResponse | None = None
        self.cid = str(uuid.UUID(int=uuid.getnode()))
```

--------------------------------

### GET trophy_summary

Source: https://psnawp.readthedocs.io/en/stable/generated/psnawp_api.models.client.html

Retrieves an overall summary of the number of trophies earned for a user.

```APIDOC
## GET trophy_summary

### Description
Retrieve an overall summary of the number of trophies earned for a user broken down by type, overall trophy level, progress towards the next level, and current tier.

### Response
#### Success Response (200)
- **TrophySummary** (object) - Object containing all trophy summary information.

### Request Example
```python
client = psnawp.me()
print(client.trophy_summary())
```
```

--------------------------------

### Create Group from Group ID

Source: https://psnawp.readthedocs.io/en/stable/generated/psnawp_api.models.group.group.html

Initializes a Group instance using a provided group ID and an Authenticator object. This is a canonical way to create a Group object.

```python
Group.create_from_group_id(authenticator, group_id)
```

--------------------------------

### GET /friend-requests

Source: https://psnawp.readthedocs.io/en/stable/_modules/psnawp_api/models/client.html

Retrieves the list of pending friend requests for the authenticated user.

```APIDOC
## GET /friend-requests

### Description
Get the friend request list and returns Generator of received requests.

### Method
GET

### Endpoint
/friend-requests
```

--------------------------------

### Authenticator Class Initialization

Source: https://psnawp.readthedocs.io/en/stable/_modules/psnawp_api/core/authenticator.html

Initializes the Authenticator with NPSSO cookie, common headers, and rate limiting configuration.

```APIDOC
## Authenticator Initialization

### Description
Initializes the Authenticator class, setting up the necessary components for PSN API authentication, including the NPSSO cookie, common request headers, and rate limiting.

### Method
`__init__`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```python
authenticator = Authenticator(npsso_cookie="YOUR_NPSSO_COOKIE", common_headers={"User-Agent": "PSNAWP"}, rate_limit=Rate(limit=10, interval=60))
```

### Response
None (initializes the object)

```
Tokens:
Raw