> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Use Enigma in Deepline

> Resolve a brand name to its operating locations and read 12-month card revenue per location. Includes inputs, outputs, SDK V2 examples, and Deepline cost.

[Human guide: work with your agent →](https://deepline.com/docs/human/providers/enigma/guide.md)
Inspect one Enigma action before starting provider-backed work. Your first result is a verified input and output contract.

## Provider-specific requirements

Card-spend revenue for US business locations. The only source in the Deepline
catalog that prices a **private** SMB or multi-location group.

### When to use it

* Sizing a private business or multi-location group that files no public financials
* Ranking local-services accounts by revenue per location instead of review count
* Detecting decline (negative growth) as an outbound trigger
* Segmenting by average ticket, which separates business models better than
  location count does

### Contract notes

`enigma_brand_revenue_search` resolves a brand name to its operating locations
and returns per-location card metrics plus group-level aggregates.

**Always pass `state`.** Enigma matches brand names nationwide, so an ungated
lookup mixes unrelated operators that happen to share a name. `state` is applied
as a post-response filter on the resolved address. Enigma's own
`searchInput.address` is a match hint, not a filter, and returns zero results
when supplied alone.

### Reading the numbers

**Use `median_yoy_growth`, never the mean.** Mean growth is corrupted by new
locations entering the panel. A 10-location group in the field test showed +461%
mean growth driven entirely by one ramping new shop at +3915%. its median was a
sober +7%. Growth values are ratios, not percentages: `0.0721` means +7.21%.

**`revenue_per_location_median` beats the average** for groups with a wide spread
between flagship and satellite locations.

### Coverage caveat

Card spend covers card transactions only. It **understates invoiced fleet and
commercial work**, which is a real share of revenue in verticals like auto
repair, HVAC, and plumbing. Treat these figures as directional floors, not
audited revenue, and never present them to a customer as their actual revenue.

## Find an applicable action

Confirm your effective workspace, then search the live catalog:

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline auth status --json
deepline search "Enigma" --type tools --json
```

Search returns candidates. Check the returned provider and operation rather than selecting a similar title automatically.

## Inspect the selected contract

Replace `<returned-tool-id>` with the identifier returned by discovery:

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline describe <returned-tool-id> --json
```

These commands do not execute the selected provider action. Read its required inputs, supported access mode, pricing unit, outputs, and limits.

A connection does not establish that every action supports BYOK. Follow the provider-specific requirements above and the live action contract.

## Prepare one reviewed input

Use one authorized record that matches the inspected schema. Preserve its source identity and define the result you will accept.

Open the action reference for its payload and response shape. Provider-backed execution can incur usage or external effects.

For reusable logic, follow [Write Plays](https://deepline.com/docs/sdk-v2/plays.md). For direct-call recovery, use [Tool execution recovery](https://deepline.com/docs/sdk-v2/tool-execution-recovery.md).

> [!TIP]
>
> Continue only when the workspace, provider, required fields, acceptance rule, and applicable price are understood. Keep unavailable access separate from no-result evidence.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.