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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: blocket_api
-Version: 0.2.9
+Version: 0.3.1
 Summary: A python API wrapper for blocket.se
 Author-email: dunderrrrrr <emil.bjorkroth@gmail.com>
 Requires-Python: >=3.10
@@ -12,14 +12,14 @@ 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.0
+Requires-Dist: ruff>=0.13.1
 Dynamic: license-file
 
 # 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) 
 
-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.
+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.
 
 > Blocket is one of Sweden's largest online marketplaces. It was founded in 1996 and allows users to buy and sell a wide range of items, including cars, real estate, jobs, services, and second-hand goods. The platform is known for its extensive reach and user-friendly interface, making it a popular choice for Swedes looking to purchase or sell items quickly and efficiently.
 
@@ -31,15 +31,18 @@ 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
 
-BlocketAPI is available on PyPI.
+Install BlocketAPI via PyPI...
 
 ```sh
 pip install blocket-api
 ```
 
+or use [blocket-api.se](https://blocket-api.se) without installing anything!
+
 ## 💁‍♀️ Usage
 
 ```py
@@ -63,9 +66,12 @@ Some calls require a `bearerToken`. However, some calls are public and don't req
 | [`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. |
 | [`api.price_eval()`](#price_eval)  | 👏 No | - | Vehicle purchase valuation and details. | 
-| [`api.home_search()`](#home_search)  | 👏 No | - | Query home listings.
+| [`api.home_search()`](#home_search)  | 👏 No | Yes | Query home listings.
 | [`api.store_search()`](#store_search)  | 👏 No | Yes | Search for a store.
-| [`api.get_store_listings()`](#get_store_listings)  | 👏 No | - | Get listings from a specific 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
 
@@ -133,7 +139,7 @@ Parameters:
 - `as_objects` (`bool`, optional) - Return results as pydantic models, default is `False`.
 
 ```py
->>> from blocket_api import Region
+>>> from blocket_api.blocket import Region, Category
 >>> api.custom_search("saab", Region.blekinge) # search for term "saab" in region of "Blekinge"
 {
    "data":[
@@ -215,6 +221,7 @@ Query home listings from [bostad.blocket.se](https://bostad.blocket.se/).
 - `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`.
+- `as_objects` (`bool`, optional) - Return results as pydantic models, default is False.
 
 ```py
 >>> from blocket_api.qasa import HomeType, OrderBy
@@ -254,6 +261,8 @@ 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.
+- `as_objects` (`bool`, optional) - Return results as pydantic models, default is `False`.
+
 
 ```py
 >>> api.get_store_listings(1234)
@@ -271,6 +280,53 @@ Get listings from a specific store.
 }
 ```
 
+### get_ad_by_id
+Get ad data from a specific ad id.
+
+- `ad_id` (`int`, required) - The ad id. Can be found by calling any other method or from ad url.
+- `as_objects` (`bool`, optional) - Return results as pydantic models, default is `False`.
+
+
+```py
+>>> api.get_ad_by_id(1234)
+{
+   "data": {
+      "ad_id": "1234",
+      "ad_status": "active",
+      "advertiser": {...},
+      "body": "A nice ad.",
+      "category": [
+            {"id": "4000", "name": "Personligt"},
+            {"id": "4080", "name": "Kläder & skor"},
+      ],
+      ...
+   }
+}
+```
+
+### 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:
@@ -295,5 +351,6 @@ My token has never expired or changed during this project. However, if your're m
 
 ## 📝 Notes
 
+- REST API: https://blocket-api.se
 - Source repo: https://github.com/dunderrrrrr/blocket_api
 - PyPI: https://pypi.org/project/blocket-api/

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

@@ -2,7 +2,7 @@
 
 [![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) 
 
-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.
+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.
 
 > Blocket is one of Sweden's largest online marketplaces. It was founded in 1996 and allows users to buy and sell a wide range of items, including cars, real estate, jobs, services, and second-hand goods. The platform is known for its extensive reach and user-friendly interface, making it a popular choice for Swedes looking to purchase or sell items quickly and efficiently.
 
@@ -14,15 +14,18 @@ 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
 
-BlocketAPI is available on PyPI.
+Install BlocketAPI via PyPI...
 
 ```sh
 pip install blocket-api
 ```
 
+or use [blocket-api.se](https://blocket-api.se) without installing anything!
+
 ## 💁‍♀️ Usage
 
 ```py
@@ -46,9 +49,12 @@ Some calls require a `bearerToken`. However, some calls are public and don't req
 | [`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. |
 | [`api.price_eval()`](#price_eval)  | 👏 No | - | Vehicle purchase valuation and details. | 
-| [`api.home_search()`](#home_search)  | 👏 No | - | Query home listings.
+| [`api.home_search()`](#home_search)  | 👏 No | Yes | Query home listings.
 | [`api.store_search()`](#store_search)  | 👏 No | Yes | Search for a store.
-| [`api.get_store_listings()`](#get_store_listings)  | 👏 No | - | Get listings from a specific 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
 
@@ -116,7 +122,7 @@ Parameters:
 - `as_objects` (`bool`, optional) - Return results as pydantic models, default is `False`.
 
 ```py
->>> from blocket_api import Region
+>>> from blocket_api.blocket import Region, Category
 >>> api.custom_search("saab", Region.blekinge) # search for term "saab" in region of "Blekinge"
 {
    "data":[
@@ -198,6 +204,7 @@ Query home listings from [bostad.blocket.se](https://bostad.blocket.se/).
 - `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`.
+- `as_objects` (`bool`, optional) - Return results as pydantic models, default is False.
 
 ```py
 >>> from blocket_api.qasa import HomeType, OrderBy
@@ -237,6 +244,8 @@ 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.
+- `as_objects` (`bool`, optional) - Return results as pydantic models, default is `False`.
+
 
 ```py
 >>> api.get_store_listings(1234)
@@ -254,6 +263,53 @@ Get listings from a specific store.
 }
 ```
 
+### get_ad_by_id
+Get ad data from a specific ad id.
+
+- `ad_id` (`int`, required) - The ad id. Can be found by calling any other method or from ad url.
+- `as_objects` (`bool`, optional) - Return results as pydantic models, default is `False`.
+
+
+```py
+>>> api.get_ad_by_id(1234)
+{
+   "data": {
+      "ad_id": "1234",
+      "ad_status": "active",
+      "advertiser": {...},
+      "body": "A nice ad.",
+      "category": [
+            {"id": "4000", "name": "Personligt"},
+            {"id": "4080", "name": "Kläder & skor"},
+      ],
+      ...
+   }
+}
+```
+
+### 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:
@@ -278,5 +334,6 @@ My token has never expired or changed during this project. However, if your're m
 
 ## 📝 Notes
 
+- REST API: https://blocket-api.se
 - Source repo: https://github.com/dunderrrrrr/blocket_api
 - PyPI: https://pypi.org/project/blocket-api/

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

@@ -10,8 +10,12 @@ from typing import TYPE_CHECKING, Any, List, Literal, Optional, Tuple, Union, ov
 import httpx
 
 from blocket_api.models import (
+    AdByIdResults,
+    BlocketUser,
     CustomSearchResults,
+    HomeSearchResults,
     MotorSearchResults,
+    StoreListings,
     StoreSearchResults,
 )
 from blocket_api.qasa import HOME_SEARCH_ORDERING, HomeType, OrderBy, Qasa
@@ -403,6 +407,7 @@ class BlocketAPI:
         url = f"{BYTBIL_URL}/blocket-basedata-api/v3/vehicle-data/{registration_number}"
         return _make_request(url=f"{url}", token=None).json()
 
+    @overload
     def home_search(
         self,
         city: str,
@@ -410,36 +415,54 @@ class BlocketAPI:
         order_by: OrderBy = OrderBy.published_at,
         ordering: HOME_SEARCH_ORDERING = "descending",
         offset: int = 0,
-    ) -> dict:
+        *,
+        as_objects: Literal[True],
+    ) -> HomeSearchResults: ...
+
+    @overload
+    def home_search(
+        self,
+        city: str,
+        type: HomeType,
+        order_by: OrderBy = OrderBy.published_at,
+        ordering: HOME_SEARCH_ORDERING = "descending",
+        offset: int = 0,
+        *,
+        as_objects: Literal[False] = False,
+    ) -> dict: ...
+
+    def home_search(
+        self,
+        city: str,
+        type: HomeType,
+        order_by: OrderBy = OrderBy.published_at,
+        ordering: HOME_SEARCH_ORDERING = "descending",
+        offset: int = 0,
+        *,
+        as_objects: bool = False,
+    ) -> dict | HomeSearchResults:
         """
         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(
+        response = Qasa(
             city=city,
             home_type=type,
             order_by=order_by,
             ordering=ordering,
             offset=offset,
         ).search()
+        return HomeSearchResults.model_validate(response) if as_objects else response
 
     @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
@@ -473,12 +496,24 @@ class BlocketAPI:
         response = _make_request(url=f"{url}", token=self.token).json()
         return StoreSearchResults.model_validate(response) if as_objects else response
 
+    @overload
+    def get_store_listings(
+        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
+    ) -> dict: ...
+
     @public_token
     def get_store_listings(
         self,
         store_id: int,
         page: int = 0,
-    ) -> dict:
+        *,
+        as_objects: bool = False,
+    ) -> dict | StoreListings:
         """
         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().
@@ -487,4 +522,49 @@ class BlocketAPI:
             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()
+        response = _make_request(url=f"{url}", token=self.token).json()
+        return StoreListings.model_validate(response) if as_objects else response
+
+    @overload
+    def get_ad_by_id(
+        self, ad_id: int, *, as_objects: Literal[True]
+    ) -> AdByIdResults: ...
+
+    @overload
+    def get_ad_by_id(
+        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
+    ) -> 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.1/blocket_api/models.py

@@ -0,0 +1,592 @@
+import datetime
+from typing import Any
+
+from pydantic import BaseModel
+
+### CustomSearch ###
+
+
+class CustomSearchPrice(BaseModel):
+    suffix: str
+    value: int
+
+
+class CustomSearchLocation(BaseModel):
+    image_url: str
+    label: str
+    query_key: str | None = None
+
+
+class CustomSearchImage(BaseModel):
+    height: int
+    type: str
+    url: str
+    width: int
+
+
+class CustomSearchCategory(BaseModel):
+    id: str
+    name: str
+
+
+class CustomSearchResult(BaseModel):
+    ad_id: str
+    ad_status: str
+    body: str
+    category: list[CustomSearchCategory]
+    images: list[CustomSearchImage] = []
+    list_id: str
+    list_time: datetime.datetime
+    map: CustomSearchLocation | None = None
+    map_url: str | None = None
+    price: CustomSearchPrice
+    share_url: str
+    state_id: str
+    subject: str
+    type: str
+    zipcode: str | None = None
+
+
+class CustomSearchResults(BaseModel):
+    data: list[CustomSearchResult]
+    total_count: int
+
+
+### MotorSearch ###
+
+
+class MotorSearchCarEquipment(BaseModel):
+    label: str
+
+
+class MotorSearchCarLocation(BaseModel):
+    region: str
+    municipality: str
+    area: str
+
+
+class MotorSearchCarImage(BaseModel):
+    height: int
+    width: int
+    image: str
+
+
+class MotorSearchCar(BaseModel):
+    images: list[MotorSearchCarImage]
+    location: MotorSearchCarLocation
+    fuel: str
+    gearbox: str
+    regDate: int
+    mileage: int
+    equipment: list[MotorSearchCarEquipment] | None = None
+
+
+class MotorSearchPrice(BaseModel):
+    amount: str
+    billingPeriod: str
+    oldPrice: str | None = None
+
+
+class MotorSearchSeller(BaseModel):
+    type: str
+    name: str
+    id: str
+
+
+class MotorSearchResult(BaseModel):
+    dealId: str
+    link: str
+    listTime: datetime.datetime
+    originalListTime: datetime.datetime
+    seller: MotorSearchSeller
+    heading: str
+    price: MotorSearchPrice
+    thumbnail: str
+    car: MotorSearchCar
+    description: str
+
+
+class MotorSearchResults(BaseModel):
+    cars: list[MotorSearchResult]
+    hits: int
+    pages: int
+
+
+### StoreSearch ###
+
+
+class StoreSearchLocation(BaseModel):
+    longitude: float
+    latitude: float
+
+
+class StoreSearchImage(BaseModel):
+    height: int
+    width: int
+    url: str
+
+
+class StoreSearchLogotype(BaseModel):
+    height: int
+    width: int
+    url: str
+
+
+class StoreSearchResult(BaseModel):
+    address: str | None = None
+    id: str
+    logotype: StoreSearchLogotype
+    image: StoreSearchImage | None = None
+    description: str
+    external_store_url: str | None = None
+    location: StoreSearchLocation | None = None
+    name: str
+    title: str
+    ad_count: int
+    category: str
+
+
+class StoreSearchResults(BaseModel):
+    data: list[StoreSearchResult]
+    total_count: int
+    total_page_count: int
+
+
+### HomeSearch ###
+
+
+class HomeSearchGeoPoint(BaseModel):
+    lat: float
+    lon: float
+
+
+class HomeSearchLocation(BaseModel):
+    id: int
+    locality: str
+    countryCode: str
+    streetNumber: str | None = None
+    point: HomeSearchGeoPoint
+    route: str
+
+
+class HomeSearchUpload(BaseModel):
+    id: int
+    order: int | None = None
+    type: str
+    url: str
+
+
+class HomeSearchResult(BaseModel):
+    bedroomCount: int | None = None
+    blockListing: bool
+    rentalLengthSeconds: float | None = None
+    householdSize: int
+    corporateHome: bool
+    description: str
+    endDate: str | None = None
+    firstHand: bool
+    furnished: bool
+    homeType: str
+    id: str
+    instantSign: bool
+    market: str
+    lastBumpedAt: str | None = None
+    monthlyCost: int
+    petsAllowed: bool
+    platform: str
+    publishedAt: str
+    publishedOrBumpedAt: str
+    earlyAccessEndsAt: str | None = None
+    rent: int
+    currency: str
+    roomCount: int
+    seniorHome: bool
+    shared: bool
+    shortcutHome: bool
+    smokingAllowed: bool
+    sortingScore: float
+    squareMeters: int
+    startDate: str
+    studentHome: bool
+    tenantBaseFee: int
+    title: str | None = None
+    wheelchairAccessible: bool
+    location: HomeSearchLocation
+    displayStreetNumber: bool
+    uploads: list[HomeSearchUpload]
+
+
+class Documents(BaseModel):
+    hasNextPage: bool
+    hasPreviousPage: bool
+    nodes: list[HomeSearchResult]
+    pagesCount: int
+    totalCount: int
+
+
+class HomeIndexSearch(BaseModel):
+    documents: Documents
+
+
+class DataModel(BaseModel):
+    homeIndexSearch: HomeIndexSearch
+
+
+class HomeSearchResults(BaseModel):
+    data: DataModel
+
+
+### StoreListings ###
+
+
+class StoreListingContactMethods(BaseModel):
+    phone: bool
+
+
+class StoreListingAdvertiser(BaseModel):
+    contact_methods: StoreListingContactMethods
+    name: str
+    store_name: str | None = None
+    type: str
+
+
+class StoreListingAttribute(BaseModel):
+    header: str
+    id: str
+    items: list[str]
+
+
+class StoreListingCategory(BaseModel):
+    id: str
+    name: str
+
+
+class StoreListingImage(BaseModel):
+    height: int
+    type: str
+    url: str
+    width: int
+
+
+class StorListingLocationItem(BaseModel):
+    id: str
+    name: str
+    query_key: str
+
+
+class StoreListingParameter(BaseModel):
+    id: str
+    label: str
+    value: str
+    suffix: str | None = None
+
+
+class ParameterGroup(BaseModel):
+    label: str
+    parameters: list[StoreListingParameter]
+    type: str
+
+
+class StoreListingPartnerInfo(BaseModel):
+    external_id: str
+    name: str
+
+
+class StoreListingPrice(BaseModel):
+    suffix: str
+    value: int
+
+
+class StoreListing(BaseModel):
+    ad_id: str
+    ad_status: str
+    advertiser: StoreListingAdvertiser
+    attributes: list[StoreListingAttribute]
+    body: str
+    category: list[StoreListingCategory]
+    images: list[StoreListingImage]
+    license_plate: str | None = None
+    list_id: str
+    list_time: str
+    location: list[StorListingLocationItem]
+    map_url: str | None = None
+    parameter_groups: list[ParameterGroup]
+    partner_info: StoreListingPartnerInfo
+    price: StoreListingPrice
+    share_url: str
+    state_id: str
+    subject: str
+    type: str
+
+
+class StoreListings(BaseModel):
+    data: list[StoreListing]
+
+
+### GetAdById ###
+
+
+class AdByIdReviews(BaseModel):
+    overall_score: int
+    reviews_received_count: int
+
+
+class AdByIdPublicProfile(BaseModel):
+    account_created_at: str
+    badges: list[Any]
+    blocket_account_id: str
+    display_name: str
+    number_of_active_ads: int
+    reviews: AdByIdReviews
+    verified: bool
+    verified_label: str
+
+
+class AdByIdContactMethods(BaseModel):
+    mc: bool
+
+
+class AdByIdAdvertiser(BaseModel):
+    account_id: str
+    contact_methods: AdByIdContactMethods
+    name: str
+    public_profile: AdByIdPublicProfile
+    type: str
+
+
+class AdByIdCategory(BaseModel):
+    id: str
+    name: str
+
+
+class AdByIdImage(BaseModel):
+    height: int
+    type: str
+    url: str
+    width: int
+
+
+class AdByIdLocation(BaseModel):
+    id: str
+    name: str
+    query_key: str
+
+
+class AdByIdMap(BaseModel):
+    image_url: str
+    label: str
+    type: str
+
+
+class AdByIdParameter(BaseModel):
+    id: str
+    label: str
+    value: str
+    suffix: str | None = None
+
+
+class AdByIdParameterGroup(BaseModel):
+    label: str
+    parameters: list[AdByIdParameter]
+    type: str
+
+
+class AdByIdPrice(BaseModel):
+    suffix: str
+    value: int
+
+
+class AdByIdFeatures(BaseModel):
+    is_part_of_merge: bool
+
+
+class AdByIdUrls(BaseModel):
+    seller_activate: str
+
+
+class AdByIdBlocketPackage(BaseModel):
+    activated_providers: list[Any]
+    ad_id: str
+    blocket_payment_backwards_compatability: Any
+    buyers_protection_fee: Any
+    eligible_providers: list[Any]
+    fail_code: Any
+    failure: Any
+    feature_swish: bool
+    features: AdByIdFeatures
+    is_in_dispute: bool
+    partner: str
+    payment_methods: list[Any]
+    payment_request_entrance: Any
+    payment_url: Any
+    service_data: Any
+    shipping_buy_now_entrance: Any
+    state: str
+    transaction_dates: Any
+    urls: AdByIdUrls
+
+
+class AdByIdGamApiKeywords(BaseModel):
+    adid: list[str]
+    adtitle: list[str]
+    adtype: list[str]
+    appmode: list[str]
+    blocket_section: list[str]
+    companyad: list[str]
+    country: list[str]
+    country_code: list[str]
+    county: list[str]
+    id: list[str]
+    itemimage: list[str]
+    itemsecuredthumb: list[str]
+    itemthumb: list[str]
+    livingarea: list[str] | None = None
+    lkf: list[str]
+    municipality: list[str]
+    nmp_vertical: list[str]
+    page: list[str]
+    price: list[str]
+    price_range_2: list[str] | None = None
+    publisher: list[str]
+    services: list[Any]
+
+
+class AdByIdClientKeywords(BaseModel):
+    cmp_advertising: str
+    logged_in: str
+    page_gen: str
+    ppid_1: str
+    ppid_2: str
+    screen_height: str
+    screen_width: str
+    site_mode: str
+    supply_type: str
+    viewport_height: str
+    viewport_width: str
+
+
+class AdByIdGamContext(BaseModel):
+    api_keywords: AdByIdGamApiKeywords
+    client_keywords: AdByIdClientKeywords
+
+
+class AdByIdContext(BaseModel):
+    gam: AdByIdGamContext
+    network_id: str | None = None
+
+
+class AdByIdInventory(BaseModel):
+    context: AdByIdContext
+
+
+class AdByIdGamKeywords(BaseModel):
+    adformat: list[str]
+    adsize: list[str]
+
+
+class AdByIdGamMediaType(BaseModel):
+    height: int | None = None
+    type: str
+    width: int | None = None
+
+
+class AdByIdGamPlacement(BaseModel):
+    keywords: AdByIdGamKeywords
+    media_types: list[AdByIdGamMediaType]
+    path: str
+    target_id: str
+
+
+class AdByIdPlacement(BaseModel):
+    gam: AdByIdGamPlacement | None = None
+    type: str
+    vendor: str
+    viewport: str
+    safe_purchase: dict[str, Any] | None = None
+
+
+class AdByIdData(BaseModel):
+    ad_id: str
+    ad_status: str
+    advertiser: AdByIdAdvertiser
+    body: str
+    category: list[AdByIdCategory]
+    images: list[AdByIdImage]
+    latitude: float | None = None
+    list_id: str
+    list_time: str
+    location: list[AdByIdLocation]
+    longitude: float | None = None
+    map: AdByIdMap
+    map_url: str
+    parameter_groups: list[AdByIdParameterGroup]
+    price: AdByIdPrice
+    saved: bool
+    share_url: str
+    state_id: str
+    subject: str
+    type: str
+    zipcode: str
+    blocket_package: AdByIdBlocketPackage
+
+
+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.2.9 → blocket_api-0.3.1}/blocket_api.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: blocket_api
-Version: 0.2.9
+Version: 0.3.1
 Summary: A python API wrapper for blocket.se
 Author-email: dunderrrrrr <emil.bjorkroth@gmail.com>
 Requires-Python: >=3.10
@@ -12,14 +12,14 @@ 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.0
+Requires-Dist: ruff>=0.13.1
 Dynamic: license-file
 
 # 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) 
 
-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.
+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.
 
 > Blocket is one of Sweden's largest online marketplaces. It was founded in 1996 and allows users to buy and sell a wide range of items, including cars, real estate, jobs, services, and second-hand goods. The platform is known for its extensive reach and user-friendly interface, making it a popular choice for Swedes looking to purchase or sell items quickly and efficiently.
 
@@ -31,15 +31,18 @@ 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
 
-BlocketAPI is available on PyPI.
+Install BlocketAPI via PyPI...
 
 ```sh
 pip install blocket-api
 ```
 
+or use [blocket-api.se](https://blocket-api.se) without installing anything!
+
 ## 💁‍♀️ Usage
 
 ```py
@@ -63,9 +66,12 @@ Some calls require a `bearerToken`. However, some calls are public and don't req
 | [`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. |
 | [`api.price_eval()`](#price_eval)  | 👏 No | - | Vehicle purchase valuation and details. | 
-| [`api.home_search()`](#home_search)  | 👏 No | - | Query home listings.
+| [`api.home_search()`](#home_search)  | 👏 No | Yes | Query home listings.
 | [`api.store_search()`](#store_search)  | 👏 No | Yes | Search for a store.
-| [`api.get_store_listings()`](#get_store_listings)  | 👏 No | - | Get listings from a specific 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
 
@@ -133,7 +139,7 @@ Parameters:
 - `as_objects` (`bool`, optional) - Return results as pydantic models, default is `False`.
 
 ```py
->>> from blocket_api import Region
+>>> from blocket_api.blocket import Region, Category
 >>> api.custom_search("saab", Region.blekinge) # search for term "saab" in region of "Blekinge"
 {
    "data":[
@@ -215,6 +221,7 @@ Query home listings from [bostad.blocket.se](https://bostad.blocket.se/).
 - `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`.
+- `as_objects` (`bool`, optional) - Return results as pydantic models, default is False.
 
 ```py
 >>> from blocket_api.qasa import HomeType, OrderBy
@@ -254,6 +261,8 @@ 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.
+- `as_objects` (`bool`, optional) - Return results as pydantic models, default is `False`.
+
 
 ```py
 >>> api.get_store_listings(1234)
@@ -271,6 +280,53 @@ Get listings from a specific store.
 }
 ```
 
+### get_ad_by_id
+Get ad data from a specific ad id.
+
+- `ad_id` (`int`, required) - The ad id. Can be found by calling any other method or from ad url.
+- `as_objects` (`bool`, optional) - Return results as pydantic models, default is `False`.
+
+
+```py
+>>> api.get_ad_by_id(1234)
+{
+   "data": {
+      "ad_id": "1234",
+      "ad_status": "active",
+      "advertiser": {...},
+      "body": "A nice ad.",
+      "category": [
+            {"id": "4000", "name": "Personligt"},
+            {"id": "4080", "name": "Kläder & skor"},
+      ],
+      ...
+   }
+}
+```
+
+### 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:
@@ -295,5 +351,6 @@ My token has never expired or changed during this project. However, if your're m
 
 ## 📝 Notes
 
+- REST API: https://blocket-api.se
 - Source repo: https://github.com/dunderrrrrr/blocket_api
 - PyPI: https://pypi.org/project/blocket-api/

{blocket_api-0.2.9 → blocket_api-0.3.1}/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.0
+ruff>=0.13.1

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

@@ -1,6 +1,6 @@
 [project]
 name = "blocket_api"
-version = "0.2.9"
+version = "0.3.1"
 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.0",
+    "ruff>=0.13.1",
 ]
 
 

blocket_api-0.2.9/blocket_api/models.py

@@ -1,151 +0,0 @@
-import datetime
-
-from pydantic import BaseModel
-
-### CustomSearch ###
-
-
-class CustomSearchPrice(BaseModel):
-    suffix: str
-    value: int
-
-
-class CustomSearchLocation(BaseModel):
-    image_url: str
-    label: str
-    query_key: str | None = None
-
-
-class CustomSearchImage(BaseModel):
-    height: int
-    type: str
-    url: str
-    width: int
-
-
-class CustomSearchCategory(BaseModel):
-    id: str
-    name: str
-
-
-class CustomSearchResult(BaseModel):
-    ad_id: str
-    ad_status: str
-    body: str
-    category: list[CustomSearchCategory]
-    images: list[CustomSearchImage] = []
-    list_id: str
-    list_time: datetime.datetime
-    map: CustomSearchLocation | None = None
-    map_url: str | None = None
-    price: CustomSearchPrice
-    share_url: str
-    state_id: str
-    subject: str
-    type: str
-    zipcode: str | None = None
-
-
-class CustomSearchResults(BaseModel):
-    data: list[CustomSearchResult]
-    total_count: int
-
-
-### MotorSearch ###
-
-
-class MotorSearchCarEquipment(BaseModel):
-    label: str
-
-
-class MotorSearchCarLocation(BaseModel):
-    region: str
-    municipality: str
-    area: str
-
-
-class MotorSearchCarImage(BaseModel):
-    height: int
-    width: int
-    image: str
-
-
-class MotorSearchCar(BaseModel):
-    images: list[MotorSearchCarImage]
-    location: MotorSearchCarLocation
-    fuel: str
-    gearbox: str
-    regDate: int
-    mileage: int
-    equipment: list[MotorSearchCarEquipment] | None = None
-
-
-class MotorSearchPrice(BaseModel):
-    amount: str
-    billingPeriod: str
-    oldPrice: str | None = None
-
-
-class MotorSearchSeller(BaseModel):
-    type: str
-    name: str
-    id: str
-
-
-class MotorSearchResult(BaseModel):
-    dealId: str
-    link: str
-    listTime: datetime.datetime
-    originalListTime: datetime.datetime
-    seller: MotorSearchSeller
-    heading: str
-    price: MotorSearchPrice
-    thumbnail: str
-    car: MotorSearchCar
-    description: str
-
-
-class MotorSearchResults(BaseModel):
-    cars: list[MotorSearchResult]
-    hits: int
-    pages: int
-
-
-### StoreSearch ###
-
-
-class StoreSearchLocation(BaseModel):
-    longitude: float
-    latitude: float
-
-
-class StoreSearchImage(BaseModel):
-    height: int
-    width: int
-    url: str
-
-
-class StoreSearchLogotype(BaseModel):
-    height: int
-    width: int
-    url: str
-
-
-class StoreSearchResult(BaseModel):
-    address: str | None = None
-    id: str
-    logotype: StoreSearchLogotype
-    image: StoreSearchImage | None = None
-    description: str
-    external_store_url: str | None = None
-    location: StoreSearchLocation | None = None
-    name: str
-    title: str
-    ad_count: int
-    category: str
-
-
-class StoreSearchResults(BaseModel):
-    data: list[StoreSearchResult]
-    total_count: int
-    total_page_count: int