Address search
Enter address text to retrieve related Point of Interest (POI) information. This service supports address searches using Pinyin (full Pinyin) and Chinese characters, including typos. You can also specify the number of search results to return.
Test
You can test the API in the Address Purification console.
Request parameters
Name | Type | Required | Example | Description |
Action | String | Yes | GetAddressSearch | A required parameter. Value: GetAddressSearch. |
AppKey | String | Yes | Axqwerasdf1a | The AppKey of the project. |
ServiceCode | String | Yes | addrp | Static field: addrp |
Text | String | Yes | Wenyixi Road No. 969 | The text content. |
MaxReturn | String | No | 5 | The number of search results. |
DefaultProvince | String | No | Zhejiang Province | The default province. |
DefaultCity | String | No | Hangzhou City | The default city. |
DefaultDistrict | String | No | Yuhang District | The default administrative region. |
Response data
Name | Type | Example | Description |
Data | String | {"address_search":[{"address":"Wenyixi Road No. 969","name":"Alibaba Phase 5 (under construction)","std_addr":"Zhejiang Province Hangzhou City Yuhang District Wuchang Street Wenyixi Road No. 969 Alibaba Phase 5 (under construction)"},{"address":"Wenyixi Road No. 969","name":"Alibaba Xixi Campus","std_addr":"Zhejiang Province Hangzhou City Yuhang District Wuchang Street Wenyixi Road No. 969 Alibaba Xixi Campus"},{"address":"Wenyixi Road No. 969","name":"Alibaba Xixi Campus (North Gate 1)","std_addr":"Zhejiang Province Hangzhou City Yuhang District Wuchang Street Wenyixi Road No. 969 Alibaba Xixi Campus (North Gate 1)"},{"address":"Wenyixi Road No. 969","name":"Alibaba Xixi Campus (North Gate 2)","std_addr":"Zhejiang Province Hangzhou City Yuhang District Wuchang Street Wenyixi Road No. 969 Alibaba Xixi Campus (North Gate 2)"},{"address":"Wuchang Street Wenyixi Road No. 969","name":"Taobao City Ali Auto","std_addr":"Zhejiang Province Hangzhou City Yuhang District Wuchang Street Wenyixi Road No. 969 Taobao City Ali Auto"}],"status":"OK","time_used":{"rt":{"segment":0.00003123283386230469,"address_correct":0.004131793975830078,"address_search":0.0687861442565918,"structure":0.005232095718383789},"start":1619318276.1305299}} | address_search: The address search results. time_used: The time consumed by the algorithm. status: The status. |
RequestId | String | E0627DDE-28D7-4C00-A611-E047DF81AF05 | RequestId |
Examples
Request example
http(s)://[Endpoint]/?Action=GetAddressSearch
&AppKey=Axqwerasdf1a
&ServiceCode=addrp
&Text=Wenyixi Road No. 969
&<Common request parameters>Response example
XML format
<RequestId>D4749823-A66E-4CF1-A3DE-0FB84E9C4031</RequestId>
<Data>
<address_search>
<address>Wenyixi Road No. 969</address>
<name>Alibaba Phase 5 (under construction)</name>
<std_addr>Zhejiang Province Hangzhou City Yuhang District Wuchang Street Wenyixi Road No. 969 Alibaba Phase 5 (under construction)</std_addr>
</address_search>
<address_search>
<address>Wenyixi Road No. 969</address>
<name>Alibaba Xixi Campus</name>
<std_addr>Zhejiang Province Hangzhou City Yuhang District Wuchang Street Wenyixi Road No. 969 Alibaba Xixi Campus</std_addr>
</address_search>
<address_search>
<address>Wenyixi Road No. 969</address>
<name>Alibaba Xixi Campus (North Gate 1)</name>
<std_addr>Zhejiang Province Hangzhou City Yuhang District Wuchang Street Wenyixi Road No. 969 Alibaba Xixi Campus (North Gate 1)</std_addr>
</address_search>
<address_search>
<address>Wenyixi Road No. 969</address>
<name>Alibaba Xixi Campus (North Gate 2)</name>
<std_addr>Zhejiang Province Hangzhou City Yuhang District Wuchang Street Wenyixi Road No. 969 Alibaba Xixi Campus (North Gate 2)</std_addr>
</address_search>
<address_search>
<address>Wuchang Street Wenyixi Road No. 969</address>
<name>Taobao City Ali Auto</name>
<std_addr>Zhejiang Province Hangzhou City Yuhang District Wuchang Street Wenyixi Road No. 969 Taobao City Ali Auto</std_addr>
</address_search>
<status>OK</status>
<time_used>
<rt>
<segment>0.00003123283386230469</segment>
<address_correct>0.004131793975830078</address_correct>
<address_search>0.0687861442565918</address_search>
<structure>0.005232095718383789</structure>
</rt>
<start>1619318276.1305299</start>
</time_used>
</Data>JSON format
{"RequestId":"D4749823-A66E-4CF1-A3DE-0FB84E9C4031","Data":{"address_search":
[{"address":"Wenyixi Road No. 969","name":"Alibaba Phase 5 (under construction)","std_addr":"Zhejiang Province Hangzhou City Yuhang District Wuchang
Street Wenyixi Road No. 969 Alibaba Phase 5 (under construction)"},{"address":"Wenyixi Road No. 969","name":"Alibaba Xixi
Campus","std_addr":"Zhejiang Province Hangzhou City Yuhang District Wuchang Street Wenyixi Road No. 969 Alibaba Xixi Campus"},
{"address":"Wenyixi Road No. 969","name":"Alibaba Xixi Campus (North Gate 1)","std_addr":"Zhejiang Province Hangzhou City Yuhang District
Wuchang Street Wenyixi Road No. 969 Alibaba Xixi Campus (North Gate 1)"},{"address":"Wenyixi Road No. 969","name":"Alibaba
Xixi Campus (North Gate 2)","std_addr":"Zhejiang Province Hangzhou City Yuhang District Wuchang Street Wenyixi Road No. 969 Alibaba Xixi Campus (North
Gate 2)"},{"address":"Wuchang Street Wenyixi Road No. 969","name":"Taobao City Ali Auto","std_addr":"Zhejiang Province Hangzhou City
Yuhang District Wuchang Street Wenyixi Road No. 969 Taobao City Ali Auto"}],"status":"OK","time_used":{"rt":
{"segment":0.00003123283386230469,"address_correct":0.004131793975830078,"address_search":
0.0687861442565918,"structure":0.005232095718383789},"start":1619318276.1305299}}}Error codes
HTTP code | Error code | Error message | Description |
403 | Forbidden.NoAuth | Failed to perform user authentication. | User authentication failed. |
500 | InternalError | A service error occurred. | An internal service error occurred. |
400 | InvalidParameter | The parameter is invalid. | The parameter is invalid. |
404 | ResourceDoesNotExist | The resource does not exist. | The resource does not exist. |
429 | Throttling.User | Flow control has been triggered. | Throttling was triggered. |
400 | UserStatusInvalid | The user status is invalid. | The user status is invalid. |
For more error codes, see the Error Center.