> ## 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.
# Get company competitors
> Returns the competitive landscape for a company, a ranked list of competitors, the dimensions the market splits on, and a short summary of the competitive landscape.
This endpoint uses 1 credit per request.
## Behaviour
- `companyId` (the Specter company ID) is required in the path.
- Cache-first: a company that's already been analysed returns instantly; one that's never been analysed (or a request with `refresh: true`) computes the full landscape on demand and is slower.
- Results older than 30 days are recomputed automatically, so the landscape is never more than 30 days stale. `last_updated` reports when it was last computed.
- At most 30 competitors are returned; `limit` (1–30) only narrows that set — it can't raise the ceiling above 30.
- The request body is optional — omit it to use the defaults (`limit` 30, `refresh` false).
- Returns `404` if the company doesn't exist.
## OpenAPI
````yaml /api-ref/bundle_api.yaml post /companies/{companyId}/competitors
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/{companyId}/competitors:
post:
tags:
- Companies
summary: Get company competitors
description: >
Returns the competitive landscape for a company, a ranked list of
competitors, the dimensions the market splits on, and a short summary of
the competitive landscape.
This endpoint uses 1 credit per request.
## Behaviour
- `companyId` (the Specter company ID) is required in the path.
- Cache-first: a company that's already been analysed returns instantly;
one that's never been analysed (or a request with `refresh: true`)
computes the full landscape on demand and is slower.
- Results older than 30 days are recomputed automatically, so the
landscape is never more than 30 days stale. `last_updated` reports when
it was last computed.
- At most 30 competitors are returned; `limit` (1–30) only narrows that
set — it can't raise the ceiling above 30.
- The request body is optional — omit it to use the defaults (`limit`
30, `refresh` false).
- Returns `404` if the company doesn't exist.
parameters:
- $ref: '#/components/parameters/CompanyId'
requestBody:
required: false
content:
application/json:
schema:
type: object
additionalProperties: false
properties:
limit:
type: integer
default: 30
minimum: 1
maximum: 30
description: >
Maximum number of competitors to return. 30 is also the hard
ceiling — the endpoint never returns more than 30.
refresh:
type: boolean
default: false
description: >
Recompute the competitive landscape from scratch instead of
serving the cached result. Use when you want the freshest
analysis; expect a slower response.
example:
limit: 10
refresh: false
responses:
'200':
description: >
The company's competitive landscape, ranked competitors, the
dimensions the market splits on, and a summary of the competitive
landscape.
content:
application/json:
schema:
type: object
properties:
competitors:
type: array
description: >-
Competitors ranked by how directly they compete (closest
first).
items:
type: object
properties:
company_id:
type: string
nullable: true
description: >
The competitor's Specter company ID, when it is in
our data set; `null` otherwise.
example: 5e3a8f19040ca7b0c6f031f8
name:
type: string
example: Adyen
domain:
type: string
example: adyen.com
competitiveness_score:
type: number
nullable: true
description: >
How directly the competitor competes with the
company, from 0 to 1 (higher means a closer rival).
example: 0.95
dimensions:
type: array
description: The dimension labels this competitor matches.
items:
type: string
example: Omnichannel Payments
focus:
type: string
nullable: true
description: >-
A terse description of what the competitor is best
at.
example: Unified global payment and fraud platform.
dimensions:
type: array
description: The dimensions the market splits on for this company.
items:
type: object
properties:
code:
type: string
description: Stable identifier for the dimension.
example: omnichannel_payments
label:
type: string
description: Human-readable dimension name.
example: Omnichannel Payments
description:
type: string
description: What this dimension captures.
example: Unified in-store and online payment acceptance.
summary_headline:
type: string
nullable: true
description: A one-line headline summarising the competitive set.
example: A crowded payments market led by full-stack platforms.
summary_body:
type: string
nullable: true
description: A short summary of the competitive landscape.
last_updated:
type: string
format: date-time
nullable: true
description: >
ISO 8601 timestamp of when this landscape was last
computed. Results older than 30 days are recomputed
automatically, so this is never more than 30 days in the
past.
example: '2026-06-01T00:00:00Z'
'401':
$ref: '#/components/responses/Unauthorized'
'402':
$ref: '#/components/responses/OutOfCredits'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'429':
$ref: '#/components/responses/RateLimits'
components:
parameters:
CompanyId:
in: path
name: companyId
schema:
type: string
required: true
description: The Specter company ID.
responses:
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
NotFound:
description: Not Found
content:
application/json:
schema:
type: object
required:
- errorCode
- message
properties:
errorCode:
type: string
description: NOT_FOUND
message:
type: string
description: Not Found
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:
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
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: X-API-Key
````