> ## Documentation Index
> Fetch the complete documentation index at: https://api.tryspecter.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Search company name
> Search Specter companies with a `query` term — typically a company name. Returns lightweight matches; fetch the full record for any result with [Get company by ID](/api-reference/companies/get-company-by-id).
Costs 1 credit per request, regardless of how many match.
## Behaviour
- `query` is required.
- Returns at most 10 results per query.
- Results are ordered by match strength; no matches returns an empty list.
- Each result carries a `match_confidence` from 0 to 1; only matches scoring at least 0.5 are returned.
- Results are lightweight — ID, name, domain, HQ, tagline, founded year, and match confidence.
## OpenAPI
````yaml /api-ref/bundle_api.yaml get /companies/search
openapi: 3.0.0
info:
title: Specter API
termsOfService: https://tryspecter.com/terms/
contact:
name: API support
email: api-support@tryspecter.com
version: 1.0.0
servers:
- description: Production
url: https://app.tryspecter.com/api/v1
security:
- ApiKeyAuth: []
tags:
- name: Enrichment
description: >
Endpoints which can be used to query for data and, if the data is not
found request that it be retrieved by Specter systems.
- name: Companies
description: >
Endpoints that provide the most up to date information about all the
companies in our data set. Giving the ability to query by a specific
company id, or using a keyword such as the domain.
This also allows us to enrich the data about a company if we either do not
have it or it is older than expected, which means you always have the most
up-to-date information possible.
- name: People
description: >
Endpoints that expose Specter people records — profile data and contact
details — for a known person ID.
- name: Investors
description: >
Endpoints that expose Specter investor records — profile, activity,
targeting, funds, portfolio companies, and the funding rounds they have
participated in — for a known investor ID.
- name: Talent and Interest Signals
description: >
Endpoints for retrieving Specter Talent Signals and Investor Interest
Signals by ID.
- name: News Signals
description: >
Company-level news signals generated from articles monitored by Specter.
Each signal represents a single classified company mention within an
article and includes a summary of the newsworthy update (such as funding,
deals, revenue, profitability, or traction) along with an assigned
importance score.
- name: Revenue Signals
description: >
Revenue and profitability observations for companies, derived from news
coverage and public filings. Each signal captures one data point — the
revenue or profitability metric, the year it refers to, the source, and
the company it is attributed to.
- name: Transactions
description: >
Endpoints that expose transaction detail — funding rounds, acquisitions,
and IPOs — by ID.
- name: Company Lists
description: >
Create, query and maintain lists of companies that are of particular
interest. The endpoints here allow you to interrogate and maintain those
lists using a programmatic interface.
- name: People Lists
description: >
Create, query and maintain lists of people that are of particular
interest. The endpoints here allow you to interrogate and maintain those
lists using a programmatic interface.
- name: Investor Lists
description: >
Create, query and maintain lists of investors that are of particular
interest. The endpoints here allow you to interrogate and maintain those
lists using a programmatic interface.
- name: Network
description: >
Endpoints for accessing your team's LinkedIn network - the people and
companies your teammates are connected to.
- name: Saved Searches
description: >
Manage searches that have been saved via `tryspecter.com`. These endpoints
are useful to programmatically list and delete saved searches. To update a
search the UI should be used at `tryspecter.com`.
- name: Company Saved Searches
description: >
Query and get results for company searches that have been saved via
`tryspecter.com`. These endpoints are useful to programmatically get
results and information for a search. To update a search the UI should be
used at `tryspecter.com`.
- name: People Saved Searches
description: >
Query and get results for people searches that have been saved via
`tryspecter.com` or via the API. These endpoints are useful to
programmatically get results and information for a search. To update a
search the UI should be used at `tryspecter.com`.
- name: Investor Saved Searches
description: >
Query and inspect saved investor searches — metadata (name, match counts)
and paginated results — from searches saved via `tryspecter.com` or shared
with the API.
- name: Talent Signals Saved Searches
description: >
Query and get results for Talent Signals searches that have been saved via
`tryspecter.com`.
- name: Investor Interest Saved Searches
description: >
Query and get results for Investor Interest Signals searches that have
been saved via `tryspecter.com`.
- name: Organization
description: >
Endpoints for accessing your organization's members and org-level
resources.
- name: Customer Data
description: >
Retrieve a log of API calls made by your organization. Useful for auditing
usage, debugging integrations, and monitoring activity.
paths:
/companies/search:
get:
tags:
- Companies
summary: Search company name
description: >
Search Specter companies with a `query` term — typically a company name.
Returns lightweight matches; fetch the full record for any result with
[Get company by ID](/api-reference/companies/get-company-by-id).
Costs 1 credit per request, regardless of how many match.
## Behaviour
- `query` is required.
- Returns at most 10 results per query.
- Results are ordered by match strength; no matches returns an empty
list.
- Each result carries a `match_confidence` from 0 to 1; only matches
scoring at least 0.5 are returned.
- Results are lightweight — ID, name, domain, HQ, tagline, founded year,
and match confidence.
parameters:
- in: query
name: query
schema:
type: string
required: true
allowEmptyValue: false
description: The search query — typically a company name.
responses:
'200':
$ref: '#/components/responses/ListOfBasicCompaniesResponse'
'400':
description: Bad request — the `query` parameter is missing or invalid.
content:
application/json:
schema:
type: object
properties:
errorCode:
type: string
example: VALIDATION_ERROR
message:
type: string
example: Field required (query.query)
'401':
$ref: '#/components/responses/Unauthorized'
'402':
$ref: '#/components/responses/OutOfCredits'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/RateLimits'
components:
responses:
ListOfBasicCompaniesResponse:
description: The list of basic company information
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/BasicCompany'
Unauthorized:
description: Unauthorized
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/ApiKeyMissing'
- $ref: '#/components/schemas/ApiKeyNotValid'
OutOfCredits:
description: Out of credits - API credit limit exceeded
content:
application/json:
schema:
type: object
required:
- errorCode
- message
properties:
errorCode:
type: string
enum:
- OUT_OF_CREDITS
message:
type: string
description: |
There are no more credits available to complete the request.
headers:
X-CreditLimit-Limit:
schema:
type: integer
description: The total number of credits allocated for the current period
X-CreditLimit-Remaining:
schema:
type: integer
description: The number of credits remaining for the current period
X-CreditLimit-Reset:
schema:
type: number
format: float
description: The number of seconds until the credit limit resets
Forbidden:
description: Forbidden - There is no permissions to use the endpoint
content:
application/json:
schema:
type: object
properties:
errorCode:
description: NOT_PERMITTED
type: string
example: NOT_PERMITTED
message:
type: string
description: You do not have permission to access this resource.
example: You do not have permission to access this resource.
required:
- errorCode
- message
RateLimits:
description: Too Many Requests - API Rate limit exceeded
content:
application/json:
schema:
type: object
required:
- errorCode
- message
properties:
errorCode:
type: string
description: RATE_LIMITED
message:
type: string
description: You have been rate-limited
headers:
X-RateLimit-Limit:
schema:
type: integer
description: The total rate limit allowed for this endpoint
X-RateLimit-Remaining:
schema:
type: integer
description: The number of requests remaining
X-RateLimit-Reset:
schema:
type: number
format: float
description: The number of seconds until the rate limit resets
schemas:
BasicCompany:
type: object
properties:
id:
description: The Specter company ID; use it with the other company endpoints.
type: string
example: 5e3a8f19040ca7b0c6f03082
name:
description: The company's main public name.
type: string
example: Rippling
domain:
description: The domain of the website, can have a sub-domain.
type: string
example: rippling.com
hq:
$ref: '#/components/schemas/HQ'
description: The company's HQ location.
tagline:
description: A concise description of what the company does.
type: string
example: Workforce management that unifies HR, IT, and finance.
founded_year:
description: The year the company was founded.
type: number
nullable: true
example: 2016
match_confidence:
description: >
How closely the company matches the query, from 0 to 1. Relative to
the other results in this response; not comparable across searches.
type: number
example: 0.8
required:
- id
- name
- hq
- match_confidence
additionalProperties: false
ApiKeyMissing:
properties:
errorCode:
description: API_KEY_MISSING
example: API_KEY_MISSING
type: string
message:
description: No API Key was presented on the header X-API-KEY
example: No API Key was presented on the header X-API-KEY
type: string
ApiKeyNotValid:
properties:
errorCode:
description: API_KEY_NOT_VALID
example: API_KEY_NOT_VALID
type: string
message:
description: API key present, but not valid
example: API key present, but not valid
type: string
HQ:
properties:
city:
description: City for the location.
type: string
example: London
state:
description: >-
State for the location, outside of America will relate to the
country and region.
type: string
example: England
country:
description: Country for the location.
type: string
example: United Kingdom
region:
description: Use `continent` instead.
type: string
example: Europe
deprecated: true
continent:
description: The continent the HQ is in.
type: string
example: Europe
regions:
description: Any regions that the HQ is in.
type: array
items:
type: string
example:
- London Metropolitan Area
- EMEA
required:
- city
- state
- country
- region
additionalProperties: false
title: HQ
type: object
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: X-API-Key
````