接口说明

该接口用于 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-token必填String

示例：clt.943da17996fb5cebfbc70c044c3fc25a57T54DcjT6HNKGqnUdxzy1KcxFnZ

调用https://open.douyin.com/oauth/client_token/生成的token

content-type必填String

示例：application/json

固定值"application/json"

Query

count必填Int64

示例：10

每页数量

keyword必填String

示例：美食

查询关键字，例如美食

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展开全部子属性

extra必填Struct

展开子属性

dataStruct

展开子属性

extra_bodyStruct

展开子属性

响应示例
正常响应示例异常响应示例
{
  "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"
  }
}

切换单列布局

错误码

HTTP 状态码	错误码	错误码描述	排查建议
200	28001005	系统内部错误，请重试	请求重试，若依然无解请向平台提交反馈
200	28001003	access_token无效	重新请求生成access_token
200	28001008	access_token过期,请刷新或重新授权	重新请求生成access_token
200	28001016	当前应用已被封禁或下线	clientKey被封禁或者下线
200	28001006	网络调用错误，请重试	重试即可
200	28001014	应用未授权任何能力	确认应用是否授权能力
200	28001018	应用未获得该能力	开通相关能力
200	28003017	quota已用完	联系平台处理
200	28001019	应用该能力已被封禁	该能力被封禁，联系平台处理
200	28001007	参数不合法	根据错误信息检查请求参数是否填写正常

开发者文档

查询视频携带的地点信息

状态码排查

接口说明

基本信息

请求参数

响应参数

错误码

查询视频携带的地点信息在线调试

状态码排查

接口说明

基本信息

请求参数

响应参数

错误码

查询视频携带的地点信息