地址搜索

更新时间:
复制 MD 格式

输入地址文本相关信息,返回相关POI信息,当前支持拼音搜索(全拼)、汉字搜索(包含错别字)的地址搜索,支持设置搜索结果条数。

测试

您可以在地址标准化产品控制台进行API测试。

请求参数

名称

类型

是否必选

示例值

描述

Action

String

是

GetAddressSearch

系统规定参数。取值:GetAddressSearch。

AppKey

String

是

Axqwerasdf1a

项目AppKey

ServiceCode

String

是

addrp

固定值:addrp

Text

String

是

文一西路969号

文本内容

MaxReturn

String

否

5

搜索结果条数

DefaultProvince

String

否

浙江省

默认省份

DefaultCity

String

否

杭州市

默认城市

DefaultDistrict

String

否

余杭区

默认行政区

返回数据

名称

类型

示例值

描述

Data

String

{"address_search":[{"address":"文一西路969号","name":"阿里巴巴5期(建设中)","std_addr":"浙江省 杭州市 余杭区 五常街道 文一西路 969号 阿里巴巴5期(建设中)"},{"address":"文一西路969号","name":"阿里巴巴西溪园区","std_addr":"浙江省 杭州市 余杭区 五常街道 文一西路 969号 阿里巴巴西溪园区"},{"address":"文一西路969号","name":"阿里巴巴西溪园区(北1门)","std_addr":"浙江省 杭州市 余杭区 五常街道 文一西路 969号 阿里巴巴西溪园区(北1门)"},{"address":"文一西路969号","name":"阿里巴巴西溪园区(北2门)","std_addr":"浙江省 杭州市 余杭区 五常街道 文一西路 969号 阿里巴巴西溪园区(北2门)"},{"address":"五常街道文一西路969号","name":"淘宝城阿里汽车","std_addr":"浙江省 杭州市 余杭区 五常街道 文一西路 969号 淘宝城阿里汽车"}],"status":"OK","time_used":{"rt":{"segment":0.00003123283386230469,"address_correct":0.004131793975830078,"address_search":0.0687861442565918,"structure":0.005232095718383789},"start":1619318276.1305299}}

address_search:地址搜索结果

time_used:算法处理耗时

status:状态

RequestId

String

E0627DDE-28D7-4C00-A611-E047DF81AF05

RequestId

示例

请求示例

http(s)://[Endpoint]/?Action=GetAddressSearch
&AppKey=Axqwerasdf1a
&ServiceCode=addrp
&Text=文一西路969号
&<公共请求参数>

正常返回示例

XML格式

 <RequestId>D4749823-A66E-4CF1-A3DE-0FB84E9C4031</RequestId>
 <Data>
  <address_search>
   <address>文一西路969号</address>
   <name>阿里巴巴5期(建设中)</name>
   <std_addr>浙江省 杭州市 余杭区 五常街道  文一西路 969号  阿里巴巴5期(建设中)</std_addr>
  </address_search>
  <address_search>
   <address>文一西路969号</address>
   <name>阿里巴巴西溪园区</name>
   <std_addr>浙江省 杭州市 余杭区 五常街道  文一西路 969号  阿里巴巴西溪园区</std_addr>
  </address_search>
  <address_search>
   <address>文一西路969号</address>
   <name>阿里巴巴西溪园区(北1门)</name>
   <std_addr>浙江省 杭州市 余杭区 五常街道  文一西路 969号  阿里巴巴西溪园区(北1门)</std_addr>
  </address_search>
  <address_search>
   <address>文一西路969号</address>
   <name>阿里巴巴西溪园区(北2门)</name>
   <std_addr>浙江省 杭州市 余杭区 五常街道  文一西路 969号  阿里巴巴西溪园区(北2门)</std_addr>
  </address_search>
  <address_search>
   <address>五常街道文一西路969号</address>
   <name>淘宝城阿里汽车</name>
   <std_addr>浙江省 杭州市 余杭区 五常街道  文一西路 969号  淘宝城阿里汽车</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格式

{"RequestId":"D4749823-A66E-4CF1-A3DE-0FB84E9C4031","Data":{"address_search":
[{"address":"文一西路969号","name":"阿里巴巴5期(建设中)","std_addr":"浙江省 杭州市 余杭区 五常
街道  文一西路 969号  阿里巴巴5期(建设中)"},{"address":"文一西路969号","name":"阿里巴巴西溪园
区","std_addr":"浙江省 杭州市 余杭区 五常街道  文一西路 969号  阿里巴巴西溪园区"},
{"address":"文一西路969号","name":"阿里巴巴西溪园区(北1门)","std_addr":"浙江省 杭州市 余杭区 
五常街道  文一西路 969号  阿里巴巴西溪园区(北1门)"},{"address":"文一西路969号","name":"阿里巴巴
西溪园区(北2门)","std_addr":"浙江省 杭州市 余杭区 五常街道  文一西路 969号  阿里巴巴西溪园区(北
2门)"},{"address":"五常街道文一西路969号","name":"淘宝城阿里汽车","std_addr":"浙江省 杭州市 余
杭区 五常街道  文一西路 969号  淘宝城阿里汽车"}],"status":"OK","time_used":{"rt":
{"segment":0.00003123283386230469,"address_correct":0.004131793975830078,"address_search":
0.0687861442565918,"structure":0.005232095718383789},"start":1619318276.1305299}}}

错误码

HttpCode

错误码

错误信息

描述

403

Forbidden.NoAuth

Failed to perform user authentication.

用户鉴权失败

500

InternalError

A service error occurred.

服务内部异常

400

InvalidParameter

The parameter is invalid.

参数无效

404

ResourceDoesNotExist

The resource does not exist.

资源不存在

429

Throttling.User

Flow control has been triggered.

触发流控

400

UserStatusInvalid

The user status is invalid.

用户状态无效

访问错误中心查看更多错误码。