Query Home

Last Updated on : 2024-09-10 09:51:51

Based on the home ID, query the basic information about the specified home.

API address

GET: /v1.0/homes/{home_id}

Request parameter

Parameter name	Type	IN	Required	Description
home_id	Long	uri	true	The home ID.

Return parameter

Parameter name	Type	Description
result	HomeRes	The returned result.

Description of result

Parameter name	Type	Description
home_id	Long	The home ID.
name	String	The name of the specified home.
lon	Double	The longitude.
lat	Double	The latitude.
geo_name	String	The detailed address.

Request example

GET: /v1.0/homes/157913***

Return example

{
    "tid": "b504ee827d3911eeaf40161d72836dc2",
    "result": {
        "lon": 120.06379847441336,
        "name": "My Home",
        "home_id": 16900015,
        "lat": 30.302736025227816,
        "geo_name": "Hangzhou Grand Center"
    },
    "t": 1699339729904,
    "success": true
}

Error code

For more information, see error code.

Prev DocAdd Home

Next DocModify Home