Listings & Search

Typeahead

Search-as-you-type suggestions for a short prefix. Without sub, returns up to limit SUBREDDIT suggestions (subreddits: name, display_name_prefixed, title, icon_url, subscribers, over_18, url, match). With sub, returns up to limit POSTS in that subreddit whose titles match (posts: id, fullname, title, permalink, url, subreddit, score, num_comments, over_18, created_utc, created, match). Rows are ranked prefix, then contains, then related, and each row's match says which. No cursor: a typeahead returns one short list. Cost: $0.0015 per call.

get/api/reddit/typeahead

Request

  • Base URL: https://api.redditapis.com
  • URL: https://api.redditapis.com/api/reddit/typeahead
  • Auth: HTTP bearer

Query parameters

qstring required

The prefix typed so far, 1-100 characters. Without sub, a leading r/ is ignored.

substring

Subreddit name (no r/ prefix). Present: suggest posts in this subreddit by title. Absent: suggest subreddits.

limitinteger

Suggestions to return, default 8. Values outside 1-20 are clamped to that range.

nsfwboolean

true = include NSFW results (Safe Search off)

Response

Successful response.

object required

Changes

No recorded changes to this operation across all 1 revision of this API.