---
title: "List the hashflags X shows after hashtags"
method: GET
path: "/x/hashflags"
tags: ["Trends"]
---

# List the hashflags X shows after hashtags

`GET /x/hashflags`

## Request

- Base URL: `https://xquik.com/api/v1`
- URL: `https://xquik.com/api/v1/x/hashflags`
- Auth: one of:
  - API key in header `x-api-key`
  - HTTP bearer
  - none

Returns X's hashflags, the custom emoji X shows after some hashtags. Lists the ones running now unless activeOnly is false. Each returned hashflag costs 1 credit.

## Query parameters

- `q` string
- `activeOnly` boolean
- `limit` integer
- `fields` string
- `omit` string

## Response `200`

Hashflags X shows after hashtags

- object
  - `hashflags` Hashflag[], required
    - `hashtag` string, required: Hashtag text without the hash sign. X also lists some plain phrases.
    - `assetUrl` string, uri, required: Image of the emoji.
    - `startsAt` string, date-time, required: When X starts showing the emoji, in UTC.
    - `endsAt` string, date-time, required: When X stops showing the emoji, in UTC.
    - `isHashfettiEnabled` boolean, required: Whether X marks the hashflag for its hashfetti effect.
    - `animations` object[], required: Animations X plays for the hashtag, such as on a like. Often empty.
      - `context` string, nullable, required: What plays the animation, such as Like.
      - `assetUrl` string, uri, required: Animation file.
      - `priority` number, nullable, required: X's order among the animations of a hashtag.
  - `count` integer, required: Hashflags returned & charged.
  - `total` integer, required: Hashflags that match the filters, before limit.
  - `message` string: What to send instead. Present only when no hashflag matches.

## Other responses

- `400`: A name in fields or omit names no field of the answer. Xquik reads & charges nothing.
- `401`: Non-MPP paid reads require Bearer authentication. Without credentials, the answer offers a guest checkout but does not create it. Invalid credentials return a plain error. Confirm before using any offered action.
- `402`: Payment required. MPP reads include `WWW-Authenticate`. Authenticated reads include balances, plus checkout when the key can open it. A key that reads only gets the account page instead. A failed request never creates checkout. A caller on a plan gets top-up only, plus `credits_renew_at` when the plan renews. Guest keys offer top-up.
- `424`: Dependency unavailable, unauthorized, or limited. Default v1 uses 502. Best-practice responses use 424 for transparent dependency failures. Search answers 424 `search_unavailable` when X fails the query itself, or when its filters matched none of the last 3,000 posts read. The message says how far back the search read.
- `429`: Too many requests right now. Each user gets 500 reads a second. Each minute allows 120 writes & 60 deletes. `x_api_rate_limited` means X limits this read for now. Neither answer costs anything. Wait for the seconds in `Retry-After`, then retry.
- `502`: Dependency unavailable, unauthorized, or limited. Default v1 uses 502. Best-practice responses use 424 for transparent dependency failures. Search answers 424 `search_unavailable` when X fails the query itself, or when its filters matched none of the last 3,000 posts read. The message says how far back the search read.
- `503`: Retry x_api_unavailable after Retry-After. With X-Xquik-Busy, retry until your deadline.

## Changes

- **2026-10-21** `245194cd4ea7`: 14 warning
  - added the new `topup_in_progress` enum value to the `allOf[#/components/schemas/Error]/error/oneOf[subschema #1: LegacyErrorCode]/` response property for the response status `429`
  - added the new `topup_in_progress` enum value to the `allOf[#/components/schemas/Error]/error/oneOf[subschema #2: StructuredError]/code` response property for the response status `429`
  - added the new `topup_in_progress` enum value to the `error/oneOf[subschema #1: LegacyErrorCode]/` response property for the response status `400`
  - added the new `topup_in_progress` enum value to the `error/oneOf[subschema #1: LegacyErrorCode]/` response property for the response status `424`
  - …10 more
- **2026-10-18** `d17988b4a85d`: 1 breaking, 6 info
  - added `#/components/schemas/AccountPagePaymentRequired` to the response body `oneOf` list for the response status `402`
  - the response property `oneOf[#/components/schemas/AuthenticatedPaymentRequired]/payment_options` became required for the status `402`
  - the response property `oneOf[#/components/schemas/AuthenticatedPaymentRequired]/top_up_endpoint` became required for the status `402`
  - the response property `oneOf[#/components/schemas/AuthenticatedPaymentRequired]/top_up_url` became required for the status `402`
  - …3 more
- …earlier changes not shown

[Operation history](https://skmtc.dev/xquik-dev/apis/xquik-api/changes/x/hashflags/get.md)

---

[API](https://skmtc.dev/xquik-dev/apis/xquik-api.md) · [All operations](https://skmtc.dev/xquik-dev/apis/xquik-api/llms.txt) · [OpenAPI document](https://skmtc.dev/xquik-dev/apis/xquik-api/revisions/ef03679f1918?raw)