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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: blocket_api
-Version: 0.3.0
+Version: 0.3.3
 Summary: A python API wrapper for blocket.se
 Author-email: dunderrrrrr <emil.bjorkroth@gmail.com>
 Requires-Python: >=3.10
@@ -12,7 +12,7 @@ Requires-Dist: pytest>=8.2.2
 Requires-Dist: respx>=0.21.1
 Requires-Dist: mypy>=1.15.0
 Requires-Dist: pydantic>=2.11.7
-Requires-Dist: ruff>=0.13.1
+Requires-Dist: ruff>=0.13.2
 Dynamic: license-file
 
 # BlocketAPI
@@ -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
 
@@ -60,7 +61,7 @@ Some calls require a `bearerToken`. However, some calls are public and don't req
 
 | Function  | Token required | `as_objects` | Description  |
 |---|---|---|---|
-| [`api.saved_searches()`](#saved_searches) | 🔐 Yes | - | List your saved searches (bevakningar)  |
+| [`api.saved_searches()`](#saved_searches) | 🔐 Yes | Yes | List your saved searches (bevakningar)  |
 | [`api.get_listings()`](#get_listings) | 🔐 Yes | - | List items related to a saved search |
 | [`api.custom_search()`](#custom_search)  | 👏 No | Yes | Search for everything on Blocket and filter by region |
 | [`api.motor_search()`](#motor_search)  | 👏 No | Yes | Advanced search for car-listings. |
@@ -69,6 +70,9 @@ 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.
+| [`api.save_ad()`](#save_ad)  | 🔐 Yes | - | Save ad to "Saved ads".
+| [`api.get_saved_ads()`](#get_saved_ads)  | 🔐 Yes | - | Save ad to "Saved ads".
 
 
 ## 🤓 Detailed usage
@@ -77,6 +81,9 @@ Some calls require a `bearerToken`. However, some calls are public and don't req
 
 Saved searches are your so called "Bevakningar" and can be found [here](https://www.blocket.se/sparade/bevakningar). Each saved search has and unique `id` which can be used as a parameter to `get_listings()`, see below.
 
+Parameters:  
+- `as_objects` (`bool`, optional) - Return results as pydantic models, default is `False`.
+
 ```py
 >>> api.saved_searches()
 [
@@ -302,6 +309,56 @@ 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': {[
+      ...
+   ]}
+}
+```
+
+### save_ad
+This saves the ad to "Saved ads" which can be found here at `https://www.blocket.se/sparade/annonser`. When saving an ad, blocket always responds with 204, even if the ad is already saved or does not exist.
+
+- `ad_id` (`int`, required) - The ad id. Can be found by calling any other method or from ad url.
+
+```py
+>>> api.save_ad(1234)
+```
+
+### get_saved_ads
+Returns all of your saved ads from `https://www.blocket.se/sparade/annonser`.
+
+```py
+>>> api.get_saved_ads()
+{
+   'data': [{
+      'ad_id': '1213682185'
+      'list_id': '1213682185'
+      'subject': 'Jeans från Gina tricot 158'
+      'body': 'Moderna jeans från Gina Tricot!'
+      ...
+   }]
+   ...
+}
+
+```
+
 ## 🔐 Blocket API token
 
 There are two ways to acquire your token:

{blocket_api-0.3.0 → blocket_api-0.3.3}/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
 
@@ -43,7 +44,7 @@ Some calls require a `bearerToken`. However, some calls are public and don't req
 
 | Function  | Token required | `as_objects` | Description  |
 |---|---|---|---|
-| [`api.saved_searches()`](#saved_searches) | 🔐 Yes | - | List your saved searches (bevakningar)  |
+| [`api.saved_searches()`](#saved_searches) | 🔐 Yes | Yes | List your saved searches (bevakningar)  |
 | [`api.get_listings()`](#get_listings) | 🔐 Yes | - | List items related to a saved search |
 | [`api.custom_search()`](#custom_search)  | 👏 No | Yes | Search for everything on Blocket and filter by region |
 | [`api.motor_search()`](#motor_search)  | 👏 No | Yes | Advanced search for car-listings. |
@@ -52,6 +53,9 @@ 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.
+| [`api.save_ad()`](#save_ad)  | 🔐 Yes | - | Save ad to "Saved ads".
+| [`api.get_saved_ads()`](#get_saved_ads)  | 🔐 Yes | - | Save ad to "Saved ads".
 
 
 ## 🤓 Detailed usage
@@ -60,6 +64,9 @@ Some calls require a `bearerToken`. However, some calls are public and don't req
 
 Saved searches are your so called "Bevakningar" and can be found [here](https://www.blocket.se/sparade/bevakningar). Each saved search has and unique `id` which can be used as a parameter to `get_listings()`, see below.
 
+Parameters:  
+- `as_objects` (`bool`, optional) - Return results as pydantic models, default is `False`.
+
 ```py
 >>> api.saved_searches()
 [
@@ -285,6 +292,56 @@ 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': {[
+      ...
+   ]}
+}
+```
+
+### save_ad
+This saves the ad to "Saved ads" which can be found here at `https://www.blocket.se/sparade/annonser`. When saving an ad, blocket always responds with 204, even if the ad is already saved or does not exist.
+
+- `ad_id` (`int`, required) - The ad id. Can be found by calling any other method or from ad url.
+
+```py
+>>> api.save_ad(1234)
+```
+
+### get_saved_ads
+Returns all of your saved ads from `https://www.blocket.se/sparade/annonser`.
+
+```py
+>>> api.get_saved_ads()
+{
+   'data': [{
+      'ad_id': '1213682185'
+      'list_id': '1213682185'
+      'subject': 'Jeans från Gina tricot 158'
+      'body': 'Moderna jeans från Gina Tricot!'
+      ...
+   }]
+   ...
+}
+
+```
+
 ## 🔐 Blocket API token
 
 There are two ways to acquire your token:

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

@@ -11,9 +11,11 @@ import httpx
 
 from blocket_api.models import (
     AdByIdResults,
+    BlocketUser,
     CustomSearchResults,
     HomeSearchResults,
     MotorSearchResults,
+    SavedSearchResponse,
     StoreListings,
     StoreSearchResults,
 )
@@ -164,7 +166,11 @@ def public_token(method: Callable) -> Callable:
 
 
 def _make_request(
-    *, url: str, token: str | None, raise_for_status: bool = True
+    *,
+    method: Callable[..., Response] = httpx.get,
+    url: str,
+    token: str | None,
+    raise_for_status: bool = True,
 ) -> Response:
     headers = {
         "User-Agent": "Mozilla/5.0 (X11; Linux x86_64; rv:128.0) Gecko/20100101 Firefox/128.0"
@@ -172,11 +178,11 @@ def _make_request(
     if token:
         headers["Authorization"] = f"Bearer {token}"
     try:
-        response = httpx.get(url, headers=headers)
+        response = method(url, headers=headers)
         if raise_for_status:
             response.raise_for_status()
-    except Exception as E:
-        raise APIError(E)
+    except Exception as e:
+        raise APIError(e)
     return response
 
 
@@ -184,8 +190,28 @@ def _make_request(
 class BlocketAPI:
     token: str | None = None
 
+    @overload
+    def saved_searches(
+        self,
+        limit: int = 99,
+        *,
+        as_objects: Literal[True],
+    ) -> SavedSearchResponse: ...
+
+    @overload
+    def saved_searches(
+        self,
+        limit: int = 99,
+        *,
+        as_objects: Literal[False] = False,
+    ) -> list[dict]: ...
+
     @auth_token
-    def saved_searches(self) -> list[dict]:
+    def saved_searches(
+        self,
+        *,
+        as_objects: bool = False,
+    ) -> list[dict] | SavedSearchResponse:
         """
         Retrieves saved searches data, also known as "Bevakningar".
         """
@@ -204,7 +230,8 @@ class BlocketAPI:
             .get("data", [])
         )
 
-        return searches + mobility_searches
+        result = searches + mobility_searches
+        return SavedSearchResponse(searches=result) if as_objects else result
 
     def _for_search_id(self, search_id: int, limit: int) -> dict:
         assert self.token
@@ -456,20 +483,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 +524,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 +553,63 @@ 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
+
+    @auth_token
+    def save_ad(self, ad_id: int) -> dict:
+        """
+        Save an ad to "Saved ads" which can be found here:
+        https://www.blocket.se/sparade/annonser
+        """
+        url = f"{BASE_URL}/search_bff/v1/saved_content/{ad_id}"
+        response = _make_request(method=httpx.put, url=f"{url}", token=self.token)
+        return {"status_code": response.status_code}
+
+    @auth_token
+    def get_saved_ads(self, limit: int = 100) -> dict:
+        """
+        Returns all of your saved ads from https://www.blocket.se/sparade/annonser.
+        """
+        url = f"{BASE_URL}/search_bff/v1/saved_content?lim={limit}"
+        response = _make_request(url=f"{url}", token=self.token).json()
+        return response

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

@@ -534,3 +534,77 @@ 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
+
+
+### SavedSearchesResult ###
+
+
+class SavedSearch(BaseModel):
+    id: str
+    name: str
+    query: str
+    total_count: int
+    new_count: int
+    push_enabled: bool
+    push_available: bool
+    email_enabled: bool | None = None
+
+
+class SavedSearchResponse(BaseModel):
+    searches: list[SavedSearch]

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: blocket_api
-Version: 0.3.0
+Version: 0.3.3
 Summary: A python API wrapper for blocket.se
 Author-email: dunderrrrrr <emil.bjorkroth@gmail.com>
 Requires-Python: >=3.10
@@ -12,7 +12,7 @@ Requires-Dist: pytest>=8.2.2
 Requires-Dist: respx>=0.21.1
 Requires-Dist: mypy>=1.15.0
 Requires-Dist: pydantic>=2.11.7
-Requires-Dist: ruff>=0.13.1
+Requires-Dist: ruff>=0.13.2
 Dynamic: license-file
 
 # BlocketAPI
@@ -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
 
@@ -60,7 +61,7 @@ Some calls require a `bearerToken`. However, some calls are public and don't req
 
 | Function  | Token required | `as_objects` | Description  |
 |---|---|---|---|
-| [`api.saved_searches()`](#saved_searches) | 🔐 Yes | - | List your saved searches (bevakningar)  |
+| [`api.saved_searches()`](#saved_searches) | 🔐 Yes | Yes | List your saved searches (bevakningar)  |
 | [`api.get_listings()`](#get_listings) | 🔐 Yes | - | List items related to a saved search |
 | [`api.custom_search()`](#custom_search)  | 👏 No | Yes | Search for everything on Blocket and filter by region |
 | [`api.motor_search()`](#motor_search)  | 👏 No | Yes | Advanced search for car-listings. |
@@ -69,6 +70,9 @@ 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.
+| [`api.save_ad()`](#save_ad)  | 🔐 Yes | - | Save ad to "Saved ads".
+| [`api.get_saved_ads()`](#get_saved_ads)  | 🔐 Yes | - | Save ad to "Saved ads".
 
 
 ## 🤓 Detailed usage
@@ -77,6 +81,9 @@ Some calls require a `bearerToken`. However, some calls are public and don't req
 
 Saved searches are your so called "Bevakningar" and can be found [here](https://www.blocket.se/sparade/bevakningar). Each saved search has and unique `id` which can be used as a parameter to `get_listings()`, see below.
 
+Parameters:  
+- `as_objects` (`bool`, optional) - Return results as pydantic models, default is `False`.
+
 ```py
 >>> api.saved_searches()
 [
@@ -302,6 +309,56 @@ 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': {[
+      ...
+   ]}
+}
+```
+
+### save_ad
+This saves the ad to "Saved ads" which can be found here at `https://www.blocket.se/sparade/annonser`. When saving an ad, blocket always responds with 204, even if the ad is already saved or does not exist.
+
+- `ad_id` (`int`, required) - The ad id. Can be found by calling any other method or from ad url.
+
+```py
+>>> api.save_ad(1234)
+```
+
+### get_saved_ads
+Returns all of your saved ads from `https://www.blocket.se/sparade/annonser`.
+
+```py
+>>> api.get_saved_ads()
+{
+   'data': [{
+      'ad_id': '1213682185'
+      'list_id': '1213682185'
+      'subject': 'Jeans från Gina tricot 158'
+      'body': 'Moderna jeans från Gina Tricot!'
+      ...
+   }]
+   ...
+}
+
+```
+
 ## 🔐 Blocket API token
 
 There are two ways to acquire your token:

{blocket_api-0.3.0 → blocket_api-0.3.3}/blocket_api.egg-info/requires.txt

@@ -4,4 +4,4 @@ pytest>=8.2.2
 respx>=0.21.1
 mypy>=1.15.0
 pydantic>=2.11.7
-ruff>=0.13.1
+ruff>=0.13.2

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

@@ -1,6 +1,6 @@
 [project]
 name = "blocket_api"
-version = "0.3.0"
+version = "0.3.3"
 description = "A python API wrapper for blocket.se"
 authors = [{name = "dunderrrrrr", email = "emil.bjorkroth@gmail.com"}]
 readme = "README.md"
@@ -12,7 +12,7 @@ dependencies = [
     "respx>=0.21.1",
     "mypy>=1.15.0",
     "pydantic>=2.11.7",
-    "ruff>=0.13.1",
+    "ruff>=0.13.2",
 ]