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
orc research x accounts get <handle> --workspace <workspace-id> --jsonRetrieve an account.
Subcommands
accounts get
Get X account
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.
orc research x accounts get <handle> --max-age <value>accounts posts list
List X account posts
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.
orc research x accounts posts list <handle> --max-age <value>--include-replies
Include replies along with posts. Preserve this value while paging.; enum: true|false
Type: string. Optional.
orc research x accounts posts list <handle> --include-replies <value>posts get
Get X post
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.
orc research x posts get <id> --max-age <value>accounts post-observations import
Import previously acquired X observations
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.
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.
orc research x accounts post-observations import <handle> --posts <value>posts list
Rank and search saved X posts
orc research x posts list [options]Unique options
--handles
Comma-separated timeline handles. Omit to query this workspace.
Type: string. Optional.
orc research x posts list --handles <value>--q
Case-insensitive literal text substring, not a provider search.; max 300 chars
Type: string. Optional.
orc research x posts list --q <value>--since
Inclusive publication time, UTC.
Type: string. Optional.
orc research x posts list --since <value>--until
Exclusive publication time, UTC.
Type: string. Optional.
orc research x posts list --until <value>Compare source author with timeline account. Unknown authors are never inferred from timeline ownership.; enum: own|other|unknown|all
Type: string. Optional.
orc research x posts list --authorship <value>--post-type
enum: all|original|reply|repost
Type: string. Optional.
orc research x posts list --post-type <value>--min-views
(use "null" or "reset" to clear)
Type: number. Optional.
orc research x posts list --min-views <value>--sort
enum: engagements|likes|reposts|replies|quotes|views|bookmarks|engagement_rate|published_at
Type: string. Optional.
orc research x posts list --sort <value>--order
enum: desc|asc
Type: string. Optional.
orc research x posts list --order <value>--offset
(use "null" or "reset" to clear)
Type: number. Optional.
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.
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.
orc research x posts list --group-by <value>posts analytics
Analyze saved X posts
orc research x posts analytics [options]Unique options
--handles
Comma-separated timeline handles. Omit to query this workspace.
Type: string. Optional.
orc research x posts analytics --handles <value>--q
Case-insensitive literal text substring, not a provider search.; max 300 chars
Type: string. Optional.
orc research x posts analytics --q <value>--since
Inclusive publication time, UTC.
Type: string. Optional.
orc research x posts analytics --since <value>--until
Exclusive publication time, UTC.
Type: string. Optional.
orc research x posts analytics --until <value>Compare source author with timeline account. Unknown authors are never inferred from timeline ownership.; enum: own|other|unknown|all
Type: string. Optional.
orc research x posts analytics --authorship <value>--post-type
enum: all|original|reply|repost
Type: string. Optional.
orc research x posts analytics --post-type <value>--min-views
(use "null" or "reset" to clear)
Type: number. Optional.
orc research x posts analytics --min-views <value>--sort
enum: engagements|likes|reposts|replies|quotes|views|bookmarks|engagement_rate|published_at
Type: string. Optional.
orc research x posts analytics --sort <value>--order
enum: desc|asc
Type: string. Optional.
orc research x posts analytics --order <value>--offset
(use "null" or "reset" to clear)
Type: number. Optional.
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.
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.
orc research x posts analytics --group-by <value>Global Options
The following global options can be used with orc research x:
For details and examples, see global options.