<!-- AUTO-GENERATED from the capability registry — regenerate: npm run generate:registry -->

# `ocean_companies` — Orange Slice capability

> Outcome-priced capability. One price for the answer, whichever providers it took.
> Everything we expose, with prices: https://orangeslice.ai/llms.txt

Find companies resembling domains you already win, or filter by country, industry, headcount and ecommerce. Billed 15 credits per company returned.

## Price

**$0.03 per result, up to $3.00 per call**

Billed per row returned, within the floor and ceiling above.

The price is a property of the outcome, not of the work behind it. Whichever
vendor serves this call, and whatever it costs us, the number above is the number
quoted before the run and charged after it.


## Call it

**CLI**

```bash
orangeslice search ocean_companies --lookalike-domain stripe.com --country US --size 25
```

**HTTP**

```bash
curl -X POST 'https://orangeslice.ai/api/v1/run' \
  -H 'Authorization: Bearer $ORANGESLICE_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"capability":"ocean_companies","input":{"companySize":"<string[]>","country":"<string[]>","ecommerce":"<boolean>"}}'
```

**SDK**

```ts
await services.ocean.search.companies({ companySize: "…", country: "…", ecommerce: "…" });
```

## Inputs

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `companySize` | string[] | No | Headcount bands |
| `country` | string[] | No | Countries to restrict to |
| `ecommerce` | boolean | No | Only companies Ocean flags as ecommerce |
| `industry` | string[] | No |  |
| `lookalikeDomain` | string[] | No | Domains to find companies similar to — Ocean's reason for existing |
| `searchAfter` | string | No | Cursor from a previous page's `searchAfter` |
| `size` | number | No | Companies to return, 1-100. 15 credits each |

Inputs may also be piped as NDJSON, one JSON object per line.

## Output

```json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "companies": {
      "default": [],
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "domain": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "companyName": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "description": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "country": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "companySize": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "employeeCount": {
            "anyOf": [
              {
                "type": "number"
              },
              {
                "type": "null"
              }
            ]
          },
          "revenue": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "yearFounded": {
            "anyOf": [
              {
                "type": "number"
              },
              {
                "type": "null"
              }
            ]
          },
          "industries": {
            "default": [],
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "technologies": {
            "default": [],
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "ecommerce": {
            "anyOf": [
              {
                "type": "boolean"
              },
              {
                "type": "null"
              }
            ]
          },
          "relevance": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          }
        },
        "required": [
          "domain",
          "companyName",
          "description",
          "country",
          "companySize",
          "employeeCount",
          "revenue",
          "yearFounded",
          "industries",
          "technologies",
          "ecommerce",
          "relevance"
        ],
        "additionalProperties": false
      }
    },
    "total": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ]
    },
    "searchAfter": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "companies",
    "total",
    "searchAfter"
  ],
  "additionalProperties": false
}
```

The field that carries the answer is `companies`. It is
`null` — or empty — when nothing was found, which is how a miss is told from a
hit without knowing anything else about this entry.

## Before you run

- **Price it first.** `orangeslice search ocean_companies --dry-run` returns the
  exact dollar cost and spends nothing.
- **Large runs need approval.** Above the spend-gate threshold a run exits **7**
  until it carries a plan token, and only a dry run mints one.
- **Scopes:** enrich
- **Permitted uses:** research, outreach, export

## Exit codes

`0` ok · `2` bad input · `3` auth · `4` not found · `5` provider ·
`6` rate limited · `7` spend gate, nothing billed · `8` timeout ·
`9` a third-party account needs connecting