blocket-api 0.2.6__tar.gz → 0.2.8__tar.gz

{blocket_api-0.2.6 → blocket_api-0.2.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: blocket_api
-Version: 0.2.6
+Version: 0.2.8
 Summary: A python API wrapper for blocket.se
 Author-email: dunderrrrrr <emil.bjorkroth@gmail.com>
 Requires-Python: >=3.10
@@ -8,10 +8,10 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: httpx>=0.27.0
 Requires-Dist: pre-commit>=3.7.1
-Requires-Dist: ruff>=0.5.2
 Requires-Dist: pytest>=8.2.2
 Requires-Dist: respx>=0.21.1
 Requires-Dist: mypy>=1.15.0
+Requires-Dist: ruff>=0.12.4
 Dynamic: license-file
 
 # BlocketAPI
@@ -25,9 +25,11 @@ BlocketAPI allows users to query saved searches, known as "Bevakningar", on [blo
 ## ✨ Features
 
 - List saved searches, called "Bevakningar".
-- Query all listings/ads filtered on a region.
-- Query listings related to a saved search.
-- Use motor search to query listings related to a specific car.
+- Get listings from all or a specific saved search.
+- Search for anything on Blocket with filters for region and category.
+- 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.
 
 ## 🧑‍💻️ Install
 
@@ -48,7 +50,7 @@ pip install blocket-api
 ...
 ```
 
-Some calls require a bearerToken. However, some calls are public and don't require a token.
+Some calls require a `bearerToken`. However, some calls are public and don't require a token.
 
 [Where token?](#-blocket-api-token)
 
@@ -61,6 +63,8 @@ Some calls require a bearerToken. However, some calls are public and don't requi
 | [`api.motor_search()`](#motor_searchpage-make-fuel-chassi-price-modelyear-milage-gearbox)  | 👏 No | Advanced search for car-listings. |
 | [`api.price_eval()`](#price_evalregistration_number)  | 👏 No | Vehicle purchase valuation and details. | 
 | [`api.home_search()`](#home_searchcity-type-order_by-ordering-offset)  | 👏 No | Query home listings.
+| [`api.store_search()`](#store_searchsearch_query-page)  | 👏 No | Search for a store.
+| [`api.get_store_listings()`](#get_store_listingsstore_id-page)  | 👏 No | Get listings from a specific store.
 
 ## 🤓 Detailed usage
 
@@ -122,7 +126,8 @@ Make a custom search through out all of blocked. A region can be passed in as pa
 
 Parameters:
 - `search_query` (`str`, required) - A string to search for.
-- `region` (`str`, optional) - Filter results on a region, default is all of Sweden.
+- `region` (`enum`, optional) - Filter results on a region, default is all of Sweden.
+- `category` (`enum`, optional) - Filter for a specific category, ex. `Category.for_hemmet`.
 - `limit` (`int`, optional) - Limit number of results returned, max is 99.
 
 ```py
@@ -184,7 +189,7 @@ Query price evaluation for a specific vehicle by using cars registration number
 
 - `registration_number` (`str`, required) - Registration number of the vehicle.
 ```py
->>> api.price_eval("ABC123)
+>>> api.price_eval("ABC123")
 {
    "registration_number": "ABC123",
    "private_valuation": 108155,
@@ -208,6 +213,7 @@ Query home listings from [bostad.blocket.se](https://bostad.blocket.se/).
 - `offset` (`int`, optional) - Offset for results, ex. `60`.
 
 ```py
+>>> from blocket_api.qasa import HomeType, OrderBy
 >>> api.home_search(
     city="Stockholm",
     type=HomeType.apartment,
@@ -217,6 +223,48 @@ Query home listings from [bostad.blocket.se](https://bostad.blocket.se/).
 ...
 ```
 
+### store_search(search_query, page)
+Search for a store in Blocket stores from [blocket.se/butiker](https://www.blocket.se/butiker).
+
+- `search_query` (`str`, required) - The name of the store. 
+- `page` (`int`, optional) - The page number to return.
+
+```py
+>>> api.store_search("Jannes Car and Kebab")
+{
+  "data": [
+    {
+      "store_id": "1234",
+      "store_name": "Jannes Car and Kebab",
+      ...
+    },
+    ...
+  ]
+}
+```
+
+### get_store_listings(store_id, page)
+Get listings from a specific store.
+
+- `store_id` (`int`, required) - The store id. Can be obtained by calling `store_search()`.
+- `page` (`int`, optional) - The page number to return.
+
+```py
+>>> api.get_store_listings(1234)
+{
+  "data": [
+    {
+      "ad_id": "1234",
+      "price": 316000,
+      "body": "A very nice car.",
+      "images": [],
+      ...
+    },
+    ...
+  ]
+}
+```
+
 ## 🔐 Blocket API token
 
 There are two ways to acquire your token:

{blocket_api-0.2.6 → blocket_api-0.2.8}/README.md

@@ -9,9 +9,11 @@ BlocketAPI allows users to query saved searches, known as "Bevakningar", on [blo
 ## ✨ Features
 
 - List saved searches, called "Bevakningar".
-- Query all listings/ads filtered on a region.
-- Query listings related to a saved search.
-- Use motor search to query listings related to a specific car.
+- Get listings from all or a specific saved search.
+- Search for anything on Blocket with filters for region and category.
+- 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.
 
 ## 🧑‍💻️ Install
 
@@ -32,7 +34,7 @@ pip install blocket-api
 ...
 ```
 
-Some calls require a bearerToken. However, some calls are public and don't require a token.
+Some calls require a `bearerToken`. However, some calls are public and don't require a token.
 
 [Where token?](#-blocket-api-token)
 
@@ -45,6 +47,8 @@ Some calls require a bearerToken. However, some calls are public and don't requi
 | [`api.motor_search()`](#motor_searchpage-make-fuel-chassi-price-modelyear-milage-gearbox)  | 👏 No | Advanced search for car-listings. |
 | [`api.price_eval()`](#price_evalregistration_number)  | 👏 No | Vehicle purchase valuation and details. | 
 | [`api.home_search()`](#home_searchcity-type-order_by-ordering-offset)  | 👏 No | Query home listings.
+| [`api.store_search()`](#store_searchsearch_query-page)  | 👏 No | Search for a store.
+| [`api.get_store_listings()`](#get_store_listingsstore_id-page)  | 👏 No | Get listings from a specific store.
 
 ## 🤓 Detailed usage
 
@@ -106,7 +110,8 @@ Make a custom search through out all of blocked. A region can be passed in as pa
 
 Parameters:
 - `search_query` (`str`, required) - A string to search for.
-- `region` (`str`, optional) - Filter results on a region, default is all of Sweden.
+- `region` (`enum`, optional) - Filter results on a region, default is all of Sweden.
+- `category` (`enum`, optional) - Filter for a specific category, ex. `Category.for_hemmet`.
 - `limit` (`int`, optional) - Limit number of results returned, max is 99.
 
 ```py
@@ -168,7 +173,7 @@ Query price evaluation for a specific vehicle by using cars registration number
 
 - `registration_number` (`str`, required) - Registration number of the vehicle.
 ```py
->>> api.price_eval("ABC123)
+>>> api.price_eval("ABC123")
 {
    "registration_number": "ABC123",
    "private_valuation": 108155,
@@ -192,6 +197,7 @@ Query home listings from [bostad.blocket.se](https://bostad.blocket.se/).
 - `offset` (`int`, optional) - Offset for results, ex. `60`.
 
 ```py
+>>> from blocket_api.qasa import HomeType, OrderBy
 >>> api.home_search(
     city="Stockholm",
     type=HomeType.apartment,
@@ -201,6 +207,48 @@ Query home listings from [bostad.blocket.se](https://bostad.blocket.se/).
 ...
 ```
 
+### store_search(search_query, page)
+Search for a store in Blocket stores from [blocket.se/butiker](https://www.blocket.se/butiker).
+
+- `search_query` (`str`, required) - The name of the store. 
+- `page` (`int`, optional) - The page number to return.
+
+```py
+>>> api.store_search("Jannes Car and Kebab")
+{
+  "data": [
+    {
+      "store_id": "1234",
+      "store_name": "Jannes Car and Kebab",
+      ...
+    },
+    ...
+  ]
+}
+```
+
+### get_store_listings(store_id, page)
+Get listings from a specific store.
+
+- `store_id` (`int`, required) - The store id. Can be obtained by calling `store_search()`.
+- `page` (`int`, optional) - The page number to return.
+
+```py
+>>> api.get_store_listings(1234)
+{
+  "data": [
+    {
+      "ad_id": "1234",
+      "price": 316000,
+      "body": "A very nice car.",
+      "images": [],
+      ...
+    },
+    ...
+  ]
+}
+```
+
 ## 🔐 Blocket API token
 
 There are two ways to acquire your token:

{blocket_api-0.2.6 → blocket_api-0.2.8}/blocket_api/blocket.py

@@ -46,6 +46,52 @@ class Region(Enum):
     örebro = 8
 
 
+class Category(Enum):
+    fordon = 1000
+    bilar = 1020
+    bildelar_biltillbehor = 1040
+    batar = 1060
+    batdelar_tillbehor = 1080
+    husvagnar_husbilar = 1100
+    mopeder_a_traktor = 1120
+    motorcyklar = 1140
+    mc_delar_tillbehor = 1160
+    lastbil_truck_entreprenad = 1220
+    skogs_lantbruksmaskiner = 1240
+    snoskotrar = 1180
+    snoskoterdelar_tillbehor = 1200
+    for_hemmet = 2000
+    bygg_tradgard = 2020
+    mobler_heminredning = 2040
+    husgerad_vitvaror = 2060
+    verktyg = 2026
+    bostad = 3000
+    lagenheter = 3020
+    villor = 3100
+    radhus = 3120
+    tomter = 3060
+    gardar = 3070
+    fritidsboende = 3040
+    utland = 3080
+    personligt = 4000
+    klader_skor = 4080
+    accessoarer_klockor = 4060
+    barnklader_skor = 4020
+    barnartiklar_leksaker = 4040
+    elektronik = 5000
+    datorer_tv_spel = 5020
+    ljud_bild = 5040
+    telefoner_tillbehor = 5060
+    fritid_hobby = 6000
+    biljetter_resor = 6020
+    bocker_studentlitteratur = 6040
+    cyklar = 6060
+    djur = 6080
+    hobby_samlarprylar = 6100
+    hastar_ridsport = 6120
+    jakt_fiske = 6140
+
+
 MAKE_OPTIONS = Literal[
     "Audi",
     "BMW",
@@ -188,7 +234,11 @@ class BlocketAPI:
 
     @public_token
     def custom_search(
-        self, search_query: str, region: Region = Region.hela_sverige, limit: int = 99
+        self,
+        search_query: str,
+        region: Region = Region.hela_sverige,
+        category: Category | None = None,
+        limit: int = 99,
     ) -> dict:
         """
         Do a custom search through out all of Blocket.
@@ -199,10 +249,12 @@ class BlocketAPI:
         if limit > 99:
             raise LimitError("Limit cannot be greater than 99.")
 
-        return _make_request(
-            url=f"{BASE_URL}/search_bff/v2/content?lim={limit}&q={search_query}&r={region.value}&status=active",
-            token=self.token,
-        ).json()
+        url = f"{BASE_URL}/search_bff/v2/content?lim={limit}&q={search_query}&r={region.value}&status=active"
+
+        if category:
+            url += f"&cg={category.value}"
+
+        return _make_request(url=url, token=self.token).json()
 
     @public_token
     def motor_search(
@@ -282,3 +334,32 @@ class BlocketAPI:
             ordering=ordering,
             offset=offset,
         ).search()
+
+    @public_token
+    def search_store(
+        self,
+        search_query: str,
+        page: int = 0,
+    ) -> dict:
+        """
+        Searching through Blocket stores from https://www.blocket.se/butiker.
+        The store_id is used for get_store_listings().
+        """
+        url = f"{BASE_URL}/search_bff/v1/stores?q={search_query}&page={page}"
+        return _make_request(url=f"{url}", token=self.token).json()
+
+    @public_token
+    def get_store_listings(
+        self,
+        store_id: int,
+        page: int = 0,
+    ) -> dict:
+        """
+        Return all listings from a specific store from https://www.blocket.se/butik/<store>.
+        The store_id can be found by searching for the store with search_store().
+        """
+        url = (
+            f"{BASE_URL}/search_bff/v2/content?lim=60&page={page}&sort=rel&store_id={store_id}"
+            "&status=active&gl=3&include=extend_with_shipping"
+        )
+        return _make_request(url=f"{url}", token=self.token).json()

{blocket_api-0.2.6 → blocket_api-0.2.8}/blocket_api.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: blocket_api
-Version: 0.2.6
+Version: 0.2.8
 Summary: A python API wrapper for blocket.se
 Author-email: dunderrrrrr <emil.bjorkroth@gmail.com>
 Requires-Python: >=3.10
@@ -8,10 +8,10 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: httpx>=0.27.0
 Requires-Dist: pre-commit>=3.7.1
-Requires-Dist: ruff>=0.5.2
 Requires-Dist: pytest>=8.2.2
 Requires-Dist: respx>=0.21.1
 Requires-Dist: mypy>=1.15.0
+Requires-Dist: ruff>=0.12.4
 Dynamic: license-file
 
 # BlocketAPI
@@ -25,9 +25,11 @@ BlocketAPI allows users to query saved searches, known as "Bevakningar", on [blo
 ## ✨ Features
 
 - List saved searches, called "Bevakningar".
-- Query all listings/ads filtered on a region.
-- Query listings related to a saved search.
-- Use motor search to query listings related to a specific car.
+- Get listings from all or a specific saved search.
+- Search for anything on Blocket with filters for region and category.
+- 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.
 
 ## 🧑‍💻️ Install
 
@@ -48,7 +50,7 @@ pip install blocket-api
 ...
 ```
 
-Some calls require a bearerToken. However, some calls are public and don't require a token.
+Some calls require a `bearerToken`. However, some calls are public and don't require a token.
 
 [Where token?](#-blocket-api-token)
 
@@ -61,6 +63,8 @@ Some calls require a bearerToken. However, some calls are public and don't requi
 | [`api.motor_search()`](#motor_searchpage-make-fuel-chassi-price-modelyear-milage-gearbox)  | 👏 No | Advanced search for car-listings. |
 | [`api.price_eval()`](#price_evalregistration_number)  | 👏 No | Vehicle purchase valuation and details. | 
 | [`api.home_search()`](#home_searchcity-type-order_by-ordering-offset)  | 👏 No | Query home listings.
+| [`api.store_search()`](#store_searchsearch_query-page)  | 👏 No | Search for a store.
+| [`api.get_store_listings()`](#get_store_listingsstore_id-page)  | 👏 No | Get listings from a specific store.
 
 ## 🤓 Detailed usage
 
@@ -122,7 +126,8 @@ Make a custom search through out all of blocked. A region can be passed in as pa
 
 Parameters:
 - `search_query` (`str`, required) - A string to search for.
-- `region` (`str`, optional) - Filter results on a region, default is all of Sweden.
+- `region` (`enum`, optional) - Filter results on a region, default is all of Sweden.
+- `category` (`enum`, optional) - Filter for a specific category, ex. `Category.for_hemmet`.
 - `limit` (`int`, optional) - Limit number of results returned, max is 99.
 
 ```py
@@ -184,7 +189,7 @@ Query price evaluation for a specific vehicle by using cars registration number
 
 - `registration_number` (`str`, required) - Registration number of the vehicle.
 ```py
->>> api.price_eval("ABC123)
+>>> api.price_eval("ABC123")
 {
    "registration_number": "ABC123",
    "private_valuation": 108155,
@@ -208,6 +213,7 @@ Query home listings from [bostad.blocket.se](https://bostad.blocket.se/).
 - `offset` (`int`, optional) - Offset for results, ex. `60`.
 
 ```py
+>>> from blocket_api.qasa import HomeType, OrderBy
 >>> api.home_search(
     city="Stockholm",
     type=HomeType.apartment,
@@ -217,6 +223,48 @@ Query home listings from [bostad.blocket.se](https://bostad.blocket.se/).
 ...
 ```
 
+### store_search(search_query, page)
+Search for a store in Blocket stores from [blocket.se/butiker](https://www.blocket.se/butiker).
+
+- `search_query` (`str`, required) - The name of the store. 
+- `page` (`int`, optional) - The page number to return.
+
+```py
+>>> api.store_search("Jannes Car and Kebab")
+{
+  "data": [
+    {
+      "store_id": "1234",
+      "store_name": "Jannes Car and Kebab",
+      ...
+    },
+    ...
+  ]
+}
+```
+
+### get_store_listings(store_id, page)
+Get listings from a specific store.
+
+- `store_id` (`int`, required) - The store id. Can be obtained by calling `store_search()`.
+- `page` (`int`, optional) - The page number to return.
+
+```py
+>>> api.get_store_listings(1234)
+{
+  "data": [
+    {
+      "ad_id": "1234",
+      "price": 316000,
+      "body": "A very nice car.",
+      "images": [],
+      ...
+    },
+    ...
+  ]
+}
+```
+
 ## 🔐 Blocket API token
 
 There are two ways to acquire your token:

{blocket_api-0.2.6 → blocket_api-0.2.8}/blocket_api.egg-info/requires.txt

@@ -1,6 +1,6 @@
 httpx>=0.27.0
 pre-commit>=3.7.1
-ruff>=0.5.2
 pytest>=8.2.2
 respx>=0.21.1
 mypy>=1.15.0
+ruff>=0.12.4

{blocket_api-0.2.6 → blocket_api-0.2.8}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "blocket_api"
-version = "0.2.6"
+version = "0.2.8"
 description = "A python API wrapper for blocket.se"
 authors = [{name = "dunderrrrrr", email = "emil.bjorkroth@gmail.com"}]
 readme = "README.md"
@@ -8,10 +8,10 @@ requires-python = ">=3.10"
 dependencies = [
     "httpx>=0.27.0",
     "pre-commit>=3.7.1",
-    "ruff>=0.5.2",
     "pytest>=8.2.2",
     "respx>=0.21.1",
     "mypy>=1.15.0",
+    "ruff>=0.12.4",
 ]