​

research

orc research provides commands for investigating keyword demand, public articles, social posts, videos and web pages. Choose a source-specific command to search, retrieve details or continue through results while sharing authentication, Workspace selection and output formats.

Use Google Keywords and Google Trends for keyword research, or dedicated service commands for public-content research. This overview introduces discovery entry points; provider pages explain individual search conditions and interpretation.

Authenticate the CLI and select an accessible Workspace. Use --workspace to set the scope for this call.

Discover keyword-research operations.

Discover URLs with paid fallback disabled.

Discover up to 100,000 URLs from sitemaps, llms.txt and links without retrieving all page bodies. Use --fallback none to disable the default Firecrawl fallback.

Body field: fallback; enum: none|firecrawl

Type: string. Optional.

Body field: maxAge

Type: number. Optional.

Body field: sitemap; enum: include|only|skip

Type: string. Optional.

(required) Body field: url; max 2048 chars

Type: string. Optional.

Discover note topics and retrieval entry points. Use a returned topic path with topics get.

Discover categories and release-list entry points. Use the returned IDs in category-specific list commands.

Discover the available keyword-research operations and their input primitives before choosing a retrieval workflow.

Retrieve interest over time, geographic interest, related queries and topics for a location, language and time window. Graphs and maps accept up to five terms; related queries or topics require exactly one.

Requested result types: graph for interest over time, map for geographic interest, topics_list for related topics, and queries_list for related searches. Topic and query lists require exactly one keyword.; csv of: google_trends_graph|google_trends_map|google_trends_topics_list|google_trends_queries_list

Type: string. Optional.

(required) Search terms to compare. Specify exactly one term when requesting related topics or related queries in item_types. Leading and trailing whitespace is removed.; csv

Type: string. Optional.

(required) Provider language code for the request. Support depends on the upstream dataset; Labs combinations are available from the locales endpoint.

Type: string. Optional.

(required) Provider location identifier for geographic targeting. This is not a country ISO code. Supported locations depend on the upstream dataset.

Type: number. Optional.

Relative time window for the comparison. Scores are normalized within the requested comparison and are not absolute search counts.; enum: past_hour|past_4_hours|past_day|past_7_days|past_30_days|past_90_days|past_12_months|past_5_years

Type: string. Optional.

Google search surface: web, news, youtube, images, or froogle for Google Shopping.; enum: web|news|youtube|images|froogle

Type: string. Optional.

Discover Zenn retrieval operations and content entry points.

Discover Qiita operations for articles, tags and users.

Discover itreview retrieval operations and research entry points.

Maximum cached acquisition age in milliseconds. Default 24 hours; zero forces acquisition. Original source timestamps are preserved. Successful refreshes append history. Refresh is on request, not scheduled.; (use "null" or "reset" to clear)

Type: number. Optional.

--json retains the full API response inside the CLI data envelope; --raw removes that envelope. Array flags use comma-separated values. --dry-run previews a request without sending it.

List calls retrieve one source page. Research does not support automatic traversal with --page-all; follow the provider-specific continuation instructions. A successful HTTP response may still contain failed batch rows, so inspect each result.

Exit codes are zero for success, one for API/authentication/network failures, and two for argument errors. Correct authentication, Workspace or inputs before retrying, and avoid blindly resubmitting successful batch rows.

API-key GET calls require read scope; POST keyword retrieval and Trends require write scope. YouTube transcripts get uses POST but requires read scope. Select an accessible Workspace.

The following global options can be used with orc research:

For details and examples, see global options.