---
title: "Global search"
method: GET
path: "/v1/reddit/search"
tags: ["Reddit"]
---

# Global search

`GET /v1/reddit/search`

## Request

- Base URL: `https://api.scrapeatlas.com`
- URL: `https://api.scrapeatlas.com/v1/reddit/search`
- Auth: API key in header `x-api-key`

Search public posts or comments across all of Reddit with ranking, a publication window, optional exact matching, trimmed records and after continuation. Each successful request costs 1 account credit, including partial results. Failed requests cost 0 credits.

## Query parameters

- `query` string, required
- `filter` 'posts' | 'comments'
- `sort` 'relevance' | 'new' | 'top' | 'comment_count'
- `timeframe` 'all' | 'hour' | 'day' | 'week' | 'month' | 'year'
- `since` union
  - number
  - string
- `until` union
  - number
  - string
- `after` string
- `trim` union
  - boolean
  - 'true' | 'false'
- `exact_match` union
  - boolean
  - 'true' | 'false'

## Response `200`

Inspect the response status and failure or coverage fields.

- union
  - object
    - `requestId` string, required
    - `coverage` object, required
      - `complete` boolean, required
      - `reasons` string[], required
      - `order` 'newest_first' | 'oldest_first' | 'ranked' | 'relevance' | 'source_order'
      - `window` object
        - `since` string, date-time
        - `until` string, date-time
    - `accounting` object, required
      - `httpRequests` integer, required
      - `proxyBytes` number, required
      - `durationMs` number, required
      - `pageLoads` integer, required
      - `challengeCount` integer, required
      - `rssRequests` integer, required
      - `proxySessionId` string, required
    - `success` true, required
    - `status` 'success' | 'partial', required
    - `posts` object[], required
      - `id` string, required
      - `title` string, required
      - `permalink` string, required
      - `name` string
      - `author` string, nullable
      - `author_fullname` string, nullable
      - `subreddit` string, nullable
      - `subreddit_id` string, nullable
      - `selftext` string, nullable
      - `selftext_html` string, nullable
      - `score` number, nullable
      - `ups` number, nullable
      - `downs` number, nullable
      - `upvote_ratio` number, nullable
      - `num_comments` number, nullable
      - `created` number, nullable
      - `created_utc` number, nullable
      - `created_at_iso` string, nullable, required
      - `url` string, nullable
      - `is_video` boolean, nullable
      - `over_18` boolean, nullable
      - `archived` boolean, nullable
      - `locked` boolean, nullable
      - `spoiler` boolean, nullable
      - `link_flair_text` string, nullable
      - `total_awards_received` number, nullable
      - `subreddit_subscribers` number, nullable
    - `after` string, nullable, required
  - object
    - `requestId` string, required
    - `coverage` object, required
      - `complete` boolean, required
      - `reasons` string[], required
      - `order` 'newest_first' | 'oldest_first' | 'ranked' | 'relevance' | 'source_order'
      - `window` object
        - `since` string, date-time
        - `until` string, date-time
    - `accounting` object, required
      - `httpRequests` integer, required
      - `proxyBytes` number, required
      - `durationMs` number, required
      - `pageLoads` integer, required
      - `challengeCount` integer, required
      - `rssRequests` integer, required
      - `proxySessionId` string, required
    - `success` true, required
    - `status` 'success' | 'partial', required
    - `comments` object[], required
      - `id` string, required
      - `body` string, required
      - `parent_id` string, nullable, required
      - `name` string
      - `link_id` string, nullable
      - `author` string, nullable
      - `author_fullname` string, nullable
      - `body_html` string, nullable
      - `score` number, nullable
      - `ups` number, nullable
      - `downs` number, nullable
      - `created_utc` number, nullable
      - `created_at_iso` string, nullable, required
      - `permalink` string, nullable
      - `url` string, nullable
    - `after` string, nullable, required
  - object
    - `requestId` string, required
    - `coverage` object, required
      - `complete` boolean, required
      - `reasons` string[], required
      - `order` 'newest_first' | 'oldest_first' | 'ranked' | 'relevance' | 'source_order'
      - `window` object
        - `since` string, date-time
        - `until` string, date-time
    - `accounting` object, required
      - `httpRequests` integer, required
      - `proxyBytes` number, required
      - `durationMs` number, required
      - `pageLoads` integer, required
      - `challengeCount` integer, required
      - `rssRequests` integer, required
      - `proxySessionId` string, required
    - `success` false, required
    - `status` 'failed' | 'challenged', required
    - `error` string, required

## Other responses

- `400`: Request could not complete; inspect error or failure.code.
- `401`: Request could not complete; inspect error or failure.code.
- `402`: Request could not complete; inspect error or failure.code.
- `403`: Request could not complete; inspect error or failure.code.
- `404`: Request could not complete; inspect error or failure.code.
- `408`: Request could not complete; inspect error or failure.code.
- `413`: Request could not complete; inspect error or failure.code.
- `429`: Request could not complete; inspect error or failure.code.
- `500`: Request could not complete; inspect error or failure.code.
- `502`: Request could not complete; inspect error or failure.code.
- `503`: Request could not complete; inspect error or failure.code.
- `504`: Request could not complete; inspect error or failure.code.

---

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