homegater

Name	homegater JSON
Version	0.1.1 JSON
	download
home_page	https://github.com/babiscodelab/ch-homegate/tree/main
Summary	A Python package to retrieve data from homegate.ch
upload_time	2025-02-09 14:29:39
maintainer	None
docs_url	None
author	Charalampos (Babis) Moustafelos
requires_python	<4.0,>=3.11
license	None
keywords	homegate data api
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # Homegater

This is a client python api aim to query homegate.ch buy and rent properties. The python package and client API is done purely for academic/experimental purpose and not approved for any commercial usage. It is not an official API.


# Installation

If you want to ge the latest version


```
pip install homegater
```

# Usage


```python

from homegater import Homegate

api = Homegate()

# Search by zip-code
api.search_rent_listings(location="8001")

# Search by Gemeinde
api.search_buy_listings(location="Horgen")

# Search in Switzerland
api.search_buy_listings()

# Specify arguments
kwargs = {"monthlyRent": {"from": 100, "to": 3000000}}
api.search_rent_listings(location="8001", **kwargs)

```

More examples can be found on [API usage examples](./examples/api_usage.py).

## Location

The location should be a valid location used in homegate.ch search. The suggested and most straight forward/robust is to provide the zip codes.


## Further Improvements

Make the location searching more robust even when the user provides the location name.
            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/babiscodelab/ch-homegate/tree/main",
    "name": "homegater",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4.0,>=3.11",
    "maintainer_email": null,
    "keywords": "homegate, data, api",
    "author": "Charalampos (Babis) Moustafelos",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/36/1f/57820542d96d47710643c9178e066d148601da507206ce86e4ee52a85e25/homegater-0.1.1.tar.gz",
    "platform": null,
    "description": "# Homegater\n\nThis is a client python api aim to query homegate.ch buy and rent properties. The python package and client API is done purely for academic/experimental purpose and not approved for any commercial usage. It is not an official API.\n\n\n# Installation\n\nIf you want to ge the latest version\n\n\n```\npip install homegater\n```\n\n# Usage\n\n\n```python\n\nfrom homegater import Homegate\n\napi = Homegate()\n\n# Search by zip-code\napi.search_rent_listings(location=\"8001\")\n\n# Search by Gemeinde\napi.search_buy_listings(location=\"Horgen\")\n\n# Search in Switzerland\napi.search_buy_listings()\n\n# Specify arguments\nkwargs = {\"monthlyRent\": {\"from\": 100, \"to\": 3000000}}\napi.search_rent_listings(location=\"8001\", **kwargs)\n\n```\n\nMore examples can be found on [API usage examples](./examples/api_usage.py).\n\n## Location\n\nThe location should be a valid location used in homegate.ch search. The suggested and most straight forward/robust is to provide the zip codes.\n\n\n## Further Improvements\n\nMake the location searching more robust even when the user provides the location name.",
    "bugtrack_url": null,
    "license": null,
    "summary": "A Python package to retrieve data from homegate.ch",
    "version": "0.1.1",
    "project_urls": {
        "Homepage": "https://github.com/babiscodelab/ch-homegate/tree/main",
        "Repository": "https://github.com/babiscodelab/ch-homegate/tree/main"
    },
    "split_keywords": [
        "homegate",
        " data",
        " api"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "8b048ba62820758000a6738b4f82ca16aba04f20853ad383280311656cf932c5",
                "md5": "a997cca0c6239568191044a54a4d3a48",
                "sha256": "e9739d51d53a7201d66bd6799c8a962fab8f4d6c5e1003316035f5e7d0bd60ba"
            },
            "downloads": -1,
            "filename": "homegater-0.1.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "a997cca0c6239568191044a54a4d3a48",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.11",
            "size": 4546,
            "upload_time": "2025-02-09T14:29:38",
            "upload_time_iso_8601": "2025-02-09T14:29:38.242154Z",
            "url": "https://files.pythonhosted.org/packages/8b/04/8ba62820758000a6738b4f82ca16aba04f20853ad383280311656cf932c5/homegater-0.1.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "361f57820542d96d47710643c9178e066d148601da507206ce86e4ee52a85e25",
                "md5": "80e18ca3e33980f6a3979b673ae337c2",
                "sha256": "c5fda12f4bf1d4203cbb62da57b3bafc9dcd5669b2b28fb456b200ff84961b34"
            },
            "downloads": -1,
            "filename": "homegater-0.1.1.tar.gz",
            "has_sig": false,
            "md5_digest": "80e18ca3e33980f6a3979b673ae337c2",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.11",
            "size": 4060,
            "upload_time": "2025-02-09T14:29:39",
            "upload_time_iso_8601": "2025-02-09T14:29:39.779397Z",
            "url": "https://files.pythonhosted.org/packages/36/1f/57820542d96d47710643c9178e066d148601da507206ce86e4ee52a85e25/homegater-0.1.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-02-09 14:29:39",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "babiscodelab",
    "github_project": "ch-homegate",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "homegater"
}