跳转到主要内容

开始使用 List Posts 查询端点

本快速入门指南将帮助你使用 Postman 向 List Posts 查询端点发起你的第一个请求。 如果你想查看不同语言的示例代码,请访问我们的 X API v2 示例代码 GitHub 代码库。

前提条件

完成本指南,你需要一组用于请求认证的密钥和令牌。你可以按照以下步骤生成这些密钥和令牌:
  • 注册开发者账号并通过审批。
  • 在开发者门户中创建一个项目以及关联的开发者应用
  • 前往你的应用的“Keys and tokens”页面以生成所需的凭证。请确保将所有凭证保存在安全的位置。

构建 List Posts 查找请求的步骤

第一步:先选择一个工具或库

有多种工具、代码示例和库可用于向该端点发起请求,但为简化流程,我们将在这里使用 Postman。 要将 X API v2 的 Postman 集合导入到你的环境中,请点击以下按钮: 在你将 X API v2 集合加载到 Postman 后,进入“List”文件夹,选择“List Posts”文件夹,然后选择“List Posts lookup”。  

步骤二:为请求进行认证

要正确地向 X API 发起请求,你需要确认自己具有相应权限。对于此端点,你必须使用以下任一认证方式对请求进行认证:App onlyOAuth 2.0 授权码(PKCE)OAuth 1.0a 用户上下文 为简便起见,我们将在本次请求中使用 App only,但如果你想请求私有的 metrics 或 Posts,则需要使用其他认证方式之一。 要使用 App only,你需要将密钥和令牌(具体为 App only Access Token,也称为 App only Bearer Token)添加到 Postman:在 Postman 右上角选择名为“X API v2”的环境,并将你的密钥和令牌添加到“initial value”和“current value”字段(点击环境下拉菜单旁的眼睛图标)。 如果设置正确,这些变量会自动填充到请求的 authorization 选项卡中。  

第三步:确定并指定要从哪个 List 检索 Post

你必须在请求中指定要接收的 List。你可以通过访问 x.com,点击某个 List,然后在 URL 中查找该 List 的 ID。比如,以下 URL 的 List ID 是 84839422。 https://x.com/i/lists/84839422 目标 ID 可以是任何有效的 List ID。在 Postman 中,转到“Params”选项卡,在路径变量 id 的“Value”列中输入你的 ID。请确保任何 ID 前后都不要包含空格。
KeyValue
id84839422(List ID)

第四步:确定并指定要检索的字段

如果你在第三步后点击“Send”按钮,你将在响应中收到默认的 Post 对象 字段:id 和 text。 如果你想接收更多字段,需要在请求中通过 tweet.fields 和/或 expansions 参数来指定这些字段。 在本练习中,我们将从不同对象请求三组额外字段:
  • 主 Lists 对象中的额外 created_at 字段。
  • 使用 expansions 参数获取完整的 user 对象
  • 关联 user 对象中的额外 user.created_at 字段。
在 Postman 中,进入“Params”选项卡,并在“Query Params”表中添加以下键值对:
KeyValueReturned fields
tweet.fieldscreated_atcreated_at
expansionsauthor_idincludes.users.id,
includes.users.name,
includes.users.username
user.fieldscreated_atincludes.users.created_at
你现在应该会在“Send”按钮旁看到类似的 URL: https://api.x.com/2/lists/84839422/tweets?expansions=author_id&user.fields=created_at&max_results=1

步骤五:发出请求并查看响应

在完成所有设置后,点击“Send”按钮,你将会收到与下方示例相似的响应:
{
  "data": [
    {
      "author_id": "4172587277",
      "id": "1458172421115101189",
      "text": "A Alemanha registrou nesta semana um recorde de novos casos de Covid-19. Segundo o governo e especialistas em Saúde, pessoas não vacinadas são responsáveis pela situação \nhttps://t.co/4POyaPwMLu"
    }
  ],
  "includes": {
    "users": [
      {
        "username": "MomentsBrasil",
        "name": "Twitter Moments Brasil",
        "created_at": "2015-11-12T16:46:02.000Z",
        "id": "4172587277"
      }
    ]
  },
  "meta": {
    "result_count": 1,
    "next_token": "7140dibdnow9c7btw3z2vwioavpvutgzrzm9icis4ndix"
  }
}
请注意: 此端点的响应支持查询指定 List 的最新 800 条 Post