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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: blocket_api
-Version: 0.3.1
+Version: 0.3.4
 Summary: A python API wrapper for blocket.se
 Author-email: dunderrrrrr <emil.bjorkroth@gmail.com>
 Requires-Python: >=3.10
@@ -12,12 +12,19 @@ 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: mkdocs>=1.6.1
+Requires-Dist: mkdocs-material>=9.6.21
+Requires-Dist: mkdocs-swagger-ui-tag>=0.7.2
+Requires-Dist: ruff>=0.14.1
 Dynamic: license-file
 
+<p align="center">
+  <img src="https://blocket-api.se/blocket-api.png" />
+</p>
+
 # BlocketAPI
 
-[![PyPI version](https://img.shields.io/pypi/v/blocket_api?style=for-the-badge)](https://pypi.org/project/blocket_api/) [![License](https://img.shields.io/badge/license-WTFPL-green?style=for-the-badge)](https://github.com/dunderrrrrr/blocket_api/blob/main/LICENSE) ![Python](https://img.shields.io/badge/Python-3.10-blue?style=for-the-badge) ![PyPI - Downloads](https://img.shields.io/pypi/dm/blocket_api?style=for-the-badge&color=%23dbce58) 
+[![PyPI version](https://img.shields.io/pypi/v/blocket_api?style=for-the-badge)](https://pypi.org/project/blocket_api/) [![License](https://img.shields.io/badge/license-WTFPL-green?style=for-the-badge)](https://github.com/dunderrrrrr/blocket_api/blob/main/LICENSE) ![Python](https://img.shields.io/badge/Python-3.10-blue?style=for-the-badge) ![PyPI - Downloads](https://img.shields.io/pypi/dw/blocket_api?style=for-the-badge&color=%23dbce58) 
 
 BlocketAPI allows users to query saved searches, known as "Bevakningar", on [blocket.se](https://blocket.se/). This means you can either retrieve results from a specific saved search or list all listings/ads across all saved searches. The results from these queries are returned in a `json` format or as cleaned pydantic objects.
 
@@ -61,7 +68,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. |
@@ -71,6 +78,8 @@ Some calls require a `bearerToken`. However, some calls are public and don't req
 | [`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 | - | List all saved ads. 
 
 
 ## 🤓 Detailed usage
@@ -79,6 +88,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()
 [
@@ -327,6 +339,33 @@ Get user data from a user id. User id can be found in ads, searches and in block
 }
 ```
 
+### 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.1/PKG-INFO → blocket_api-0.3.4/README.md

@@ -1,23 +1,10 @@
-Metadata-Version: 2.4
-Name: blocket_api
-Version: 0.3.1
-Summary: A python API wrapper for blocket.se
-Author-email: dunderrrrrr <emil.bjorkroth@gmail.com>
-Requires-Python: >=3.10
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: httpx>=0.27.0
-Requires-Dist: pre-commit>=3.7.1
-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
-Dynamic: license-file
+<p align="center">
+  <img src="https://blocket-api.se/blocket-api.png" />
+</p>
 
 # BlocketAPI
 
-[![PyPI version](https://img.shields.io/pypi/v/blocket_api?style=for-the-badge)](https://pypi.org/project/blocket_api/) [![License](https://img.shields.io/badge/license-WTFPL-green?style=for-the-badge)](https://github.com/dunderrrrrr/blocket_api/blob/main/LICENSE) ![Python](https://img.shields.io/badge/Python-3.10-blue?style=for-the-badge) ![PyPI - Downloads](https://img.shields.io/pypi/dm/blocket_api?style=for-the-badge&color=%23dbce58) 
+[![PyPI version](https://img.shields.io/pypi/v/blocket_api?style=for-the-badge)](https://pypi.org/project/blocket_api/) [![License](https://img.shields.io/badge/license-WTFPL-green?style=for-the-badge)](https://github.com/dunderrrrrr/blocket_api/blob/main/LICENSE) ![Python](https://img.shields.io/badge/Python-3.10-blue?style=for-the-badge) ![PyPI - Downloads](https://img.shields.io/pypi/dw/blocket_api?style=for-the-badge&color=%23dbce58) 
 
 BlocketAPI allows users to query saved searches, known as "Bevakningar", on [blocket.se](https://blocket.se/). This means you can either retrieve results from a specific saved search or list all listings/ads across all saved searches. The results from these queries are returned in a `json` format or as cleaned pydantic objects.
 
@@ -61,7 +48,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. |
@@ -71,6 +58,8 @@ Some calls require a `bearerToken`. However, some calls are public and don't req
 | [`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 | - | List all saved ads. 
 
 
 ## 🤓 Detailed usage
@@ -79,6 +68,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()
 [
@@ -327,6 +319,33 @@ Get user data from a user id. User id can be found in ads, searches and in block
 }
 ```
 
+### 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.1 → blocket_api-0.3.4}/blocket_api/blocket.py

@@ -15,6 +15,7 @@ from blocket_api.models import (
     CustomSearchResults,
     HomeSearchResults,
     MotorSearchResults,
+    SavedSearchResponse,
     StoreListings,
     StoreSearchResults,
 )
@@ -165,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"
@@ -173,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
 
 
@@ -185,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".
         """
@@ -205,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
@@ -568,3 +594,22 @@ class BlocketAPI:
         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.1 → blocket_api-0.3.4}/blocket_api/models.py

@@ -590,3 +590,21 @@ class BlocketUser(BaseModel):
     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.1/README.md → blocket_api-0.3.4/blocket_api.egg-info/PKG-INFO

@@ -1,6 +1,30 @@
+Metadata-Version: 2.4
+Name: blocket_api
+Version: 0.3.4
+Summary: A python API wrapper for blocket.se
+Author-email: dunderrrrrr <emil.bjorkroth@gmail.com>
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: httpx>=0.27.0
+Requires-Dist: pre-commit>=3.7.1
+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: mkdocs>=1.6.1
+Requires-Dist: mkdocs-material>=9.6.21
+Requires-Dist: mkdocs-swagger-ui-tag>=0.7.2
+Requires-Dist: ruff>=0.14.1
+Dynamic: license-file
+
+<p align="center">
+  <img src="https://blocket-api.se/blocket-api.png" />
+</p>
+
 # BlocketAPI
 
-[![PyPI version](https://img.shields.io/pypi/v/blocket_api?style=for-the-badge)](https://pypi.org/project/blocket_api/) [![License](https://img.shields.io/badge/license-WTFPL-green?style=for-the-badge)](https://github.com/dunderrrrrr/blocket_api/blob/main/LICENSE) ![Python](https://img.shields.io/badge/Python-3.10-blue?style=for-the-badge) ![PyPI - Downloads](https://img.shields.io/pypi/dm/blocket_api?style=for-the-badge&color=%23dbce58) 
+[![PyPI version](https://img.shields.io/pypi/v/blocket_api?style=for-the-badge)](https://pypi.org/project/blocket_api/) [![License](https://img.shields.io/badge/license-WTFPL-green?style=for-the-badge)](https://github.com/dunderrrrrr/blocket_api/blob/main/LICENSE) ![Python](https://img.shields.io/badge/Python-3.10-blue?style=for-the-badge) ![PyPI - Downloads](https://img.shields.io/pypi/dw/blocket_api?style=for-the-badge&color=%23dbce58) 
 
 BlocketAPI allows users to query saved searches, known as "Bevakningar", on [blocket.se](https://blocket.se/). This means you can either retrieve results from a specific saved search or list all listings/ads across all saved searches. The results from these queries are returned in a `json` format or as cleaned pydantic objects.
 
@@ -44,7 +68,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. |
@@ -54,6 +78,8 @@ Some calls require a `bearerToken`. However, some calls are public and don't req
 | [`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 | - | List all saved ads. 
 
 
 ## 🤓 Detailed usage
@@ -62,6 +88,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()
 [
@@ -310,6 +339,33 @@ Get user data from a user id. User id can be found in ads, searches and in block
 }
 ```
 
+### 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.1 → blocket_api-0.3.4}/blocket_api.egg-info/requires.txt

@@ -4,4 +4,7 @@ pytest>=8.2.2
 respx>=0.21.1
 mypy>=1.15.0
 pydantic>=2.11.7
-ruff>=0.13.1
+mkdocs>=1.6.1
+mkdocs-material>=9.6.21
+mkdocs-swagger-ui-tag>=0.7.2
+ruff>=0.14.1

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

@@ -1,6 +1,6 @@
 [project]
 name = "blocket_api"
-version = "0.3.1"
+version = "0.3.4"
 description = "A python API wrapper for blocket.se"
 authors = [{name = "dunderrrrrr", email = "emil.bjorkroth@gmail.com"}]
 readme = "README.md"
@@ -12,7 +12,10 @@ dependencies = [
     "respx>=0.21.1",
     "mypy>=1.15.0",
     "pydantic>=2.11.7",
-    "ruff>=0.13.1",
+    "mkdocs>=1.6.1",
+    "mkdocs-material>=9.6.21",
+    "mkdocs-swagger-ui-tag>=0.7.2",
+    "ruff>=0.14.1",
 ]