> ## Documentation Index
> Fetch the complete documentation index at: https://docs.xquik.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Twitter hashflags API: list X hashtag emoji

> List Twitter and X hashflags, the custom emoji X shows after hashtags. Get each hashtag, image URL, start and end time, and animations. 1 credit per hashflag.

<Panel>
  <Tabs defaultTabIndex={0} sync={false}>
    <Tab title="200" id="response-x-hashflags-200">
      ```json theme={null}
      {
        "hashflags": [
          {
            "hashtag": "AION2",
            "assetUrl": "https://abs.twimg.com/hashflags/BF-16692_AIon2_jp_Hashmoji_v3/BF-16692_AIon2_jp_Hashmoji_v3.png",
            "startsAt": "2026-10-02T10:00:00.000Z",
            "endsAt": "2027-01-03T14:59:00.000Z",
            "isHashfettiEnabled": false
          }
        ],
        "count": 1,
        "total": 1
      }
      ```
    </Tab>

    <Tab title="401" id="response-x-hashflags-401">
      ```json theme={null}
      {
        "error": "unauthenticated",
        "message": "Authentication required."
      }
      ```
    </Tab>

    <Tab title="402" id="response-x-hashflags-402">
      ```json theme={null}
      {
        "error": "insufficient_credits",
        "message": "Insufficient credits. Top up or subscribe to continue."
      }
      ```
    </Tab>

    <Tab title="424" id="response-x-hashflags-424">
      ```json theme={null}
      {
        "error": "x_api_unavailable",
        "message": "X data source temporarily unavailable. Try again later."
      }
      ```
    </Tab>

    <Tab title="429" id="response-x-hashflags-429">
      ```json theme={null}
      {
        "error": "rate_limit_exceeded",
        "message": "Too many requests. Try again later.",
        "retryAfter": 60
      }
      ```
    </Tab>

    <Tab title="502" id="response-x-hashflags-502">
      ```json theme={null}
      {
        "error": "x_api_unavailable",
        "message": "X data source temporarily unavailable. Try again later."
      }
      ```
    </Tab>

    <Tab title="503" id="response-x-hashflags-503">
      ```json theme={null}
      {
        "error": "x_api_unavailable",
        "message": "Xquik is busy right now. Retry shortly."
      }
      ```
    </Tab>
  </Tabs>
</Panel>

<blockquote className="agent-llms-directive">
  For the complete documentation index, see <a href="/llms.txt">llms.txt</a>.
</blockquote>

<Callout icon="coins" color="#5c3327">
  **1 credit per hashflag returned** · [All plans](https://xquik.com/#pricing) from \$0.00012/credit
</Callout>

<CodeGroup>
  ```bash cURL theme={null}
  curl -G https://xquik.com/api/v1/x/hashflags \
    --data-urlencode "q=football" \
    --data-urlencode "limit=20" \
    -H "x-api-key: xq_your_api_key_here" | jq
  ```

  ```javascript Node.js theme={null}
  const params = new URLSearchParams({ q: "football", limit: "20" });
  const response = await fetch(`https://xquik.com/api/v1/x/hashflags?${params}`, {
    headers: { "x-api-key": "xq_your_api_key_here" },
  });
  const data = await response.json();
  const hashflagRows = data.hashflags.map((hashflag) => ({
    hashtag: hashflag.hashtag,
    image_url: hashflag.assetUrl,
    starts_at: hashflag.startsAt,
    ends_at: hashflag.endsAt,
    animation_count: hashflag.animations.length,
  }));

  for (const row of hashflagRows) {
    process.stdout.write(`${JSON.stringify(row)}\n`);
  }
  ```

  ```python Python theme={null}
  import json
  import requests

  response = requests.get(
      "https://xquik.com/api/v1/x/hashflags",
      params={"q": "football", "limit": 20},
      headers={"x-api-key": "xq_your_api_key_here"},
  )
  data = response.json()
  hashflag_rows = [
      {
          "hashtag": hashflag["hashtag"],
          "image_url": hashflag["assetUrl"],
          "starts_at": hashflag["startsAt"],
          "ends_at": hashflag["endsAt"],
          "animation_count": len(hashflag["animations"]),
      }
      for hashflag in data["hashflags"]
  ]
  for row in hashflag_rows:
      print(json.dumps(row))
  ```
</CodeGroup>

Use `GET /x/hashflags` to list X's hashflags.
A hashflag is the custom emoji X shows after a hashtag for a set time.
Each returned hashflag costs 1 credit. Filters and `limit` lower the cost.
An empty result costs nothing.

## Track branded hashtags

The endpoint lists the hashflags that run now.
Send `activeOnly=false` to add ended and upcoming ones.
Use `q` to keep hashtags that contain your text.

`startsAt` and `endsAt` give the time X shows each emoji.
`assetUrl` is the emoji image. `animations` lists the animations X plays, such as on a like.

X lists a few hundred hashflags. Send `limit` when you need only some.

## Query parameters

<ParamField query="q" type="string">
  Text the hashtag contains, such as `football`. Case insensitive. A leading `#` is ignored. Alias: `query`.
</ParamField>

<ParamField query="activeOnly" type="boolean" default="true">
  Keeps hashflags that run now. Send `false` to add ended and upcoming ones.
</ParamField>

<ParamField query="limit" type="integer">
  Maximum hashflags to return, starting at `1`. Omit it for every match. Your credit balance can return fewer. Aliases: `pageSize`, `count`, `max_results`, `maxItems`, `max_items` & `per_page`.
</ParamField>

## Headers

<ParamField header="x-api-key" type="string">
  Send a full Xquik account API key.
</ParamField>

<ParamField header="Authorization" type="string">
  `Bearer xq_your_guest_key_here` for `paid_reads`.
</ParamField>

## Response

### 200 OK

<ResponseField name="hashflags" type="object[]">
  Hashflags that match your filters, in X's order.
  **Hashflag object fields.**

  <ResponseField name="hashtag" type="string">
    Hashtag text without `#`. X also lists some plain phrases.
  </ResponseField>

  <ResponseField name="assetUrl" type="string">
    Image of the emoji.
  </ResponseField>

  <ResponseField name="startsAt" type="string">
    When X starts showing the emoji, in UTC.
  </ResponseField>

  <ResponseField name="endsAt" type="string">
    When X stops showing the emoji, in UTC.
  </ResponseField>

  <ResponseField name="isHashfettiEnabled" type="boolean">
    Whether X marks the hashflag for its hashfetti effect.
  </ResponseField>

  <ResponseField name="animations" type="object[]">
    Animations X plays for the hashtag. Often empty. Each has `context`, such as `Like`, `assetUrl`,
    and `priority`.
  </ResponseField>
</ResponseField>

<ResponseField name="count" type="number">Hashflags returned and charged.</ResponseField>
<ResponseField name="total" type="number">Hashflags that match the filters, before `limit`.</ResponseField>

<ResponseField name="message" type="string">
  What to send instead. Present only when no hashflag matches.
</ResponseField>

```json theme={null}
{
  "hashflags": [
    {
      "hashtag": "College Football",
      "assetUrl": "https://abs.twimg.com/hashflags/2026FootballCustomLikeEvergreenv3/2026FootballCustomLikeEvergreenv3.png",
      "startsAt": "2026-10-02T00:00:00.000Z",
      "endsAt": "2027-01-10T00:00:00.000Z",
      "isHashfettiEnabled": false,
      "animations": [
        {
          "context": "Like",
          "assetUrl": "https://abs.twimg.com/hashflags/2026FootballCustomLikeEvergreenv3/2026FootballCustomLikeEvergreenv3_sakura_0.json",
          "priority": 1
        }
      ]
    }
  ],
  "count": 1,
  "total": 1
}
```

A filter that matches no hashflag returns an empty list and a `message`:

```json theme={null}
{
  "hashflags": [],
  "count": 0,
  "total": 0,
  "message": "No hashflag runs now. Send activeOnly=false to list the rest."
}
```

### 401 Unauthenticated

Anonymous requests get `WWW-Authenticate: Bearer` and a guest wallet checkout action. This is not a Payment challenge.

```json theme={null}
{ "error": "unauthenticated" }
```

### 402 Payment required

Account keys get account options. Guest keys get guest top-up only.
No checkout starts automatically. Confirm any payment action.

### 502 X API unavailable

```json theme={null}
{ "error": "x_api_unavailable" }
```

The read service returned an error. Retry after a short delay.

### 503 Service busy

```json theme={null}
{ "error": "x_api_unavailable" }
```

Xquik is busy. Wait for `Retry-After`, then retry.

### 429 Rate limit exceeded

```json theme={null}
{ "error": "rate_limit_exceeded", "retryAfter": 60 }
```

The Xquik tier limit blocked the request.
Use `Retry-After` when present. Otherwise, use the JSON `retryAfter` field.

### 424 Dependency failed

```json theme={null}
{ "error": "x_api_unavailable" }
```

The opt-in normalized contract returns 424 when the read service fails.
Send `xquik-api-contract: 2026-04-29` to opt in. Default v1 returns 502.

## Twitter hashflags API questions

### What is a Twitter hashflag?

A hashflag is a custom emoji X shows after a hashtag for a set time.
Brands and events use them. Some people call them hashmoji.

### How do I list the hashflags that run now?

Call `GET /x/hashflags` without parameters.
The response lists every hashflag X shows at that moment.

### How do I find the emoji of 1 hashtag?

Send `q` with the hashtag text, with or without `#`.
Read `assetUrl` from the matching hashflag.

### How much does a hashflags request cost?

Each returned hashflag costs 1 credit. An empty result costs nothing.
Add `q` or `limit` to return fewer hashflags.

### Does this replace X's official API?

No. This page documents Xquik, an independent third-party service.
It does not document X's official API.

<Note>
  **Next steps.** [Search tweets](/api-reference/x/search-tweets) finds the posts that use a hashtag.
</Note>

<div className="related-api-links">
  <Accordion title="Related tweet, reply & media APIs" icon="link">
    * Tweets: [Get tweet](/api-reference/x/get-tweet) · [Batch tweets](/api-reference/x/batch-tweets) · [Tweet thread](/api-reference/x/tweet-thread) · [Hidden replies](/api-reference/x/tweet-hidden-replies) · [Translate tweet](/api-reference/x/tweet-translation) · [Embed tweet](/api-reference/x/tweet-embed) · [Resolve links](/api-reference/x/resolve-links) · [Tweet subtitles](/api-reference/x/tweet-subtitles) · [X Article](/api-reference/x/get-article)
    * Engagement: [Tweet replies](/api-reference/x/tweet-replies) · [Quote tweets](/api-reference/x/tweet-quotes) · [Likers](/api-reference/x/favoriters) · [Reposters](/api-reference/x/retweeters) · [Check repost](/api-reference/x/tweet-repost-check)
    * Profiles: [User tweets](/api-reference/x/user-tweets) · [Batch user tweets](/api-reference/x/batch-user-tweets) · [User replies](/api-reference/x/user-replies) · [User likes](/api-reference/x/user-likes) · [User media](/api-reference/x/user-media) · [User highlights](/api-reference/x/user-highlights) · [User articles](/api-reference/x/user-articles)
    * Feeds: [List tweets](/api-reference/x/list-tweets) · [Trends](/api-reference/x/trends) · [Trend locations](/api-reference/x/trend-locations) · [Search Spaces](/api-reference/x/search-spaces) · [Get Space](/api-reference/x/get-space) · [Space replay](/api-reference/x/space-replay) · [Get broadcast](/api-reference/x/get-broadcast) · [Hashflags](/api-reference/x/hashflags) · [Search places](/api-reference/x/search-places) · [Download media](/api-reference/x/download-media)
  </Accordion>
</div>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.