--- title: "Business Search" method: POST path: "/business-search" --- # Business Search `POST /business-search` ## Request - Base URL: `https://api.octen.ai` - URL: `https://api.octen.ai/business-search` - Auth: one of: - HTTP bearer - API key in header `x-api-key` Searches the web for business content. The companies and people behind the query are also returned as entity cards. ## Request body - BusinessSearchRequest - `query` string, required: The search query. **Operators** - `site:`: restrict results to a single domain. For multiple domains, use `include_domains` and `exclude_domains`. - `-site:`: exclude a single domain from the results. - `count` integer: Number of results to return. - `include_domains` string[]: A list of domains to specifically include in the search results. The `site:` query operator adds to this list. Applies to `results` only; entity cards do not support domain filtering. - `exclude_domains` string[]: A list of domains to specifically exclude from the search results. The `-site:` query operator adds to this list. If a domain appears in both `include_domains` and `exclude_domains`, `exclude_domains` takes precedence. Applies to `results` only; entity cards do not support domain filtering. - `time_basis` 'auto' | 'published' | 'crawled': Determines which time field is used for time filtering. `published` uses time_published; `crawled` uses time_last_crawled. Results missing this field are excluded when filtering by time. Applies to `results` only; entity cards do not support time filtering. - `time_range` 'day' | 'week' | 'month' | 'year' | 'd' | 'w' | 'm' | 'y': Relative time window counting back from the current time based on `time_basis`. Mutually exclusive with `start_time`/`end_time`: if both are provided, `start_time`/`end_time` take precedence. - `start_time` string, date-time: Start time for filtering results. ISO 8601 format. - `end_time` string, date-time: End time for filtering results. ISO 8601 format. - `language` string[]: A list of languages to restrict results to, as ISO 639-1 codes. Applies to `results` only; entity cards do not support language filtering. - `highlight` HighlightOptions: Controls highlight extraction from result pages. - `enable` boolean: If true, returns query-relevant highlight in each result. - `max_tokens` integer: Max tokens returned per highlight. - `full_content` FullContentOptions: Controls whether to return the full raw content of each result page. - `enable` boolean: If true, returns full_content for each result. - `max_tokens` integer: Maximum tokens of full content included per result. - `entities` BusinessEntityOptions: Controls the entity cards returned for companies and people. - `enable` boolean: If true, returns data.entities. - `count` integer: Maximum number of entity cards to return. - `max_activities` integer: Maximum number of recent activities to return per entity card. - `max_news` integer: Maximum number of related news items to return per entity card. ## Response `200` Successful business search response - BusinessSearchResponse - `code` integer: Business status code. 0 indicates success. - `msg` string: A message describing the result. - `request_id` string: The unique identifier for this request. - `data` BusinessSearchData: The main response payload. Fields without data are omitted, at every level. - `query` string: The original query. - `results` BusinessSearchResult[]: A list of business results. - `title` string: The title of the page. - `url` string: The URL of the page. - `highlight` string: Query-relevant highlight snippets. Returned only if highlight.enable is true. - `full_content` string: Full raw page content. Returned only if full_content.enable is true. - `authors` string: Website name or author. - `time_published` string, date-time: Publish time in ISO 8601. - `time_last_crawled` string, date-time: Last crawl time in ISO 8601. - `favicon` string: The favicon URL of the source site. - `cover_image` BusinessImage: An image attached to a page. - `url` string: The image URL. - `description` string: Text description of the image. Can be empty. - `images` BusinessImage[]: In-body images of the page, in order of appearance. - `url` string: The image URL. - `description` string: Text description of the image. Can be empty. - `entities` BusinessEntity[]: A list of entity cards for the companies and people in the query. Returned only when entities.enable is true and the query matches at least one entity. - union - BusinessCompanyEntity - `type` 'company', required: The kind of entity this card describes. Always `company`. - `name` string: The company name. - `summary` string: A profile of the company. - `aliases` string[]: Other names and spellings for the company. - `identifiers` BusinessEntityIdentifiers: Identifiers for the company. - `website` string: The official website. - `linkedin_url` string: LinkedIn company page URL. - `stock_ticker` string: Stock ticker. - `sec_cik` string: SEC Central Index Key. - `attributes` BusinessEntityAttributes: Basic attributes of the company. - `industry` string: The industry the company operates in. - `hq_location` string: Headquarters location. - `founded_year` integer: The year the company was founded. - `employee_range` string: Employee count, as a range. - `metrics` BusinessEntityMetrics: Quantitative metrics for the company. - `financials` BusinessFinancials[]: Financial results by reporting period. - … - `stock` BusinessStock: Live stock data from Octen. Returned for listed companies. - … - `funding` BusinessFunding[]: Funding rounds. - … - `web_traffic` BusinessWebTraffic: Web traffic for the company's website. - … - `key_people` BusinessKeyPerson[]: Key people at the company. - `name` string: The person's name. - `title` string: The person's title. - `logo` object: The company logo. - `url` string: The logo image URL. - `activities` BusinessSearchResult[]: Recent activity from the company's own channels. - `title` string: The title of the page. - `url` string: The URL of the page. - `highlight` string: Query-relevant highlight snippets. Returned only if highlight.enable is true. - `full_content` string: Full raw page content. Returned only if full_content.enable is true. - `authors` string: Website name or author. - `time_published` string, date-time: Publish time in ISO 8601. - `time_last_crawled` string, date-time: Last crawl time in ISO 8601. - `favicon` string: The favicon URL of the source site. - `cover_image` BusinessImage: An image attached to a page. - … - `images` BusinessImage[]: In-body images of the page, in order of appearance. - … - `news` BusinessNewsItem[]: Recent news about the company from third-party outlets. - `title` string: The title of the page. - `url` string: The URL of the page. - `highlight` string: Query-relevant highlight snippets. Returned only if highlight.enable is true. - `full_content` string: Full raw page content. Returned only if full_content.enable is true. - `time_published` string, date-time: Publish time in ISO 8601. - `time_last_crawled` string, date-time: Last crawl time in ISO 8601. - `favicon` string: The favicon URL of the source site. - `cover_image` BusinessImage: An image attached to a page. - … - `images` BusinessImage[]: In-body images of the page, in order of appearance. - … - BusinessPersonEntity - `type` 'person', required: The kind of entity this card describes. Always `person`. - `name` string: The person's name. - `summary` string: A profile of the person. - `linkedin_url` string: LinkedIn profile URL. - `current_position` string: Current role and organization. - `career` BusinessCareerEntry[]: Career history. - `organization` string: The organization. - `title` string: The role held. - `start` string: When the role started, as a year or a year and month. - `end` string: When the role ended, as a year or a year and month. Omitted while the role is current. - `photo` object: A photo of the person. - `url` string: The photo URL. - `activities` BusinessSearchResult[]: Recent activity from the person's own channels. - `title` string: The title of the page. - `url` string: The URL of the page. - `highlight` string: Query-relevant highlight snippets. Returned only if highlight.enable is true. - `full_content` string: Full raw page content. Returned only if full_content.enable is true. - `authors` string: Website name or author. - `time_published` string, date-time: Publish time in ISO 8601. - `time_last_crawled` string, date-time: Last crawl time in ISO 8601. - `favicon` string: The favicon URL of the source site. - `cover_image` BusinessImage: An image attached to a page. - … - `images` BusinessImage[]: In-body images of the page, in order of appearance. - … - `news` BusinessNewsItem[]: Recent news about the person from third-party outlets. - `title` string: The title of the page. - `url` string: The URL of the page. - `highlight` string: Query-relevant highlight snippets. Returned only if highlight.enable is true. - `full_content` string: Full raw page content. Returned only if full_content.enable is true. - `time_published` string, date-time: Publish time in ISO 8601. - `time_last_crawled` string, date-time: Last crawl time in ISO 8601. - `favicon` string: The favicon URL of the source site. - `cover_image` BusinessImage: An image attached to a page. - … - `images` BusinessImage[]: In-body images of the page, in order of appearance. - … - `meta` BusinessSearchMeta: Additional metadata for the search request. - `usage` BusinessSearchUsage: Usage information for the search request. - `num_search_queries` integer: Number of text search queries executed. - `full_content_extra_count` integer: Billable full_content results beyond the free allowance. - `latency` number: Response time in milliseconds. - `warning` string: Warning message, if any. ## Other responses - `400`: Invalid or missing parameter. - `401`: Invalid API Key — Returned when the API key is missing or invalid. - `403`: Insufficient balance in account — Returned when the account balance is insufficient to complete the request. - `429`: Exceeding the rate limit — Returned when the request exceeds the configured rate limit. - `500`: Internal error — Returned when an unexpected server-side error occurs. --- [API](https://skmtc.dev/octen/apis/octen-api.md) - [All operations](https://skmtc.dev/octen/apis/octen-api/llms.txt) - [OpenAPI document](https://skmtc.dev/octen/apis/octen-api/revisions/aaa6caaf46b0?raw)