Research

research boxil

Research BOXIL categories, products, reviews, and articles. Distinguish page placement, sponsored listings, and document-request rankings when comparing results.

Usage

terminal
orc research boxil categories list --q CRM --workspace YOUR_WORKSPACE_ID --json

Search categories

Subcommands

article get

Get BOXIL Magazine article

terminal
orc research boxil article get <id> [options]

Unique options

--include-raw

enum: true|false

Type: string. Optional.

terminal
orc research boxil article get <id> --include-raw <value>
--full

enum: true|false

Type: string. Optional.

terminal
orc research boxil article get <id> --full <value>

categories list

Search BOXIL categories

terminal
orc research boxil categories list [options]

Unique options

--include-raw

enum: true|false

Type: string. Optional.

terminal
orc research boxil categories list --include-raw <value>
--full

enum: true|false

Type: string. Optional.

terminal
orc research boxil categories list --full <value>
--q

max 200 chars

Type: string. Optional.

terminal
orc research boxil categories list --q <value>

products list

List BOXIL category products

terminal
orc research boxil products list <slug> [options]

Unique options

--include-raw

enum: true|false

Type: string. Optional.

terminal
orc research boxil products list <slug> --include-raw <value>
--full

enum: true|false

Type: string. Optional.

terminal
orc research boxil products list <slug> --full <value>
--all-pages

enum: true|false

Type: string. Optional.

terminal
orc research boxil products list <slug> --all-pages <value>
--max-pages

value

Type: number. Optional.

terminal
orc research boxil products list <slug> --max-pages <value>
--page

value

Type: number. Optional.

terminal
orc research boxil products list <slug> --page <value>

ranking get

Get BOXIL monthly ranking

terminal
orc research boxil ranking get <slug> [options]

Unique options

--include-raw

enum: true|false

Type: string. Optional.

terminal
orc research boxil ranking get <slug> --include-raw <value>
--full

enum: true|false

Type: string. Optional.

terminal
orc research boxil ranking get <slug> --full <value>

discovery get

Get BOXIL discovery document

terminal
orc research boxil discovery get [options]

Unique options

--include-raw

enum: true|false

Type: string. Optional.

terminal
orc research boxil discovery get --include-raw <value>
--full

enum: true|false

Type: string. Optional.

terminal
orc research boxil discovery get --full <value>
--kind

enum: robots|llms|sitemap|mag-sitemap

Type: string. Optional.

terminal
orc research boxil discovery get --kind <value>

product get

Get BOXIL product

terminal
orc research boxil product get <id> [options]

Unique options

--include-raw

enum: true|false

Type: string. Optional.

terminal
orc research boxil product get <id> --include-raw <value>
--full

enum: true|false

Type: string. Optional.

terminal
orc research boxil product get <id> --full <value>

reviews list

List BOXIL reviews

terminal
orc research boxil reviews list <id> [options]

Unique options

--include-raw

enum: true|false

Type: string. Optional.

terminal
orc research boxil reviews list <id> --include-raw <value>
--full

enum: true|false

Type: string. Optional.

terminal
orc research boxil reviews list <id> --full <value>
--all-pages

enum: true|false

Type: string. Optional.

terminal
orc research boxil reviews list <id> --all-pages <value>
--max-pages

value

Type: number. Optional.

terminal
orc research boxil reviews list <id> --max-pages <value>
--page

value

Type: number. Optional.

terminal
orc research boxil reviews list <id> --page <value>

Search BOXIL services

terminal
orc research boxil search [options]

Unique options

--include-raw

enum: true|false

Type: string. Optional.

terminal
orc research boxil search --include-raw <value>
--full

enum: true|false

Type: string. Optional.

terminal
orc research boxil search --full <value>
--all-pages

enum: true|false

Type: string. Optional.

terminal
orc research boxil search --all-pages <value>
--max-pages

value

Type: number. Optional.

terminal
orc research boxil search --max-pages <value>
--page

value

Type: number. Optional.

terminal
orc research boxil search --page <value>
--q

max 70 chars

Type: string. Required.

terminal
orc research boxil search --q <value>

Examples

Retrieve products in a category

terminal
orc research boxil products list electronic_contract --page 1 --workspace YOUR_WORKSPACE_ID --json

Retrieve products in a category

Retrieve product details

terminal
orc research boxil product get 611 --workspace YOUR_WORKSPACE_ID --json

Retrieve product details

Save all pages and raw sources

terminal
orc research boxil products list electronic_contract --all-pages true --include-raw true --full true --workspace YOUR_WORKSPACE_ID --json --output result.json

Save all pages and raw sources

Collection and export

Product details include company information and multiple categories. Product position means placement and sponsored identifies PR listings. Duplicate placements are not independent products. Rankings measure document requests, not satisfaction; unknown prices, ratings, and company information are not inferred.

Use --all-pages true on paginated lists to follow continuation pages. --max-pages limits each collection to 100 pages by default. Check collection.fetched_count, pages_fetched, complete, stop_reason, next_url, and failure for counts, termination, and partial failure. A limit or failure does not mean the collection is complete.

--include-raw true includes fetched HTML or JSON in raw_sources. Save extracted fields and original content together with --json --output result.json. The global --raw flag controls CLI formatting; it does not request source content.

--full true avoids content truncation and compact projection. Check omissions and body truncated fields for omitted content. Collection options default to JSON output. Tables, CSV, and field selection reduce the output, so use JSON when preserving data for re-extraction.

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 boxil:

For details and examples, see global options.