抖音开放平台Logo
控制台

查询视频携带的地点信息

收藏
我的收藏

​状态码排查​

进入【状态码排查工具】​

接口说明

该接口用于 poi 信息的查询，应用场景为在发布内容时查询并携带该 poi 信息发布至抖音，该接口当前定向开放给媒体行业第三方；若其他行业有相关诉求，也可发起权限申请，会有相关工作人员尽快给予反馈。

Scope: poi.search

需要申请权限。路径：移动/网站应用：抖音开放平台控制台 > 应用详情 > 权限管理 > 特殊权限

不需要用户授权。

查询 POI 信息：通过用 POI 的关键词进行条件搜索，获取匹配 POI 列表，例如：肯德基、朝阳公园等。

注意：

抖音的 OAuth API 以https://open.douyin.com/ 开头。

基本信息

名称描述
HTTP URL
https://open.douyin.com/poi/search/keyword/
HTTP Method
GET
Scope
poi.search

请求头

名称字段类型是否必填示例描述
access-tokenString是clt.943da17996fb5cebfbc70c044c3fc25a57T54DcjT6HNKGqnUdxzy1KcxFnZ
调用https://open.douyin.com/oauth/client_token/生成的token
content-typeString是application/json
固定值"application/json"

请求参数

Query

名称字段类型是否必填示例描述
countInt64是10
每页数量
keywordString是美食
查询关键字，例如美食
cityString否北京
查询城市，例如上海、北京
cursorInt64否0
分页游标, 第一页请求cursor是0, response中会返回下一页请求用到的cursor, 同时response还会返回has_more来表明是否有更多的数据。

请求示例

curl --location --request GET 'https://open.douyin.com/poi/search/keyword/?cursor=1398640286132272095&count=3737132339231560475&keyword=I8shTG0gao&city=pCsJY6jh6d' \
--header 'content-type: application/json' \
--header 'access-token: clt.943da17996fb5cebfbc70c044c3fc25a57T54DcjT6HNKGqnUdxzy1KcxFnZ' \

响应参数

Body

名称字段类型是否必填示例描述

响应示例

正常响应示例

{
  "data": {
    "cursor": 1,
    "description": "",
    "error_code": "0",
    "has_more": true,
    "pois": [
      {
        "address": "东城区",
        "city": "北京市",
        "city_code": "110101",
        "country": "中国",
        "country_code": "CN",
        "district": "东城区",
        "location": "116.401179,39.902768",
        "poi_id": "6601131771805304836",
        "poi_name": "北京市",
        "province": "北京市"
      }
    ]
  },
  "extra": {
    "description": "",
    "error_code": "0",
    "logid": "202008121419360101980821035705926A",
    "now": "1597213176393",
    "sub_description": "",
    "sub_error_code": "0"
  }
}

异常响应示例

{
  "data": {
    "description": "Parameter error",
    "error_code": 2100005
  },
  "extra": {
    "logid": "2020070614111601022506808001045D59",
    "now": 1594015876138
  }
}
​