腾讯位置服务 WebService API

https://lbs.qq.com/service/webService/webServiceGuide
Admin
腾讯位置服务 WebService API 提供丰富的地理位置服务，包括地点搜索、地址解析、路线规划、定位、室内地图和海外服务，助力开发者高效集成LBS能力。
Tokens:219,779
Snippets:592
Trust Score:10
Update:1 month ago
Show doc for...
Tokens:
Raw
### GET /ws/direction/v1/bicycling

Source: https://lbs.qq.com/service/webService/webServiceGuide/Overseas/webServiceRoute

Plans a bicycling route between a start and end coordinate. Returns route details including distance, duration, polyline, and step-by-step instructions.

```APIDOC
## [GET] /ws/direction/v1/bicycling

### Description
Plans a bicycling route between a start and end coordinate. Returns route details including distance, duration, polyline, and step-by-step instructions.

### Method
GET

### Endpoint
https://apis.map.qq.com/ws/direction/v1/bicycling

### Parameters
#### Query Parameters
- **key** (string) - Required - Development key.
- **from** (string) - Required - Start location coordinate. Format: latitude,longitude (comma-separated). The system will snap to the nearest road within 20 km; otherwise, route calculation fails.
- **to** (string) - Required - End location coordinate. Format: latitude,longitude. Distance must be between 10 meters and 500 kilometers.
- **language** (string) - Optional - Response language. `cn` (default) for Chinese, `local` for local language. See appendix for supported languages.
- **callback** (string) - Optional - Callback function name for JSONP.
- **output** (string) - Optional - Response format: `json` or `jsonp`.

### Request Example
https://apis.map.qq.com/ws/direction/v1/bicycling?key=API_KEY&from=40.7480,-73.9862&to=40.7561,-73.9833

### Response
#### Success Response (200)
- **status** (number) - Status code, 0 for success, others for errors.
- **message** (string) - Status description.
- **result** (object) - Search result.
  - **routes** (array) - Route plans.
    - **mode** (string) - Transportation mode, fixed value: "BICYCLING".
    - **distance** (number) - Total distance in meters.
    - **duration** (number) - Estimated time in minutes.
    - **polyline** (array) - Compressed polyline coordinates.
    - **steps** (array) - Route steps.
      - **instruction** (string) - Step description.
      - **polyline_idx** (array) - Indices of step polyline in the overall polyline.
      - **road_name** (string) - Road name.
      - **dir_desc** (string) - Direction description.
      - **distance** (number) - Step distance in meters.
      - **act_desc** (string) - Action at the end of the step.

#### Response Example
{
    "status": 0,
    "message": "Success",
    "request_id": "here_14721e5efd2c468cbc430c3e64964e67",
    "result": {
        "routes": [
            {
                "mode": "BICYCLING",
                "distance": 4903,
                "duration": 23.22,
                "polyline": [
                    -23.522211,
                    -46.857983,
                    -109,
                    173,
                    -140,
                    200
                ],
                "steps": [
                    {
                        "instruction": "Head southeast on Rua Arthur Montovanelli. Go for 95 m.",
                        "polyline_idx": [0, 7],
                        "road_name": "Rua Arthur Montovanelli",
                        "duration": 0,
                        "distance": 95,
                        "act_desc": "depart"
                    },
                    {
                        "instruction": "Arrive at Avenida Doutor Dib Sauaia Neto. Your destination is on the left.",
                        "polyline_idx": [242, 243],
                        "road_name": "Avenida Doutor Dib Sauaia Neto",
                        "duration": 0,
                        "distance": 0,
                        "act_desc": "arrive"
                    }
                ]
            }
        ]
    }
}
```

--------------------------------

### GET /ws/place/v1/alongby

Source: https://lbs.qq.com/service/webService/webServiceGuide/alongby

检索某段道路附近的POI信息，可配合路线规划，为用户提供沿途服务区、加油站等搜索功能。该接口为高级付费服务，请求方式为GET，接口长度不能超过8kb。

```APIDOC
## [GET] /ws/place/v1/alongby

### Description
检索某段道路附近的POI信息，可配合路线规划，为用户提供沿途服务区、加油站等搜索功能。

### Method
GET

### Endpoint
https://apis.map.qq.com/ws/place/v1/alongby

### Parameters
#### Query Parameters
- **key** (string) - Required - 开发密钥（Key）
- **keyword** (string) - Required - 搜索关键词，支持分类：充电站、厕所、停车场、购物、加油站、银行ATM、加气站、便利店、服务区、汽车维修、中石油、中石化
- **polyline** (string) - Required - 路线坐标串，格式：lat<纬度>,lng经度,lat<纬度>,lng经度…，经纬度建议保留6位小数，坐标个数受HTTP/GET方法长度限制，一般可支持350个左右
- **output** (string) - Optional - 返回格式：支持JSON/JSONP，默认JSON
- **callback** (string) - Optional - JSONP方式回调函数

### Request Example
https://apis.map.qq.com/ws/place/v1/alongby?keyword=便利店&polyline=39.884354953696814,116.46138998314004,39.88697994710748,116.46141998687052,39.88697994710748,116.46141998687052&key=OB4BZ-D4W3U-*****

### Response
#### Success Response (200)
- **status** (number) - 状态码，0为正常，其它为异常
- **request_id** (string) - 本次请求唯一ID，可用于问题排查
- **count** (number) - POI数量
- **result** (object) - 检索结果
  - **id** (string) - POI（地点）唯一标识
  - **title** (string) - POI（地点）名称
  - **address** (string) - 地址
  - **tel** (string) - 电话
  - **category** (string) - POI（地点）分类
  - **type** (number) - POI类型
- **location** (object) - 坐标
  - **lat** (number) - 纬度
  - **lng** (number) - 经度
- **ad_info** (object) - 定位行政区划信息
  - **adcode** (number) - 行政区划代码
  - **province** (string) - 省
  - **city** (string) - 市（可选）
  - **district** (string) - 区（可选）

#### Response Example
{
  "status": 0,
  "request_id": "...",
  "count": 1,
  "result": [
    {
      "id": "...",
      "title": "...",
      "address": "...",
      "tel": "...",
      "category": "...",
      "type": 0,
      "location": {
        "lat": 39.9,
        "lng": 116.4
      },
      "ad_info": {
        "adcode": 110000,
        "province": "北京市",
        "city": "北京市",
        "district": "海淀区"
      }
    }
  ]
}
```

--------------------------------

### POST /ws/scheduler/v1/async/create

Source: https://lbs.qq.com/service/webService/webServiceGuide/route/scheduler

异步模式创建排线任务，支持大于200个点的计算。

```APIDOC
## [POST] /ws/scheduler/v1/async/create

### Description
创建排线任务，提交接口所需参数（车辆、仓库、配送点地等），提交成功后，任务会在后台运行。

### Method
POST

### Endpoint
/ws/scheduler/v1/async/create

### Parameters
#### Request Body
- **key** (string) - Required - 开发者key。
- **depot** (array) - Required - 仓库列表。
- **vehicle_type** (string) - Required - 车辆类型。
- **vehicle_model** (object) - Optional - 货车车型信息。
- **vehicle** (array) - Required - 车辆信息。
- **job** (array) - Required - 工作任务列表。

### Request Example
{
  "key": "XXXXX-XXXXX-XXXXX...",
  "depot": [
    {
      "id": "depot_0000001",
      "location": {
        "lat": 39.165234,
        "lng": 116.45278924
      }
    }
  ],
  "vehicle_type": "trucking",
  "vehicle": [
    {
      "id": "vehicle_00003",
      "depot_id": "depot_0000001",
      "capacity": {
        "count": 20
      }
    }
  ],
  "job": [
    {
      "id": "job_0000001",
      "location": {
        "lat": 39.165234,
        "lng": 116.45278924
      },
      "demand": {
        "count": 20
      }
    }
  ]
}

### Response
#### Success Response (200)
- **status** (number) - 状态码，0为正常。
- **message** (string) - 状态信息。
- **request_id** (string) - 请求唯一标识。
- **task_id** (string) - 任务ID，用于后续查询。

#### Response Example
{
  "status": 0,
  "message": "Success",
  "request_id": "81012f0292a945e4aacd8d5022cefe97",
  "task_id": "task_ad5bdb6..."
}
```

--------------------------------

### GET /ws/geocoder/v1/

Source: https://lbs.qq.com/service/webService/webServiceGuide/Overseas/Gcoder

This code snippet documents the reverse geocoding API endpoint for overseas locations, including its request parameters, response structure, and an example request.

```APIDOC
## [GET] /ws/geocoder/v1/

### Description
This endpoint converts latitude and longitude coordinates to a textual address and related location information. It is widely used in logistics, travel, O2O, and social scenarios.

### Method
GET

### Endpoint
https://apis.map.qq.com/ws/geocoder/v1/?location=

### Parameters
#### Query Parameters
- **key** (string) - Required - Development key (Key)
- **location** (string) - Required - Latitude and longitude to parse (must be overseas), e.g., `41.8840047,-87.630220`
- **language** (string) - Optional - Language of returned results: `cn` (Chinese, default) or `local` (local language). See appendix for supported languages.
- **output** (string) - Optional - Return format: `JSON` or `JSONP`, default is `JSON`
- **callback** (string) - Optional - Callback function for JSONP

### Request Example
https://apis.map.qq.com/ws/geocoder/v1?location=41.8840047,-87.6302201&key=API_KEY&language=cn

### Response
#### Success Response (200)
- **status** (number) - Status code, 0 for normal
- **message** (string) - Status description
- **result** (object) - Reverse geocoding result
  - **location** (object) - Coordinates
    - **lat** (number) - Latitude
    - **lng** (number) - Longitude
  - **address** (string) - Address
  - **address_component** (object) - Address components, can be used to assemble address if `address` is insufficient
    - **nation** (string) - Country
    - **ad_level_1** (string) - First-level administrative division: usually state (US) / prefecture (Japan)
    - **ad_level_2** (string) - Second-level division, usually county
    - **ad_level_3** (string) - Third-level division, usually city
    - **ad_level_4** (string) - Fourth-level division, usually district
    - **ad_level_5** (string) - Fifth-level division, usually community
    - **street** (string) - Street, may be empty string
    - **street_number** (string) - Street number
  - **ad_info** (object) - Administrative division information
    - **nation** (string) - Country
    - **nation_code** (string) - Country code

#### Response Example
{
  "status": 0,
  "message": "ok",
  "result": {
    "location": {
      "lat": 41.8840047,
      "lng": -87.6302201
    },
    "address": "...",
    "address_component": {
      "nation": "...",
      "ad_level_1": "...",
      "ad_level_2": "...",
      "ad_level_3": "...",
      "ad_level_4": "...",
      "ad_level_5": "...",
      "street": "...",
      "street_number": "..."
    },
    "ad_info": {
      "nation": "...",
      "nation_code": "..."
    }
  }
}
```

--------------------------------

### GET /ws/indoor/v1/explore

Source: https://lbs.qq.com/service/webService/webServiceGuide/indoorservice/indoorexplore

根据室内地图指定选点获取该区域内的楼层和相关室内POI（兴趣点）信息。该接口为GET请求，属于高级付费服务。

```APIDOC
## [GET] /ws/indoor/v1/explore

### Description
根据室内地图指定选点获取该区域内的楼层和相关室内POI（兴趣点）信息。

### Method
GET

### Endpoint
https://apis.map.qq.com/ws/indoor/v1/explore

### Parameters
#### Query Parameters
- **key** (string) - Required - 开发密钥（Key）
- **floor_name** (string) - Required - 搜索所在楼层
- **boundary** (string) - Required - 范围条件，目前支持周边搜索方式：nearby(lat<纬度>,lng<经度>,radius<半径>)，半径（单位：米）取值范围0-100，推荐取10
- **callback** (string) - Optional - 回调函数
- **output** (string) - Optional - 返回格式：支持JSON/JSONP，默认JSON

### Request Example
GET https://apis.map.qq.com/ws/indoor/v1/explore?key=OB4BZ-D4W3U-***&floor_name=F1&boundary=nearby(39.984154,116.307490,10)&output=json

### Response
#### Success Response (200)
- **status** (number) - 状态码，0为正常，其它为异常
- **message** (string) - 状态说明
- **request_id** (string) - 本次请求的唯一标识，用于问题排查
- **result** (object) - 结果
  - **pois** (array) - 返回POI列表，本数组目前最多返回1个POI
    - **id** (string) - POI唯一标识
    - **title** (string) - POI名称
    - **address** (string) - 地址
    - **category** (string) - POI类型
    - **category_code** (string) - POI类型编码
    - **location** (object) - 坐标
      - **lat** (number) - 纬度
      - **lng** (number) - 经度
    - **_distance** (number) - 传入location（定位坐标）参数时，返回定位坐标到各POI的直线距离，单位：米
    - **building_id** (string) - 室内建筑物唯一标识，室内POI时存在
    - **floor_name** (string) - 楼层名称，室内POI时存在
    - **indoor_id** (string) - 室内点位ID，室内POI时存在

#### Response Example
{
    "status": 0,
    "message": "query ok",
    "request_id": "f1596a32804*******",
    "result": {
        "pois": [
            {
                "id": "340175464*******",
                "title": "只有红楼梦戏剧幻城",
                "address": "河北省廊坊市广阳区耀华********",
                "category": "娱乐休闲:剧场音乐厅:剧场",
                "category_code": "161710",
                "location": {
                    "lat": 39.562678,
                    "lng": 116.719353
                },
                "_distance": 0
            }
        ]
    }
}
```

--------------------------------

### GET /ws/direction/v1/ebicycling/

Source: https://lbs.qq.com/service/webService/webServiceGuide/route/webServiceRoute

This endpoint provides route planning for electric bicycles. It accepts start and end coordinates (or POI IDs) and returns route plans with distance, duration, direction, polyline, and step-by-step instructions.

```APIDOC
## [GET] /ws/direction/v1/ebicycling/

### Description
Provides route planning for electric bicycles, considering facilities and roads accessible to e-bikes to ensure route reasonableness.

### Method
GET

### Endpoint
https://apis.map.qq.com/ws/direction/v1/ebicycling/

### Parameters
#### Query Parameters
- **key** (string) - Required - Development key.
- **from** (string) - Required - Start location coordinates, format: latitude,longitude (e.g., 39.915285,116.403857). The system will snap to the nearest road; if no road within 20km, route calculation fails.
- **from_poi** (string) - Optional - Start POI ID. If provided, it takes priority over the from coordinate for route calculation.
- **to** (string) - Required - End location coordinates, format: latitude,longitude (e.g., 39.915285,116.803857).
- **to_poi** (string) - Optional - End POI ID (obtainable via Tencent Location Service Place Search). If the destination is a large campus or community, the guide point (e.g., entrance/exit) is used as the endpoint. This parameter takes priority over the to coordinate, but if no guide point data exists or the POI ID is invalid, the to coordinate is used.
- **added_fields** (string) - Optional - Returns specified optional fields. Supported: ferry_count (number of ferry rides included in the route).
- **callback** (string) - Optional - Callback function name.
- **output** (string) - Optional - Return value type: json or jsonp.

### Request Example
https://apis.map.qq.com/ws/direction/v1/ebicycling/?from=23.020685,113.489096&to=23.019998,113.489190&key=[your key]

### Response
#### Success Response (200)
- **status** (number) - Status code, 0 for normal, others for error.
- **message** (string) - Status description.
- **result** (object) - Search result.
  - **routes** (array) - Route plans.
    - **mode** (string) - Traffic mode, fixed value: "EBICYCLING".
    - **distance** (number) - Total distance in meters.
    - **duration** (number) - Estimated time in minutes.
    - **direction** (string) - Overall direction.
    - **polyline** (array) - Route coordinate point string (compressed; see polyline decompression).
    - **steps** (array) - Route steps.
      - **instruction** (string) - Step description.
      - **polyline_idx** (array) - Indices of the step's coordinate points in the overall polyline.
      - **road_name** (string) - Road name (optional).
      - **dir_desc** (string) - Step direction (optional).
      - **distance** (number) - Step distance in meters.
      - **act_desc** (string) - Action at the end of the step (optional).
    - **ferry_count** (number) - Number of ferry rides in the route (>=1 indicates the route includes ferries). Returned only when added_fields=ferry_count.

#### Response Example
{
    "status": 0,
    "message": "query ok",
    "result": {
        "routes": [
            {
                "mode": "EBICYCLING",
                "distance": 26,
                "duration": 0,
                "direction": "南",
                "polyline": [
                    23.020059,
                    113.489437,
                    -101,
                    -219,
                    0,
                    0,
                    -4,
                    -11
                ],
                "steps": [
                    {
                        "instruction": "从起点朝西南,行进26米,到达终点",
                        "polyline_idx": [
                            0,
                            7
                        ],
                        "road_name": "",
                        "dir_desc": "西南",
                        "distance": 26,
                        "act_desc": ""
                    }
                ]
            }
        ]
    }
}
```

--------------------------------

### GET https://apis.map.qq.com/ws/place/v1/here

Source: https://lbs.qq.com/service/webService/webServiceGuide/webServiceSearch

周边推荐（here）接口的API文档，包含请求URL、请求参数、响应结果和调用示例。

```APIDOC
## [GET] https://apis.map.qq.com/ws/place/v1/here

### Description
搜索获取周边高热度地点，侧重于以地标+主要的路+近距离POI为主，着力描述当前位置，同时提供到家场景（如创建收货地址）、出行场景的地点推荐。

### Method
GET

### Endpoint
https://apis.map.qq.com/ws/place/v1/here

### Parameters
#### Query Parameters
- **key** (string) - Required - 开发密钥（Key）
- **boundary** (string) - Required - 格式：boundary=nearby(lat,lng,radius[, auto_extend])，子参数：lat,lng：搜索中心点的经纬度，纬度在前，经度在后；radius：搜索半径，单位：米，取值范围：10到1000
- **policy** (number) - Optional - 搜索策略：policy=1[默认] 以地标+主要的路+近距离POI为主，着力描述当前位置；policy=2 到家场景：筛选合适收货的POI，并会细化收货地址，精确到楼栋；policy=3 出行场景：过滤掉车辆不易到达的POI(如一些景区内POI)，增加道路出入口、交叉口、大区域出入口类POI，排序会根据真实API大用户的用户点击自动优化。
- **filter** (string) - Optional - 筛选条件，支持指定分类筛选，语句格式为：category=分类名1,分类名2，分类词数量建议不超过5个
- **address_format** (string) - Optional - 地址格式，可选值：short，返回不包含省市区的短地址（缺省则为包含省市区的标准地址）
- **output** (string) - Optional - 返回格式：支持JSON/JSONP，默认JSON
- **callback** (string) - Optional - JSONP方式回调函数

### Request Example
https://apis.map.qq.com/ws/place/v1/here?boundary=nearby(40.040394,116.273523,1000)&policy=1&page_size=10&page_index=1&key=OB4BZ-D4W3U-*****

### Response
#### Success Response (200)
- **status** (number) - 状态码，0为正常，其它为异常
- **message** (string) - 状态说明
- **count** (number) - 本次搜索结果总数，本服务限制最多返回10条数据(data)
- **request_id** (string) - 本次请求的唯一标识，由系统自动生成，用于追查结果有异常时使用
- **data** (array) - 搜索结果POI（地点）数组，每项为一个POI（地点）对象
  - **id** (string) - POI（地点）唯一标识（即：POI ID）
  - **title** (string) - POI（地点）名称
  - **address** (string) - 地址
  - **category** (string) - POI（地点）分类
  - **location** (object) - 坐标
    - **lat** (number) - 纬度
    - **lng** (number) - 经度
  - **_distance** (number) - 与boundary传入的经纬度的直线距离，单位：米
  - **ad_info** (object) - 行政区划信息
    - **adcode** (number) - 行政区划代码
    - **province** (string) - 省
    - **city** (string) - 市，如果当前城市为省直辖县级区划，city与district字段均会返回此城市
    - **district** (string) - 区

#### Response Example
{
  "status": 0,
  "message": "query ok",
  "count": 1,
  "request_id": "xxx",
  "data": [
    {
      "id": "xxx",
      "title": "xxx",
      "address": "xxx",
      "category": "xxx",
      "location": {
        "lat": 40.040394,
        "lng": 116.273523
      },
      "_distance": 100,
      "ad_info": {
        "adcode": 110000,
        "province": "北京市",
        "city": "北京市",
        "district": "朝阳区"
      }
    }
  ]
}
```

--------------------------------

### GET 请求调用距离矩阵服务

Source: https://lbs.qq.com/service/webService/webServiceGuide/webServiceMatrix

GET 请求示例，用于调用腾讯位置服务距离矩阵服务。需将 [你的key] 替换为实际密钥。

```http
// GET请求   
 https://apis.map.qq.com/ws/distance/v1/matrix/?mode=driving&from=39.829647,116.422462,-1,0,-1,0,1639108623|39.830553,116.422924,-1,0,-1,0,1639108628|39.831261,116.423289,-1,0,-1,0,1639108633;22.902664,113.824282&to=43.889352,87.460222&key=[你的key]  
```

--------------------------------

### GET 请求调用距离矩阵接口

Source: https://lbs.qq.com/service/webService/webServiceGuide/route/webServiceMatrix

GET 请求示例，用于调用腾讯位置服务距离矩阵接口。请求参数包括 mode=driving、from（多起点坐标及时间戳）、to（终点坐标）和 key（需替换为实际密钥）。

```http
// GET请求   
   https://apis.map.qq.com/ws/distance/v1/matrix/?mode=driving&from=39.829647,116.422462,-1,0,-1,0,1639108623|39.830553,116.422924,-1,0,-1,0,1639108628|39.831261,116.423289,-1,0,-1,0,1639108633;22.902664,113.824282&to=43.889352,87.460222&key=[你的key]
```
Tokens:
Raw