Getting started

research reddit

Research Reddit posts, comments, and communities. Use canonical post URLs returned by search to retrieve details or comments.

Usage

terminal
orc research reddit posts search --query "AI agents" --sort new --workspace YOUR_WORKSPACE_ID --format json

Find recent posts

Subcommands

posts get

Get Reddit post

terminal
orc research reddit posts get [options]

Unique options

--url

Full HTTPS Reddit post permalink containing /r/{community}/comments/{post_id}. Shortlinks are not accepted.; max 2048 chars

Type: string. Required.

terminal
orc research reddit posts get --url <value>

posts comments list

List Reddit post comments

terminal
orc research reddit posts comments list [options]

Unique options

--url

Full HTTPS Reddit post permalink containing /r/{community}/comments/{post_id}. Shortlinks are not accepted.; max 2048 chars

Type: string. Required.

terminal
orc research reddit posts comments list --url <value>

Search Reddit comments

terminal
orc research reddit comments search [options]

Unique options

--query

Search text. Search indexes do not guarantee exhaustive coverage.; max 500 chars

Type: string. Required.

terminal
orc research reddit comments search --query <value>
--sort

Source comment search ordering.; enum: relevance|top|new

Type: string. Optional.

terminal
orc research reddit comments search --sort <value>

Search Reddit posts

terminal
orc research reddit posts search [options]

Unique options

--query

Search text. Search indexes do not guarantee exhaustive coverage.; max 500 chars

Type: string. Required.

terminal
orc research reddit posts search --query <value>
--sort

Source ranking. timeframe does not apply to new.; enum: relevance|new|top|comment_count

Type: string. Optional.

terminal
orc research reddit posts search --sort <value>
--timeframe

Relative source time window. Ignored with sort=new; on subreddit listing applies only to top ordering.; enum: all|day|week|month|year

Type: string. Optional.

terminal
orc research reddit posts search --timeframe <value>

subreddits get

Get Reddit community

terminal
orc research reddit subreddits get [options]

Unique options

--subreddit

Canonical subreddit name without r/, for example AskReddit. Preserve source casing.

Type: string. Required.

terminal
orc research reddit subreddits get --subreddit <value>

subreddits posts list

List Reddit community posts

terminal
orc research reddit subreddits posts list [options]

Unique options

--subreddit

Canonical subreddit name without r/, for example AskReddit. Preserve source casing.

Type: string. Required.

terminal
orc research reddit subreddits posts list --subreddit <value>
--sort

Community listing order.; enum: best|hot|new|top|rising

Type: string. Optional.

terminal
orc research reddit subreddits posts list --sort <value>
--timeframe

Relative source time window. Ignored with sort=new; on subreddit listing applies only to top ordering.; enum: all|day|week|month|year

Type: string. Optional.

terminal
orc research reddit subreddits posts list --timeframe <value>

Search within a Reddit community

terminal
orc research reddit subreddits posts search [options]

Unique options

--subreddit

Canonical subreddit name without r/, for example AskReddit. Preserve source casing.

Type: string. Required.

terminal
orc research reddit subreddits posts search --subreddit <value>
--query

Search text. Search indexes do not guarantee exhaustive coverage.; max 500 chars

Type: string. Required.

terminal
orc research reddit subreddits posts search --query <value>
--sort

Source search ordering.; enum: relevance|hot|top|new|comments

Type: string. Optional.

terminal
orc research reddit subreddits posts search --sort <value>
--timeframe

Relative window; ignored for new ordering.; enum: all|year|month|week|day|hour

Type: string. Optional.

terminal
orc research reddit subreddits posts search --timeframe <value>

Output and continuation

Each call returns one page. When continuation is available, pass the top-level pagination.next_cursor as --cursor with unchanged filters. Never replay data.next_cursor. has_more: null means unknown, not complete. --page-all is unavailable.

JSON retains records in data.data, continuation in data.pagination and provenance in data.source. --raw removes the CLI envelope; --field data selects the API data. Missing and null values do not mean zero.

data.usage.provider_credits uses the provider’s units, not Orchestor billing units. See each API reference for coverage and provider-specific constraints.

Permissions

Sign in with orc auth login using a beta-approved account, or use an API key with the read scope. Select an accessible workspace with --workspace. No research-specific workspace allowlist is required.

Global Options

The following global options can be used with orc research reddit:

For details and examples, see global options.