Address Input Autocomplete
Enter an address to receive address suggestions.
Test
You can run API tests in the Address Purification console.
Request parameters
Name | Type | Required | Example value | Description |
Action | String | Yes | GetInputSearch | Required parameter. Value: GetInputSearch. |
AppKey | String | Yes | Axqwerasdf1a | Project AppKey |
ServiceCode | String | Yes | addrp | Static field: addrp |
Text | String | Yes | Wenyi West Road 969; Yuhang District Alibaba | Text content |
DefaultProvince | String | No | Zhejiang Province | Default province |
DefaultCity | String | No | Hangzhou City | Default city |
DefaultDistrict | String | No | Yuhang District | Default administrative region |
Response data
Name | Type | Example value | Description |
Data | String | {"input_search":["Zhejiang Province Hangzhou City Yuhang District Wuchang Subdistrict Wenyi West Road 969 Alibaba Phase 5 (Under Construction)","Zhejiang Province Hangzhou City Yuhang District Wuchang Subdistrict Wenyi West Road 969 Alibaba Xixi Campus","Zhejiang Province Hangzhou City Yuhang District Wuchang Subdistrict Wenyi West Road 969 Alibaba Xixi Campus (North Gate 1)","Zhejiang Province Hangzhou City Yuhang District Wuchang Subdistrict Wenyi West Road 969 Alibaba Xixi Campus (North Gate 2)","Zhejiang Province Hangzhou City Yuhang District Wuchang Subdistrict Wenyi West Road 969 Taobao City Alibaba Auto"],"status":"OK","time_used":{"rt":{"input_search":0.000014781951904296875,"segment":0.0000324249267578125,"address_correct":0.004187583923339844,"address_search":0.07518362998962402,"structure":0.005253791809082031},"start":1619181931.496255}} | input_search: Address input autocomplete results time_used: Algorithm processing time status: Status |
RequestId | String | E0627DDE-28D7-4C00-A611-E047DF81AF05 | RequestId |
Examples
Sample request
http(s)://[Endpoint]/?Action=GetInputSearch
&AppKey=Axqwerasdf1a
&ServiceCode=addrp
&Text=Wenyi West Road 969
&<Common request parameters>Sample success response
XML format
<RequestId>264F5E1C-D01B-43E7-BE12-3B19E02C3EB0</RequestId>
<Data>
<input_search>Zhejiang Province Hangzhou City Yuhang District Wuchang Subdistrict Wenyi West Road 969 Alibaba Phase 5 (Under Construction)</input_search>
<input_search>Zhejiang Province Hangzhou City Yuhang District Wuchang Subdistrict Wenyi West Road 969 Alibaba Xixi Campus</input_search>
<input_search>Zhejiang Province Hangzhou City Yuhang District Wuchang Subdistrict Wenyi West Road 969 Alibaba Xixi Campus (North Gate 1)</input_search>
<input_search>Zhejiang Province Hangzhou City Yuhang District Wuchang Subdistrict Wenyi West Road 969 Alibaba Xixi Campus (North Gate 2)</input_search>
<input_search>Zhejiang Province Hangzhou City Yuhang District Wuchang Subdistrict Wenyi West Road 969 Taobao City Alibaba Auto</input_search>
<status>OK</status>
<time_used>
<rt>
<input_search>0.000014781951904296875</input_search>
<segment>0.0000324249267578125</segment>
<address_correct>0.004187583923339844</address_correct>
<address_search>0.07518362998962402</address_search>
<structure>0.005253791809082031</structure>
</rt>
<start>1619181931.496255</start>
</time_used>
</Data>JSON format
{"RequestId":"264F5E1C-D01B-43E7-BE12-3B19E02C3EB0","Data":{"input_search":["Zhejiang Province Hangzhou City Yuhang District Wuchang Subdistrict Wenyi West Road 969 Alibaba Phase 5 (Under Construction)","Zhejiang Province Hangzhou City Yuhang District Wuchang Subdistrict Wenyi West Road 969 Alibaba Xixi Campus","Zhejiang Province Hangzhou City Yuhang District Wuchang Subdistrict Wenyi West Road 969 Alibaba Xixi Campus (North Gate 1)","Zhejiang Province Hangzhou City Yuhang District Wuchang Subdistrict Wenyi West Road 969 Alibaba Xixi Campus (North Gate 2)","Zhejiang Province Hangzhou City Yuhang District Wuchang Subdistrict Wenyi West Road 969 Taobao City Alibaba Auto"],"status":"OK","time_used":{"rt":{"input_search":0.000014781951904296875,"segment":0.0000324249267578125,"address_correct":0.004187583923339844,"address_search":0.07518362998962402,"structure":0.005253791809082031},"start":1619181931.496255}}}Error codes
HttpCode | Error code | Error message | Description |
403 | Forbidden.NoAuth | Failed to perform user authentication. | User authentication failed |
500 | InternalError | A service error occurred. | Service internal error |
400 | InvalidParameter | The parameter is invalid. | Invalid parameter |
404 | ResourceDoesNotExist | The resource does not exist. | Resource does not exist |
429 | Throttling.User | Flow control has been triggered. | Throttling triggered |
400 | UserStatusInvalid | The user status is invalid. | Invalid user status |
For more information, see Error Center.