Skip to content
Navigation

Search Reddit Comments

GET /v1/reddit/search/comments
1 credit per page Permission: reddit:read

Searches Reddit comments globally or scoped to a specific subreddit with pagination support.

Authorization

  • bearerAuth: optional HTTP
  • apiKeyAuth: optional API key in header

Query parameters

  • q: required string

    Search query, 1 to 500 characters.

    maxLength: 500
  • sub: optional string

    Only search this subreddit.

  • sort: optional relevance|new|top
    default: "relevance"
  • t: optional hour|day|week|month|year|all

    Time window when sorting by top or controversial.

  • after: optional string

    Pagination cursor from the previous page's after field.

  • nsfw: optional boolean

    Include NSFW content (filtered out by default).

    default: false

Returns

200

The comments.

JSON
  • sort: required string
  • count: required integer
  • items: required array ofobject
    • id: optional string
    • name: optional string
    • post_id: optional string
    • post_title: optional string
    • subreddit: optional string
    • author: optional string
    • score: optional integer
    • body: optional string
    • created_at: optional string
      format: date-time
    • parent_id: optional string
    • is_submitter: optional boolean
    • controversiality: optional integer
  • filtered_nsfw: required integer
  • subreddit: optional string | null
  • query: optional string | null
  • after: optional string | null
  • degraded: optional boolean

400

Bad request (invalid parameter or unknown action)
JSON

One of the following:

  • ErrorResponse
    • error: required string

      Human-readable error message

    • error_code: optional forbidden_scope|rate_limited|daily_quota_exceeded|insufficient_credits|duplicate_transaction

      Machine-readable error code. Known values include: forbidden_scope, rate_limited, daily_quota_exceeded, insufficient_credits, duplicate_transaction. Additional codes may be introduced in future releases.

  • Error
    • error: required object
      • code: required string
      • message: required string
      • retryable: required boolean
      • retry_after: optional integer

        Seconds to wait before retrying.

401

Missing or invalid API key or OAuth access token
JSON

One of the following:

  • ErrorResponse
    • error: required string

      Human-readable error message

    • error_code: optional forbidden_scope|rate_limited|daily_quota_exceeded|insufficient_credits|duplicate_transaction

      Machine-readable error code. Known values include: forbidden_scope, rate_limited, daily_quota_exceeded, insufficient_credits, duplicate_transaction. Additional codes may be introduced in future releases.

  • Error
    • error: required object
      • code: required string
      • message: required string
      • retryable: required boolean
      • retry_after: optional integer

        Seconds to wait before retrying.

402

The account has no credits left (insufficient_credits).
JSON
  • error: required object
    • code: required string
    • message: required string
    • retryable: required boolean
    • retry_after: optional integer

      Seconds to wait before retrying.

403

Reddit does not show this content to logged-out readers, e.g. a private or quarantined subreddit (reddit_refused).
JSON
  • error: required object
    • code: required string
    • message: required string
    • retryable: required boolean
    • retry_after: optional integer

      Seconds to wait before retrying.

429

Rate limit or daily request quota exceeded
JSON

One of the following:

  • ErrorResponse
    • error: required string

      Human-readable error message

    • error_code: optional forbidden_scope|rate_limited|daily_quota_exceeded|insufficient_credits|duplicate_transaction

      Machine-readable error code. Known values include: forbidden_scope, rate_limited, daily_quota_exceeded, insufficient_credits, duplicate_transaction. Additional codes may be introduced in future releases.

  • Error
    • error: required object
      • code: required string
      • message: required string
      • retryable: required boolean
      • retry_after: optional integer

        Seconds to wait before retrying.

503

A temporary problem reaching Reddit (upstream_busy, upstream_timeout, upstream_error). Retry shortly; nothing was billed.
JSON
  • error: required object
    • code: required string
    • message: required string
    • retryable: required boolean
    • retry_after: optional integer

      Seconds to wait before retrying.

Type to search…

↑↓ navigate ↵ select Esc close