blocket-api 0.3.0__tar.gz → 0.3.1__tar.gz

{blocket_api-0.3.0 → blocket_api-0.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: blocket_api
-Version: 0.3.0
+Version: 0.3.1
 Summary: A python API wrapper for blocket.se
 Author-email: dunderrrrrr <emil.bjorkroth@gmail.com>
 Requires-Python: >=3.10
@@ -31,6 +31,7 @@ BlocketAPI allows users to query saved searches, known as "Bevakningar", on [blo
 - Get vehicle information, price evaluation and search for vehicles with multiple filters.
 - Search for homes with filters for city, home type and more.
 - Search for stores and get a specific store's listings.
+- ...and more!
 
 ## 🧑‍💻️ Install
 
@@ -69,6 +70,7 @@ Some calls require a `bearerToken`. However, some calls are public and don't req
 | [`api.store_search()`](#store_search)  | 👏 No | Yes | Search for a store.
 | [`api.get_store_listings()`](#get_store_listings)  | 👏 No | Yes | Get listings from a specific store.
 | [`api.get_ad_by_id()`](#get_ad_by_id)  | 👏 No | Yes | Get ad data from id.
+| [`api.get_user_by_id()`](#get_user_by_id)  | 👏 No | Yes | Get user data from id.
 
 
 ## 🤓 Detailed usage
@@ -302,6 +304,29 @@ Get ad data from a specific ad id.
 }
 ```
 
+### get_user_by_id
+Get user data from a user id. User id can be found in ads, searches and in blocket url `https://www.blocket.se/profil/<user_id>`.
+
+- `user_id` (`int`, required) - The blocket user id.
+- `as_objects` (`bool`, optional) - Return results as pydantic models, default is `False`.
+
+
+```py
+>>> api.get_user_by_id(1234)
+{
+   'account': {
+         'blocket_account_id': '1234', 
+         'created_at': '2020-10-10T15:45:06.407660', 
+         'is_verified': True, 
+         'name': 'Janne',
+         ...
+   }, 
+   'active_ads': {[
+      ...
+   ]}
+}
+```
+
 ## 🔐 Blocket API token
 
 There are two ways to acquire your token:

{blocket_api-0.3.0 → blocket_api-0.3.1}/README.md

@@ -14,6 +14,7 @@ BlocketAPI allows users to query saved searches, known as "Bevakningar", on [blo
 - Get vehicle information, price evaluation and search for vehicles with multiple filters.
 - Search for homes with filters for city, home type and more.
 - Search for stores and get a specific store's listings.
+- ...and more!
 
 ## 🧑‍💻️ Install
 
@@ -52,6 +53,7 @@ Some calls require a `bearerToken`. However, some calls are public and don't req
 | [`api.store_search()`](#store_search)  | 👏 No | Yes | Search for a store.
 | [`api.get_store_listings()`](#get_store_listings)  | 👏 No | Yes | Get listings from a specific store.
 | [`api.get_ad_by_id()`](#get_ad_by_id)  | 👏 No | Yes | Get ad data from id.
+| [`api.get_user_by_id()`](#get_user_by_id)  | 👏 No | Yes | Get user data from id.
 
 
 ## 🤓 Detailed usage
@@ -285,6 +287,29 @@ Get ad data from a specific ad id.
 }
 ```
 
+### get_user_by_id
+Get user data from a user id. User id can be found in ads, searches and in blocket url `https://www.blocket.se/profil/<user_id>`.
+
+- `user_id` (`int`, required) - The blocket user id.
+- `as_objects` (`bool`, optional) - Return results as pydantic models, default is `False`.
+
+
+```py
+>>> api.get_user_by_id(1234)
+{
+   'account': {
+         'blocket_account_id': '1234', 
+         'created_at': '2020-10-10T15:45:06.407660', 
+         'is_verified': True, 
+         'name': 'Janne',
+         ...
+   }, 
+   'active_ads': {[
+      ...
+   ]}
+}
+```
+
 ## 🔐 Blocket API token
 
 There are two ways to acquire your token:

{blocket_api-0.3.0 → blocket_api-0.3.1}/blocket_api/blocket.py

@@ -11,6 +11,7 @@ import httpx
 
 from blocket_api.models import (
     AdByIdResults,
+    BlocketUser,
     CustomSearchResults,
     HomeSearchResults,
     MotorSearchResults,
@@ -456,20 +457,12 @@ class BlocketAPI:
 
     @overload
     def search_store(
-        self,
-        search_query: str,
-        page: int = 0,
-        *,
-        as_objects: Literal[True],
+        self, search_query: str, page: int = 0, *, as_objects: Literal[True]
     ) -> StoreSearchResults: ...
 
     @overload
     def search_store(
-        self,
-        search_query: str,
-        page: int = 0,
-        *,
-        as_objects: Literal[False] = False,
+        self, search_query: str, page: int = 0, *, as_objects: Literal[False] = False
     ) -> dict: ...
 
     @overload
@@ -505,20 +498,12 @@ class BlocketAPI:
 
     @overload
     def get_store_listings(
-        self,
-        store_id: int,
-        page: int = 0,
-        *,
-        as_objects: Literal[True],
+        self, store_id: int, page: int = 0, *, as_objects: Literal[True]
     ) -> StoreListings: ...
 
     @overload
     def get_store_listings(
-        self,
-        store_id: int,
-        page: int = 0,
-        *,
-        as_objects: Literal[False] = False,
+        self, store_id: int, page: int = 0, *, as_objects: Literal[False] = False
     ) -> dict: ...
 
     @public_token
@@ -542,27 +527,44 @@ class BlocketAPI:
 
     @overload
     def get_ad_by_id(
-        self,
-        ad_id: int,
-        *,
-        as_objects: Literal[True],
+        self, ad_id: int, *, as_objects: Literal[True]
     ) -> AdByIdResults: ...
 
     @overload
     def get_ad_by_id(
-        self,
-        ad_id: int,
-        *,
-        as_objects: Literal[False] = False,
+        self, ad_id: int, *, as_objects: Literal[False] = False
     ) -> dict: ...
 
     @public_token
     def get_ad_by_id(
-        self,
-        ad_id: int,
-        *,
-        as_objects: bool = False,
+        self, ad_id: int, *, as_objects: bool = False
     ) -> dict | AdByIdResults:
+        """
+        Return an ad with it's content. The ad_id can be found by searching or
+        from the blocket ad url.
+        """
         url = f"{BASE_URL}/search_bff/v2/content/{ad_id}"
         response = _make_request(url=f"{url}", token=self.token).json()
         return AdByIdResults.model_validate(response) if as_objects else response
+
+    @overload
+    def get_user_by_id(
+        self, user_id: int, *, as_objects: Literal[True]
+    ) -> BlocketUser: ...
+
+    @overload
+    def get_user_by_id(
+        self, user_id: int, *, as_objects: Literal[False] = False
+    ) -> dict: ...
+
+    @public_token
+    def get_user_by_id(
+        self, user_id: int, *, as_objects: bool = False
+    ) -> dict | BlocketUser:
+        """
+        Returns a user's profile data. Contains account information, ads and more.
+        Blocket url is https://www.blocket.se/profil/<user_id>.
+        """
+        url = f"{BASE_URL}/profile-be/v1/public-profiles/{user_id}"
+        response = _make_request(url=f"{url}", token=self.token).json()
+        return BlocketUser.model_validate(response) if as_objects else response

{blocket_api-0.3.0 → blocket_api-0.3.1}/blocket_api/models.py

@@ -534,3 +534,59 @@ class AdByIdResults(BaseModel):
     data: AdByIdData
     inventory: AdByIdInventory
     placements: list[AdByIdPlacement] | None = None
+
+
+### GetUserById ###
+
+
+class BlocketUserAccount(BaseModel):
+    blocket_account_id: str
+    created_at: datetime.datetime
+    is_verified: bool
+    name: str
+    on_blocket_since: str
+    verified_with: str
+
+
+class BlocketUserAd(BaseModel):
+    ad_id: str
+    ad_url: str
+    image_url: str
+    price: str
+    region: str
+    subject: str
+
+
+class BlocketUserActiveAds(BaseModel):
+    ads: list[BlocketUserAd]
+    label_primary: str
+    label_secondary: str
+
+
+class BlocketUserBadge(BaseModel):
+    description: str
+    icon: str
+    icon_blocket_ui: str
+    id: str
+    label: str
+
+
+class BlocketUserCO2Savings(BaseModel):
+    date_range: str
+    equivalent: str
+    text: str
+
+
+class BlocketUserProfileInfo(BaseModel):
+    description: str | None = None
+    has_reviews: bool
+    name: str
+
+
+class BlocketUser(BaseModel):
+    account: BlocketUserAccount
+    active_ads: BlocketUserActiveAds
+    badges: list[BlocketUserBadge]
+    co2_savings: BlocketUserCO2Savings
+    profile_info: BlocketUserProfileInfo
+    review_scores: dict | None = None

{blocket_api-0.3.0 → blocket_api-0.3.1}/blocket_api.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: blocket_api
-Version: 0.3.0
+Version: 0.3.1
 Summary: A python API wrapper for blocket.se
 Author-email: dunderrrrrr <emil.bjorkroth@gmail.com>
 Requires-Python: >=3.10
@@ -31,6 +31,7 @@ BlocketAPI allows users to query saved searches, known as "Bevakningar", on [blo
 - Get vehicle information, price evaluation and search for vehicles with multiple filters.
 - Search for homes with filters for city, home type and more.
 - Search for stores and get a specific store's listings.
+- ...and more!
 
 ## 🧑‍💻️ Install
 
@@ -69,6 +70,7 @@ Some calls require a `bearerToken`. However, some calls are public and don't req
 | [`api.store_search()`](#store_search)  | 👏 No | Yes | Search for a store.
 | [`api.get_store_listings()`](#get_store_listings)  | 👏 No | Yes | Get listings from a specific store.
 | [`api.get_ad_by_id()`](#get_ad_by_id)  | 👏 No | Yes | Get ad data from id.
+| [`api.get_user_by_id()`](#get_user_by_id)  | 👏 No | Yes | Get user data from id.
 
 
 ## 🤓 Detailed usage
@@ -302,6 +304,29 @@ Get ad data from a specific ad id.
 }
 ```
 
+### get_user_by_id
+Get user data from a user id. User id can be found in ads, searches and in blocket url `https://www.blocket.se/profil/<user_id>`.
+
+- `user_id` (`int`, required) - The blocket user id.
+- `as_objects` (`bool`, optional) - Return results as pydantic models, default is `False`.
+
+
+```py
+>>> api.get_user_by_id(1234)
+{
+   'account': {
+         'blocket_account_id': '1234', 
+         'created_at': '2020-10-10T15:45:06.407660', 
+         'is_verified': True, 
+         'name': 'Janne',
+         ...
+   }, 
+   'active_ads': {[
+      ...
+   ]}
+}
+```
+
 ## 🔐 Blocket API token
 
 There are two ways to acquire your token:

{blocket_api-0.3.0 → blocket_api-0.3.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "blocket_api"
-version = "0.3.0"
+version = "0.3.1"
 description = "A python API wrapper for blocket.se"
 authors = [{name = "dunderrrrrr", email = "emil.bjorkroth@gmail.com"}]
 readme = "README.md"