> ## 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 Bulk Enrich: Inputs, Cost & CLI Example
> Get enriched details on multiple companies. Includes inputs, outputs, pricing notes, Deepline CLI examples, and GTM automation guidance.
## Run in Enrichment Spreadsheet
Use this function as a column step in `deepline enrich`.
```bash theme={null}
deepline enrich --input leads.csv --output leads.enriched.csv --with 'result=aviato_company_bulk_enrich:{"lookups":"{{lookups}}"}' --json
```
Map payload values to spreadsheet columns with `{{column_name}}` placeholders.
## Input Schema
| Name | Type | Required | Default | Description |
| ------------------------ | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `payload.lookups` | `array` | Yes | | List of company lookups to perform (max 100) |
| `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.require` | `array` | No | | List of top-level response fields that must each have a non-empty value on a given lookup. Lookups that don't satisfy this gate are returned with `lookupSuccessful=false` and are not billed. |
Show raw input schema
### Input JSON Schema
```json theme={null}
{
"type": "object",
"description": "Get enriched details on multiple companies",
"properties": {
"lookups": {
"type": "array",
"description": "List of company lookups to perform (max 100)",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"linkedinID": {
"type": "string"
},
"linkedinNumID": {
"type": "string"
},
"linkedinURL": {
"type": "string"
},
"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"
}
},
"additionalProperties": false
}
},
"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)."
},
"require": {
"type": "array",
"description": "List of top-level response fields that must each have a non-empty value on a given lookup. Lookups that don't satisfy this gate are returned with `lookupSuccessful=false` and are not billed.",
"items": {
"type": "string"
}
}
},
"required": [
"lookups"
],
"additionalProperties": false
}
```
## Output Schema
| Name | Type | Required | Default | Description |
| ------------- | -------- | -------- | ------- | ---------------------------------------------- |
| `result.data` | `object` | Yes | | Provider response payload. |
| `result.meta` | `object` | No | | Additional response metadata (status, paging). |
Show raw output schema
### Output JSON Schema
```json theme={null}
{
"type": "object",
"description": "Standard tool result payload.",
"properties": {
"data": {
"type": "object",
"description": "Provider response payload.",
"properties": {
"companies": {
"type": "array",
"items": {
"type": "object",
"properties": {
"lookupSuccessful": {
"type": "boolean"
},
"company": {
"type": "object",
"description": "This object represents a company. It includes general information about the company, along with social metrics, web traction metrics, and more.",
"properties": {
"id": {
"type": "string",
"description": "The Aviato ID of the company"
},
"name": {
"type": "string",
"description": "The name of the company"
},
"description": {
"type": "string",
"description": "Description of the company"
},
"country": {
"type": "string",
"description": "The country of the company (Full country name)"
},
"region": {
"type": "string",
"description": "The region of the company (state/province)"
},
"locality": {
"type": "string",
"description": "The locality of the company (city/town/village)"
},
"URLs": {
"type": "object",
"description": "This object represents different urls that can be associated with any type of entity. (Does not include http prefix)",
"properties": {
"golden": {
"type": "string"
},
"contact": {
"type": "string"
},
"twitter": {
"type": "string"
},
"website": {
"type": "string"
},
"facebook": {
"type": "string"
},
"github": {
"type": "string"
},
"linkedin": {
"type": "string"
},
"pitchbook": {
"type": "string"
},
"angelList": {
"type": "string"
},
"signalNFX": {
"type": "string"
},
"crunchbase": {
"type": "string"
}
},
"additionalProperties": false
},
"industryList": {
"type": "array",
"description": "The industries the company is associated with.",
"items": {
"type": "string"
}
},
"weeklyFacebookChange": {
"type": "number",
"description": "The absolute change in the number of Facebook likes the company has over the past week.",
"format": "double"
},
"weeklyFacebookPercent": {
"type": "number",
"description": "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"
},
"monthlyFacebookChange": {
"type": "number",
"description": "The absolute change in the number of Facebook likes the company has over the past month.",
"format": "double"
},
"monthlyFacebookPercent": {
"type": "number",
"description": "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"
},
"triMonthlyFacebookChange": {
"type": "number",
"description": "The absolute change in the number of Facebook likes the company has over the past 3 months.",
"format": "double"
},
"triMonthlyFacebookPercent": {
"type": "number",
"description": "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"
},
"yearlyFacebookChange": {
"type": "number",
"description": "The absolute change in the number of Facebook likes the company has over the past year.",
"format": "double"
},
"yearlyFacebookPercent": {
"type": "number",
"description": "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"
},
"weeklyTwitterChange": {
"type": "number",
"description": "The absolute change in the number of Twitter followers the company has over the past week.",
"format": "double"
},
"weeklyTwitterPercent": {
"type": "number",
"description": "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"
},
"monthlyTwitterChange": {
"type": "number",
"description": "The absolute change in the number of Twitter followers the company has over the past month.",
"format": "double"
},
"monthlyTwitterPercent": {
"type": "number",
"description": "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"
},
"triMonthlyTwitterChange": {
"type": "number",
"description": "The absolute change in the number of Twitter followers the company has over the past 3 months.",
"format": "double"
},
"triMonthlyTwitterPercent": {
"type": "number",
"description": "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"
},
"yearlyTwitterChange": {
"type": "number",
"description": "The absolute change in the number of Twitter followers the company has over the past year.",
"format": "double"
},
"yearlyTwitterPercent": {
"type": "number",
"description": "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"
},
"facebookHistorical": {
"type": "object",
"description": "This object represents a historical metric. It is a map of Unix timestamps (in milliseconds) to the value of the metric at that time.",
"additionalProperties": {
"type": "number",
"format": "double"
}
},
"twitterHistorical": {
"type": "object",
"description": "This object represents a historical metric. It is a map of Unix timestamps (in milliseconds) to the value of the metric at that time.",
"additionalProperties": {
"type": "number",
"format": "double"
}
},
"facebookLikes": {
"type": "integer",
"description": "The current number of Facebook likes the company has."
},
"twitterFollowers": {
"type": "integer",
"description": "The current number of Twitter followers the company has."
},
"linkedinFollowers": {
"type": "integer",
"description": "The current number of LinkedIn followers the company has."
},
"monthlyWebTrafficChange": {
"type": "number",
"description": "The absolute change in the number of web visitors the company has had over the past month.",
"format": "double"
},
"monthlyWebTrafficPercent": {
"type": "number",
"description": "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"
},
"triMonthlyWebTrafficChange": {
"type": "number",
"description": "The absolute change in the number of web visitors the company has had over the past 3 months.",
"format": "double"
},
"triMonthlyWebTrafficPercent": {
"type": "number",
"description": "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"
},
"yearlyWebTrafficChange": {
"type": "number",
"description": "The absolute change in the number of web visitors the company has had over the past year.",
"format": "double"
},
"yearlyWebTrafficPercent": {
"type": "number",
"description": "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"
},
"currentWebTraffic": {
"type": "number",
"description": "The current number of web visitors the company has.",
"format": "double"
},
"webTrafficSources": {
"type": "object",
"properties": {
"mail": {
"type": "number",
"description": "Percentage of web traffic from email sources",
"format": "double"
},
"direct": {
"type": "number",
"description": "Percentage of direct web traffic",
"format": "double"
},
"search": {
"type": "number",
"description": "Percentage of web traffic from search engines",
"format": "double"
},
"social": {
"type": "number",
"description": "Percentage of web traffic from social media",
"format": "double"
},
"referrals": {
"type": "number",
"description": "Percentage of web traffic from referrals",
"format": "double"
},
"paidReferrals": {
"type": "number",
"description": "Percentage of web traffic from paid referrals",
"format": "double"
}
},
"additionalProperties": false
},
"webTrafficHistorical": {
"type": "object",
"description": "This object represents a historical metric. It is a map of Unix timestamps (in milliseconds) to the value of the metric at that time.",
"additionalProperties": {
"type": "number",
"format": "double"
}
},
"webViewerCountries": {
"type": "array",
"description": "The countries of the web visitors the company has had.",
"items": {
"type": "object",
"properties": {
"country": {
"type": "string",
"description": "Country Web traffic is coming from"
},
"percentage": {
"type": "number",
"description": "Percentage of web traffic coming from the country. Ranges from 0 to 1.",
"format": "double"
}
},
"required": [
"country",
"percentage"
],
"additionalProperties": false
}
},
"cageCode": {
"type": "string",
"description": "The Cage Code of the company."
},
"dunsNumber": {
"type": "string",
"description": "The DUNS Number of the company."
},
"NAICSCode": {
"type": "string",
"description": "The NAICS Code of the company."
},
"CIKNumber": {
"type": "string",
"description": "The CIK Number of the company."
},
"wikidataID": {
"type": "string",
"description": "The Wikidata ID of the company."
},
"wellfoundID": {
"type": "string",
"description": "The Wellfound ID of the company."
},
"huggingFaceID": {
"type": "string",
"description": "The Hugging Face ID of the company"
},
"glassdoorID": {
"type": "string",
"description": "The Glassdoor ID of the company"
},
"legalEntityID": {
"type": "string",
"description": "The legal entity ID of the company"
},
"legalName": {
"type": "string",
"description": "The legal name of the company"
},
"alternateNames": {
"type": "array",
"description": "Alternative names for the company",
"items": {
"type": "string"
}
},
"tagline": {
"type": "string",
"description": "The company's tagline or slogan"
},
"founded": {
"type": "string",
"description": "The date the company was founded",
"format": "date-time"
},
"computed_tags": {
"type": "array",
"description": "Tags computed by Aviato's algorithms",
"items": {
"type": "string"
}
},
"headcount": {
"type": "integer",
"description": "The current number of employees at the company"
},
"computed_headcount": {
"type": "integer",
"description": "The computed headcount based on Aviato's algorithms"
},
"financingStatus": {
"type": "string",
"description": "The current financing status of the company"
},
"ownershipStatus": {
"type": "string",
"description": "The ownership status of the company (public, private, etc.)"
},
"status": {
"type": "string",
"description": "The current operational status of the company"
},
"ipoDate": {
"type": "string",
"description": "The date the company went public (IPO)",
"format": "date-time"
},
"latestDealType": {
"type": "string",
"description": "The type of the company's latest funding deal"
},
"latestDealDate": {
"type": "string",
"description": "The date of the company's latest funding deal",
"format": "date-time"
},
"latestDealAmount": {
"type": "integer",
"description": "The amount raised in the company's latest funding deal"
},
"investmentCount": {
"type": "integer",
"description": "The number of investments made by the company"
},
"investorCount": {
"type": "integer",
"description": "The number of investors that have invested in the company"
},
"leadInvestorCount": {
"type": "integer",
"description": "The number of lead investors for the company"
},
"leadInvestmentCount": {
"type": "integer",
"description": "The number of investments where the company was a lead investor"
},
"stockExchange": {
"type": "string",
"description": "The stock exchange where the company is listed"
},
"stockSymbol": {
"type": "string",
"description": "The stock symbol of the company"
},
"exitCount": {
"type": "integer",
"description": "The number of exits (acquisitions/IPOs) for the company"
},
"totalFunding": {
"type": "number",
"description": "The total amount of funding (USD) raised by the company",
"format": "double"
},
"fundingRoundCount": {
"type": "integer",
"description": "The number of funding rounds the company has raised"
},
"lastRoundValuation": {
"type": "number",
"description": "The valuation (USD) of the company's last funding round",
"format": "double"
},
"outstandingShares": {
"type": "number",
"description": "The number of outstanding shares of the company",
"format": "double"
},
"sharePrice": {
"type": "number",
"description": "The current share price (USD) of the company",
"format": "double"
},
"sharePriceHistorical": {
"type": "object",
"description": "This object represents a historical metric. It is a map of Unix timestamps (in milliseconds) to the value of the metric at that time.",
"additionalProperties": {
"type": "number",
"format": "double"
}
},
"targetMarketList": {
"type": "array",
"description": "The target markets that the company serves",
"items": {
"type": "string"
}
},
"monthlyHeadcountChange": {
"type": "number",
"description": "The absolute change in headcount over the past month",
"format": "double"
},
"monthlyHeadcountPercent": {
"type": "number",
"description": "The percentage change in headcount over the past month",
"format": "double"
},
"triMonthlyHeadcountChange": {
"type": "number",
"description": "The absolute change in headcount over the past 3 months",
"format": "double"
},
"triMonthlyHeadcountPercent": {
"type": "number",
"description": "The percentage change in headcount over the past 3 months",
"format": "double"
},
"yearlyHeadcountChange": {
"type": "number",
"description": "The absolute change in headcount over the past year",
"format": "double"
},
"yearlyHeadcountPercent": {
"type": "number",
"description": "The percentage change in headcount over the past year",
"format": "double"
},
"headcountHistorical": {
"type": "object",
"description": "This object represents a historical metric. It is a map of Unix timestamps (in milliseconds) to the value of the metric at that time.",
"additionalProperties": {
"type": "number",
"format": "double"
}
},
"producthuntFollowerCount": {
"type": "integer",
"description": "The number of followers the company has on Product Hunt"
},
"producthuntAvgRating": {
"type": "number",
"description": "The average rating of the company's products on Product Hunt",
"format": "double"
},
"producthuntTotalVotes": {
"type": "integer",
"description": "The total number of votes received on Product Hunt"
},
"productList": {
"type": "array",
"description": "List of products created by the company",
"items": {
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"description": "The date when the product was created",
"format": "date-time"
},
"imageID": {
"type": "string",
"description": "The ID of the product's image"
},
"producthuntURL": {
"type": "string",
"description": "The Product Hunt URL for this product"
},
"productName": {
"type": "string",
"description": "The name of the product"
},
"productURL": {
"type": "string",
"description": "The URL of the product"
},
"tagline": {
"type": "string",
"description": "The tagline or description of the product"
},
"votes": {
"type": "integer",
"description": "The number of votes the product received on Product Hunt"
}
},
"additionalProperties": false
}
},
"screenshotList": {
"type": "array",
"description": "List of screenshot URLs for the company's products",
"items": {
"type": "string"
}
},
"linkedinID": {
"type": "string",
"description": "The LinkedIn company ID or page name"
},
"linkedinNumID": {
"type": "string",
"description": "The numeric ID of the company on LinkedIn"
},
"businessModelList": {
"type": "array",
"description": "List of business models employed by the company",
"items": {
"type": "string"
}
},
"marketCap": {
"type": "number",
"description": "The market capitalization of the company",
"format": "double"
},
"patentCount": {
"type": "integer",
"description": "The number of patents owned by the company"
},
"equityCompensation": {
"type": "object",
"properties": {
"max": {
"type": "number",
"description": "Maximum value in the range",
"format": "double"
},
"mean": {
"type": "number",
"description": "Mean (average) value in the range",
"format": "double"
},
"min": {
"type": "number",
"description": "Minimum value in the range",
"format": "double"
},
"p10": {
"type": "number",
"description": "10th percentile value",
"format": "double"
},
"p25": {
"type": "number",
"description": "25th percentile value",
"format": "double"
},
"p50": {
"type": "number",
"description": "50th percentile (median) value",
"format": "double"
},
"p75": {
"type": "number",
"description": "75th percentile value",
"format": "double"
},
"p90": {
"type": "number",
"description": "90th percentile value",
"format": "double"
}
},
"additionalProperties": false
},
"monetaryCompensation": {
"type": "object",
"properties": {
"max": {
"type": "number",
"description": "Maximum value in the range",
"format": "double"
},
"mean": {
"type": "number",
"description": "Mean (average) value in the range",
"format": "double"
},
"min": {
"type": "number",
"description": "Minimum value in the range",
"format": "double"
},
"p10": {
"type": "number",
"description": "10th percentile value",
"format": "double"
},
"p25": {
"type": "number",
"description": "25th percentile value",
"format": "double"
},
"p50": {
"type": "number",
"description": "50th percentile (median) value",
"format": "double"
},
"p75": {
"type": "number",
"description": "75th percentile value",
"format": "double"
},
"p90": {
"type": "number",
"description": "90th percentile value",
"format": "double"
}
},
"additionalProperties": false
},
"departmentMonetaryCompensation": {
"type": "object",
"description": "Maps department names to their monetary compensation (USD) data",
"additionalProperties": {
"type": "object",
"properties": {
"max": {
"type": "number",
"description": "Maximum value in the range",
"format": "double"
},
"mean": {
"type": "number",
"description": "Mean (average) value in the range",
"format": "double"
},
"min": {
"type": "number",
"description": "Minimum value in the range",
"format": "double"
},
"p10": {
"type": "number",
"description": "10th percentile value",
"format": "double"
},
"p25": {
"type": "number",
"description": "25th percentile value",
"format": "double"
},
"p50": {
"type": "number",
"description": "50th percentile (median) value",
"format": "double"
},
"p75": {
"type": "number",
"description": "75th percentile value",
"format": "double"
},
"p90": {
"type": "number",
"description": "90th percentile value",
"format": "double"
}
},
"additionalProperties": false
}
},
"jobListingList": {
"type": "array",
"description": "List of current job openings at the company",
"items": {
"type": "object",
"properties": {
"category": {
"type": "string",
"description": "The category of the job listing"
},
"subCategory": {
"type": "string",
"description": "The sub-category of the job listing"
},
"title": {
"type": "string",
"description": "The title of the job position"
},
"isFullTime": {
"type": "boolean",
"description": "Whether the job is full-time"
},
"isRemote": {
"type": "boolean",
"description": "Whether the job allows remote work"
},
"locations": {
"type": "array",
"description": "List of locations where the job can be performed",
"items": {
"type": "string"
}
},
"mdDescription": {
"type": "string",
"description": "The job description in markdown format"
},
"slug": {
"type": "string",
"description": "The URL slug for the job listing"
},
"url": {
"type": "string",
"description": "The URL of the job listing"
}
},
"additionalProperties": false
}
},
"embeddedNews": {
"type": "array",
"description": "Recent news articles related to the company",
"items": {
"type": "object",
"description": "Represents a news article or blog post",
"properties": {
"date": {
"type": "string",
"description": "The publication date of the article"
},
"title": {
"type": "string",
"description": "The title of the article"
},
"author": {
"type": "string",
"description": "The author of the article"
},
"source": {
"type": "string",
"description": "The source publication of the article"
},
"linkUrl": {
"type": "string",
"description": "The URL link to the article"
},
"imageUrl": {
"type": "string",
"description": "The URL of the article's featured image"
}
},
"additionalProperties": false
}
},
"isAcquired": {
"type": "boolean",
"description": "Whether the company has been acquired"
},
"acquiredBy": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The unique identifier of the acquisition"
},
"announcedOn": {
"type": "string",
"description": "The date when the acquisition was announced",
"format": "date-time"
},
"acquirerName": {
"type": "string",
"description": "The name of the company doing the acquiring"
},
"acquireeName": {
"type": "string",
"description": "The name of the company being acquired"
},
"price": {
"type": "number",
"description": "The price paid for the acquisition",
"format": "double"
}
},
"required": [
"id"
],
"additionalProperties": false
},
"isGovernment": {
"type": "boolean",
"description": "Whether the company is a government entity"
},
"isNonProfit": {
"type": "boolean",
"description": "Whether the company is a non-profit organization"
},
"techStackList": {
"type": "array",
"description": "List of technologies used by the company",
"items": {
"type": "object",
"properties": {
"productName": {
"type": "string",
"description": "The name of the technology product"
},
"productCategories": {
"type": "array",
"description": "Categories that the technology product belongs to",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
}
},
"isExited": {
"type": "boolean",
"description": "Whether the company has exited (via IPO or acquisition)"
},
"isShutDown": {
"type": "boolean",
"description": "Whether the company has shut down operations"
},
"jobFamilyList": {
"type": "array",
"description": "List of job families/departments at the company",
"items": {
"type": "string"
}
},
"paySchedule": {
"type": "string",
"description": "The pay schedule used by the company (weekly, bi-weekly, monthly, etc.)"
},
"customerTypes": {
"type": "array",
"description": "Types of customers the company serves (B2B, B2C, B2G)",
"items": {
"type": "string"
}
},
"g2AverageStars": {
"type": "number",
"description": "The average star rating of the company on G2",
"format": "double"
},
"g2ReviewCount": {
"type": "integer",
"description": "The number of reviews the company has on G2"
},
"weeklyG2StarsChange": {
"type": "number",
"description": "The absolute change in G2 star rating over the past week",
"format": "double"
},
"weeklyG2StarsPercent": {
"type": "number",
"description": "The percentage change in G2 star rating over the past week",
"format": "double"
},
"monthlyG2StarsChange": {
"type": "number",
"description": "The absolute change in G2 star rating over the past month",
"format": "double"
},
"monthlyG2StarsPercent": {
"type": "number",
"description": "The percentage change in G2 star rating over the past month",
"format": "double"
},
"triMonthlyG2StarsChange": {
"type": "number",
"description": "The absolute change in G2 star rating over the past 3 months",
"format": "double"
},
"triMonthlyG2StarsPercent": {
"type": "number",
"description": "The percentage change in G2 star rating over the past 3 months",
"format": "double"
},
"yearlyG2StarsChange": {
"type": "number",
"description": "The absolute change in G2 star rating over the past year",
"format": "double"
},
"yearlyG2StarsPercent": {
"type": "number",
"description": "The percentage change in G2 star rating over the past year",
"format": "double"
},
"weeklyG2ReviewCountChange": {
"type": "number",
"description": "The absolute change in G2 review count over the past week",
"format": "double"
},
"weeklyG2ReviewCountPercent": {
"type": "number",
"description": "The percentage change in G2 review count over the past week",
"format": "double"
},
"monthlyG2ReviewCountChange": {
"type": "number",
"description": "The absolute change in G2 review count over the past month",
"format": "double"
},
"monthlyG2ReviewCountPercent": {
"type": "number",
"description": "The percentage change in G2 review count over the past month",
"format": "double"
},
"triMonthlyG2ReviewCountChange": {
"type": "number",
"description": "The absolute change in G2 review count over the past 3 months",
"format": "double"
},
"triMonthlyG2ReviewCountPercent": {
"type": "number",
"description": "The percentage change in G2 review count over the past 3 months",
"format": "double"
},
"yearlyG2ReviewCountChange": {
"type": "number",
"description": "The absolute change in G2 review count over the past year",
"format": "double"
},
"yearlyG2ReviewCountPercent": {
"type": "number",
"description": "The percentage change in G2 review count over the past year",
"format": "double"
},
"g2StarsHistorical": {
"type": "object",
"description": "This object represents a historical metric. It is a map of Unix timestamps (in milliseconds) to the value of the metric at that time.",
"additionalProperties": {
"type": "number",
"format": "double"
}
},
"g2ReviewCountHistorical": {
"type": "object",
"description": "This object represents a historical metric. It is a map of Unix timestamps (in milliseconds) to the value of the metric at that time.",
"additionalProperties": {
"type": "number",
"format": "double"
}
},
"stockPriceHistorical": {
"type": "object",
"description": "Historical stock price data for the company",
"additionalProperties": {
"type": "object",
"properties": {
"high": {
"type": "number",
"description": "The highest stock price (USD) for the period",
"format": "double"
},
"volume": {
"type": "number",
"description": "The trading volume (USD) for the period",
"format": "double"
},
"open": {
"type": "number",
"description": "The opening stock price (USD) for the period",
"format": "double"
},
"low": {
"type": "number",
"description": "The lowest stock price (USD) for the period",
"format": "double"
},
"close": {
"type": "number",
"description": "The closing stock price (USD) for the period",
"format": "double"
},
"adjclose": {
"type": "number",
"description": "The adjusted closing stock price (USD) for the period",
"format": "double"
}
},
"additionalProperties": false
}
},
"ownedPatents": {
"type": "object",
"properties": {
"documentId": {
"type": "string",
"description": "The unique document ID of the patent"
},
"documentUrl": {
"type": "string",
"description": "The URL to view the patent document"
},
"inventionTitle": {
"type": "string",
"description": "The title of the patented invention"
},
"latestFilingDate": {
"type": "string",
"description": "The latest filing date for the patent",
"format": "date-time"
},
"datePublished": {
"type": "string",
"description": "The date when the patent was published",
"format": "date-time"
}
},
"additionalProperties": false
},
"governmentAwards": {
"type": "object",
"properties": {
"awardId": {
"type": "string",
"description": "The unique identifier of the government award"
},
"awardType": {
"type": "string",
"description": "The type of government award"
},
"awardAmount": {
"type": "number",
"description": "The monetary amount (USD) of the award",
"format": "double"
},
"startDate": {
"type": "string",
"description": "The start date of the award period",
"format": "date-time"
},
"endDate": {
"type": "string",
"description": "The end date of the award period",
"format": "date-time"
},
"actionDate": {
"type": "string",
"description": "The date when action was taken on the award",
"format": "date-time"
},
"dateSigned": {
"type": "string",
"description": "The date when the award was signed",
"format": "date-time"
},
"awardingTopTierAgency": {
"type": "string",
"description": "The top-tier government agency awarding this"
},
"awardingSubTierAgency": {
"type": "string",
"description": "The sub-tier government agency awarding this"
},
"productOrServiceDescription": {
"type": "string",
"description": "Description of the product or service being awarded for"
},
"cfdaProgram": {
"type": "string",
"description": "The CFDA program associated with this award"
}
},
"additionalProperties": false
},
"locationIDList": {
"type": "array",
"description": "All Geoencoded IDs of the locations the company is associated with. These IDs are typically used to quickly and efficiently filter companies by location. Use the Geocoder Search endpoint to turn a location string into a Geocoded ID (https://docs.data.aviato.co/api-reference/geocoder/search)",
"items": {
"type": "integer"
}
},
"locationDetails": {
"type": "object",
"description": "This object represents the detailed location data of the entity. The below placetypes are the only placetypes that we support in the Who's On First gazetter. The returned IDs are valid Who's On First location ids. See [https://github.com/whosonfirst/whosonfirst-placetypes](this page) for a detailed description of the various placetypes",
"properties": {
"continent": {
"type": "object",
"description": "Represents a geographic place with its location details",
"properties": {
"id": {
"type": "integer",
"description": "The Geocoded location ID"
},
"name": {
"type": "string",
"description": "The name of the place"
},
"placeType": {
"type": "string",
"description": "The type of place (locality, region, country, etc.)"
},
"geometry": {
"type": "object",
"description": "Geographic geometry data for a location",
"properties": {
"area_square_degrees": {
"type": "number",
"description": "The area of the location in square degrees",
"format": "double"
},
"bbox": {
"type": "string",
"description": "The bounding box coordinates of the location"
},
"lat": {
"type": "number",
"description": "The latitude coordinate",
"format": "double"
},
"lon": {
"type": "number",
"description": "The longitude coordinate",
"format": "double"
}
},
"required": [
"area_square_degrees",
"bbox",
"lat",
"lon"
],
"additionalProperties": false
}
},
"required": [
"id",
"name",
"placeType",
"geometry"
],
"additionalProperties": false
},
"country": {
"type": "object",
"description": "Represents a geographic place with its location details",
"properties": {
"id": {
"type": "integer",
"description": "The Geocoded location ID"
},
"name": {
"type": "string",
"description": "The name of the place"
},
"placeType": {
"type": "string",
"description": "The type of place (locality, region, country, etc.)"
},
"geometry": {
"type": "object",
"description": "Geographic geometry data for a location",
"properties": {
"area_square_degrees": {
"type": "number",
"description": "The area of the location in square degrees",
"format": "double"
},
"bbox": {
"type": "string",
"description": "The bounding box coordinates of the location"
},
"lat": {
"type": "number",
"description": "The latitude coordinate",
"format": "double"
},
"lon": {
"type": "number",
"description": "The longitude coordinate",
"format": "double"
}
},
"required": [
"area_square_degrees",
"bbox",
"lat",
"lon"
],
"additionalProperties": false
}
},
"required": [
"id",
"name",
"placeType",
"geometry"
],
"additionalProperties": false
},
"county": {
"type": "object",
"description": "Represents a geographic place with its location details",
"properties": {
"id": {
"type": "integer",
"description": "The Geocoded location ID"
},
"name": {
"type": "string",
"description": "The name of the place"
},
"placeType": {
"type": "string",
"description": "The type of place (locality, region, country, etc.)"
},
"geometry": {
"type": "object",
"description": "Geographic geometry data for a location",
"properties": {
"area_square_degrees": {
"type": "number",
"description": "The area of the location in square degrees",
"format": "double"
},
"bbox": {
"type": "string",
"description": "The bounding box coordinates of the location"
},
"lat": {
"type": "number",
"description": "The latitude coordinate",
"format": "double"
},
"lon": {
"type": "number",
"description": "The longitude coordinate",
"format": "double"
}
},
"required": [
"area_square_degrees",
"bbox",
"lat",
"lon"
],
"additionalProperties": false
}
},
"required": [
"id",
"name",
"placeType",
"geometry"
],
"additionalProperties": false
},
"localadmin": {
"type": "object",
"description": "Represents a geographic place with its location details",
"properties": {
"id": {
"type": "integer",
"description": "The Geocoded location ID"
},
"name": {
"type": "string",
"description": "The name of the place"
},
"placeType": {
"type": "string",
"description": "The type of place (locality, region, country, etc.)"
},
"geometry": {
"type": "object",
"description": "Geographic geometry data for a location",
"properties": {
"area_square_degrees": {
"type": "number",
"description": "The area of the location in square degrees",
"format": "double"
},
"bbox": {
"type": "string",
"description": "The bounding box coordinates of the location"
},
"lat": {
"type": "number",
"description": "The latitude coordinate",
"format": "double"
},
"lon": {
"type": "number",
"description": "The longitude coordinate",
"format": "double"
}
},
"required": [
"area_square_degrees",
"bbox",
"lat",
"lon"
],
"additionalProperties": false
}
},
"required": [
"id",
"name",
"placeType",
"geometry"
],
"additionalProperties": false
},
"locality": {
"type": "object",
"description": "Represents a geographic place with its location details",
"properties": {
"id": {
"type": "integer",
"description": "The Geocoded location ID"
},
"name": {
"type": "string",
"description": "The name of the place"
},
"placeType": {
"type": "string",
"description": "The type of place (locality, region, country, etc.)"
},
"geometry": {
"type": "object",
"description": "Geographic geometry data for a location",
"properties": {
"area_square_degrees": {
"type": "number",
"description": "The area of the location in square degrees",
"format": "double"
},
"bbox": {
"type": "string",
"description": "The bounding box coordinates of the location"
},
"lat": {
"type": "number",
"description": "The latitude coordinate",
"format": "double"
},
"lon": {
"type": "number",
"description": "The longitude coordinate",
"format": "double"
}
},
"required": [
"area_square_degrees",
"bbox",
"lat",
"lon"
],
"additionalProperties": false
}
},
"required": [
"id",
"name",
"placeType",
"geometry"
],
"additionalProperties": false
},
"borough": {
"type": "object",
"description": "Represents a geographic place with its location details",
"properties": {
"id": {
"type": "integer",
"description": "The Geocoded location ID"
},
"name": {
"type": "string",
"description": "The name of the place"
},
"placeType": {
"type": "string",
"description": "The type of place (locality, region, country, etc.)"
},
"geometry": {
"type": "object",
"description": "Geographic geometry data for a location",
"properties": {
"area_square_degrees": {
"type": "number",
"description": "The area of the location in square degrees",
"format": "double"
},
"bbox": {
"type": "string",
"description": "The bounding box coordinates of the location"
},
"lat": {
"type": "number",
"description": "The latitude coordinate",
"format": "double"
},
"lon": {
"type": "number",
"description": "The longitude coordinate",
"format": "double"
}
},
"required": [
"area_square_degrees",
"bbox",
"lat",
"lon"
],
"additionalProperties": false
}
},
"required": [
"id",
"name",
"placeType",
"geometry"
],
"additionalProperties": false
},
"macroregion": {
"type": "object",
"description": "Represents a geographic place with its location details",
"properties": {
"id": {
"type": "integer",
"description": "The Geocoded location ID"
},
"name": {
"type": "string",
"description": "The name of the place"
},
"placeType": {
"type": "string",
"description": "The type of place (locality, region, country, etc.)"
},
"geometry": {
"type": "object",
"description": "Geographic geometry data for a location",
"properties": {
"area_square_degrees": {
"type": "number",
"description": "The area of the location in square degrees",
"format": "double"
},
"bbox": {
"type": "string",
"description": "The bounding box coordinates of the location"
},
"lat": {
"type": "number",
"description": "The latitude coordinate",
"format": "double"
},
"lon": {
"type": "number",
"description": "The longitude coordinate",
"format": "double"
}
},
"required": [
"area_square_degrees",
"bbox",
"lat",
"lon"
],
"additionalProperties": false
}
},
"required": [
"id",
"name",
"placeType",
"geometry"
],
"additionalProperties": false
},
"region": {
"type": "object",
"description": "Represents a geographic place with its location details",
"properties": {
"id": {
"type": "integer",
"description": "The Geocoded location ID"
},
"name": {
"type": "string",
"description": "The name of the place"
},
"placeType": {
"type": "string",
"description": "The type of place (locality, region, country, etc.)"
},
"geometry": {
"type": "object",
"description": "Geographic geometry data for a location",
"properties": {
"area_square_degrees": {
"type": "number",
"description": "The area of the location in square degrees",
"format": "double"
},
"bbox": {
"type": "string",
"description": "The bounding box coordinates of the location"
},
"lat": {
"type": "number",
"description": "The latitude coordinate",
"format": "double"
},
"lon": {
"type": "number",
"description": "The longitude coordinate",
"format": "double"
}
},
"required": [
"area_square_degrees",
"bbox",
"lat",
"lon"
],
"additionalProperties": false
}
},
"required": [
"id",
"name",
"placeType",
"geometry"
],
"additionalProperties": false
},
"macrohood": {
"type": "object",
"description": "Represents a geographic place with its location details",
"properties": {
"id": {
"type": "integer",
"description": "The Geocoded location ID"
},
"name": {
"type": "string",
"description": "The name of the place"
},
"placeType": {
"type": "string",
"description": "The type of place (locality, region, country, etc.)"
},
"geometry": {
"type": "object",
"description": "Geographic geometry data for a location",
"properties": {
"area_square_degrees": {
"type": "number",
"description": "The area of the location in square degrees",
"format": "double"
},
"bbox": {
"type": "string",
"description": "The bounding box coordinates of the location"
},
"lat": {
"type": "number",
"description": "The latitude coordinate",
"format": "double"
},
"lon": {
"type": "number",
"description": "The longitude coordinate",
"format": "double"
}
},
"required": [
"area_square_degrees",
"bbox",
"lat",
"lon"
],
"additionalProperties": false
}
},
"required": [
"id",
"name",
"placeType",
"geometry"
],
"additionalProperties": false
},
"neighbourhood": {
"type": "object",
"description": "Represents a geographic place with its location details",
"properties": {
"id": {
"type": "integer",
"description": "The Geocoded location ID"
},
"name": {
"type": "string",
"description": "The name of the place"
},
"placeType": {
"type": "string",
"description": "The type of place (locality, region, country, etc.)"
},
"geometry": {
"type": "object",
"description": "Geographic geometry data for a location",
"properties": {
"area_square_degrees": {
"type": "number",
"description": "The area of the location in square degrees",
"format": "double"
},
"bbox": {
"type": "string",
"description": "The bounding box coordinates of the location"
},
"lat": {
"type": "number",
"description": "The latitude coordinate",
"format": "double"
},
"lon": {
"type": "number",
"description": "The longitude coordinate",
"format": "double"
}
},
"required": [
"area_square_degrees",
"bbox",
"lat",
"lon"
],
"additionalProperties": false
}
},
"required": [
"id",
"name",
"placeType",
"geometry"
],
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"required": [
"id",
"alternateNames",
"targetMarketList",
"screenshotList",
"businessModelList",
"jobListingList",
"techStackList",
"jobFamilyList",
"customerTypes"
],
"additionalProperties": false
}
},
"required": [
"lookupSuccessful"
],
"additionalProperties": false
}
}
},
"required": [
"companies"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"description": "Additional response metadata (status, paging).",
"additionalProperties": true
}
},
"required": [
"data"
],
"additionalProperties": false
}
```
## Advanced: Direct CLI
Use direct execution for single payload debugging.
```bash theme={null}
deepline tools execute aviato_company_bulk_enrich --payload '{
"lookups": "array"
}' --json
```
### CLI flags
| Flag | Description |
| --------------------------- | --------------------------------------------------- |
| `--json` | Print machine-readable output. |
| `--wait` | Wait for terminal provider status when supported. |
| `--debug` | Enable wait mode with additional status/log output. |
| `--wait-timeout SECONDS` | Max seconds to wait in wait mode. |
| `--poll-interval SECONDS` | Polling interval in seconds during wait mode. |
| `--timeout SECONDS` | Request timeout in seconds. |
| `--connect-timeout SECONDS` | Connection timeout in seconds. |
## Cost
* Pricing model: `per_result` (per result).
* Estimated Deepline credits: `0.14` per pricing unit.
* Billing mode: `post_deduct`.