Skip to main content
GET
Search subreddits (live)

Authorizations

Authorization
string
header
required

XPOZ API access key, created from the dashboard or POST /api/tokens. Send as Authorization: Bearer <access key>.

Query Parameters

q
string
required

Search query (Lucene-style keyword syntax). Must not be blank.

fields
enum<string>[]

Subreddit fields to return. Comma-separated. Allowed values: id, displayName, title, publicDescription, description, subscribersCount, activeUserCount, subredditType, over18, lang, url, subredditUrl, iconImg, bannerImg, headerImg, communityIcon, createdAt, createdAtTimestamp, createdAtDate, submissionType.

Available options:
id,
displayName,
title,
publicDescription,
description,
subscribersCount,
activeUserCount,
subredditType,
over18,
lang,
url,
subredditUrl,
iconImg,
bannerImg,
headerImg,
communityIcon,
createdAt,
createdAtTimestamp,
createdAtDate,
submissionType
limit
integer
default:100

Items per page (1-100). Defaults to 100. Ignored by post search when since/until are set (10 per page).

Required range: 1 <= x <= 100
cursor
string

Opaque cursor from next_page_cursor of the previous page.

Response

One page of results.

Envelope for on-demand /live endpoints: one provider page plus a cursor.

results
object[]
required
count
integer
required
dataSource
enum<string>
required

Where the results came from.

Available options:
database,
api,
hybrid
has_more
boolean
required
next_page_cursor
string | null
required