{ "openapi": "3.0.3", "info": { "title": "高德接口", "description": "高德Web服务API向开发者提供HTTP接口，开发者可通过这些接口使用各类型的地理数据服务，返回结果支持JSON和XML格式", "termsOfService": "https://www.showapi.com/helpcenter/view#/4019/2", "version": "1.0.0" }, "servers": [ { "url": "https://route.showapi.com" } ], "paths": { "/2127-28": { "x-pointCode": 28, "x-mode": "mapping", "x-read-timeout": 5, "x-connect-timeout": 5, "post": { "summary": "多边形搜索", "description": "提供多种查询POI信息的能力，其中包括关键字搜索、周边搜索、多边形搜索、ID查询四种筛选机制。", "responses": { "200": { "description": "成功响应", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ShowapiResEnvelope" }, { "type": "object", "properties": { "showapi_res_body": { "type": "object", "properties": { "infocode": { "type": "string" }, "count": { "type": "string", "description": "搜索方案数目(最大值为1000)" }, "status": { "type": "string", "description": "结果状态值，值为0或1\n\n0：请求失败；1：请求成功" }, "pois": { "type": "array", "items": { "type": "object", "properties": { "biz_type": { "type": "array", "items": { "type": "string" }, "description": "行业类型" }, "typecode": { "type": "string", "description": "兴趣点类型编码\n\n例如：050118" }, "location": { "type": "string", "description": "经纬度\n\n格式：X,Y" }, "poiweight": { "type": "array", "items": { "type": "string" } }, "tel": { "type": "array", "items": { "type": "string" }, "description": "POI的电话" }, "parent": { "type": "string", "description": "父POI的ID\n\n当前POI如果有父POI，则返回父POI的ID。可能为空" }, "type": { "type": "string", "description": "兴趣点类型\n\n顺序为大类、中类、小类\n\n例如：餐饮服务;中餐厅;特色/地方风味餐厅" }, "photos": { "type": "array", "items": { "type": "object", "properties": { "title": { "type": "array", "items": { "type": "string" }, "description": "图片介绍" }, "url": { "type": "string", "description": "具体链接" } } }, "description": "照片相关信息\n\nextensions=all时返回" }, "id": { "type": "string", "description": "唯一ID" }, "shopinfo": { "type": "string" }, "distance": { "type": "array", "items": { "type": "string" }, "description": "离中心点距离\n\n单位：米；仅在周边搜索的时候有值返回" }, "shopid": { "type": "array", "items": { "type": "string" } }, "importance": { "type": "array", "items": { "type": "string" } }, "address": { "type": "string", "description": "地址" }, "biz_ext": { "type": "object", "properties": { "rating": { "type": "array", "items": { "type": "string" }, "description": "评分\n\n仅存在于餐饮、酒店、景点、影院类POI之下" }, "cost": { "type": "array", "items": { "type": "string" }, "description": "人均消费\n\n仅存在于餐饮、酒店、景点、影院类POI之下" } }, "description": "深度信息\n\n extensions=all时返回" }, "name": { "type": "string", "description": "名称" }, "pname": { "type": "string", "description": "POI所在省份名称\n\n若是直辖市的时候，此处直接显示市名，例如北京市" }, "childtype": { "type": "string" }, "cityname": { "type": "string", "description": "城市名\n\n 若是直辖市的时候，此处直接显示市名，例如北京市" }, "adname": { "type": "string", "description": "区域名称\n\n区县级别的返回，例如朝阳区" }, "navi_poiid": { "type": "string", "description": "POI导航id\n\n extensions=all时返回" }, "gridcode": { "type": "string", "description": "地理格ID extensions=all时返回" }, "alias": { "type": "string", "description": "别名 extensions=all时返回" }, "business_area": { "type": "string", "description": "所在商圈 extensions=all时返回" }, "parking_type": { "type": "string", "description": "停车场类型 仅在停车场类型POI的时候显示该字段 展示停车场类型，包括：地下、地面、路边 extensions=all的时候显示" }, "tag": { "type": "string", "description": "该POI的特色内容 主要出现在美食类POI中，代表特色菜 例如“烤鱼,麻辣香锅,老干妈回锅肉” extensions=all时返回" }, "indoor_map": { "type": "string", "description": "是否有室内地图标志 1，表示有室内相关数据 0，代表没有室内相关数据 extensions=all时返回" }, "indoor_data": { "type": "object", "properties": { "cpid": { "type": "string", "description": "当前POI的父级POI 如果当前POI为建筑物类POI，则cpid为自身POI ID；如果当前POI为商铺类POI，则cpid为其所在建筑物的POI ID" }, "floor": { "type": "string", "description": "楼层索引 一般会用数字表示，例如8" }, "truefloor": { "type": "string", "description": "所在楼层 一般会带有字母，例如F8" } }, "description": "室内地图相关数据 当indoor_map=0时，字段为空 extensions=all时返回" }, "entr_location": { "type": "string", "description": "POI的入口经纬度 extensions=all时返回，也可用作于POI的到达点；" }, "exit_location": { "type": "string", "description": "POI的出口经纬度" }, "pcode": { "type": "string", "description": "POI所在省份编码 extensions=all时返回" }, "email": { "type": "string", "description": "POI的电子邮箱 extensions=all时返回" }, "website": { "type": "string", "description": "POI的网址 extensions=all时返回" }, "postcode": { "type": "string", "description": "邮编 extensions=all时返回" } } }, "description": "搜索POI信息列表" }, "suggestion": { "type": "object", "properties": { "keywords": { "type": "array", "items": { "type": "string" }, "description": "关键字" }, "cities": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "名称" }, "num": { "type": "string", "description": "该城市包含此关键字的个数" }, "citycode": { "type": "string", "description": "该城市的citycode" }, "adcode": { "type": "string", "description": "该城市的adcode" } } }, "description": "城市列表" } }, "description": "城市建议列表\n\n当搜索的文本关键字在限定城市中没有返回时会返回建议城市列表；" }, "info": { "type": "string", "description": "返回状态说明\n\nstatus为0时，info返回错误原因，否则返回“OK”。详情参阅info状态表" }, "sug_address": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "搜索文本内容\n\n搜索的文本内容" }, "address": { "type": "string", "description": "地址\n\n地址描述" }, "location": { "type": "string", "description": "经纬度" }, "pname": { "type": "string", "description": "省市" }, "country": { "type": "string", "description": "国家" }, "cityname": { "type": "string", "description": "城市" }, "adcode": { "type": "string", "description": "adcode" }, "adnam": { "type": "string", "description": "区域名称" }, "district": { "type": "string", "description": "地级市或县级市" }, "aoi": { "type": "string", "description": "所属aoi" }, "street": { "type": "string", "description": "街道名称" } } }, "description": "建议地址结果\n\n当搜索结果并非是POI（是地址时），且没有搜索到POI时返回" } }, "description": "业务返回体" } } } ] } } } } }, "operationId": "2127_28_POST", "parameters": [], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ds_id": { "type": "string", "description": "数据源" }, "polygon": { "type": "string", "description": "经纬度坐标对\n\n规则：经度和纬度用\",\"分割，经度在前，纬度在后，坐标对用\"|\"分割。经纬度小数点后不得超过6位。 多边形为矩形时，可传入左上右下两顶点坐标对；其他情况下首尾坐标对需相同。" }, "keywords": { "type": "string", "description": "查询关键字\n\n规则： 多个关键字用“|”分割" }, "types": { "type": "string", "description": "查询POI类型\n\n多个类型用“|”分割；\n\n可选值：分类代码 或 汉字 （若用汉字，请严格按照附件之中的汉字填写） \n\n分类代码由六位数字组成，一共分为三个部分，前两个数字代表大类；中间两个数字代表中类；最后两个数字代表小类。\n\n若指定了某个大类，则所属的中类、小类都会被显示。\n\n例如：010000为汽车服务（大类）\n\n 010100为加油站（中类）\n\n 010101为中国石化（小类）\n\n 010900为汽车租赁（中类）\n\n 010901为汽车租赁还车（小类）\n\n当指定010000，则010100等中类、010101等小类都会被包含。\n\n当指定010900，则010901等小类都会被包含\n\n详情请查看POI分类编码和城市编码表 \n\n\n\n当keywords和types均为空的时候，默认指定types为050000（餐饮服务）、070000（生活服务）、120000（商务住宅）" }, "offset": { "type": "string", "description": "每页记录数据\n\n强烈建议不超过25，若超过25可能造成访问报错" }, "page": { "type": "string", "description": "当前页数\n\n最大翻页数100" }, "extensions": { "type": "string", "description": "返回结果控制\n\n此项默认返回基本地址信息；取值为all返回地址信息、附近POI、道路以及道路交叉口信息。" } }, "required": [ "ds_id", "polygon" ] } } } } } }, "/2127-27": { "x-pointCode": 27, "x-mode": "mapping", "x-read-timeout": 5, "x-connect-timeout": 5, "post": { "summary": "周边搜索", "description": "提供多种查询POI信息的能力，其中包括关键字搜索、周边搜索、多边形搜索、ID查询四种筛选机制。", "responses": { "200": { "description": "成功响应", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ShowapiResEnvelope" }, { "type": "object", "properties": { "showapi_res_body": { "type": "object", "properties": { "infocode": { "type": "string" }, "count": { "type": "string", "description": "搜索方案数目(最大值为1000)" }, "status": { "type": "string", "description": "结果状态值，值为0或1\n\n0：请求失败；1：请求成功" }, "pois": { "type": "array", "items": { "type": "object", "properties": { "biz_type": { "type": "array", "items": { "type": "string" }, "description": "行业类型" }, "typecode": { "type": "string", "description": "兴趣点类型编码\n\n例如：050118" }, "location": { "type": "string", "description": "经纬度\n\n格式：X,Y" }, "poiweight": { "type": "array", "items": { "type": "string" } }, "tel": { "type": "array", "items": { "type": "string" }, "description": "POI的电话" }, "parent": { "type": "string", "description": "父POI的ID\n\n当前POI如果有父POI，则返回父POI的ID。可能为空" }, "type": { "type": "string", "description": "兴趣点类型\n\n顺序为大类、中类、小类\n\n例如：餐饮服务;中餐厅;特色/地方风味餐厅" }, "photos": { "type": "array", "items": { "type": "object", "properties": { "title": { "type": "array", "items": { "type": "string" }, "description": "图片介绍" }, "url": { "type": "string", "description": "具体链接" } } }, "description": "照片相关信息\n\nextensions=all时返回" }, "id": { "type": "string", "description": "唯一ID" }, "shopinfo": { "type": "string" }, "distance": { "type": "array", "items": { "type": "string" }, "description": "离中心点距离\n\n单位：米；仅在周边搜索的时候有值返回" }, "shopid": { "type": "array", "items": { "type": "string" } }, "importance": { "type": "array", "items": { "type": "string" } }, "address": { "type": "string", "description": "地址" }, "biz_ext": { "type": "object", "properties": { "rating": { "type": "array", "items": { "type": "string" }, "description": "评分\n\n仅存在于餐饮、酒店、景点、影院类POI之下" }, "cost": { "type": "array", "items": { "type": "string" }, "description": "人均消费\n\n仅存在于餐饮、酒店、景点、影院类POI之下" } }, "description": "深度信息\n\n extensions=all时返回" }, "name": { "type": "string", "description": "名称" }, "pname": { "type": "string", "description": "POI所在省份名称\n\n若是直辖市的时候，此处直接显示市名，例如北京市" }, "childtype": { "type": "string" }, "cityname": { "type": "string", "description": "城市名\n\n 若是直辖市的时候，此处直接显示市名，例如北京市" }, "adname": { "type": "string", "description": "区域名称\n\n区县级别的返回，例如朝阳区" }, "navi_poiid": { "type": "string", "description": "POI导航id\n\n extensions=all时返回" }, "gridcode": { "type": "string", "description": "地理格ID extensions=all时返回" }, "alias": { "type": "string", "description": "别名 extensions=all时返回" }, "business_area": { "type": "string", "description": "所在商圈 extensions=all时返回" }, "parking_type": { "type": "string", "description": "停车场类型 仅在停车场类型POI的时候显示该字段 展示停车场类型，包括：地下、地面、路边 extensions=all的时候显示" }, "tag": { "type": "string", "description": "该POI的特色内容 主要出现在美食类POI中，代表特色菜 例如“烤鱼,麻辣香锅,老干妈回锅肉” extensions=all时返回" }, "indoor_map": { "type": "string", "description": "是否有室内地图标志 1，表示有室内相关数据 0，代表没有室内相关数据 extensions=all时返回" }, "indoor_data": { "type": "object", "properties": { "cpid": { "type": "string", "description": "当前POI的父级POI 如果当前POI为建筑物类POI，则cpid为自身POI ID；如果当前POI为商铺类POI，则cpid为其所在建筑物的POI ID" }, "floor": { "type": "string", "description": "楼层索引 一般会用数字表示，例如8" }, "truefloor": { "type": "string", "description": "所在楼层 一般会带有字母，例如F8" } }, "description": "室内地图相关数据 当indoor_map=0时，字段为空 extensions=all时返回" }, "entr_location": { "type": "string", "description": "POI的入口经纬度 extensions=all时返回，也可用作于POI的到达点；" }, "exit_location": { "type": "string", "description": "POI的出口经纬度" }, "pcode": { "type": "string", "description": "POI所在省份编码 extensions=all时返回" }, "email": { "type": "string", "description": "POI的电子邮箱 extensions=all时返回" }, "website": { "type": "string", "description": "POI的网址 extensions=all时返回" }, "postcode": { "type": "string", "description": "邮编 extensions=all时返回" } } }, "description": "搜索POI信息列表" }, "suggestion": { "type": "object", "properties": { "keywords": { "type": "array", "items": { "type": "string" }, "description": "关键字" }, "cities": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "名称" }, "num": { "type": "string", "description": "该城市包含此关键字的个数" }, "citycode": { "type": "string", "description": "该城市的citycode" }, "adcode": { "type": "string", "description": "该城市的adcode" } } }, "description": "城市列表" } }, "description": "城市建议列表\n\n当搜索的文本关键字在限定城市中没有返回时会返回建议城市列表；" }, "info": { "type": "string", "description": "返回状态说明\n\nstatus为0时，info返回错误原因，否则返回“OK”。详情参阅info状态表" }, "sug_address": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "搜索文本内容\n\n搜索的文本内容" }, "address": { "type": "string", "description": "地址\n\n地址描述" }, "location": { "type": "string", "description": "经纬度" }, "pname": { "type": "string", "description": "省市" }, "country": { "type": "string", "description": "国家" }, "cityname": { "type": "string", "description": "城市" }, "adcode": { "type": "string", "description": "adcode" }, "adnam": { "type": "string", "description": "区域名称" }, "district": { "type": "string", "description": "地级市或县级市" }, "aoi": { "type": "string", "description": "所属aoi" }, "street": { "type": "string", "description": "街道名称" } } }, "description": "建议地址结果\n\n当搜索结果并非是POI（是地址时），且没有搜索到POI时返回" } }, "description": "业务返回体" } } } ] } } } } }, "operationId": "2127_27_POST", "parameters": [], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ds_id": { "type": "string", "description": "数据源" }, "location": { "type": "string", "description": "中心点坐标 规则： 经度和纬度用\",\"分割，经度在前，纬度在后，经纬度小数点后不得超过6位" }, "keywords": { "type": "string", "description": "查询关键字 规则： 多个关键字用“|”分割" }, "types": { "type": "string", "description": "查询POI类型\n\n多个类型用“|”分割；\n\n可选值：分类代码 或 汉字 （若用汉字，请严格按照附件之中的汉字填写） \n\n分类代码由六位数字组成，一共分为三个部分，前两个数字代表大类；中间两个数字代表中类；最后两个数字代表小类。\n\n若指定了某个大类，则所属的中类、小类都会被显示。\n\n例如：010000为汽车服务（大类）\n\n 010100为加油站（中类）\n\n 010101为中国石化（小类）\n\n 010900为汽车租赁（中类）\n\n 010901为汽车租赁还车（小类）\n\n当指定010000，则010100等中类、010101等小类都会被包含。\n\n当指定010900，则010901等小类都会被包含\n\n详情请查看POI分类编码和城市编码表 \n\n\n\n当keywords和types均为空的时候，默认指定types为050000（餐饮服务）、070000（生活服务）、120000（商务住宅）" }, "city": { "type": "string", "description": "查询城市\n\n可选值：城市中文、中文全拼、citycode、adcode\n\n如：北京/beijing/010/110000\n\n当用户指定的经纬度和city出现冲突，若范围内有用户指定city的数据，则返回相关数据，否则返回为空。\n\n如：经纬度指定石家庄，而city却指定天津，若搜索范围内有天津的数据则返回相关数据，否则返回为空。" }, "radius": { "type": "string", "description": "查询半径\n\n取值范围:0-50000。规则：大于50000按默认值，单位：米" }, "sortrule": { "type": "string", "description": "排序规则\n\n规定返回结果的排序规则。\n\n按距离排序：distance；综合排序：weight" }, "offset": { "type": "string", "description": "每页记录数据\n\n强烈建议不超过25，若超过25可能造成访问报错" }, "page": { "type": "string", "description": "当前页数\n\n最大翻页数100" }, "extensions": { "type": "string", "description": "返回结果控制\n\n此项默认返回基本地址信息；取值为all返回地址信息、附近POI、道路以及道路交叉口信息。" } }, "required": [ "ds_id", "location" ] } } } } } }, "/2127-26": { "x-pointCode": 26, "x-mode": "mapping", "x-read-timeout": 5, "x-connect-timeout": 5, "post": { "summary": "关键词搜索", "description": "提供多种查询POI信息的能力，其中包括关键字搜索、周边搜索、多边形搜索、ID查询四种筛选机制。", "responses": { "200": { "description": "成功响应", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ShowapiResEnvelope" }, { "type": "object", "properties": { "showapi_res_body": { "type": "object", "properties": { "infocode": { "type": "string" }, "count": { "type": "string", "description": "搜索方案数目(最大值为1000)" }, "status": { "type": "string", "description": "结果状态值，值为0或1\n\n0：请求失败；1：请求成功" }, "pois": { "type": "array", "items": { "type": "object", "properties": { "biz_type": { "type": "array", "items": { "type": "string" }, "description": "行业类型" }, "typecode": { "type": "string", "description": "兴趣点类型编码\n\n例如：050118" }, "location": { "type": "string", "description": "经纬度\n\n格式：X,Y" }, "poiweight": { "type": "array", "items": { "type": "string" } }, "tel": { "type": "array", "items": { "type": "string" }, "description": "POI的电话" }, "parent": { "type": "string", "description": "父POI的ID\n\n当前POI如果有父POI，则返回父POI的ID。可能为空" }, "type": { "type": "string", "description": "兴趣点类型\n\n顺序为大类、中类、小类\n\n例如：餐饮服务;中餐厅;特色/地方风味餐厅" }, "photos": { "type": "array", "items": { "type": "object", "properties": { "title": { "type": "array", "items": { "type": "string" }, "description": "图片介绍" }, "url": { "type": "string", "description": "具体链接" } } }, "description": "照片相关信息\n\nextensions=all时返回" }, "id": { "type": "string", "description": "唯一ID" }, "shopinfo": { "type": "string" }, "distance": { "type": "array", "items": { "type": "string" }, "description": "离中心点距离\n\n单位：米；仅在周边搜索的时候有值返回" }, "shopid": { "type": "array", "items": { "type": "string" } }, "importance": { "type": "array", "items": { "type": "string" } }, "address": { "type": "string", "description": "地址" }, "biz_ext": { "type": "object", "properties": { "rating": { "type": "array", "items": { "type": "string" }, "description": "评分\n\n仅存在于餐饮、酒店、景点、影院类POI之下" }, "cost": { "type": "array", "items": { "type": "string" }, "description": "人均消费\n\n仅存在于餐饮、酒店、景点、影院类POI之下" } }, "description": "深度信息\n\n extensions=all时返回" }, "name": { "type": "string", "description": "名称" }, "pname": { "type": "string", "description": "POI所在省份名称\n\n若是直辖市的时候，此处直接显示市名，例如北京市" }, "childtype": { "type": "string" }, "cityname": { "type": "string", "description": "城市名\n\n 若是直辖市的时候，此处直接显示市名，例如北京市" }, "adname": { "type": "string", "description": "区域名称\n\n区县级别的返回，例如朝阳区" }, "navi_poiid": { "type": "string", "description": "POI导航id\n\n extensions=all时返回" }, "gridcode": { "type": "string", "description": "地理格ID extensions=all时返回" }, "alias": { "type": "string", "description": "别名 extensions=all时返回" }, "business_area": { "type": "string", "description": "所在商圈 extensions=all时返回" }, "parking_type": { "type": "string", "description": "停车场类型 仅在停车场类型POI的时候显示该字段 展示停车场类型，包括：地下、地面、路边 extensions=all的时候显示" }, "tag": { "type": "string", "description": "该POI的特色内容 主要出现在美食类POI中，代表特色菜 例如“烤鱼,麻辣香锅,老干妈回锅肉” extensions=all时返回" }, "indoor_map": { "type": "string", "description": "是否有室内地图标志 1，表示有室内相关数据 0，代表没有室内相关数据 extensions=all时返回" }, "indoor_data": { "type": "object", "properties": { "cpid": { "type": "string", "description": "当前POI的父级POI 如果当前POI为建筑物类POI，则cpid为自身POI ID；如果当前POI为商铺类POI，则cpid为其所在建筑物的POI ID" }, "floor": { "type": "string", "description": "楼层索引 一般会用数字表示，例如8" }, "truefloor": { "type": "string", "description": "所在楼层 一般会带有字母，例如F8" } }, "description": "室内地图相关数据 当indoor_map=0时，字段为空 extensions=all时返回" }, "entr_location": { "type": "string", "description": "POI的入口经纬度 extensions=all时返回，也可用作于POI的到达点；" }, "exit_location": { "type": "string", "description": "POI的出口经纬度" }, "pcode": { "type": "string", "description": "POI所在省份编码 extensions=all时返回" }, "email": { "type": "string", "description": "POI的电子邮箱 extensions=all时返回" }, "website": { "type": "string", "description": "POI的网址 extensions=all时返回" }, "postcode": { "type": "string", "description": "邮编 extensions=all时返回" } } }, "description": "搜索POI信息列表" }, "suggestion": { "type": "object", "properties": { "keywords": { "type": "array", "items": { "type": "string" }, "description": "关键字" }, "cities": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "名称" }, "num": { "type": "string", "description": "该城市包含此关键字的个数" }, "citycode": { "type": "string", "description": "该城市的citycode" }, "adcode": { "type": "string", "description": "该城市的adcode" } } }, "description": "城市列表" } }, "description": "城市建议列表\n\n当搜索的文本关键字在限定城市中没有返回时会返回建议城市列表；" }, "info": { "type": "string", "description": "返回状态说明\n\nstatus为0时，info返回错误原因，否则返回“OK”。详情参阅info状态表" }, "sug_address": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "搜索文本内容\n\n搜索的文本内容" }, "address": { "type": "string", "description": "地址\n\n地址描述" }, "location": { "type": "string", "description": "经纬度" }, "pname": { "type": "string", "description": "省市" }, "country": { "type": "string", "description": "国家" }, "cityname": { "type": "string", "description": "城市" }, "adcode": { "type": "string", "description": "adcode" }, "adnam": { "type": "string", "description": "区域名称" }, "district": { "type": "string", "description": "地级市或县级市" }, "aoi": { "type": "string", "description": "所属aoi" }, "street": { "type": "string", "description": "街道名称" } } }, "description": "建议地址结果\n\n当搜索结果并非是POI（是地址时），且没有搜索到POI时返回" } }, "description": "业务返回体" } } } ] } } } } }, "operationId": "2127_26_POST", "parameters": [], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ds_id": { "type": "string", "description": "数据源" }, "keywords": { "type": "string", "description": "查询关键字\n\n规则： 多个关键字用“|”分割\n\n若不指定city，并且搜索的为泛词（例如“美食”）的情况下，返回的内容为城市列表以及此城市内有多少结果符合要求。" }, "types": { "type": "string", "description": "查询POI类型\n\n多个类型用“|”分割；\n\n可选值：分类代码 或 汉字 （若用汉字，请严格按照附件之中的汉字填写） \n\n分类代码由六位数字组成，一共分为三个部分，前两个数字代表大类；中间两个数字代表中类；最后两个数字代表小类。\n\n若指定了某个大类，则所属的中类、小类都会被显示。\n\n例如：010000为汽车服务（大类）\n\n 010100为加油站（中类）\n\n 010101为中国石化（小类）\n\n 010900为汽车租赁（中类）\n\n 010901为汽车租赁还车（小类）\n\n当指定010000，则010100等中类、010101等小类都会被包含。\n\n当指定010900，则010901等小类都会被包含\n\n详情请查看POI分类编码和城市编码表 \n\n\n\n当keywords和types均为空的时候，默认指定types为050000（餐饮服务）、070000（生活服务）、120000（商务住宅）" }, "city": { "type": "string", "description": "查询城市\n\n可选值：城市中文、中文全拼、citycode、adcode\n\n如：北京/beijing/010/110000\n\n填入此参数后，会尽量优先返回此城市数据，但是不一定仅局限此城市结果，若仅需要某个城市数据请调用citylimit参数。\n\n如：在深圳市搜天安门，返回北京天安门结果。" }, "citylimit": { "type": "string", "description": "仅返回指定城市数据\n\n可选值：true/false" }, "children": { "type": "string", "description": "是否按照层级展示子POI数据\n\n可选值：children=1\n\n当为0的时候，子POI都会显示。\n\n当为1的时候，子POI会归类到父POI之中。\n\n\n\n仅在extensions=all的时候生效" }, "offset": { "type": "string", "description": "每页记录数据\n\n强烈建议不超过25，若超过25可能造成访问报错" }, "page": { "type": "string", "description": "当前页数\n\n最大翻页数100" }, "extensions": { "type": "string", "description": "返回结果控制\n\n此项默认返回基本地址信息；取值为all返回地址信息、附近POI、道路以及道路交叉口信息。" } }, "required": [ "ds_id", "keywords", "types" ] } } } } } }, "/2127-25": { "x-pointCode": 25, "x-mode": "mapping", "x-read-timeout": 5, "x-connect-timeout": 5, "post": { "summary": "未来路径规划", "description": "驾车路径规划 API 可以规划货车出行的方案，并且返回通勤方案的数据。高德原接口订购地址：https://developer.amap.com/api/webservice/guide/create-project/get-key", "responses": { "200": { "description": "成功响应", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ShowapiResEnvelope" }, { "type": "object", "properties": { "showapi_res_body": { "type": "object", "properties": { "errcode": { "type": "string", "description": "返回状态编码，0表示成功" }, "errmsg": { "type": "string", "description": "返回状态说明。\n\n成功时返回OK，其他错误返回错误信息。" }, "errdetail": { "type": "string", "description": "返回错误详细原因" }, "data": { "type": "array", "items": { "type": "object", "properties": { "paths": { "type": "array", "items": { "type": "object", "properties": { "distance": { "type": "string", "description": "行驶距离，单位：米" }, "traffic_lights": { "type": "string", "description": "红绿灯个数" }, "steps": { "type": "array", "items": { "type": "object", "properties": { "adcode": { "type": "string", "description": "途径区域的区域代码" }, "road": { "type": "string", "description": "道路名称" }, "distance": { "type": "string", "description": "路段距离" }, "toll": { "type": "string", "description": "道路属性字段，是否收费，0：不收费，1：收费。" }, "polyline": { "type": "string", "description": "路段坐标点串" } } }, "description": "导航路段，列表" } } }, "description": "路径规划方案，列表" }, "time_infos": { "type": "array", "items": { "type": "object", "properties": { "starttime": { "type": "string", "description": "出发时间，Unix时间戳精确到毫秒" }, "elements": { "type": "array", "items": { "type": "object", "properties": { "pathindex": { "type": "string", "description": "对应的路线" }, "duration": { "type": "string", "description": "总时长，单位：分钟" }, "tolls": { "type": "string", "description": "总收费，单位：元" }, "restriction": { "type": "string", "description": "0：代表限行已规避或未限行，即该路线没有限行路段 1：代表限行无法规避，即该线路有限行路段" }, "tmcs": { "type": "array", "items": { "type": "object", "properties": { "status": { "type": "string", "description": "路况状态" }, "polyline": { "type": "string", "description": "路段坐标点" } } }, "description": "路况信息" } } }, "description": "路线列表" } } }, "description": "不同时间的规划以及信息列表" } } } } }, "description": "业务返回体" } } } ] } } } } }, "operationId": "2127_25_POST", "parameters": [], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "origin": { "type": "string", "description": "出发点\n\n规则： lon，lat（经度，纬度）， “,”分割，如117.500244, 40.417801 经纬度小数点不超过6位" }, "destination": { "type": "string", "description": "目的地\n\n规则： lon，lat（经度，纬度）， “,”分割，如117.500244, 40.417801 经纬度小数点不超过6位" }, "strategy": { "type": "string", "description": "规划策略\n\n1.返回的结果考虑路况，尽量躲避拥堵而规划路径，与高德地图的“躲避拥堵”策略一致\n\n2.返回的结果不走高速，与高德地图“不走高速”策略一致\n\n3.返回的结果尽可能规划收费较低甚至免费的路径，与高德地图“避免收费”策略一致\n\n4.返回的结果考虑路况，尽量躲避拥堵而规划路径，并且不走高速，与高德地图的“躲避拥堵&不走高速”策略一致\n\n5.返回的结果尽量不走高速，并且尽量规划收费较低甚至免费的路径结果，与高德地图的“避免收费&不走高速”策略一致\n\n6.返回路径规划结果会尽量的躲避拥堵，并且规划收费较低甚至免费的路径结果，与高德地图的“躲避拥堵&避免收费”策略一致\n\n7.返回的结果尽量躲避拥堵，规划收费较低甚至免费的路径结果，并且尽量不走高速路，与高德地图的“避免拥堵&避免收费&不走高速”策略一致\n\n8.返回的结果会优先选择高速路，与高德地图的“高速优先”策略一致\n\n9.返回的结果会优先考虑高速路，并且会考虑路况躲避拥堵，与高德地图的“躲避拥堵&高速优先”策略一致\n\n10.不考虑路况，返回速度最优、耗时最短的路线，但是此路线不一定距离最短\n\n11.避让拥堵&速度优先&避免收费" }, "province": { "type": "string", "description": "用汉字填入车牌省份缩写，用于判断是否限行\n\n例如：京" }, "number": { "type": "string", "description": "填入除省份及标点之外，车牌的字母和数字（需大写）。用于判断限行相关。\n\n例如:NH1N11\n\n支持6位传统车牌和7位新能源车牌" }, "cartype": { "type": "string", "description": "车辆类型\n\n0：普通汽车(默认值)\n1：纯电动车\n2：插电混动车" }, "firsttime": { "type": "string", "description": "出发时间，第一个时间戳\n\nunix时间戳，精确到秒，必须是未来时间，如果小于当前时间会报错。" }, "interval": { "type": "string", "description": "时间间隔\n\n单位：秒" }, "count": { "type": "string", "description": "时间点个数\n\n最多支持48个" }, "ds_id": { "type": "string", "description": "数据源" } }, "required": [ "ds_id" ] } } } } } }, "/2127-24": { "x-pointCode": 24, "x-mode": "mapping", "x-read-timeout": 5, "x-connect-timeout": 5, "post": { "summary": "ID查询", "description": "提供多种查询POI信息的能力，其中包括关键字搜索、周边搜索、多边形搜索、ID查询四种筛选机制。", "responses": { "200": { "description": "成功响应", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ShowapiResEnvelope" }, { "type": "object", "properties": { "showapi_res_body": { "type": "object", "properties": { "infocode": { "type": "string" }, "count": { "type": "string", "description": "搜索方案数目(最大值为1000)" }, "status": { "type": "string", "description": "结果状态值，值为0或1\n\n0：请求失败；1：请求成功" }, "pois": { "type": "array", "items": { "type": "object", "properties": { "biz_type": { "type": "array", "items": { "type": "string" }, "description": "行业类型" }, "typecode": { "type": "string", "description": "兴趣点类型编码\n\n例如：050118" }, "location": { "type": "string", "description": "经纬度\n\n格式：X,Y" }, "poiweight": { "type": "array", "items": { "type": "string" } }, "tel": { "type": "array", "items": { "type": "string" }, "description": "POI的电话" }, "parent": { "type": "string", "description": "父POI的ID\n\n当前POI如果有父POI，则返回父POI的ID。可能为空" }, "type": { "type": "string", "description": "兴趣点类型\n\n顺序为大类、中类、小类\n\n例如：餐饮服务;中餐厅;特色/地方风味餐厅" }, "photos": { "type": "array", "items": { "type": "object", "properties": { "title": { "type": "array", "items": { "type": "string" }, "description": "图片介绍" }, "url": { "type": "string", "description": "具体链接" } } }, "description": "照片相关信息\n\nextensions=all时返回" }, "id": { "type": "string", "description": "唯一ID" }, "shopinfo": { "type": "string" }, "distance": { "type": "array", "items": { "type": "string" }, "description": "离中心点距离\n\n单位：米；仅在周边搜索的时候有值返回" }, "shopid": { "type": "array", "items": { "type": "string" } }, "importance": { "type": "array", "items": { "type": "string" } }, "address": { "type": "string", "description": "地址" }, "biz_ext": { "type": "object", "properties": { "rating": { "type": "array", "items": { "type": "string" }, "description": "评分\n\n仅存在于餐饮、酒店、景点、影院类POI之下" }, "cost": { "type": "array", "items": { "type": "string" }, "description": "人均消费\n\n仅存在于餐饮、酒店、景点、影院类POI之下" } }, "description": "深度信息\n\n extensions=all时返回" }, "name": { "type": "string", "description": "名称" }, "pname": { "type": "string", "description": "POI所在省份名称\n\n若是直辖市的时候，此处直接显示市名，例如北京市" }, "childtype": { "type": "string" }, "cityname": { "type": "string", "description": "城市名\n\n 若是直辖市的时候，此处直接显示市名，例如北京市" }, "adname": { "type": "string", "description": "区域名称\n\n区县级别的返回，例如朝阳区" }, "navi_poiid": { "type": "string", "description": "POI导航id\n\n extensions=all时返回" }, "gridcode": { "type": "string", "description": "地理格ID extensions=all时返回" }, "alias": { "type": "string", "description": "别名 extensions=all时返回" }, "business_area": { "type": "string", "description": "所在商圈 extensions=all时返回" }, "parking_type": { "type": "string", "description": "停车场类型 仅在停车场类型POI的时候显示该字段 展示停车场类型，包括：地下、地面、路边 extensions=all的时候显示" }, "tag": { "type": "string", "description": "该POI的特色内容 主要出现在美食类POI中，代表特色菜 例如“烤鱼,麻辣香锅,老干妈回锅肉” extensions=all时返回" }, "indoor_map": { "type": "string", "description": "是否有室内地图标志 1，表示有室内相关数据 0，代表没有室内相关数据 extensions=all时返回" }, "indoor_data": { "type": "object", "properties": { "cpid": { "type": "string", "description": "当前POI的父级POI 如果当前POI为建筑物类POI，则cpid为自身POI ID；如果当前POI为商铺类POI，则cpid为其所在建筑物的POI ID" }, "floor": { "type": "string", "description": "楼层索引 一般会用数字表示，例如8" }, "truefloor": { "type": "string", "description": "所在楼层 一般会带有字母，例如F8" } }, "description": "室内地图相关数据 当indoor_map=0时，字段为空 extensions=all时返回" }, "entr_location": { "type": "string", "description": "POI的入口经纬度 extensions=all时返回，也可用作于POI的到达点；" }, "exit_location": { "type": "string", "description": "POI的出口经纬度" }, "pcode": { "type": "string", "description": "POI所在省份编码 extensions=all时返回" }, "email": { "type": "string", "description": "POI的电子邮箱 extensions=all时返回" }, "website": { "type": "string", "description": "POI的网址 extensions=all时返回" }, "postcode": { "type": "string", "description": "邮编 extensions=all时返回" } } }, "description": "搜索POI信息列表" }, "suggestion": { "type": "object", "properties": { "keywords": { "type": "array", "items": { "type": "string" }, "description": "关键字" }, "cities": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "名称" }, "num": { "type": "string", "description": "该城市包含此关键字的个数" }, "citycode": { "type": "string", "description": "该城市的citycode" }, "adcode": { "type": "string", "description": "该城市的adcode" } } }, "description": "城市列表" } }, "description": "城市建议列表\n\n当搜索的文本关键字在限定城市中没有返回时会返回建议城市列表；" }, "info": { "type": "string", "description": "返回状态说明\n\nstatus为0时，info返回错误原因，否则返回“OK”。详情参阅info状态表" }, "sug_address": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "搜索文本内容\n\n搜索的文本内容" }, "address": { "type": "string", "description": "地址\n\n地址描述" }, "location": { "type": "string", "description": "经纬度" }, "pname": { "type": "string", "description": "省市" }, "country": { "type": "string", "description": "国家" }, "cityname": { "type": "string", "description": "城市" }, "adcode": { "type": "string", "description": "adcode" }, "adnam": { "type": "string", "description": "区域名称" }, "district": { "type": "string", "description": "地级市或县级市" }, "aoi": { "type": "string", "description": "所属aoi" }, "street": { "type": "string", "description": "街道名称" } } }, "description": "建议地址结果\n\n当搜索结果并非是POI（是地址时），且没有搜索到POI时返回" } }, "description": "业务返回体" } } } ] } } } } }, "operationId": "2127_24_POST", "parameters": [], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ds_id": { "type": "string", "description": "数据源" }, "id": { "type": "string", "description": "兴趣点ID\n\n兴趣点的唯一标识ID" } }, "required": [ "ds_id", "id" ] } } } } } }, "/2127-20": { "x-pointCode": 20, "x-mode": "mapping", "x-read-timeout": 30, "x-connect-timeout": 30, "post": { "summary": "距离测量", "description": "测量两点之间的距离。高德原接口订购地址：https://developer.amap.com/api/webservice/guide/create-project/get-key", "responses": { "200": { "description": "成功响应", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ShowapiResEnvelope" }, { "type": "object", "properties": { "showapi_res_body": { "type": "object", "properties": { "infocode": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "properties": { "duration": { "type": "string", "description": "预计行驶时间，单位：秒" }, "distance": { "type": "string", "description": "路径距离，单位：米" }, "origin_id": { "type": "string", "description": "起点坐标，起点坐标序列号（从１开始）" }, "dest_id": { "type": "string", "description": "终点坐标，终点坐标序列号（从１开始）" }, "info": { "type": "string", "description": "仅在出错的时候显示该字段。大部分显示“未知错误”\n\n由于此接口支持批量请求，建议不论批量与否用此字段判断请求是否成功" }, "code": { "type": "string", "description": "仅在出错的时候显示此字段。\n\n在驾车模式下：\n\n1，指定地点之间没有可以行车的道路\n\n2，起点/终点 距离所有道路均距离过远（例如在海洋/矿业）\n\n3，起点/终点不在中国境内" } } }, "description": "距离信息列表" }, "count": { "type": "string" }, "status": { "type": "string", "description": "返回结果状态值，值为0或1，0表示请求失败；1表示请求成功" }, "info": { "type": "string", "description": "返回状态说明，status为0时，info返回错误原因；否则返回“OK”。详情参阅info状态表" } }, "description": "业务返回体" } } } ] } } } } }, "operationId": "2127_20_POST", "parameters": [], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ds_id": { "type": "string", "description": "数据源" }, "origins": { "type": "string", "description": "出发点\n\n支持100个坐标对，坐标对见用“| ”分隔；经度和纬度用\",\"分隔" }, "destination": { "type": "string", "description": "目的地\n\n规则： lon，lat（经度，纬度）， “,”分割\n\n如117.500244, 40.417801 经纬度小数点不超过6位" }, "type": { "type": "string", "description": "路径计算的方式和方法\n\n0：直线距离\n\n1：驾车导航距离（仅支持国内坐标）。\n\n必须指出，当为1时会考虑路况，故在不同时间请求返回结果可能不同。\n\n此策略和驾车路径规划接口的 strategy=4策略基本一致，策略为“ 躲避拥堵的路线，但是可能会存在绕路的情况，耗时可能较长 ”\n\n若需要实现高德地图客户端效果，可以考虑使用驾车路径规划接口\n\n3：步行规划距离（仅支持5km之间的距离）" } }, "required": [ "ds_id", "origins", "destination" ] } } } } } }, "/2127-17": { "x-pointCode": 17, "x-mode": "mapping", "x-read-timeout": 5, "x-connect-timeout": 5, "post": { "summary": "骑行路径规划", "description": "骑行路径规划用于规划骑行通勤方案，规划时不会考虑路况；考虑天桥、单行线、封路等情况。高德原接口订购地址：https://developer.amap.com/api/webservice/guide/create-project/get-key", "responses": { "200": { "description": "成功响应", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ShowapiResEnvelope" }, { "type": "object", "properties": { "showapi_res_body": { "type": "object", "properties": { "data": { "type": "object", "properties": { "paths": { "type": "array", "items": { "type": "object", "properties": { "0": { "type": "object", "properties": { "duration": { "type": "number", "description": "起终点的骑行时间" }, "distance": { "type": "number", "description": "起终点的骑行距离" }, "steps": { "type": "array", "items": { "type": "object", "properties": { "0": { "type": "object", "properties": { "orientation": { "type": "string", "description": "此段路骑行方向" }, "duration": { "type": "number", "description": "此段路骑行耗时" }, "distance": { "type": "number", "description": "此段路骑行距离" }, "polyline": { "type": "string", "description": "此段路骑行的坐标点" }, "action": { "type": "string", "description": "此段路骑行主要动作" }, "instruction": { "type": "string", "description": "路段骑行指示" }, "assistant_action": { "type": "string", "description": "此段路骑行辅助动作" }, "road": { "type": "string", "description": "此段路道路名称" } } } } }, "description": "具体骑行结果" } } } } }, "description": "骑行方案列表信息" }, "origin": { "type": "string", "description": "起点坐标" }, "destination": { "type": "string", "description": "终点坐标" } } }, "errmsg": { "type": "string", "description": "返回状态说明" }, "errcode": { "type": "number", "description": "返回结果码 0，表示成功" } }, "description": "业务返回体" } } } ] } } } } }, "operationId": "2127_17_POST", "parameters": [ { "name": "origin", "in": "query", "description": "出发点经纬度\n\n填入规则：X,Y，采用\",\"分隔，例如“ 117.500244, 40.417801 ”\n\n小数点后不得超过6位", "required": true, "schema": { "type": "string" } }, { "name": "destination", "in": "query", "description": "目的地经纬度\n\n填入规则：X,Y，采用\",\"分隔，例如“ 117.500244, 40.417801 ”\n\n小数点后不得超过6位", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ds_id": { "type": "string", "description": "数据源" } }, "required": [ "ds_id" ] } } } } } }, "/2127-15": { "x-pointCode": 15, "x-mode": "mapping", "x-read-timeout": 30, "x-connect-timeout": 30, "post": { "summary": "驾车路径规划", "description": "驾车路径规划 API 可以规划以小客车、轿车通勤出行的方案，并且返回通勤方案的数据。高德原接口订购地址：https://developer.amap.com/api/webservice/guide/create-project/get-key", "responses": { "200": { "description": "成功响应", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ShowapiResEnvelope" }, { "type": "object", "properties": { "showapi_res_body": { "type": "object", "properties": { "status": { "type": "string", "description": "结果状态值，值为0或1\t0：请求失败；1：请求成功" }, "info": { "type": "string", "description": "返回状态说明\tstatus为0时，info返回错误原因，否则返回“OK”。详情参阅info状态表" }, "infocode": { "type": "string", "description": "详情参阅info状态表" }, "count": { "type": "string", "description": "驾车路径规划方案数目" }, "route": { "type": "object", "properties": { "origin": { "type": "string", "description": "起点坐标\t规则： lon，lat（经度，纬度）， “,”分割，如117.500244, 40.417801 经纬度小数点不超过6位" }, "destination": { "type": "string", "description": "终点坐标\t规则： lon，lat（经度，纬度）， “,”分割，如117.500244, 40.417801 经纬度小数点不超过6位" }, "taxi_cost": { "type": "string", "description": "打车费用\t单位：元" }, "paths": { "type": "array", "items": { "type": "object", "properties": { "0": { "type": "object", "properties": { "distance": { "type": "string", "description": "行驶距离\t单位：米" }, "duration": { "type": "string", "description": "预计行驶时间\t单位：秒" }, "strategy": { "type": "string", "description": "导航策略" }, "tolls": { "type": "string", "description": "此导航方案道路收费\t单位：元" }, "toll_distance": { "type": "string", "description": "收费路段距离" }, "steps": { "type": "array", "items": { "type": "object", "properties": { "0": { "type": "object", "properties": { "instruction": { "type": "string", "description": "行驶指示" }, "orientation": { "type": "string", "description": "方向" }, "road": { "type": "string", "description": "道路名称" }, "distance": { "type": "string", "description": "此路段距离\n\n单位：米" }, "tolls": { "type": "string", "description": "此段收费\n\n单位：元" }, "toll_distance": { "type": "string", "description": "收费路段距离\n\n单位：米" }, "toll_road": { "type": "array", "items": { "type": "string" }, "description": "主要收费道路" }, "duration": { "type": "string", "description": "持续的时间" }, "polyline": { "type": "string", "description": "此路段坐标点串\n\n格式为坐标串，如：116.481247,39.990704;116.481270,39.990726" }, "action": { "type": "string", "description": "导航主要动作\n\n详见驾车动作列表" }, "assistant_action": { "type": "array", "items": { "type": "string" }, "description": "导航辅助动作\n\n详见驾车动作列表" }, "tmcs": { "type": "array", "items": { "type": "object", "properties": { "0": { "type": "object", "properties": { "lcode": { "type": "array", "items": { "type": "string" } }, "distance": { "type": "string", "description": "此段路的长度\n\n单位：米" }, "status": { "type": "string", "description": "此段路的交通情况\n\n未知、畅通、缓行、拥堵、严重拥堵" }, "polyline": { "type": "string", "description": "此段路的轨迹\n\n规格：x1,y1;x2,y2" } } } } }, "description": "驾车导航详细信息\n\n其中包含tmc对象" }, "cities": { "type": "array", "items": { "type": "object", "properties": { "0": { "type": "object", "properties": { "name": { "type": "string" }, "citycode": { "type": "string", "description": "参见\nadcode参数表" }, "adcode": { "type": "string", "description": "参见\nadcode参数表" }, "districts": { "type": "array", "items": { "type": "object", "properties": { "0": { "type": "object", "properties": { "name": { "type": "string" }, "adcode": { "type": "string", "description": "参见\nadcode参数表" } } } } }, "description": " 区域" } } } } } } }, "description": "导航路段" } } }, "description": "导航路段" }, "restriction": { "type": "string", "description": "\t限行结果\t0 代表限行已规避或未限行，即该路线没有限行路段\n1 代表限行无法规避，即该线路有限行路段" }, "traffic_lights": { "type": "string", "description": "红绿灯个数" } } } } }, "description": "驾车换乘方案" } }, "description": "驾车路径规划信息列表" } }, "description": "业务返回体" } } } ] } } } } }, "operationId": "2127_15_POST", "parameters": [], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "origin": { "type": "string", "description": "出发点\n\n经度在前，纬度在后，经度和纬度用\",\"分割，经纬度小数点后不得超过6位。格式为x1,y1|x2,y2|x3,y3。\n\n由于在实际使用过程中，存在定位飘点的情况。为了解决此类问题，允许传入多个起点用于计算车头角度。\n\n最多允许传入3个坐标对，每对坐标之间距离必须超过2m。 虽然对每对坐标之间长度没有上限，但是如果超过4米会有概率性出现不准确的情况。使用三个点来判断距离和角度的有效性，如果两者都有效，使用第一个点和最后一个点计算的角度设置抓路的角度，规划路径时以最后一个坐标对进行规划。" }, "destination": { "type": "string", "description": "目的地\n\n经度在前，纬度在后，经度和纬度用\",\"分割，经纬度小数点后不得超过6位。" }, "originid": { "type": "string", "description": "出发点poiid\n\n当起点为POI时，建议填充此值。" }, "destinationid": { "type": "string", "description": "目的地poiid\n\n当终点为POI时，建议填充此值。" }, "origintype": { "type": "string", "description": "起点的poi类别\n\n当用户知道起点POI的类别时候，建议填充此值" }, "destinationtype": { "type": "string", "description": "当用户知道终点POI的类别时候，建议填充此值" }, "strategy": { "type": "number", "description": "驾车选择策略\n下方策略 0~9的策略，仅会返回一条路径规划结果。\n0，速度优先，不考虑当时路况，此路线不一定距离最短\n1，费用优先，不走收费路段，且耗时最少的路线\n2，距离优先，不考虑路况，仅走距离最短的路线，但是可能存在穿越小路/小区的情况\n3，速度优先，不走快速路，例如京通快速路（因为策略迭代，建议使用13）\n4，躲避拥堵，但是可能会存在绕路的情况，耗时可能较长\n5，多策略（同时使用速度优先、费用优先、距离优先三个策略计算路径）。\n【其中必须说明】，就算使用三个策略算路，会根据路况不固定的返回一~三条路径规划信息。\n6，速度优先，不走高速，但是不排除走其余收费路段\n7，费用优先，不走高速且避免所有收费路段\n8，躲避拥堵和收费，可能存在走高速的情况，并且考虑路况不走拥堵路线，但有可能存在绕路和时间较长\n9，躲避拥堵和收费，不走高速\n\n下方10~20的策略，会返回多条路径规划结果。（高德地图APP策略也包含在内，强烈建议从此策略之中选择）\n下方策略返回多条路径规划结果\n10，返回结果会躲避拥堵，路程较短，尽量缩短时间，与高德地图的默认策略也就是不进行任何勾选一致\n11，返回三个结果包含：时间最短；距离最短；躲避拥堵 （由于有更优秀的算法，建议用10代替）\n12，返回的结果考虑路况，尽量躲避拥堵而规划路径，与高德地图的“躲避拥堵”策略一致\n13，返回的结果不走高速，与高德地图“不走高速”策略一致\n14，返回的结果尽可能规划收费较低甚至免费的路径，与高德地图“避免收费”策略一致\n15，返回的结果考虑路况，尽量躲避拥堵而规划路径，并且不走高速，与高德地图的“躲避拥堵&不走高速”策略一致\n16，返回的结果尽量不走高速，并且尽量规划收费较低甚至免费的路径结果，与高德地图的“避免收费&不走高速”策略一致\n17，返回路径规划结果会尽量的躲避拥堵，并且规划收费较低甚至免费的路径结果，与高德地图的“躲避拥堵&避免收费”策略一致\n18，返回的结果尽量躲避拥堵，规划收费较低甚至免费的路径结果，并且尽量不走高速路，与高德地图的“避免拥堵&避免收费&不走高速”策略一致\n19，返回的结果会优先选择高速路，与高德地图的“高速优先”策略一致\n20，返回的结果会优先考虑高速路，并且会考虑路况躲避拥堵，与高德地图的“躲避拥堵&高速优先”策略一致" }, "waypoints": { "type": "string", "description": "途经点\n\n经度和纬度用\",\"分割，经度在前，纬度在后，小数点后不超过6位，坐标点之间用\";\"分隔\n\n最大数目：16个坐标点。如果输入多个途径点，则按照用户输入的顺序进行路径规划" }, "avoidpolygons": { "type": "string", "description": "避让区域\n\n区域避让，支持32个避让区域，每个区域最多可有16个顶点\n\n经度和纬度用\",\"分割，经度在前，纬度在后，小数点后不超过6位，坐标点之间用\";\"分隔，区域之间用\"|\"分隔。如果是四边形则有四个坐标点，如果是五边形则有五个坐标点；\n\n同时传入避让区域及避让道路，仅支持避让道路；\n\n避让区域不能超过81平方公里，否则避让区域会失效。" }, "avoidroad": { "type": "string", "description": "避让道路名\n\n只支持一条避让道路" }, "province": { "type": "string", "description": "用汉字填入车牌省份缩写，用于判断是否限行\n\n例如：京" }, "number": { "type": "string", "description": "填入除省份及标点之外，车牌的字母和数字（需大写）。用于判断限行相关。\n\n例如:NH1N11\n\n支持6位传统车牌和7位新能源车牌" }, "cartype": { "type": "string", "description": "车辆类型\n\n0：普通汽车(默认值)\n1：纯电动车\n2：插电混动车" }, "ferry": { "type": "string", "description": "在路径规划中，是否使用轮渡\n\n0:使用渡轮(默认) \n1:不使用渡轮" }, "roadaggregation": { "type": "string", "description": "是否返回路径聚合信息\n\nfalse:不返回路径聚合信息\n\ntrue:返回路径聚合信息，在steps上层增加roads做聚合" }, "nosteps": { "type": "string", "description": "是否返回steps字段内容\n\n当取值为0时，steps字段内容正常返回；\n\n当取值为1时，steps字段内容为空；" }, "extensions": { "type": "string", "description": "回结果控制\n\n可选值：base/all\n\nbase:返回基本信息；all：返回全部信息" }, "ds_id": { "type": "string", "description": "数据源" } }, "required": [ "origin", "destination", "ds_id" ] } } } } } }, "/2127-14": { "x-pointCode": 14, "x-mode": "mapping", "x-read-timeout": 30, "x-connect-timeout": 30, "post": { "summary": "公交路径规划", "description": "公交路径规划 API 可以规划综合各类公共（火车、公交、地铁）交通方式的通勤方案，并且返回通勤方案的数据。高德原接口订购地址：https://developer.amap.com/api/webservice/guide/create-project/get-key", "responses": { "200": { "description": "成功响应", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ShowapiResEnvelope" }, { "type": "object", "properties": { "showapi_res_body": { "type": "object", "properties": { "status": { "type": "string", "description": "返回状态\n\n值为0或1\n1：成功；0：失败" }, "info": { "type": "string", "description": "status为0时，info返回错误原；否则返回“OK”。详情参阅info状态表" }, "infocode": { "type": "string", "description": "详情参阅info状态表" }, "count": { "type": "string", "description": "公交换乘方案数目" }, "route": { "type": "object", "properties": { "origin": { "type": "string", "description": "起点坐标" }, "destination": { "type": "string", "description": "终点坐标" }, "distance": { "type": "string", "description": "起点和终点的步行距离\n\n单位：米" }, "taxi_cost": { "type": "string", "description": "出租车费用\n\n单位：元" }, "transits": { "type": "array", "items": { "type": "object", "properties": { "0": { "type": "object", "properties": { "cost": { "type": "string", "description": "此换乘方案价格\n\n单位：元" }, "duration": { "type": "string", "description": "此换乘方案预期时间\n\n单位：秒" }, "nightflag": { "type": "string", "description": "是否是夜班车\n\n0：非夜班车；1：夜班车" }, "walking_distance": { "type": "string", "description": "此方案总步行距离\n\n单位：米" }, "distance": { "type": "string", "description": "每段线路步行距离" }, "missed": { "type": "string" }, "segments": { "type": "array", "items": { "type": "object", "properties": { "0": { "type": "object", "properties": { "taxi": { "type": "array", "items": { "type": "string" } }, "walking": { "type": "object", "properties": { "origin": { "type": "string", "description": "\t\n起点坐标" }, "destination": { "type": "string", "description": "\t\n终点坐标" }, "distance": { "type": "string", "description": "\t\n每段线路步行距离" }, "duration": { "type": "string", "description": "\t\n步行预计时间" }, "steps": { "type": "array", "items": { "type": "object", "properties": { "0": { "type": "object", "properties": { "instruction": { "type": "string", "description": "此段路的行走介绍" }, "road": { "type": "array", "items": { "type": "string" }, "description": "\t\n路的名字" }, "distance": { "type": "string", "description": "此段路的距离" }, "duration": { "type": "array", "items": { "type": "string" }, "description": "\t\n此段路预计消耗时间" }, "polyline": { "type": "string", "description": "\t\n此段路的坐标" }, "action": { "type": "string", "description": "\t\n步行主要动作" }, "assistant_action": { "type": "array", "items": { "type": "string" }, "description": "步行辅助动作" } } } } }, "description": "步行路段列表" } }, "description": "此路段步行导航信息" }, "bus": { "type": "object", "properties": { "buslines": { "type": "array", "items": { "type": "object", "properties": { "0": { "type": "object", "properties": { "departure_stop": { "type": "object", "properties": { "name": { "type": "string", "description": "站点名字" }, "id": { "type": "string", "description": "\t\n站点id" }, "location": { "type": "string", "description": "站点经纬度" } }, "description": "此段起乘站信息" }, "arrival_stop": { "type": "object", "properties": { "name": { "type": "string", "description": "站点名字 " }, "id": { "type": "string", "description": "站点id " }, "location": { "type": "string", "description": " 站点经纬度 " } }, "description": "此段下车站\n\n格式如：中关村" }, "name": { "type": "string", "description": "公交路线名称" }, "id": { "type": "string", "description": "公交路线id" }, "type": { "type": "string", "description": "公交类型" }, "distance": { "type": "string", "description": "公交行驶距离" }, "duration": { "type": "string", "description": "公交预计行驶时间" }, "polyline": { "type": "string", "description": "此路段坐标集" }, "start_time": { "type": "string", "description": "首班车时间" }, "end_time": { "type": "string", "description": "末班车时间" }, "via_num": { "type": "string", "description": "此段途经公交站数" }, "via_stops": { "type": "array", "items": { "type": "object", "properties": { "0": { "type": "object", "properties": { "name": { "type": "string", "description": "途径公交站点信息\n\n" }, "id": { "type": "string", "description": "公交站点编号" }, "location": { "type": "string", "description": "公交站点经纬度" } } } } }, "description": "此段途经公交站点列表" } } } } }, "description": "步行路段列表" } }, "description": "此路段公交导航信息" }, "entrance": { "type": "array", "items": { "type": "string" }, "description": "地铁入口\n\n只在地铁路段有值" }, "exit": { "type": "array", "items": { "type": "string" }, "description": "exit\n\n地铁出口\n\n只在地铁路段有值" }, "railway": { "type": "object", "properties": { "spaces": { "type": "array", "items": { "type": "string" }, "description": "\t\n仓位及价格信息" } }, "description": "乘坐火车的信息\n\n详情见只在地铁路段有值" } } } } }, "description": "\t\n换乘路段列表" } }, "description": "公交换乘方案" } } }, "description": "公交换乘方案列表" } }, "description": "公交换乘信息列表" } }, "description": "业务返回体" } } } ] } } } } }, "operationId": "2127_14_POST", "parameters": [], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "origin": { "type": "string", "description": "出发点\n\n规则： lon，lat（经度，纬度）， “,”分割，如117.500244, 40.417801 经纬度小数点不超过6位" }, "destination": { "type": "string", "description": "目的地\n\n规则： lon，lat（经度，纬度）， “,”分割，如117.500244, 40.417801 经纬度小数点不超过6位" }, "city": { "type": "string", "description": "城市/跨城规划时的起点城市\n\n目前支持市内公交换乘/跨城公交的起点城市。\n\n可选值：城市名称/citycode" }, "cityd": { "type": "string", "description": "跨城公交规划时的终点城市\n\n跨城公交规划必填参数。\n\n可选值：城市名称/citycode" }, "extensions": { "type": "string", "description": "返回结果详略 可选值：base(default)/all base:返回基本信息；all：返回全部信息" }, "strategy": { "type": "string", "description": "公交换乘策略\n\n可选值：\n0：最快捷模式\n1：最经济模式\n2：最少换乘模式\n3：最少步行模式\n5：不乘地铁模式" }, "date": { "type": "string", "description": "出发日期\n\n根据出发时间和日期，筛选可乘坐的公交路线，格式示例：date=2014-3-19。在无需设置预计出发时间时，请不要在请求之中携带此参数。" }, "time": { "type": "string", "description": "出发时间\n\n根据出发时间和日期，筛选可乘坐的公交路线，格式示例：time=22:34。在无需设置预计出发时间时，请不要在请求之中携带此参数。" }, "ds_id": { "type": "string", "description": "数据源" } }, "required": [ "origin", "destination", "city", "ds_id" ] } } } } } }, "/2127-13": { "x-pointCode": 13, "x-mode": "mapping", "x-read-timeout": 30, "x-connect-timeout": 30, "post": { "summary": "静态地图", "description": "用户传入指定的参数,生成一张地图图片,结果以base64的形式返回", "responses": { "200": { "description": "成功响应", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ShowapiResEnvelope" }, { "type": "object", "properties": { "showapi_res_body": { "type": "object", "properties": { "img_base64": { "type": "string", "description": "图片base64编码" } }, "description": "业务返回体" } } } ] } } } } }, "operationId": "2127_13_POST", "parameters": [ { "name": "labels", "in": "query", "description": "标签。使用规则见labels详细说明（http://lbs.amap.com/api/webservice/guide/api/staticmaps），标签最大数10个", "required": true, "schema": { "type": "string" } }, { "name": "location", "in": "query", "description": "地图中心点坐标。规则：经度和纬度用\",\"分隔 经纬度小数点后不得超过6位。", "required": true, "schema": { "type": "string" } }, { "name": "markers", "in": "query", "description": "标注。使用规则见markers详细说明（http://lbs.amap.com/api/webservice/guide/api/staticmaps），标注最大数50个", "required": false, "schema": { "type": "string" } }, { "name": "paths", "in": "query", "description": "折线。使用规则见paths详细说明（http://lbs.amap.com/api/webservice/guide/api/staticmaps），折线和多边形最大数4个", "required": false, "schema": { "type": "string" } }, { "name": "scale", "in": "query", "description": "1:返回普通图； 2:调用高清图，图片高度和宽度都增加一倍，zoom也增加一倍（当zoom为最大值时，zoom不再改变）。", "required": false, "schema": { "type": "string" } }, { "name": "size", "in": "query", "description": "图片宽度*图片高度。最大值为1024*1024", "required": false, "schema": { "type": "string" } }, { "name": "traffic", "in": "query", "description": "交通路况标识。底图是否展现实时路况。 可选值： 0，不展现；1，展现。", "required": false, "schema": { "type": "string" } }, { "name": "zoom", "in": "query", "description": "地图缩放级别:[1,17]", "required": false, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ds_id": { "type": "string", "description": "数据源" } }, "required": [ "ds_id" ] } } } } } }, "/2127-12": { "x-pointCode": 12, "x-mode": "mapping", "x-read-timeout": 5, "x-connect-timeout": 5, "post": { "summary": "逆地理编码", "description": "将经纬度转换为详细结构化的地址，且返回附近周边的POI、AOI信息。高德原接口订购地址：https://developer.amap.com/api/webservice/guide/create-project/get-key", "responses": { "200": { "description": "成功响应", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ShowapiResEnvelope" }, { "type": "object", "properties": { "showapi_res_body": { "type": "object", "properties": { "info": { "type": "string", "description": "当 status 为 0 时，info 会返回具体错误原因，否则返回“OK”。详情可以参考info状态表" }, "status": { "type": "string", "description": "返回值为 0 或 1，0 表示请求失败；1 表示请求成功。" }, "regeocodes": { "type": "object", "properties": { "formatted_address": { "type": "string", "description": "结构化地址信息包括：省份＋城市＋区县＋城镇＋乡村＋街道＋门牌号码\n\n如果坐标点处于海域范围内，则结构化地址信息为：省份＋城市＋区县＋海域信息" }, "addressComponent": { "type": "object", "properties": { "province": { "type": "string", "description": "坐标点所在省名称\n\n例如：北京市" }, "city": { "type": "string", "description": "坐标点所在城市名称\n\n请注意：当城市是省直辖县时返回为空，以及城市为北京、上海、天津、重庆四个直辖市时，该字段返回为空；省直辖县列表" }, "citycode": { "type": "string", "description": "城市编码\n\n例如：010" }, "district": { "type": "string", "description": "坐标点所在区\n\n例如：海淀区\n\n例如：海淀区" }, "adcode": { "type": "string", "description": "行政区编码\n\n例如：110108" }, "township": { "type": "string", "description": "坐标点所在乡镇/街道（此街道为社区街道，不是道路信息）\n\n例如：燕园街道" }, "towncode": { "type": "string", "description": "乡镇街道编码\n\n例如：110101001000" }, "neighborhood": { "type": "object", "properties": { "name": { "type": "string", "description": "社区名称\n\n例如：北京大学" }, "type": { "type": "string", "description": "POI类型\n\n例如：科教文化服务;学校;高等院校" } }, "description": "社区信息列表" }, "building": { "type": "object", "properties": { "name": { "type": "string", "description": "建筑名称\n\n例如：万达广场" }, "type": { "type": "string", "description": "类型\n\n例如：科教文化服务;学校;高等院校" } }, "description": "楼信息列表" }, "streetNumber": { "type": "object", "properties": { "street": { "type": "string", "description": "街道名称\n\n例如：中关村北二条" }, "number": { "type": "string", "description": "门牌号\n\n例如：3号" }, "location": { "type": "string", "description": "坐标点\n\n经纬度坐标点：经度，纬度" }, "direction": { "type": "string", "description": "方向\n\n坐标点所处街道方位" }, "distance": { "type": "string", "description": "门牌地址到请求坐标的距离\n\n单位：米" } }, "description": "门牌信息列表" }, "seaArea": { "type": "string", "description": "所属海域信息\n\n例如：渤海" }, "businessAreas": { "type": "array", "items": { "type": "object", "properties": { "businessArea": { "type": "string", "description": "商圈信息" }, "location": { "type": "string", "description": "商圈中心点经纬度" }, "name": { "type": "string", "description": "商圈名称 \n\n 例如：颐和园" }, "id": { "type": "string", "description": "商圈所在区域的adcode \n\n 例如：朝阳区/海淀区" } } }, "description": "经纬度所属商圈列表" } }, "description": "地址元素列表" }, "roads": { "type": "array", "items": { "type": "object", "properties": { "road": { "type": "object", "properties": { "id": { "type": "string", "description": "道路id" }, "name": { "type": "string", "description": "道路名称" }, "distance": { "type": "string", "description": "道路到请求坐标的距离\n\n单位：米" }, "direction": { "type": "string", "description": "方位\n\n输入点和此路的相对方位" }, "location": { "type": "string", "description": "坐标点" } }, "description": "道路信息" } } }, "description": "道路信息列表\n\n请求参数 extensions 为 all 时返回" }, "roadinters": { "type": "array", "items": { "type": "object", "properties": { "roadinter": { "type": "object", "properties": { "distance": { "type": "string", "description": "交叉路口到请求坐标的距离\n\n单位：米" }, "direction": { "type": "string", "description": "方位\n\n输入点相对路口的方位" }, "location": { "type": "string", "description": "路口经纬度" }, "first_id": { "type": "string", "description": "第一条道路id" }, "first_name": { "type": "string", "description": "第一条道路名称" }, "second_id": { "type": "string", "description": "第二条道路id" }, "second_name": { "type": "string", "description": "第二条道路名称" } }, "description": "道路交叉口" } } }, "description": "道路交叉口列表\n\n请求参数 extensions 为 all 时返回" }, "pois": { "type": "array", "items": { "type": "object", "properties": { "poi": { "type": "object", "properties": { "id": { "type": "string", "description": "poi的id" }, "name": { "type": "string", "description": "poi点名称" }, "type": { "type": "string", "description": "poi类型" }, "tel": { "type": "string", "description": "电话" }, "distance": { "type": "string", "description": "该POI的中心点到请求坐标的距离\n\n单位：米" }, "direction": { "type": "string", "description": "方向\n\n为输入点相对建筑物的方位" }, "address": { "type": "string", "description": "poi地址信息" }, "location": { "type": "string", "description": "坐标点" }, "businessarea": { "type": "string", "description": "poi所在商圈名称" } }, "description": "poi信息列表" } } }, "description": "poi信息列表\n\n请求参数 extensions 为 all 时返回" }, "aois": { "type": "array", "items": { "type": "object", "properties": { "aoi": { "type": "object", "properties": { "id": { "type": "string", "description": "所属 aoi的id" }, "name": { "type": "string", "description": "所属 aoi 名称" }, "adcode": { "type": "string", "description": "所属 aoi 所在区域编码" }, "location": { "type": "string", "description": "所属 aoi 中心点坐标" }, "area": { "type": "string", "description": "所属aoi点面积\n\n单位：平方米" }, "distance": { "type": "string" } }, "description": "aoi信息" } } }, "description": "aoi信息列表\n\n请求参数 extensions 为 all 时返回" } }, "description": "batch 字段设置为 true 时为批量请求，此时 regeocodes 标签返回，标签下为 regeocode 对象列表；batch 为false 时为单个请求，会返回 regeocode 对象；" } }, "description": "业务返回体" } } } ] } } } } }, "operationId": "2127_12_POST", "parameters": [], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "location": { "type": "string", "description": "经纬度坐标 : 传入内容规则：经度在前，纬度在后，经纬度间以“,”分割，经纬度小数点后不要超过 6 位。如果需要解析多个经纬度的话，请用\"|\"进行间隔，并且将 batch 参数设置为 true，最多支持传入 20 对坐标点。每对点坐标之间用\"|\"分割。" }, "poitype": { "type": "string", "description": "返回附近POI类型 .\n需要 extensions 参数为 all 时才生效。逆地理编码在进行坐标解析之后不仅可以返回地址描述，也可以返回经纬度附近符合限定要求的POI内容（在 extensions 字段值为 all 时才会返回POI内容）。设置 POI 类型参数相当于为上述操作限定要求。参数仅支持传入POI TYPECODE，可以传入多个POI TYPECODE，相互之间用“|”分隔。该参数在 batch 取值为 true 时不生效。获取 POI TYPECODE 可以参考POI分类码表" }, "ds_id": { "type": "string", "description": "数据源" }, "radius": { "type": "string", "description": "搜索半径 - radius取值范围在0~3000，默认是1000。单位：米" }, "extensions": { "type": "string", "description": "返回结果控制 --- extensions 参数默认取值是 base，也就是返回基本地址信息；\nextensions 参数取值为 all 时会返回基本地址信息、附近 POI 内容、道路信息以及道路交叉口信息。" }, "batch": { "type": "string", "description": "批量查询控制 -- batch 参数设置为 true 时进行批量查询操作，最多支持 20 个经纬度点进行批量地址查询操作。" }, "roadlevel": { "type": "string", "description": "道路等级 --需要 extensions 参数为 all 时才生效。\n可选值：0，1\n当roadlevel=0时，显示所有道路\n当roadlevel=1时，过滤非主干道路，仅输出主干道路数据" }, "homeorcorp": { "type": "string", "description": "homeorcorp--是否优化POI返回顺序 , 需要 extensions 参数为 all 时才生效。\nhomeorcorp 参数的设置可以影响召回 POI 内容的排序策略，目前提供三个可选参数：\n0：不对召回的排序策略进行干扰。\n1：综合大数据分析将居家相关的 POI 内容优先返回，即优化返回结果中 pois 字段的poi顺序。\n2：综合大数据分析将公司相关的 POI 内容优先返回，即优化返回结果中 pois 字段的poi顺序。" } }, "required": [ "location", "ds_id" ] } } } } } }, "/2127-10": { "x-pointCode": 10, "x-mode": "mapping", "x-read-timeout": 5, "x-connect-timeout": 5, "post": { "summary": "输入提示", "description": "提供根据用户输入的关键词查询返回建议列表。", "responses": { "200": { "description": "成功响应", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ShowapiResEnvelope" }, { "type": "object", "properties": { "showapi_res_body": { "type": "object", "properties": { "infocode": { "type": "string" }, "count": { "type": "string", "description": "返回结果总数目" }, "status": { "type": "string", "description": "1：成功；0：失败" }, "tips": { "type": "array", "items": { "type": "object", "properties": { "0": { "type": "object", "properties": { "id": { "type": "string", "description": "返回数据ID\n若数据为POI类型，则返回POI ID;若数据为bus类型，则返回bus id;若数据为busline类型，则返回busline id。" }, "typecode": { "type": "string" }, "address": { "type": "string", "description": "详细地址" }, "location": { "type": "string", "description": "tip中心点坐标" }, "name": { "type": "string", "description": "tip名称" }, "adcode": { "type": "string", "description": "六位区县编码" }, "district": { "type": "string", "description": "省+市+区（直辖市为“市+区”）" }, "city": { "type": "string" } } } } }, "description": "建议提示列表" }, "info": { "type": "string" } }, "description": "业务返回体" } } } ] } } } } }, "operationId": "2127_10_POST", "parameters": [ { "name": "keywords", "in": "query", "description": "查询关键词", "required": true, "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "POI分类\n服务可支持传入多个分类，多个类型剑用“|”分隔\n可选值：POI分类名称、分类代码\n此处强烈建议使用分类代码，否则可能会得到不符合预期的结果", "required": false, "schema": { "type": "string" } }, { "name": "location", "in": "query", "description": "坐标--格式：“X,Y”（经度,纬度），不可以包含空格\n建议使用location参数，可在此location附近优先返回搜索关键词信息", "required": false, "schema": { "type": "string" } }, { "name": "city", "in": "query", "description": "搜索城市\n可选值：citycode、adcode，不支持县级市。\n如：010/110000\nadcode信息可参考城市编码表获取。\n填入此参数后，会尽量优先返回此城市数据，但是不一定仅局限此城市结果，若仅需要某个城市数据请调用citylimit参数。\n如：在深圳市搜天安门，返回北京天安门结果。", "required": false, "schema": { "type": "string" } }, { "name": "citylimit", "in": "query", "description": "仅返回指定城市数据 -- 可选值：true/false", "required": false, "schema": { "type": "string" } }, { "name": "datatype", "in": "query", "description": "返回的数据类型 -- 多种数据类型用“|”分隔，可选值：all-返回所有数据类型、poi-返回POI数据类型、bus-返回公交站点数据类型、busline-返回公交线路数据类型", "required": false, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ds_id": { "type": "string", "description": "数据源" } }, "required": [ "ds_id" ] } } } } } }, "/2127-9": { "x-pointCode": 9, "x-mode": "mapping", "x-read-timeout": 5, "x-connect-timeout": 5, "post": { "summary": "坐标转换", "description": "能够将用户输入的非高德坐标（GPS坐标、mapbar坐标、baidu坐标）转换成高德坐标", "responses": { "200": { "description": "成功响应", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ShowapiResEnvelope" }, { "type": "object", "properties": { "showapi_res_body": { "type": "object", "properties": { "infocode": { "type": "string" }, "locations": { "type": "string", "description": "转换之后的坐标。若有多个坐标，则用 “;”进行区分和间隔" }, "status": { "type": "string", "description": "返回状态1：成功；0：失败" }, "info": { "type": "string" } }, "description": "业务返回体" } } } ] } } } } }, "operationId": "2127_9_POST", "parameters": [ { "name": "locations", "in": "query", "description": "坐标点--经度和纬度用\",\"分割，经度在前，纬度在后，经纬度小数点后不得超过6位。多个坐标对之间用”|”进行分隔最多支持40对坐标。", "required": true, "schema": { "type": "string" } }, { "name": "coordsys", "in": "query", "description": "coordsys\n原坐标系\n可选值：\ngps;\nmapbar;\nbaidu;\nautonavi(不进行转换)", "required": false, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ds_id": { "type": "string", "description": "数据源" } }, "required": [ "ds_id" ] } } } } } }, "/2127-6": { "x-pointCode": 6, "x-mode": "mapping", "x-read-timeout": 5, "x-connect-timeout": 5, "post": { "summary": "行政区域查询", "description": "根据用户输入的搜索条件可以帮助用户快速的查找特定的行政区域信息。", "responses": { "200": { "description": "成功响应", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ShowapiResEnvelope" }, { "type": "object", "properties": { "showapi_res_body": { "type": "object", "properties": { "infocode": { "type": "string", "description": "状态码,返回状态说明，10000代表正确，详情参阅info状态表" }, "count": { "type": "string" }, "status": { "type": "string", "description": "返回结果状态值, 值为0或1，0表示失败；1表示成功" }, "districts": { "type": "array", "items": { "type": "object", "properties": { "0": { "type": "object", "properties": { "center": { "type": "string", "description": "区域中心点" }, "citycode": { "type": "array", "items": { "type": "string" }, "description": "城市编码" }, "level": { "type": "string", "description": "行政区划级别country:国家\nprovince:省份（直辖市会在province和city显示）\ncity:市（直辖市会在province和city显示）\ndistrict:区县\nstreet:街道" }, "name": { "type": "string", "description": "行政区名称" }, "districts": { "type": "array", "items": { "type": "object", "properties": { "0": { "type": "object", "properties": { "center": { "type": "string", "description": "区域中心点" }, "citycode": { "type": "string", "description": "城市编码" }, "level": { "type": "string", "description": "行政区划级别" }, "name": { "type": "string", "description": "行政区名称" }, "districts": { "type": "array", "items": { "type": "object", "properties": { "0": { "type": "object", "properties": { "center": { "type": "string" }, "citycode": { "type": "array", "items": { "type": "object" } }, "level": { "type": "string" }, "name": { "type": "string" }, "districts": { "type": "string" }, "adcode": { "type": "string" } } } } }, "description": "行政区列表" }, "adcode": { "type": "array", "items": { "type": "string" }, "description": "区域编码\n街道没有独有的adcode，均继承父类（区县）的adcode" } } } } }, "description": "行政区列表" } } } } }, "description": "行政区列表" }, "suggestion": { "type": "object", "properties": { "keywords": { "type": "array", "items": { "type": "string" }, "description": "建议关键字列表" }, "cities": { "type": "string" }, "cites": { "type": "array", "items": { "type": "string" }, "description": "建议城市列表" } }, "description": "建议结果列表" }, "info": { "type": "string" } }, "description": "业务返回体" } } } ] } } } } }, "operationId": "2127_6_POST", "parameters": [ { "name": "keywords", "in": "query", "description": "查询关键字\n规则：只支持单个关键词语搜索关键词支持：行政区名称、citycode、adcode\n例如，在subdistrict=2，搜索省份（例如山东），能够显示市（例如济南），区（例如历下区）\nadcode信息可参考城市编码表获取", "required": true, "schema": { "type": "string" } }, { "name": "subdistrict", "in": "query", "description": "规则：设置显示下级行政区级数（行政区级别包括：国家、省/直辖市、市、区/县、乡镇/街道多级数据）\n可选值：0、1、2、3等数字，并以此类推\n0：不返回下级行政区；\n1：返回下一级行政区；\n2：返回下两级行政区；\n3：返回下三级行政区；\n需要在此特殊说明，目前部分城市和省直辖县因为没有区县的概念，故在市级下方直接显示街道。\n\n例如：广东-东莞、海南-文昌市", "required": false, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "需要第几页数据\n最外层的districts最多会返回20个数据，若超过限制，请用page请求下一页数据。", "required": false, "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "最外层返回数据个数", "required": false, "schema": { "type": "string" } }, { "name": "extensions", "in": "query", "description": "返回结果控制\n此项控制行政区信息中返回行政区边界坐标点； 可选值：base、all;\nbase:不返回行政区边界坐标点；\nall:只返回当前查询district的边界值，不返回子节点的边界值；\n目前不能返回乡镇/街道级别的边界值", "required": false, "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "按照指定行政区划进行过滤，填入后则只返回该省/直辖市信息\n需填入adcode，为了保证数据的正确，强烈建议填入此参数", "required": false, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ds_id": { "type": "string", "description": "数据源" } }, "required": [ "ds_id" ] } } } } } }, "/2127-5": { "x-pointCode": 5, "x-mode": "mapping", "x-read-timeout": 5, "x-connect-timeout": 5, "post": { "summary": "步行路径规划", "description": "提供的步行、公交、驾车查询及行驶距离计算接口，用于实现路径规划功能的开发。高德原接口订购地址：https://developer.amap.com/api/webservice/guide/create-project/get-key", "responses": { "200": { "description": "成功响应", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ShowapiResEnvelope" }, { "type": "object", "properties": { "showapi_res_body": { "type": "object", "properties": { "infocode": { "type": "string" }, "count": { "type": "string", "description": "返回结果总数目" }, "status": { "type": "string", "description": "返回状态 --1：成功；0：失败" }, "route": { "type": "object", "properties": { "paths": { "type": "array", "items": { "type": "object", "properties": { "0": { "type": "object", "properties": { "duration": { "type": "string", "description": "步行时间预计\t单位：秒" }, "distance": { "type": "string", "description": "起点和终点的步行距离\t单位：米" }, "steps": { "type": "array", "items": { "type": "object", "properties": { "0": { "type": "object", "properties": { "orientation": { "type": "string", "description": "方向" }, "duration": { "type": "string", "description": "此路段预计步行时间" }, "distance": { "type": "string", "description": "此路段距离" }, "polyline": { "type": "string", "description": "此路段坐标点" }, "walk_type": { "type": "string", "description": "这段路是否存在特殊的方式 \n0，普通道路\n1，人行横道\n3，地下通道\n4，过街天桥\n5，地铁通道\n6，公园\n7，广场\n8，扶梯\n9，直梯\n10，索道\n11，空中通道\n12，建筑物穿越通道\n13，行人通道\n14，游船路线\n15，观光车路线\n16，滑道\n18，扩路\n19，道路附属连接线\n20，阶梯\n21，斜坡\n22，桥\n23，隧道\n30，轮渡" }, "action": { "type": "string", "description": "步行主要动作" }, "assistant_action": { "type": "array", "items": { "type": "string" }, "description": "步行辅助动作" }, "instruction": { "type": "string", "description": "路段步行指示" }, "road": { "type": "string", "description": "道路名称" } } } } }, "description": "每段步行方案" } } } } }, "description": "步行方案" }, "origin": { "type": "string" }, "destination": { "type": "string" } }, "description": "路线信息列表" }, "info": { "type": "string", "description": "返回的状态信息 --status为0时，info返回错误原；否则返回“OK”。详情参阅info状态表" } }, "description": "业务返回体" } } } ] } } } } }, "operationId": "2127_5_POST", "parameters": [ { "name": "origin", "in": "query", "description": "出发点\n\n规则： lon，lat（经度，纬度）， “,”分割，如117.500244, 40.417801 经纬度小数点不超过6位", "required": true, "schema": { "type": "string" } }, { "name": "destination", "in": "query", "description": "目的地\n规则： lon，lat（经度，纬度）， “,”分割，如117.500244, 40.417801 经纬度小数点不超过6位", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ds_id": { "type": "string", "description": "数据源" } }, "required": [ "ds_id" ] } } } } } }, "/2127-4": { "x-pointCode": 4, "x-mode": "mapping", "x-read-timeout": 5, "x-connect-timeout": 5, "post": { "summary": "地理编码", "description": "将详细的结构化地址转换为高德经纬度坐标。且支持对地标性名胜景区、建筑物名称解析为高德经纬度坐标。高德原接口订购地址：https://developer.amap.com/api/webservice/guide/create-project/get-key", "responses": { "200": { "description": "成功响应", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ShowapiResEnvelope" }, { "type": "object", "properties": { "showapi_res_body": { "type": "object", "properties": { "count": { "type": "string", "description": "返回结果数目 , 返回结果的个数。" }, "geocodes": { "type": "array", "items": { "type": "object", "properties": { "formatted_address": { "type": "string", "description": "结构化地址信息\n\n省份＋城市＋区县＋城镇＋乡村＋街道＋门牌号码" }, "country": { "type": "string", "description": "国家\n\n国内地址默认返回中国" }, "province": { "type": "string", "description": "地址所在的省份名\n\n例如：北京市。此处需要注意的是，中国的四大直辖市也算作省级单位。" }, "city": { "type": "string", "description": "地址所在的城市名\n\n例如：北京市" }, "citycode": { "type": "string", "description": "城市编码\n\n例如：010" }, "district": { "type": "string", "description": "地址所在的区\n\n例如：朝阳区" }, "street": { "type": "string", "description": "街道\n\n例如：阜通东大街" }, "number": { "type": "string", "description": "门牌\n\n例如：6号" }, "adcode": { "type": "string", "description": "区域编码\n\n例如：110101" }, "location": { "type": "string", "description": "坐标点\n\n经度，纬度" }, "level": { "type": "string", "description": "匹配级别\n\n参见下方的地理编码匹配级别列表" } } }, "description": "地理编码信息列表" }, "status": { "type": "string", "description": "返回结果状态值\n\n返回值为 0 或 1，0 表示请求失败；1 表示请求成功。" }, "info": { "type": "string", "description": "返回状态说明\n\n当 status 为 0 时，info 会返回具体错误原因，否则返回“OK”。详情可以参阅info状态表" } }, "description": "业务返回体" } } } ] } } } } }, "operationId": "2127_4_POST", "parameters": [ { "name": "address", "in": "query", "description": "结构化地址信息。\n规则遵循：国家、省份、城市、区县、城镇、乡村、街道、门牌号码、屋邨、大厦，如：北京市朝阳区阜通东大街6号。如果需要解析多个地址的话，请用\"|\"进行间隔，并且将 batch 参数设置为 true，最多支持 10 个地址进进行\"|\"分割形式的请求。", "required": true, "schema": { "type": "string" } }, { "name": "city", "in": "query", "description": "可选输入内容包括：指定城市的中文（如北京）、指定城市的中文全拼（beijing）、citycode（010）、adcode（110000），不支持县级市。当指定城市查询内容为空时，会进行全国范围内的地址转换检索。", "required": false, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ds_id": { "type": "string", "description": "数据源" }, "batch": { "type": "string", "description": "批量查询控制\nbatch 参数设置为 true 时进行批量查询操作，最多支持 10 个地址进行批量查询。\nbatch 参数设置为 false 时进行单点查询，此时即使传入多个地址也只返回第一个地址的解析查询结果。" } }, "required": [ "ds_id" ] } } } } } }, "/2127-2": { "x-pointCode": 2, "x-mode": "mapping", "x-read-timeout": 5, "x-connect-timeout": 5, "post": { "summary": "天气查询", "description": "根据用户输入的地区编码，查询目标区域当前/未来的天气情况。", "responses": { "200": { "description": "成功响应", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ShowapiResEnvelope" }, { "type": "object", "properties": { "showapi_res_body": { "type": "object", "properties": { "status": { "type": "string" }, "count": { "type": "string" }, "info": { "type": "string" }, "infocode": { "type": "string" }, "lives": { "type": "array", "items": { "type": "object", "properties": { "0": { "type": "object", "properties": { "province": { "type": "string", "description": "省份名" }, "city": { "type": "string", "description": "城市名" }, "adcode": { "type": "string", "description": "区域编码" }, "weather": { "type": "string", "description": "天气现象（汉字描述）" }, "temperature": { "type": "string", "description": "实时气温，单位：摄氏度" }, "winddirection": { "type": "string", "description": "风向描述" }, "windpower": { "type": "string", "description": "风力级别，单位：级" }, "humidity": { "type": "string", "description": "空气湿度" }, "reporttime": { "type": "string", "description": "数据发布的时间" } } } } }, "description": "实况天气数据信息" } }, "description": "业务返回体" } } } ] } } } } }, "operationId": "2127_2_POST", "parameters": [ { "name": "city", "in": "query", "description": "输入城市的编码。具体参数值请见帮助文档，对应文档中的adcode", "required": true, "schema": { "type": "string" } }, { "name": "extensions", "in": "query", "description": "可选值：base/all\nbase:返回实况天气，为默认值。\nall:返回预报天气。", "required": false, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ds_id": { "type": "string", "description": "数据源" } }, "required": [ "ds_id" ] } } } } } }, "/2127-1": { "x-pointCode": 1, "x-mode": "mapping", "x-read-timeout": 5, "x-connect-timeout": 5, "post": { "summary": "IP定位", "description": "IP定位是一个简单的HTTP接口，根据用户输入的IP地址，能够快速的帮用户定位IP的所在位置。", "responses": { "200": { "description": "成功响应", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ShowapiResEnvelope" }, { "type": "object", "properties": { "showapi_res_body": { "type": "object", "properties": { "status": { "type": "string" }, "info": { "type": "string", "description": "是否成功的标志" }, "infocode": { "type": "string", "description": "是否成功的编码" }, "province": { "type": "string" }, "city": { "type": "string" }, "adcode": { "type": "string" }, "rectangle": { "type": "string", "description": "区间范围" } }, "description": "业务返回体" } } } ] } } } } }, "operationId": "2127_1_POST", "parameters": [ { "name": "ip", "in": "query", "description": "需要查询的IP地址", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ds_id": { "type": "string", "description": "数据源" } }, "required": [ "ds_id" ] } } } } } } }, "components": { "securitySchemes": { "AppKeyAuth": { "type": "apiKey", "in": "query", "name": "appKey", "description": "从 ShowAPI 控制台获取的 appKey，管理地址：https://www.showapi.com/console#/myApp" } }, "schemas": { "ShowapiResEnvelope": { "type": "object", "description": "ShowAPI 统一返回包裹（业务数据位于 showapi_res_body）", "properties": { "showapi_res_code": { "type": "integer", "description": "API 返回的状态码" }, "showapi_res_error": { "type": "string", "description": "API 返回的错误信息" }, "showapi_res_id": { "type": "string", "description": "API 请求的唯一标识" }, "showapi_fee_num": { "type": "integer", "description": "API 调用计费次数" } } } } }, "security": [ { "AppKeyAuth": [] } ], "externalDocs": { "url": "https://www.showapi.com/apiGateway/view/2127?tab=book" }, "x-apiCode": "2127", "x-is-own": false, "x-is-op": true }