Skip to main content
POST
/
search
/
messages
Search messages
curl --request POST \
  --url https://api.fluxer.app/v1/search/messages \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "hits_per_page": 13,
  "page": 4503599627370496,
  "max_id": "<string>",
  "min_id": "<string>",
  "content": "<string>",
  "contents": [
    "<string>"
  ],
  "exact_phrases": [
    "<string>"
  ],
  "channel_id": [
    "<string>"
  ],
  "exclude_channel_id": [
    "<string>"
  ],
  "author_type": [
    "user"
  ],
  "exclude_author_type": [
    "user"
  ],
  "author_id": [
    "<string>"
  ],
  "exclude_author_id": [
    "<string>"
  ],
  "mentions": [
    "<string>"
  ],
  "exclude_mentions": [
    "<string>"
  ],
  "mention_everyone": true,
  "pinned": true,
  "has": [
    "image"
  ],
  "exclude_has": [
    "image"
  ],
  "embed_type": [
    "image"
  ],
  "exclude_embed_type": [
    "image"
  ],
  "embed_provider": [
    "<string>"
  ],
  "exclude_embed_provider": [
    "<string>"
  ],
  "link_hostname": [
    "<string>"
  ],
  "exclude_link_hostname": [
    "<string>"
  ],
  "attachment_filename": [
    "<string>"
  ],
  "exclude_attachment_filename": [
    "<string>"
  ],
  "attachment_extension": [
    "<string>"
  ],
  "exclude_attachment_extension": [
    "<string>"
  ],
  "sort_by": "timestamp",
  "sort_order": "asc",
  "include_nsfw": true,
  "scope": "current",
  "context_channel_id": "<string>",
  "context_guild_id": "<string>",
  "channel_ids": [
    "<string>"
  ]
}
'
{
  "messages": [
    {
      "id": "<string>",
      "channel_id": "<string>",
      "author": {
        "id": "<string>",
        "username": "<string>",
        "discriminator": "<string>",
        "global_name": "<string>",
        "avatar": "<string>",
        "avatar_color": 1073741823,
        "flags": 1073741823,
        "bot": true,
        "system": true
      },
      "type": 0,
      "flags": 1073741823,
      "content": "<string>",
      "timestamp": "2023-11-07T05:31:56Z",
      "pinned": true,
      "mention_everyone": true,
      "webhook_id": "<string>",
      "edited_timestamp": "2023-11-07T05:31:56Z",
      "tts": true,
      "mentions": [
        {
          "id": "<string>",
          "username": "<string>",
          "discriminator": "<string>",
          "global_name": "<string>",
          "avatar": "<string>",
          "avatar_color": 1073741823,
          "flags": 1073741823,
          "bot": true,
          "system": true
        }
      ],
      "mention_roles": [
        "<string>"
      ],
      "embeds": [
        {
          "type": "<string>",
          "url": "<string>",
          "title": "<string>",
          "color": 1073741823,
          "timestamp": "2023-11-07T05:31:56Z",
          "description": "<string>",
          "author": {
            "name": "<string>",
            "url": "<string>",
            "icon_url": "<string>",
            "proxy_icon_url": "<string>"
          },
          "image": {
            "url": "<string>",
            "flags": 1073741823,
            "proxy_url": "<string>",
            "content_type": "<string>",
            "content_hash": "<string>",
            "width": 1073741823,
            "height": 1073741823,
            "description": "<string>",
            "placeholder": "<string>",
            "duration": 1073741823
          },
          "thumbnail": {
            "url": "<string>",
            "flags": 1073741823,
            "proxy_url": "<string>",
            "content_type": "<string>",
            "content_hash": "<string>",
            "width": 1073741823,
            "height": 1073741823,
            "description": "<string>",
            "placeholder": "<string>",
            "duration": 1073741823
          },
          "footer": {
            "text": "<string>",
            "icon_url": "<string>",
            "proxy_icon_url": "<string>"
          },
          "fields": [
            {
              "name": "<string>",
              "value": "<string>",
              "inline": true
            }
          ],
          "provider": {
            "name": "<string>",
            "url": "<string>",
            "icon_url": "<string>",
            "proxy_icon_url": "<string>"
          },
          "video": {
            "url": "<string>",
            "flags": 1073741823,
            "proxy_url": "<string>",
            "content_type": "<string>",
            "content_hash": "<string>",
            "width": 1073741823,
            "height": 1073741823,
            "description": "<string>",
            "placeholder": "<string>",
            "duration": 1073741823
          },
          "audio": {
            "url": "<string>",
            "flags": 1073741823,
            "proxy_url": "<string>",
            "content_type": "<string>",
            "content_hash": "<string>",
            "width": 1073741823,
            "height": 1073741823,
            "description": "<string>",
            "placeholder": "<string>",
            "duration": 1073741823
          },
          "nsfw": true,
          "children": [
            {
              "type": "<string>",
              "url": "<string>",
              "title": "<string>",
              "color": 1073741823,
              "timestamp": "2023-11-07T05:31:56Z",
              "description": "<string>",
              "author": {
                "name": "<string>",
                "url": "<string>",
                "icon_url": "<string>",
                "proxy_icon_url": "<string>"
              },
              "image": {
                "url": "<string>",
                "flags": 1073741823,
                "proxy_url": "<string>",
                "content_type": "<string>",
                "content_hash": "<string>",
                "width": 1073741823,
                "height": 1073741823,
                "description": "<string>",
                "placeholder": "<string>",
                "duration": 1073741823
              },
              "thumbnail": {
                "url": "<string>",
                "flags": 1073741823,
                "proxy_url": "<string>",
                "content_type": "<string>",
                "content_hash": "<string>",
                "width": 1073741823,
                "height": 1073741823,
                "description": "<string>",
                "placeholder": "<string>",
                "duration": 1073741823
              },
              "footer": {
                "text": "<string>",
                "icon_url": "<string>",
                "proxy_icon_url": "<string>"
              },
              "fields": [
                {
                  "name": "<string>",
                  "value": "<string>",
                  "inline": true
                }
              ],
              "provider": {
                "name": "<string>",
                "url": "<string>",
                "icon_url": "<string>",
                "proxy_icon_url": "<string>"
              },
              "video": {
                "url": "<string>",
                "flags": 1073741823,
                "proxy_url": "<string>",
                "content_type": "<string>",
                "content_hash": "<string>",
                "width": 1073741823,
                "height": 1073741823,
                "description": "<string>",
                "placeholder": "<string>",
                "duration": 1073741823
              },
              "audio": {
                "url": "<string>",
                "flags": 1073741823,
                "proxy_url": "<string>",
                "content_type": "<string>",
                "content_hash": "<string>",
                "width": 1073741823,
                "height": 1073741823,
                "description": "<string>",
                "placeholder": "<string>",
                "duration": 1073741823
              },
              "nsfw": true
            }
          ]
        }
      ],
      "attachments": [
        {
          "id": "<string>",
          "filename": "<string>",
          "size": 1073741823,
          "flags": 1073741823,
          "title": "<string>",
          "description": "<string>",
          "content_type": "<string>",
          "content_hash": "<string>",
          "url": "<string>",
          "proxy_url": "<string>",
          "width": 1073741823,
          "height": 1073741823,
          "placeholder": "<string>",
          "nsfw": true,
          "duration": 1073741823,
          "waveform": "<string>",
          "expires_at": "<string>",
          "expired": true
        }
      ],
      "stickers": [
        {
          "id": "<string>",
          "name": "<string>",
          "animated": true
        }
      ],
      "reactions": [
        {
          "emoji": {
            "name": "<string>",
            "id": "<string>",
            "animated": true
          },
          "count": 1073741823,
          "me": true
        }
      ],
      "message_reference": {
        "channel_id": "<string>",
        "message_id": "<string>",
        "type": 0,
        "guild_id": "<string>"
      },
      "message_snapshots": [
        {
          "timestamp": "2023-11-07T05:31:56Z",
          "type": 0,
          "flags": 1073741823,
          "content": "<string>",
          "edited_timestamp": "2023-11-07T05:31:56Z",
          "mentions": [
            "<string>"
          ],
          "mention_roles": [
            "<string>"
          ],
          "embeds": [
            {
              "type": "<string>",
              "url": "<string>",
              "title": "<string>",
              "color": 1073741823,
              "timestamp": "2023-11-07T05:31:56Z",
              "description": "<string>",
              "author": {
                "name": "<string>",
                "url": "<string>",
                "icon_url": "<string>",
                "proxy_icon_url": "<string>"
              },
              "image": {
                "url": "<string>",
                "flags": 1073741823,
                "proxy_url": "<string>",
                "content_type": "<string>",
                "content_hash": "<string>",
                "width": 1073741823,
                "height": 1073741823,
                "description": "<string>",
                "placeholder": "<string>",
                "duration": 1073741823
              },
              "thumbnail": {
                "url": "<string>",
                "flags": 1073741823,
                "proxy_url": "<string>",
                "content_type": "<string>",
                "content_hash": "<string>",
                "width": 1073741823,
                "height": 1073741823,
                "description": "<string>",
                "placeholder": "<string>",
                "duration": 1073741823
              },
              "footer": {
                "text": "<string>",
                "icon_url": "<string>",
                "proxy_icon_url": "<string>"
              },
              "fields": [
                {
                  "name": "<string>",
                  "value": "<string>",
                  "inline": true
                }
              ],
              "provider": {
                "name": "<string>",
                "url": "<string>",
                "icon_url": "<string>",
                "proxy_icon_url": "<string>"
              },
              "video": {
                "url": "<string>",
                "flags": 1073741823,
                "proxy_url": "<string>",
                "content_type": "<string>",
                "content_hash": "<string>",
                "width": 1073741823,
                "height": 1073741823,
                "description": "<string>",
                "placeholder": "<string>",
                "duration": 1073741823
              },
              "audio": {
                "url": "<string>",
                "flags": 1073741823,
                "proxy_url": "<string>",
                "content_type": "<string>",
                "content_hash": "<string>",
                "width": 1073741823,
                "height": 1073741823,
                "description": "<string>",
                "placeholder": "<string>",
                "duration": 1073741823
              },
              "nsfw": true,
              "children": [
                {
                  "type": "<string>",
                  "url": "<string>",
                  "title": "<string>",
                  "color": 1073741823,
                  "timestamp": "2023-11-07T05:31:56Z",
                  "description": "<string>",
                  "author": {
                    "name": "<string>",
                    "url": "<string>",
                    "icon_url": "<string>",
                    "proxy_icon_url": "<string>"
                  },
                  "image": {
                    "url": "<string>",
                    "flags": 1073741823,
                    "proxy_url": "<string>",
                    "content_type": "<string>",
                    "content_hash": "<string>",
                    "width": 1073741823,
                    "height": 1073741823,
                    "description": "<string>",
                    "placeholder": "<string>",
                    "duration": 1073741823
                  },
                  "thumbnail": {
                    "url": "<string>",
                    "flags": 1073741823,
                    "proxy_url": "<string>",
                    "content_type": "<string>",
                    "content_hash": "<string>",
                    "width": 1073741823,
                    "height": 1073741823,
                    "description": "<string>",
                    "placeholder": "<string>",
                    "duration": 1073741823
                  },
                  "footer": {
                    "text": "<string>",
                    "icon_url": "<string>",
                    "proxy_icon_url": "<string>"
                  },
                  "fields": [
                    {
                      "name": "<string>",
                      "value": "<string>",
                      "inline": true
                    }
                  ],
                  "provider": {
                    "name": "<string>",
                    "url": "<string>",
                    "icon_url": "<string>",
                    "proxy_icon_url": "<string>"
                  },
                  "video": {
                    "url": "<string>",
                    "flags": 1073741823,
                    "proxy_url": "<string>",
                    "content_type": "<string>",
                    "content_hash": "<string>",
                    "width": 1073741823,
                    "height": 1073741823,
                    "description": "<string>",
                    "placeholder": "<string>",
                    "duration": 1073741823
                  },
                  "audio": {
                    "url": "<string>",
                    "flags": 1073741823,
                    "proxy_url": "<string>",
                    "content_type": "<string>",
                    "content_hash": "<string>",
                    "width": 1073741823,
                    "height": 1073741823,
                    "description": "<string>",
                    "placeholder": "<string>",
                    "duration": 1073741823
                  },
                  "nsfw": true
                }
              ]
            }
          ],
          "attachments": [
            {
              "id": "<string>",
              "filename": "<string>",
              "size": 1073741823,
              "flags": 1073741823,
              "title": "<string>",
              "description": "<string>",
              "content_type": "<string>",
              "content_hash": "<string>",
              "url": "<string>",
              "proxy_url": "<string>",
              "width": 1073741823,
              "height": 1073741823,
              "placeholder": "<string>",
              "nsfw": true,
              "duration": 1073741823,
              "waveform": "<string>",
              "expires_at": "<string>",
              "expired": true
            }
          ],
          "stickers": [
            {
              "id": "<string>",
              "name": "<string>",
              "animated": true
            }
          ]
        }
      ],
      "nonce": "<string>",
      "call": {
        "participants": [
          "<string>"
        ],
        "ended_timestamp": "2023-11-07T05:31:56Z"
      }
    }
  ],
  "total": 1073741823,
  "hits_per_page": 1073741823,
  "page": 1073741823
}

Authorizations

​
Authorization
string
header
required

Bot token: Authorization: Bot <token>. This is the primary authentication method for bot applications.

Body

application/json
​
hits_per_page
integer<int32>

Number of results per page (1-25)

Required range: 1 <= x <= 25
​
page
integer<int64>

Page number for pagination

Required range: 1 <= x <= 9007199254740991
​
max_id
string<snowflake>
​
min_id
string<snowflake>
​
content
string

Text content to search for

​
contents
string[]

Multiple content queries to search for

Maximum array length: 100
​
exact_phrases
string[]

Exact phrases that must appear contiguously in message content

Maximum array length: 10
​
channel_id
string<snowflake>[]

Channel IDs to search in

Maximum array length: 500
​
exclude_channel_id
string<snowflake>[]

Channel IDs to exclude from search

Maximum array length: 500
​
author_type
enum<string>[]

Author types to filter by

The type of author who sent the message

Available options:
user,
bot,
webhook
​
exclude_author_type
enum<string>[]

Author types to exclude

The type of author who sent the message

Available options:
user,
bot,
webhook
​
author_id
string<snowflake>[]

Author user IDs to filter by

​
exclude_author_id
string<snowflake>[]

Author user IDs to exclude

​
mentions
string<snowflake>[]

User IDs that must be mentioned

​
exclude_mentions
string<snowflake>[]

User IDs that must not be mentioned

​
mention_everyone
boolean

Filter by whether message mentions everyone

​
pinned
boolean

Filter by pinned status

​
has
enum<string>[]

Content types the message must have

The type of content contained in a message

Available options:
image,
sound,
video,
file,
sticker,
embed,
link,
poll,
snapshot
​
exclude_has
enum<string>[]

Content types the message must not have

The type of content contained in a message

Available options:
image,
sound,
video,
file,
sticker,
embed,
link,
poll,
snapshot
​
embed_type
enum<string>[]

Embed types to filter by

The type of embed content

Available options:
image,
video,
sound,
article
​
exclude_embed_type
enum<string>[]

Embed types to exclude

The type of embed content

Available options:
image,
video,
sound,
article
​
embed_provider
string[]

Embed providers to filter by

​
exclude_embed_provider
string[]

Embed providers to exclude

​
link_hostname
string[]

Link hostnames to filter by

​
exclude_link_hostname
string[]

Link hostnames to exclude

​
attachment_filename
string[]

Attachment filenames to filter by

​
exclude_attachment_filename
string[]

Attachment filenames to exclude

​
attachment_extension
string[]

File extensions to filter by

​
exclude_attachment_extension
string[]

File extensions to exclude

​
sort_by
enum<string>

The field to sort search results by

Available options:
timestamp,
relevance
​
sort_order
enum<string>

The order to sort search results

Available options:
asc,
desc
​
include_nsfw
boolean

Whether to include NSFW channel results

​
scope
enum<string>

Search scope for message searches

Available options:
current,
open_dms,
all_dms,
all_guilds,
all,
open_dms_and_all_guilds
​
context_channel_id
string<snowflake>
​
context_guild_id
string<snowflake>
​
channel_ids
string<snowflake>[]

Specific channel IDs to search in

Maximum array length: 500

Response

Success

​
messages
object[]
required

The messages matching the search query

Maximum array length: 100
​
total
integer<int32>
required

The total number of messages matching the search

Required range: 0 <= x <= 2147483647
​
hits_per_page
integer<int32>
required

The maximum number of messages returned per page

Required range: 0 <= x <= 2147483647
​
page
integer<int32>
required

The current page number

Required range: 0 <= x <= 2147483647