検索API

クエリ

ベースは Twitter v2 のクエリ.

オペレータ

Operator意味例単独使用可能
keyword特定のキーワードを含む松江 AND どこyes
""文字列の完全一致"造幣局 桜"yes
from:特定ユーザーによるノートfrom:@[email protected] or from:@[email protected]yes
is:renoteリノートhello world -is:renoteno
is:quote引用リノート#筑後川花火大会 is:quoteno
has:link本文にリンクを含むノートnowplaying has:linkno
has:media添付ファイルを含むノート#徳川家康 has:mediano

演算子

演算子説明
ANDスペースを挟んで連続する演算子はAND 論理演算となり、両方の条件を満たしたノートが返されます
OROR を挟んで連続する演算子はOR論理演算となり、どちらかの条件を満たしたノートが返されます.
-キーワードの前にハイフンをつけると、そのキーワードを論理否定することができます.
()カッコでくくると演算子をグループ化できます. AND>ORの順で適用されます.

GET /search/notes

投稿を検索します. 返す最大件数は100件です

入力

  • クエリパラメータ
    • query: string
      • 検索クエリ
      • 上記の内容を受け取ります

出力

200 OK

検索に成功

出力の内容はタイムラインと同一である.

[
  {
    "id": "3893974892",
    "content": "hello world!",
    "cw_comment": "",
    "visibility": "public",
    "created_at": "2023-09-27T14:17:29.169Z",
    "attachment_files": [
      {
        "id": "204980348583",
        "filename": "hello.png",
        "content_type": "image/png",
        "url": "https://example.com/images/hello.png",
        "blur": "eoig:woi!our@nj/d",
        "nsfw": false
      }
    ],
    "reactions": [
      {
        "emoji": "<:alias:11938437>",
        "reacted_by": "3085763644"
      },
      {
        "emoji": "🎉",
        "reacted_by": "494984128"
      }
    ],
    "author": {
      "id": "2874987398",
      "name": "@[email protected]",
      "display_name": "John Doe",
      "bio": "I am Test User.",
      "avatar": "https://example.com/images/avatar.png",
      "header": "https://example.com/images/header.png",
      "followed_count": 200,
      "following_count": 10
    }
  }
]

400 Bad Request

{
  "error": "TEST_ERROR_CODE"
}
  • INVALID_QUERY: クエリが正しくありません