Research

research x

orc research x retrieves X accounts and posts and searches or analyzes saved posts.

Authenticate the CLI and select an accessible Workspace with --workspace.

Usage

terminal
orc research x accounts get <handle> --workspace <workspace-id> --json

Retrieve an account.

Subcommands

accounts get

Get X account

terminal
orc research x accounts get <handle> [options]

Unique options

--max-age

Maximum cached age in seconds, scoped to this workspace. Zero fetches fresh. Each fresh page may incur provider charges.; (use "null" or "reset" to clear)

Type: number. Optional.

terminal
orc research x accounts get <handle> --max-age <value>

library page

Page the shared X library

terminal
orc research x library page [options]

Unique options

--accounts

Required comma-separated public handles, at most 100.; max 1599 chars

Type: string. Required.

terminal
orc research x library page --accounts <value>
--media

enum: any|photo|video

Type: string. Optional.

terminal
orc research x library page --media <value>
--post-type

enum: original|reply|repost

Type: string. Optional.

terminal
orc research x library page --post-type <value>
--sort

enum: views|likes|replies|date

Type: string. Optional.

terminal
orc research x library page --sort <value>

library counts

Count shared X posts by account

terminal
orc research x library counts [options]

Unique options

--accounts

Required comma-separated public handles, at most 100.; max 1599 chars

Type: string. Required.

terminal
orc research x library counts --accounts <value>

library post

Get one stored X post with signed media

terminal
orc research x library post <id> [options]

library list

Read the shared X post library

terminal
orc research x library list <handle> [options]

library backfill

Backfill shared X media posts

terminal
orc research x library backfill <handle> [options]

Unique options

--max-pages

Body field: max_pages

Type: number. Optional.

terminal
orc research x library backfill <handle> --max-pages <value>
--media-only

Only media backfill is supported.; enum: true

Type: string. Optional.

terminal
orc research x library backfill <handle> --media-only <value>
--since

Inclusive UTC start date (YYYY-MM-DD). Preserve when resuming.

Type: string. Optional.

terminal
orc research x library backfill <handle> --since <value>
--until

Exclusive UTC end date (YYYY-MM-DD). Preserve when resuming.

Type: string. Optional.

terminal
orc research x library backfill <handle> --until <value>

accounts posts list

List X account posts

terminal
orc research x accounts posts list <handle> [options]

Unique options

--max-age

Maximum cached age in seconds, scoped to this workspace. Zero fetches fresh. Each fresh page may incur provider charges.; (use "null" or "reset" to clear)

Type: number. Optional.

terminal
orc research x accounts posts list <handle> --max-age <value>
--tracking-target

Workspace-scoped tracking target key. Associates an acquired first page with that target for restoration.

Type: string. Optional.

terminal
orc research x accounts posts list <handle> --tracking-target <value>
--include-replies

Include replies along with posts. Preserve this value while paging.; enum: true|false

Type: string. Optional.

terminal
orc research x accounts posts list <handle> --include-replies <value>

posts get

Get X post

terminal
orc research x posts get <id> [options]

Unique options

--max-age

Maximum cached age in seconds, scoped to this workspace. Zero fetches fresh. Each fresh page may incur provider charges.; (use "null" or "reset" to clear)

Type: number. Optional.

terminal
orc research x posts get <id> --max-age <value>

accounts post-observations import

Import previously acquired X observations

terminal
orc research x accounts post-observations import <handle> [options]

Unique options

--observed-at

(required) Fallback observation time for posts without their own timestamp.

Type: string. Optional.

terminal
orc research x accounts post-observations import <handle> --observed-at <value>
--posts

(required) Body field: posts; JSON array of objects (use --stdin for large resources)

Type: string. Optional.

terminal
orc research x accounts post-observations import <handle> --posts <value>

posts list

Rank and search saved X posts

terminal
orc research x posts list [options]

Unique options

--handles

Comma-separated timeline handles. Omit to query this workspace.

Type: string. Optional.

terminal
orc research x posts list --handles <value>
--q

Case-insensitive literal text substring, not a provider search.; max 300 chars

Type: string. Optional.

terminal
orc research x posts list --q <value>
--since

Inclusive publication time, UTC.

Type: string. Optional.

terminal
orc research x posts list --since <value>
--until

Exclusive publication time, UTC.

Type: string. Optional.

terminal
orc research x posts list --until <value>
--authorship

Compare source author with timeline account. Unknown authors are never inferred from timeline ownership.; enum: own|other|unknown|all

Type: string. Optional.

terminal
orc research x posts list --authorship <value>
--post-type

enum: all|original|reply|repost

Type: string. Optional.

terminal
orc research x posts list --post-type <value>
--min-views

(use "null" or "reset" to clear)

Type: number. Optional.

terminal
orc research x posts list --min-views <value>
--sort

enum: engagements|likes|reposts|replies|quotes|views|bookmarks|engagement_rate|published_at

Type: string. Optional.

terminal
orc research x posts list --sort <value>
--order

enum: desc|asc

Type: string. Optional.

terminal
orc research x posts list --order <value>
--offset

(use "null" or "reset" to clear)

Type: number. Optional.

terminal
orc research x posts list --offset <value>
--as-of

Freeze saved and observed records at this time. Preserve pagination.next_url for stable paging.

Type: string. Optional.

terminal
orc research x posts list --as-of <value>
--group-by

Analytics grouping; month uses UTC publication time.; enum: account|month|post_type

Type: string. Optional.

terminal
orc research x posts list --group-by <value>

posts analytics

Analyze saved X posts

terminal
orc research x posts analytics [options]

Unique options

--handles

Comma-separated timeline handles. Omit to query this workspace.

Type: string. Optional.

terminal
orc research x posts analytics --handles <value>
--q

Case-insensitive literal text substring, not a provider search.; max 300 chars

Type: string. Optional.

terminal
orc research x posts analytics --q <value>
--since

Inclusive publication time, UTC.

Type: string. Optional.

terminal
orc research x posts analytics --since <value>
--until

Exclusive publication time, UTC.

Type: string. Optional.

terminal
orc research x posts analytics --until <value>
--authorship

Compare source author with timeline account. Unknown authors are never inferred from timeline ownership.; enum: own|other|unknown|all

Type: string. Optional.

terminal
orc research x posts analytics --authorship <value>
--post-type

enum: all|original|reply|repost

Type: string. Optional.

terminal
orc research x posts analytics --post-type <value>
--min-views

(use "null" or "reset" to clear)

Type: number. Optional.

terminal
orc research x posts analytics --min-views <value>
--sort

enum: engagements|likes|reposts|replies|quotes|views|bookmarks|engagement_rate|published_at

Type: string. Optional.

terminal
orc research x posts analytics --sort <value>
--order

enum: desc|asc

Type: string. Optional.

terminal
orc research x posts analytics --order <value>
--offset

(use "null" or "reset" to clear)

Type: number. Optional.

terminal
orc research x posts analytics --offset <value>
--as-of

Freeze saved and observed records at this time. Preserve pagination.next_url for stable paging.

Type: string. Optional.

terminal
orc research x posts analytics --as-of <value>
--group-by

Analytics grouping; month uses UTC publication time.; enum: account|month|post_type

Type: string. Optional.

terminal
orc research x posts analytics --group-by <value>

Search public X posts

terminal
orc research x search [options]

Unique options

--q

max 4096 chars

Type: string. Optional.

terminal
orc research x search --q <value>
--accounts

max 2048 chars

Type: string. Optional.

terminal
orc research x search --accounts <value>
--since

value

Type: string. Optional.

terminal
orc research x search --since <value>
--until

value

Type: string. Optional.

terminal
orc research x search --until <value>
--within

Rolling window ending now, e.g. 24h or 7d. Emits within_time:. Cannot be combined with since or until.

Type: string. Optional.

terminal
orc research x search --within <value>
--lang

value

Type: string. Optional.

terminal
orc research x search --lang <value>
--media

enum: any|images|videos|links

Type: string. Optional.

terminal
orc research x search --media <value>
--include-replies

enum: true|false

Type: string. Optional.

terminal
orc research x search --include-replies <value>
--include-reposts

Include native reposts from approximately the last 7-10 days. Cannot be combined with min_likes, min_reposts or min_replies.; enum: true|false

Type: string. Optional.

terminal
orc research x search --include-reposts <value>
--verified-only

enum: true|false

Type: string. Optional.

terminal
orc research x search --verified-only <value>
--min-likes

(use "null" or "reset" to clear)

Type: number. Optional.

terminal
orc research x search --min-likes <value>
--min-reposts

(use "null" or "reset" to clear)

Type: number. Optional.

terminal
orc research x search --min-reposts <value>
--min-replies

(use "null" or "reset" to clear)

Type: number. Optional.

terminal
orc research x search --min-replies <value>
--min-views

(use "null" or "reset" to clear)

Type: number. Optional.

terminal
orc research x search --min-views <value>
--min-bookmarks

(use "null" or "reset" to clear)

Type: number. Optional.

terminal
orc research x search --min-bookmarks <value>
--min-length

(use "null" or "reset" to clear)

Type: number. Optional.

terminal
orc research x search --min-length <value>
--follower-bucket

enum: lt_1k|1k_10k|10k_100k|gt_100k

Type: string. Optional.

terminal
orc research x search --follower-bucket <value>
--sort

enum: relevance|newest|likes|reposts|views

Type: string. Optional.

terminal
orc research x search --sort <value>
--max-age

Maximum age of shared public cache in seconds. Zero fetches fresh.; (use "null" or "reset" to clear)

Type: number. Optional.

terminal
orc research x search --max-age <value>

inspiration accounts list

List registered X inspiration accounts

terminal
orc research x inspiration accounts list [options]

inspiration accounts save

Register or classify an X inspiration account

terminal
orc research x inspiration accounts save [options]

Unique options

--handle

(required) Body field: handle

Type: string. Optional.

terminal
orc research x inspiration accounts save --handle <value>
--kind

(required) Body field: kind; enum: company|person

Type: string. Optional.

terminal
orc research x inspiration accounts save --kind <value>
--name

(required) Body field: name; max 100 chars

Type: string. Optional.

terminal
orc research x inspiration accounts save --name <value>

Global Options

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

For details and examples, see global options.