--- title: "GET /api/v1/x/search/autocomplete" method: GET path: "/api/v1/x/search/autocomplete" tags: ["Users"] --- # GET /api/v1/x/search/autocomplete `GET /api/v1/x/search/autocomplete` ## Request - Base URL: `https://xquik.com` - URL: `https://xquik.com/api/v1/x/search/autocomplete` - Auth: one of: - API key in header `x-api-key` - HTTP bearer - none Returns the accounts, topics, hashtags & cashtags X suggests while someone types a search. X may rank them differently per request. Costs 1 credit per suggestion. ## Query parameters - `q` string, required - `types` string - `limit` integer - `fields` string - `omit` string ## Response `200` Search suggestions - SearchSuggestions: What X suggests for a partial search query. Each list keeps X's order. A list is empty when X suggests none of its type or types leaves it out. - `query` string, required: The query you sent, trimmed. - `users` SearchSuggestionUser[], required: Suggested accounts. - `id` string, required: X user ID. - `username` string, required: Handle without the @. - `name` string, required: Display name. - `verified` boolean: Whether X shows any verification badge. - `isBlueVerified` boolean: Whether X shows a blue verification badge. - `isVerified` boolean: Whether the account holds X's legacy verification. - `verifiedType` string: Verification category, such as Government or Business. Omitted when X names none. - `protected` boolean: Whether the account protects its posts. - `location` string: Public profile location text. Omitted when empty. - `profilePicture` string, uri: Avatar URL. - `profilePictureOriginal` string, uri: The same avatar at full size. - `badges` object[]: Affiliation badges X shows beside the name. - `badgeType` string: Kind of badge. - `badgeUrl` string, uri: Badge image URL. - `description` string: Name of the affiliated account. - `isPersonaMediaGenable` boolean: X's flag for whether media can be generated from this account's persona. - `score` number: X's rounded relevance score for the account. - `tokens` string[]: Normalized text tokens X matches the account by. - `inline` boolean: X's inline flag for the account. - `topics` SearchSuggestionTopic[], required: Suggested search phrases that are not hashtags. - `topic` string, required: Suggested search phrase. - `score` number: X's rounded relevance score for the phrase. - `tokens` string[]: Normalized text tokens X matches the phrase by. - `inline` boolean: X's inline flag for the phrase. - `hashtags` SearchSuggestionHashtag[], required: Suggested hashtags. - `hashtag` string, required: Suggested hashtag, with its leading #. - `score` number: X's rounded relevance score for the hashtag. - `tokens` string[]: Normalized text tokens X matches the hashtag by. - `inline` boolean: X's inline flag for the hashtag. - `cashtags` SearchSuggestionCashtag[], required: Suggested stocks & crypto tokens. - `ticker` string, required: Ticker symbol without the $. - `name` string: Company or token name. - `smartTag` string: X's tag for the asset. $TICKER for a stock, chain:contract for a token. - `currency` string: Currency of price & marketCap. - `price` string: Latest price as decimal text, which keeps every digit. - `marketCap` string: Market capitalization as decimal text. - `dailyChangePercent` number: Price change over the last 24 hours, in percent. - `logoUrl` string, uri: Logo image URL. - `exchangeShortName` string: Stock exchange. Stocks only. - `contractAddress` string: Token contract address. Tokens only. - `chainLogoUrl` string, uri: Logo of the token's chain. Tokens only. - `count` integer, required: Suggestions returned across all 4 lists. Each costs 1 credit. ## Other responses - `400`: Missing query or unknown type - `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. - `500`: Unexpected error. - `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. - `default`: Unexpected error. ## Changes - **2026-10-20** `45942c75fdc2`: 18 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` - …14 more [Operation history](https://skmtc.dev/xquik-dev/apis/xquik-api/changes/api/v1/x/search/autocomplete/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/45942c75fdc2?raw)