> ## 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.

# Aviato: Company Enrich

> Enrich one company from its website, LinkedIn URL or another profile ID, returning firmographics, headcount and funding.

Enrich one company from its website, LinkedIn URL or another profile ID, returning firmographics, headcount and funding.

> [!NOTE]
>
> Tool ID: `aviato_company_enrich`

## Run this action

Use the TypeScript SDK for one call. Use `ctx.tools.execute(...)` inside a Play for durable calls, scheduled calls, or CSV processing.

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'aviato_company_enrich',
  {
    "id": "id_123",
    "linkedinID": "https://www.linkedin.com/in/jane-doe",
    "linkedinNumID": "https://www.linkedin.com/in/jane-doe"
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute aviato_company_enrich --input '{
  "id": "id_123",
  "linkedinID": "https://www.linkedin.com/in/jane-doe",
  "linkedinNumID": "https://www.linkedin.com/in/jane-doe"
}' --json
```

## Example response

The SDK returns this shape at `result.toolResponse.raw`. The example values illustrate the response.

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "data": {
    "id": "id_123",
    "alternateNames": [
      "Example"
    ],
    "targetMarketList": [
      "example"
    ],
    "screenshotList": [
      "example"
    ],
    "businessModelList": [
      "example"
    ],
    "jobListingList": [
      {
        "category": "example",
        "subCategory": "example",
        "title": "VP of Engineering"
      }
    ],
    "techStackList": [
      {
        "productName": "Example",
        "productCategories": [
          "example"
        ]
      }
    ],
    "jobFamilyList": [
      "example"
    ],
    "customerTypes": [
      "example"
    ]
  }
}
```

Use `deepline describe aviato_company_enrich --json` for the latest machine-readable contract.

## Input reference

Get enriched details on a company

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.id` | `string` | No | — | — |
| `payload.linkedinID` | `string` | No | — | — |
| `payload.linkedinNumID` | `string` | No | — | — |
| `payload.linkedinURL` | `string` | No | — | LinkedIn URL, accepts company URLs like linkedin.com/company/google or linkedin.com/company/1441 |
| `payload.facebookID` | `string` | No | — | — |
| `payload.twitterID` | `string` | No | — | — |
| `payload.crunchbaseID` | `string` | No | — | — |
| `payload.pitchbookID` | `string` | No | — | — |
| `payload.producthuntID` | `string` | No | — | — |
| `payload.dealroomID` | `string` | No | — | — |
| `payload.goldenID` | `string` | No | — | — |
| `payload.angellistID` | `string` | No | — | — |
| `payload.wellfoundID` | `string` | No | — | — |
| `payload.website` | `string` | No | — | — |
| `payload.rescrape` | `boolean` | No | — | Whether or not to automatically rescrape entities with stale data (specified by the maxDataAgeDays parameter). |
| `payload.maxDataAgeDays` | `integer` | No | — | The threshold / amount of days to consider data stale and trigger an automatic rescrape (if supplied but rescrape parameter is false, expect a bad request error). |
| `payload.preview` | `boolean` | No | — | When true, returns only minimal identification info (id, name, URLs) without charging a credit. |
| `payload.full` | `boolean` | No | — | When true, returns all relational data including funding rounds, investments, acquisitions, founders, and funds. |
| `payload.require` | `array` | No | — | List of top-level response fields that must each have a non-empty value, otherwise a 404 is returned and no credit is charged. Example: `?require=description&require=industryList`. Ignored when `preview=true`. |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Get enriched details on a company",
    "properties": {
      "id": {
        "type": "string"
      },
      "linkedinID": {
        "type": "string"
      },
      "linkedinNumID": {
        "type": "string"
      },
      "linkedinURL": {
        "type": "string",
        "description": "LinkedIn URL, accepts company URLs like linkedin.com/company/google or linkedin.com/company/1441"
      },
      "facebookID": {
        "type": "string"
      },
      "twitterID": {
        "type": "string"
      },
      "crunchbaseID": {
        "type": "string"
      },
      "pitchbookID": {
        "type": "string"
      },
      "producthuntID": {
        "type": "string"
      },
      "dealroomID": {
        "type": "string"
      },
      "goldenID": {
        "type": "string"
      },
      "angellistID": {
        "type": "string"
      },
      "wellfoundID": {
        "type": "string"
      },
      "website": {
        "type": "string"
      },
      "rescrape": {
        "type": "boolean",
        "description": "Whether or not to automatically rescrape entities with stale data (specified by the maxDataAgeDays parameter)."
      },
      "maxDataAgeDays": {
        "type": "integer",
        "description": "The threshold / amount of days to consider data stale and trigger an automatic rescrape (if supplied but rescrape parameter is false, expect a bad request error)."
      },
      "preview": {
        "type": "boolean",
        "description": "When true, returns only minimal identification info (id, name, URLs) without charging a credit."
      },
      "full": {
        "type": "boolean",
        "description": "When true, returns all relational data including funding rounds, investments, acquisitions, founders, and funds."
      },
      "require": {
        "type": "array",
        "description": "List of top-level response fields that must each have a non-empty value, otherwise a 404 is returned and no credit is charged. Example: `?require=description&require=industryList`. Ignored when `preview=true`.",
        "items": {
          "type": "string"
        }
      }
    },
    "required": [],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Extended version of Company object that includes relational data such as funding rounds, investments, acquisitions, founders, and funds. |
| `result.data.id` | `string` | Yes | — | The Aviato ID of the company |
| `result.data.name` | `string` | No | — | The name of the company |
| `result.data.description` | `string` | No | — | Description of the company |
| `result.data.country` | `string` | No | — | The country of the company (Full country name) |
| `result.data.region` | `string` | No | — | The region of the company (state/province) |
| `result.data.locality` | `string` | No | — | The locality of the company (city/town/village) |
| `result.data.URLs` | `object` | No | — | This object represents different urls that can be associated with any type of entity. (Does not include http prefix) |
| `result.data.URLs.golden` | `string` | No | — | — |
| `result.data.URLs.contact` | `string` | No | — | — |
| `result.data.URLs.twitter` | `string` | No | — | — |
| `result.data.URLs.website` | `string` | No | — | — |
| `result.data.URLs.facebook` | `string` | No | — | — |
| `result.data.URLs.github` | `string` | No | — | — |
| `result.data.URLs.linkedin` | `string` | No | — | — |
| `result.data.URLs.pitchbook` | `string` | No | — | — |
| `result.data.URLs.angelList` | `string` | No | — | — |
| `result.data.URLs.signalNFX` | `string` | No | — | — |
| `result.data.URLs.crunchbase` | `string` | No | — | — |
| `result.data.industryList` | `array` | No | — | The industries the company is associated with. |
| `result.data.weeklyFacebookChange` | `number` | No | — | The absolute change in the number of Facebook likes the company has over the past week. Format: `double`. |
| `result.data.weeklyFacebookPercent` | `number` | No | — | The percentage change in the number of Facebook likes the company has over the past week. This is the change in the number of likes divided by the number of likes at the start of the week. Format: `double`. |
| `result.data.monthlyFacebookChange` | `number` | No | — | The absolute change in the number of Facebook likes the company has over the past month. Format: `double`. |
| `result.data.monthlyFacebookPercent` | `number` | No | — | The percentage change in the number of Facebook likes the company has over the past month. This is the change in the number of likes divided by the number of likes at the start of the month. Format: `double`. |
| `result.data.triMonthlyFacebookChange` | `number` | No | — | The absolute change in the number of Facebook likes the company has over the past 3 months. Format: `double`. |
| `result.data.triMonthlyFacebookPercent` | `number` | No | — | The percentage change in the number of Facebook likes the company has over the past 3 months. This is the change in the number of likes divided by the number of likes at the start of the 3 months. Format: `double`. |
| `result.data.yearlyFacebookChange` | `number` | No | — | The absolute change in the number of Facebook likes the company has over the past year. Format: `double`. |
| `result.data.yearlyFacebookPercent` | `number` | No | — | The percentage change in the number of Facebook likes the company has over the past year. This is the change in the number of likes divided by the number of likes at the start of the year. Format: `double`. |
| `result.data.weeklyTwitterChange` | `number` | No | — | The absolute change in the number of Twitter followers the company has over the past week. Format: `double`. |
| `result.data.weeklyTwitterPercent` | `number` | No | — | The percentage change in the number of Twitter followers the company has over the past week. This is the change in the number of followers divided by the number of followers at the start of the week. Format: `double`. |
| `result.data.monthlyTwitterChange` | `number` | No | — | The absolute change in the number of Twitter followers the company has over the past month. Format: `double`. |
| `result.data.monthlyTwitterPercent` | `number` | No | — | The percentage change in the number of Twitter followers the company has over the past month. This is the change in the number of followers divided by the number of followers at the start of the month. Format: `double`. |
| `result.data.triMonthlyTwitterChange` | `number` | No | — | The absolute change in the number of Twitter followers the company has over the past 3 months. Format: `double`. |
| `result.data.triMonthlyTwitterPercent` | `number` | No | — | The percentage change in the number of Twitter followers the company has over the past 3 months. This is the change in the number of followers divided by the number of followers at the start of the 3 months. Format: `double`. |
| `result.data.yearlyTwitterChange` | `number` | No | — | The absolute change in the number of Twitter followers the company has over the past year. Format: `double`. |
| `result.data.yearlyTwitterPercent` | `number` | No | — | The percentage change in the number of Twitter followers the company has over the past year. This is the change in the number of followers divided by the number of followers at the start of the year. Format: `double`. |
| `result.data.facebookHistorical` | `record` | No | — | This object represents a historical metric. It is a map of Unix timestamps (in milliseconds) to the value of the metric at that time. |
| `result.data.twitterHistorical` | `record` | No | — | This object represents a historical metric. It is a map of Unix timestamps (in milliseconds) to the value of the metric at that time. |
| `result.data.facebookLikes` | `integer` | No | — | The current number of Facebook likes the company has. |
| `result.data.twitterFollowers` | `integer` | No | — | The current number of Twitter followers the company has. |
| `result.data.linkedinFollowers` | `integer` | No | — | The current number of LinkedIn followers the company has. |
| `result.data.monthlyWebTrafficChange` | `number` | No | — | The absolute change in the number of web visitors the company has had over the past month. Format: `double`. |
| `result.data.monthlyWebTrafficPercent` | `number` | No | — | The percentage change in the number of web visitors the company has had over the past month. This is the change in the number of visitors divided by the number of visitors at the start of the month. Format: `double`. |
| `result.data.triMonthlyWebTrafficChange` | `number` | No | — | The absolute change in the number of web visitors the company has had over the past 3 months. Format: `double`. |
| `result.data.triMonthlyWebTrafficPercent` | `number` | No | — | The percentage change in the number of web visitors the company has had over the past 3 months. This is the change in the number of visitors divided by the number of visitors at the start of the 3 months. Format: `double`. |
| `result.data.yearlyWebTrafficChange` | `number` | No | — | The absolute change in the number of web visitors the company has had over the past year. Format: `double`. |
| `result.data.yearlyWebTrafficPercent` | `number` | No | — | The percentage change in the number of web visitors the company has had over the past year. This is the change in the number of visitors divided by the number of visitors at the start of the year. Format: `double`. |
| `result.data.currentWebTraffic` | `number` | No | — | The current number of web visitors the company has. Format: `double`. |
| `result.data.webTrafficSources` | `object` | No | — | — |
| `result.data.webTrafficSources.mail` | `number` | No | — | Percentage of web traffic from email sources Format: `double`. |

The table shows the first 50 fields. Use the live contract below for every field.

> [!NOTE]
>
> This output schema is too large for an inline display. Read the complete live contract with `deepline describe aviato_company_enrich --json`.

## Deepline cost

* Pricing model: `per_result` (per result).
* Estimated Deepline credits: `0.14` per pricing unit.

## Related documentation

* [Aviato provider guide](https://deepline.com/docs/providers/aviato/guide.md)
* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


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