Skip to content

Commit fbacb8b

Browse files
committed
Clean up readme
1 parent 6111e58 commit fbacb8b

File tree

2 files changed

+14
-1
lines changed

2 files changed

+14
-1
lines changed

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# BlocketAPI
22

3+
[![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 versions](https://img.shields.io/pypi/pyversions/blocket-api?style=for-the-badge)](https://pypi.org/project/blocket_api/)
4+
35
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.
46

57
> 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.
@@ -9,6 +11,7 @@ BlocketAPI allows users to query saved searches, known as "Bevakningar", on [blo
911
- List saved searches, called "Bevakningar".
1012
- Query all listings/ads filtered on a region.
1113
- Query listings related to a saved search.
14+
- Use motor search to query listings related to a specific car.
1215

1316
## 🧑‍💻️ Install
1417

@@ -26,6 +29,16 @@ pip install blocket-api
2629

2730
[Where token?](#-blocket-api-token)
2831

32+
33+
| Function | Description |
34+
|---|---|
35+
| `api.saved_searches()` | List your saved searches (bevakningar) |
36+
| `api.get_listings()` | List items related to a saved search |
37+
| `api.custom_search()` | Search for everything on Blocket and filter by region |
38+
| `api.motor_search()` | Advanced search for car-listings. |
39+
40+
## 🤓 Detailed usage
41+
2942
### saved_searches()
3043

3144
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.

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ authors = ["dunderrrrrr <[email protected]>"]
33
description = "A python API wrapper for blocket.se"
44
name = "blocket_api"
55
readme = "README.md"
6-
version = "0.1.4"
6+
version = "0.1.5"
77

88
[tool.poetry.dependencies]
99
httpx = "^0.27.0"

0 commit comments

Comments
 (0)