---
title: research boxil
description: Research BOXIL categories, products, reviews, and articles.
canonical_url: https://orchestor.io/docs/en/cli/research/boxil
markdown_url: https://orchestor.io/docs/en/cli/research/boxil.md
contentType: reference
---

# research boxil

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

## Usage

```bash title="terminal"
orc research boxil categories list --q CRM --workspace YOUR_WORKSPACE_ID --json
```

*Search categories*

## Subcommands

### `article get`

Get BOXIL Magazine article

```bash title="terminal"
orc research boxil article get <id> [options]
```

### `categories list`

Search BOXIL categories

```bash title="terminal"
orc research boxil categories list [options]
```

#### Unique options

##### `--q`

max 200 chars

Type: `string`. Optional.

```bash title="terminal"
orc research boxil categories list --q <value>
```

### `products list`

List BOXIL category products

```bash title="terminal"
orc research boxil products list <slug> [options]
```

#### Unique options

##### `--page`

value

Type: `number`. Optional.

```bash title="terminal"
orc research boxil products list <slug> --page <value>
```

### `ranking get`

Get BOXIL monthly ranking

```bash title="terminal"
orc research boxil ranking get <slug> [options]
```

### `discovery get`

Get BOXIL discovery document

```bash title="terminal"
orc research boxil discovery get [options]
```

#### Unique options

##### `--kind`

enum: robots|llms|sitemap|mag-sitemap

Type: `string`. Optional.

```bash title="terminal"
orc research boxil discovery get --kind <value>
```

### `product get`

Get BOXIL product

```bash title="terminal"
orc research boxil product get <id> [options]
```

### `reviews list`

List BOXIL reviews

```bash title="terminal"
orc research boxil reviews list <id> [options]
```

#### Unique options

##### `--page`

value

Type: `number`. Optional.

```bash title="terminal"
orc research boxil reviews list <id> --page <value>
```

### `search`

Search BOXIL services

```bash title="terminal"
orc research boxil search [options]
```

#### Unique options

##### `--page`

value

Type: `number`. Optional.

```bash title="terminal"
orc research boxil search --page <value>
```

##### `--q`

max 70 chars

Type: `string`. Required.

```bash title="terminal"
orc research boxil search --q <value>
```

## Examples

### Retrieve products in a category

```bash title="terminal"
orc research boxil products list electronic_contract --page 1 --workspace YOUR_WORKSPACE_ID --json
```

*Retrieve products in a category*

### Retrieve product details

```bash title="terminal"
orc research boxil product get 611 --workspace YOUR_WORKSPACE_ID --json
```

*Retrieve product details*

## Results and workflow

With `--json`, the API response is nested inside the CLI envelope's `data`. The API returns `data`, `source`, `coverage`, `warnings`, and `interpretation`. Product positions are placements, not ranks; PR and organic slots can repeat the same product. Unknown ratings and prices remain `null`.

For `orc research boxil products list`, `orc research boxil reviews list`, and `orc research boxil search`, the API’s `data.next_url` points to BOXIL. Read its page number and request that page through `--page`; it is not an Orchestor API URL. Pages are not collected automatically. See the BOXIL API guide for provenance and limits.

## 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](https://orchestor.io/docs/cli/global-flags.md) can be used with `orc research boxil`:

- [`--help`](https://orchestor.io/docs/cli/global-flags.md#help)
- [`--workspace`](https://orchestor.io/docs/cli/global-flags.md#workspace)
- [`--json`](https://orchestor.io/docs/cli/global-flags.md#json-output)
- [`--pretty`](https://orchestor.io/docs/cli/global-flags.md#json-output)
- [`--format`](https://orchestor.io/docs/cli/global-flags.md#output-format)
- [`--field`](https://orchestor.io/docs/cli/global-flags.md#field-selection)
- [`--fields`](https://orchestor.io/docs/cli/global-flags.md#field-selection)
- [`--raw`](https://orchestor.io/docs/cli/global-flags.md#raw-output)
- [`--output`](https://orchestor.io/docs/cli/global-flags.md#file-output)
- [`--no-pager`](https://orchestor.io/docs/cli/global-flags.md#pager)
- [`--dry-run`](https://orchestor.io/docs/cli/global-flags.md#dry-run)
- [`--yes`](https://orchestor.io/docs/cli/global-flags.md#confirmation)
- [`--stdin`](https://orchestor.io/docs/cli/global-flags.md#standard-input)
- [`--from-stdin`](https://orchestor.io/docs/cli/global-flags.md#standard-input)
- [`--timing`](https://orchestor.io/docs/cli/global-flags.md#request-timing)

For details and examples, see [global options](https://orchestor.io/docs/cli/global-flags.md).

---

[Documentation index](https://orchestor.io/docs/llms.txt)