Getting started

research prtimes

orc research prtimes searches PR TIMES releases and follows categories or companies to retrieve release text, reactions and public materials. Start with map, then follow company and release IDs from search results.

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

Usage

terminal
orc research prtimes search --q "生成AI" --workspace <workspace-id> --json

Search published releases.

Subcommands

business-categories releases list

List releases for a discovered business categories ID. Find valid IDs through map.

terminal
orc research prtimes business-categories releases list <id> [options]

Unique options

--page

One-based source page number. Prefer pagination.next_url for subsequent requests so filters are preserved.

Type: number. Optional.

terminal
orc research prtimes business-categories releases list <id> --page <value>
--include-native

Set true to include original source fields in each list item. false returns the smaller normalized summary. This query parameter is the literal string true or false.; enum: true|false

Type: string. Optional.

terminal
orc research prtimes business-categories releases list <id> --include-native <value>
--subcategory-id

Child category id from the selected business category in map.business_categories. Omit it to request the parent category.

Type: string. Optional.

terminal
orc research prtimes business-categories releases list <id> --subcategory-id <value>

channels releases list

List releases for a discovered channels ID. Find valid IDs through map.

terminal
orc research prtimes channels releases list <id> [options]

Unique options

--page

One-based source page number. Prefer pagination.next_url for subsequent requests so filters are preserved.

Type: number. Optional.

terminal
orc research prtimes channels releases list <id> --page <value>
--include-native

Set true to include original source fields in each list item. false returns the smaller normalized summary. This query parameter is the literal string true or false.; enum: true|false

Type: string. Optional.

terminal
orc research prtimes channels releases list <id> --include-native <value>

companies get

Retrieve a public company profile using its company ID, rather than its name or URL.

terminal
orc research prtimes companies get <company-id> [options]

companies releases list

List releases published by the selected company. Reuse the discovered company ID and keep it unchanged when continuing.

terminal
orc research prtimes companies releases list <company-id> [options]

Unique options

--offset

Number of company releases to skip. The upstream page size is fixed at 10. Use pagination.next_url instead of assuming the next offset.; (use "null" or "reset" to clear)

Type: number. Optional.

terminal
orc research prtimes companies releases list <company-id> --offset <value>
--include-native

Set true to include original source fields in each list item. false returns the smaller normalized summary. This query parameter is the literal string true or false.; enum: true|false

Type: string. Optional.

terminal
orc research prtimes companies releases list <company-id> --include-native <value>

companies releases get

Retrieve release text, reactions, classification and links to images and attachments using company and release IDs.

terminal
orc research prtimes companies releases get <company-id> <release-id> [options]

company-categories releases list

List releases for a discovered company categories ID. Find valid IDs through map.

terminal
orc research prtimes company-categories releases list <id> [options]

Unique options

--page

One-based source page number. Prefer pagination.next_url for subsequent requests so filters are preserved.

Type: number. Optional.

terminal
orc research prtimes company-categories releases list <id> --page <value>
--include-native

Set true to include original source fields in each list item. false returns the smaller normalized summary. This query parameter is the literal string true or false.; enum: true|false

Type: string. Optional.

terminal
orc research prtimes company-categories releases list <id> --include-native <value>

keywords list

Discover popular PR TIMES keywords for release searches. Counts do not measure search demand.

terminal
orc research prtimes keywords list [options]

map

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

terminal
orc research prtimes map [options]

prefectures releases list

List releases for a discovered prefectures ID. Find valid IDs through map.

terminal
orc research prtimes prefectures releases list <id> [options]

Unique options

--page

One-based source page number. Prefer pagination.next_url for subsequent requests so filters are preserved.

Type: number. Optional.

terminal
orc research prtimes prefectures releases list <id> --page <value>
--include-native

Set true to include original source fields in each list item. false returns the smaller normalized summary. This query parameter is the literal string true or false.; enum: true|false

Type: string. Optional.

terminal
orc research prtimes prefectures releases list <id> --include-native <value>
--location-type

Location relationship from map.location_types, such as headquarters or event venue. Applies only to prefecture collections. Omit it for no additional location-type filter.; (use "null" or "reset" to clear)

Type: number. Optional.

terminal
orc research prtimes prefectures releases list <id> --location-type <value>

rankings list

Read the current native ranking selected by --type. PR TIMES controls its window and update timing; this does not establish historical popularity.

terminal
orc research prtimes rankings list [options]

Unique options

--type

Native PR TIMES ranking selector. PR TIMES controls each time window and ordering; names do not imply a fixed duration guaranteed by Orchestor.; enum: hot|now|daily|weekly|monthly

Type: string. Optional.

terminal
orc research prtimes rankings list --type <value>
--include-native

Set true to include original source fields in each list item. false returns the smaller normalized summary. This query parameter is the literal string true or false.; enum: true|false

Type: string. Optional.

terminal
orc research prtimes rankings list --include-native <value>

release-types releases list

List releases for a discovered release types ID. Find valid IDs through map.

terminal
orc research prtimes release-types releases list <id> [options]

Unique options

--page

One-based source page number. Prefer pagination.next_url for subsequent requests so filters are preserved.

Type: number. Optional.

terminal
orc research prtimes release-types releases list <id> --page <value>
--include-native

Set true to include original source fields in each list item. false returns the smaller normalized summary. This query parameter is the literal string true or false.; enum: true|false

Type: string. Optional.

terminal
orc research prtimes release-types releases list <id> --include-native <value>

releases list

Retrieve newly published releases in source order. Use their company and release IDs to inspect details.

terminal
orc research prtimes releases list [options]

Unique options

--include-native

Set true to include original source fields in each list item. false returns the smaller normalized summary. This query parameter is the literal string true or false.; enum: true|false

Type: string. Optional.

terminal
orc research prtimes releases list --include-native <value>

Search PR TIMES using --q. Follow company and release IDs from the results to retrieve individual releases.

terminal
orc research prtimes search [options]

Unique options

--page

One-based source page number. Prefer pagination.next_url for subsequent requests so filters are preserved.

Type: number. Optional.

terminal
orc research prtimes search --page <value>
--include-native

Set true to include original source fields in each list item. false returns the smaller normalized summary. This query parameter is the literal string true or false.; enum: true|false

Type: string. Optional.

terminal
orc research prtimes search --include-native <value>
--q

Keyword or phrase passed to native PR TIMES search. Leading and trailing whitespace is removed. URL-encode the value.; max 200 chars

Type: string. Required.

terminal
orc research prtimes search --q <value>

Examples

Read the current weekly ranking.

terminal
orc research prtimes rankings list --type weekly --workspace <workspace-id> --json

Read the current weekly ranking.

Retrieve details for a discovered release.

terminal
orc research prtimes companies releases get <company-id> <release-id> --workspace <workspace-id> --json

Retrieve details for a discovered release.

Output and continuation

List calls retrieve one source page. Follow the query values in pagination.next_url using the corresponding flags, keeping filters unchanged. Unknown continuation does not establish completeness. Automatic traversal with --page-all is unavailable.

With --json, the full API response is retained inside the CLI data envelope. Records are in data.data, continuation in data.pagination, and provenance in data.source. --raw removes the CLI envelope; --field data selects API data. Missing and null values do not mean zero.

Reactions, classification and materials

Search discovers releases. For each release to compare, pass company.id and release_id to companies releases get; no enrichment flag is needed. Detail includes engagement.like_count with its own source.observed_at, release_type, keyword_links, linked business_categories, images with URLs, reference_url, materials_url, public attachments, and share_links.

Likes count PR TIMES actions, not unique people or Facebook reactions. The separate like-count request must succeed; failure is an error, never zero. facebook_like_count is numeric only when PR TIMES supplies it, otherwise null. Facebook, X and LINE share links are not reaction counts. Material and attachment URLs are links, not downloaded files or proof of reuse rights.

Ranking rows include one-based rank. Retain ranking_type and source.observed_at. A current window cannot establish historical popularity, and raw likes across releases of different ages are not directly comparable. Observed reactions do not establish why a release succeeded.

Permissions

API keys require read scope. Provider credentials are managed by the server.

Global Options

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

For details and examples, see global options.