| Name | j-realty-api JSON |
| Version |
0.2
JSON |
| download |
| home_page | |
| Summary | j_realty_api: Knowing the real estate transaction prices in Japan. |
| upload_time | 2023-11-08 07:56:11 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.10 |
| license | MIT License |
| keywords |
japan
real estate transaction price
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# j_realty_api: Knowing the real estate transaction prices in Japan.
## What is it?
The j_realty_api is a wrapper for an API that allows you to retrieve real estate transaction prices in Japan, utilizing the [Real Estate Transaction Price Information Retrieval API](https://www.land.mlit.go.jp/webland/api.html) provided by Japan's Ministry of Land, Infrastructure, Transport and Tourism. It makes the use of the API more convenient. It supports both Japanese and English APIs.
A feature of the tool is that it includes a tool to obtain prefecture codes and municipality codes, making it easier to search for data.
j_realty_apiは、日本の国土交通省が出している[不動産取引価格情報取得API](https://www.land.mlit.go.jp/webland/api.html)を使い、日本の不動産取引価格を取得できる、APIのラッパーです。APIの利用が容易になります。日本語API、英語APIの両方に対応しています。
ツールの特徴は、都道府県コードと市町村コードを取得できるツールを加えて、データを探しやすくした点です。
## Installation
- インストール方法
```sh
pip install j_realty_api
```
```sh
pip install git+https://github.com/mazarimono/j_realty_api.git
```
## How to Use
### 使い方
- English
- [sample notebook](https://github.com/mazarimono/j_realty_api/tree/main/samples/sample_j_realty_en.ipynb)
```python
# English
from j_realty_api import j_realty_en as jrn
j = jrn.CityCode('Kyoto')
pref_code = j.pref_code
city_code = j.city_code('kyoto')
pt = jrn.PropTransactions(pref_code, city_code, 20223, 20224)
df = pt.get_data()
# Can get Prices with forex(USD, EUR, CNY) (from ver0.2)
df_forex = pt.to_forex(df, 'USD')
```
- 日本語
- [sample notebook](https://github.com/mazarimono/j_realty_api/tree/main/samples/sample_j_realty_jp.ipynb)
```python
from j_realty_api import j_realty_jp as jrp
j = jrp.CityCode('京都')
pref_code = j.pref_code
city_code = j.city_code('京都')
pt = jrp.PropTransactions(pref_code, city_code, 20223, 20224)
df = pt.get_data()
```
## Licence
MIT
Raw data
{
"_id": null,
"home_page": "",
"name": "j-realty-api",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "",
"keywords": "japan,real estate transaction price",
"author": "",
"author_email": "HideyukiO <hogawa098@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/73/15/a6df2b08c6815a0aab53277249b7e807e6e8392d39ff7ca97173a24b8dbe/j_realty_api-0.2.tar.gz",
"platform": null,
"description": "# j_realty_api: Knowing the real estate transaction prices in Japan.\r\n\r\n## What is it?\r\n\r\nThe j_realty_api is a wrapper for an API that allows you to retrieve real estate transaction prices in Japan, utilizing the [Real Estate Transaction Price Information Retrieval API](https://www.land.mlit.go.jp/webland/api.html) provided by Japan's Ministry of Land, Infrastructure, Transport and Tourism. It makes the use of the API more convenient. It supports both Japanese and English APIs.\r\n\r\nA feature of the tool is that it includes a tool to obtain prefecture codes and municipality codes, making it easier to search for data.\r\n\r\nj_realty_api\u306f\u3001\u65e5\u672c\u306e\u56fd\u571f\u4ea4\u901a\u7701\u304c\u51fa\u3057\u3066\u3044\u308b[\u4e0d\u52d5\u7523\u53d6\u5f15\u4fa1\u683c\u60c5\u5831\u53d6\u5f97API](https://www.land.mlit.go.jp/webland/api.html)\u3092\u4f7f\u3044\u3001\u65e5\u672c\u306e\u4e0d\u52d5\u7523\u53d6\u5f15\u4fa1\u683c\u3092\u53d6\u5f97\u3067\u304d\u308b\u3001API\u306e\u30e9\u30c3\u30d1\u30fc\u3067\u3059\u3002API\u306e\u5229\u7528\u304c\u5bb9\u6613\u306b\u306a\u308a\u307e\u3059\u3002\u65e5\u672c\u8a9eAPI\u3001\u82f1\u8a9eAPI\u306e\u4e21\u65b9\u306b\u5bfe\u5fdc\u3057\u3066\u3044\u307e\u3059\u3002\r\n\r\n\u30c4\u30fc\u30eb\u306e\u7279\u5fb4\u306f\u3001\u90fd\u9053\u5e9c\u770c\u30b3\u30fc\u30c9\u3068\u5e02\u753a\u6751\u30b3\u30fc\u30c9\u3092\u53d6\u5f97\u3067\u304d\u308b\u30c4\u30fc\u30eb\u3092\u52a0\u3048\u3066\u3001\u30c7\u30fc\u30bf\u3092\u63a2\u3057\u3084\u3059\u304f\u3057\u305f\u70b9\u3067\u3059\u3002\r\n\r\n## Installation\r\n\r\n- \u30a4\u30f3\u30b9\u30c8\u30fc\u30eb\u65b9\u6cd5\r\n\r\n```sh\r\npip install j_realty_api\r\n```\r\n\r\n```sh\r\npip install git+https://github.com/mazarimono/j_realty_api.git\r\n```\r\n\r\n## How to Use\r\n### \u4f7f\u3044\u65b9\r\n\r\n- English\r\n - [sample notebook](https://github.com/mazarimono/j_realty_api/tree/main/samples/sample_j_realty_en.ipynb)\r\n\r\n```python\r\n# English\r\nfrom j_realty_api import j_realty_en as jrn\r\n\r\nj = jrn.CityCode('Kyoto')\r\npref_code = j.pref_code\r\ncity_code = j.city_code('kyoto')\r\npt = jrn.PropTransactions(pref_code, city_code, 20223, 20224)\r\ndf = pt.get_data()\r\n# Can get Prices with forex(USD, EUR, CNY) (from ver0.2)\r\ndf_forex = pt.to_forex(df, 'USD')\r\n```\r\n\r\n- \u65e5\u672c\u8a9e\r\n- [sample notebook](https://github.com/mazarimono/j_realty_api/tree/main/samples/sample_j_realty_jp.ipynb)\r\n\r\n```python\r\nfrom j_realty_api import j_realty_jp as jrp\r\n\r\nj = jrp.CityCode('\u4eac\u90fd')\r\npref_code = j.pref_code\r\ncity_code = j.city_code('\u4eac\u90fd')\r\npt = jrp.PropTransactions(pref_code, city_code, 20223, 20224)\r\ndf = pt.get_data()\r\n```\r\n\r\n\r\n## Licence\r\nMIT\r\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "j_realty_api: Knowing the real estate transaction prices in Japan.",
"version": "0.2",
"project_urls": {
"Repository": "https://github.com/mazarimono/j_realty_api"
},
"split_keywords": [
"japan",
"real estate transaction price"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "af85a37f827067d19735035835dcc59d49c390576dc0c8c832444aa701d90fcf",
"md5": "2fa7eba716d3a90c7659886681f17352",
"sha256": "ff2c5d5545af3835cf14af3b12dda0b825032bcd1869b5a2af180e4a2b646a03"
},
"downloads": -1,
"filename": "j_realty_api-0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2fa7eba716d3a90c7659886681f17352",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 9801,
"upload_time": "2023-11-08T07:56:09",
"upload_time_iso_8601": "2023-11-08T07:56:09.399488Z",
"url": "https://files.pythonhosted.org/packages/af/85/a37f827067d19735035835dcc59d49c390576dc0c8c832444aa701d90fcf/j_realty_api-0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7315a6df2b08c6815a0aab53277249b7e807e6e8392d39ff7ca97173a24b8dbe",
"md5": "6893b5ab0fdc7266d11f61cec69d02d6",
"sha256": "da4feb3e764fe39c331854d1b2a0330a78da1e42fb661342d19a65d385dbaee4"
},
"downloads": -1,
"filename": "j_realty_api-0.2.tar.gz",
"has_sig": false,
"md5_digest": "6893b5ab0fdc7266d11f61cec69d02d6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 10376,
"upload_time": "2023-11-08T07:56:11",
"upload_time_iso_8601": "2023-11-08T07:56:11.186590Z",
"url": "https://files.pythonhosted.org/packages/73/15/a6df2b08c6815a0aab53277249b7e807e6e8392d39ff7ca97173a24b8dbe/j_realty_api-0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-08 07:56:11",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "mazarimono",
"github_project": "j_realty_api",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "j-realty-api"
}
