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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: blocket_api
-Version: 0.2.5
+Version: 0.2.6
 Summary: A python API wrapper for blocket.se
 Author-email: dunderrrrrr <emil.bjorkroth@gmail.com>
 Requires-Python: >=3.10
@@ -60,6 +60,7 @@ Some calls require a bearerToken. However, some calls are public and don't requi
 | [`api.custom_search()`](#custom_searchsearch_query-region-limit)  | 👏 No | Search for everything on Blocket and filter by region |
 | [`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.
 
 ## 🤓 Detailed usage
 
@@ -197,6 +198,25 @@ Query price evaluation for a specific vehicle by using cars registration number
 }
 ```
 
+### home_search(city, type, order_by, ordering, offset)
+Query home listings from [bostad.blocket.se](https://bostad.blocket.se/).
+
+- `city` (`str`, required) - City name, ex. Stockholm. 
+- `type` (`HomeType`, optional) - Type of home, ex. `HomeType.apartment`.
+- `order_by` (`OrderBy`, optional) - Sorting order, ex. `OrderBy.price`.
+- `ordering` (`HOME_SEARCH_ORDERING`, optional) - Sorting order, ex. `"descending"`.
+- `offset` (`int`, optional) - Offset for results, ex. `60`.
+
+```py
+>>> api.home_search(
+    city="Stockholm",
+    type=HomeType.apartment,
+    order_by=OrderBy.price,
+    ordering="descending",
+)
+...
+```
+
 ## 🔐 Blocket API token
 
 There are two ways to acquire your token:

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

@@ -44,6 +44,7 @@ Some calls require a bearerToken. However, some calls are public and don't requi
 | [`api.custom_search()`](#custom_searchsearch_query-region-limit)  | 👏 No | Search for everything on Blocket and filter by region |
 | [`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.
 
 ## 🤓 Detailed usage
 
@@ -181,6 +182,25 @@ Query price evaluation for a specific vehicle by using cars registration number
 }
 ```
 
+### home_search(city, type, order_by, ordering, offset)
+Query home listings from [bostad.blocket.se](https://bostad.blocket.se/).
+
+- `city` (`str`, required) - City name, ex. Stockholm. 
+- `type` (`HomeType`, optional) - Type of home, ex. `HomeType.apartment`.
+- `order_by` (`OrderBy`, optional) - Sorting order, ex. `OrderBy.price`.
+- `ordering` (`HOME_SEARCH_ORDERING`, optional) - Sorting order, ex. `"descending"`.
+- `offset` (`int`, optional) - Offset for results, ex. `60`.
+
+```py
+>>> api.home_search(
+    city="Stockholm",
+    type=HomeType.apartment,
+    order_by=OrderBy.price,
+    ordering="descending",
+)
+...
+```
+
 ## 🔐 Blocket API token
 
 There are two ways to acquire your token:

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

@@ -9,6 +9,8 @@ from typing import TYPE_CHECKING, Any, List, Literal, Optional, Tuple
 
 import httpx
 
+from blocket_api.qasa import HOME_SEARCH_ORDERING, HomeType, OrderBy, Qasa
+
 if TYPE_CHECKING:
     from httpx import Response
 
@@ -259,3 +261,24 @@ class BlocketAPI:
         """
         url = f"{BYTBIL_URL}/blocket-basedata-api/v3/vehicle-data/{registration_number}"
         return _make_request(url=f"{url}", token=None).json()
+
+    def home_search(
+        self,
+        city: str,
+        type: HomeType,
+        order_by: OrderBy = OrderBy.published_at,
+        ordering: HOME_SEARCH_ORDERING = "descending",
+        offset: int = 0,
+    ) -> dict:
+        """
+        This returns all available home listings available at
+        https://bostad.blocket.se/. Specify offset to get next page. Each page contains
+        60 items, which is max items returned per api query.
+        """
+        return Qasa(
+            city=city,
+            home_type=type,
+            order_by=order_by,
+            ordering=ordering,
+            offset=offset,
+        ).search()

blocket_api-0.2.6/blocket_api/qasa.py

@@ -0,0 +1,135 @@
+from dataclasses import dataclass
+from enum import Enum
+from typing import Literal
+import httpx
+
+QASA_URL = "https://api.qasa.se/graphql"
+HOME_SEARCH_ORDERING = Literal["descending", "ascending"]
+
+
+class OrderBy(Enum):
+    published_at = "published_or_bumped_at"
+    price = "monthly_cost_cents"
+    size = "square_meters"
+    move_in_date = "start_date"
+    move_out_date = "end_date"
+
+
+class HomeType(Enum):
+    apartment = ["apartment", "loft"]
+    house = ["house", "terrace_house", "duplex"]
+    cottage = ["cottage"]
+    corridor = ["corridor", "room"]
+    other = ["other"]
+
+
+@dataclass
+class Qasa:
+    city: str
+    home_type: HomeType
+    order_by: OrderBy
+    ordering: HOME_SEARCH_ORDERING
+    offset: int
+
+    def _construct_payload(self) -> dict:
+        return {
+            "operationName": "HomeSearch",
+            "variables": {
+                "limit": 60,  # no more than 60 items per page is allowed
+                "offset": 0,
+                "order": {
+                    "direction": f"{self.ordering}",
+                    "orderBy": f"{self.order_by.value}",
+                },
+                "params": {
+                    "currency": "SEK",
+                    "homeType": self.home_type.value,
+                    "areaIdentifier": [f"se/{self.city}"],
+                    "rentalType": ["long_term"],
+                    "markets": ["sweden"],
+                },
+            },
+            "query": """
+                query HomeSearch(
+                    $order: HomeIndexSearchOrderInput, 
+                    $offset: Int, 
+                    $limit: Int, 
+                    $params: HomeSearchParamsInput
+                ) {
+                    homeIndexSearch(order: $order, params: $params) {
+                        documents(offset: $offset, limit: $limit) {
+                            hasNextPage
+                            hasPreviousPage
+                            nodes {
+                                bedroomCount
+                                blockListing
+                                rentalLengthSeconds
+                                householdSize
+                                corporateHome
+                                description
+                                endDate
+                                firstHand
+                                furnished
+                                homeType
+                                id
+                                instantSign
+                                market
+                                lastBumpedAt
+                                monthlyCost
+                                petsAllowed
+                                platform
+                                publishedAt
+                                publishedOrBumpedAt
+                                earlyAccessEndsAt
+                                rent
+                                currency
+                                roomCount
+                                seniorHome
+                                shared
+                                shortcutHome
+                                smokingAllowed
+                                sortingScore
+                                squareMeters
+                                startDate
+                                studentHome
+                                tenantBaseFee
+                                title
+                                wheelchairAccessible
+                                location {
+                                    id
+                                    locality
+                                    countryCode
+                                    streetNumber
+                                    point {
+                                    lat
+                                    lon
+                                    __typename
+                                    }
+                                    route
+                                    __typename
+                                }
+                                displayStreetNumber
+                                uploads {
+                                    id
+                                    order
+                                    type
+                                    url
+                                    __typename
+                                }
+                                __typename
+                            }
+                            pagesCount
+                            totalCount
+                            __typename
+                        }
+                    __typename
+                    }
+                }""",
+        }
+
+    def search(self) -> dict:
+        query = self._construct_payload()
+
+        response = httpx.post(QASA_URL, json=query)
+        response.raise_for_status()
+        return response.json()

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: blocket_api
-Version: 0.2.5
+Version: 0.2.6
 Summary: A python API wrapper for blocket.se
 Author-email: dunderrrrrr <emil.bjorkroth@gmail.com>
 Requires-Python: >=3.10
@@ -60,6 +60,7 @@ Some calls require a bearerToken. However, some calls are public and don't requi
 | [`api.custom_search()`](#custom_searchsearch_query-region-limit)  | 👏 No | Search for everything on Blocket and filter by region |
 | [`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.
 
 ## 🤓 Detailed usage
 
@@ -197,6 +198,25 @@ Query price evaluation for a specific vehicle by using cars registration number
 }
 ```
 
+### home_search(city, type, order_by, ordering, offset)
+Query home listings from [bostad.blocket.se](https://bostad.blocket.se/).
+
+- `city` (`str`, required) - City name, ex. Stockholm. 
+- `type` (`HomeType`, optional) - Type of home, ex. `HomeType.apartment`.
+- `order_by` (`OrderBy`, optional) - Sorting order, ex. `OrderBy.price`.
+- `ordering` (`HOME_SEARCH_ORDERING`, optional) - Sorting order, ex. `"descending"`.
+- `offset` (`int`, optional) - Offset for results, ex. `60`.
+
+```py
+>>> api.home_search(
+    city="Stockholm",
+    type=HomeType.apartment,
+    order_by=OrderBy.price,
+    ordering="descending",
+)
+...
+```
+
 ## 🔐 Blocket API token
 
 There are two ways to acquire your token:

{blocket_api-0.2.5 → blocket_api-0.2.6}/blocket_api.egg-info/SOURCES.txt

@@ -3,6 +3,7 @@ README.md
 pyproject.toml
 blocket_api/__init__.py
 blocket_api/blocket.py
+blocket_api/qasa.py
 blocket_api.egg-info/PKG-INFO
 blocket_api.egg-info/SOURCES.txt
 blocket_api.egg-info/dependency_links.txt

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

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