Skip to navigation
aVenture APICompaniesEntity Similar

Get Similar Companies by ID

View as Markdown

Returns entities similar to the entity with this entityId, most similar first. Rows include the entity and similarity provenance. Use relationshipType to filter stored relationships. Defaults to 20 rows. Follow X-Next-Cursor with the same filters and size for the next page; page is ignored with cursor. A changed ranked roster rejects continuation: restart without cursor. Custom sorting is unsupported. Any signed-in user may call this on every plan. The list is free: it never counts against the monthly record-view allowance, which charges only a separate full-detail view of one record.

Authentication

AuthorizationBearer

Your aVenture API key (https://aventure.vc/settings/api-keys) or OAuth access token

Path parameters

entityIdstringRequiredformat: "uuid"

Entity unique identifier (UUID)

Query parameters

relationshipTypestringOptional

Filter by stored relationship type, one of: acceleratorParticipant, acquirer, affinity, calculated, competingProductService, competitor, customer, fundManagerFirm, parent, productService, serviceProvider, similarCompany, spinOffFrom, successor.

typeRecordlist of stringsOptional
Optional entity typeRecord filter. Repeat to allow multiple entity types.
excludeManagerIdstringOptionalformat: "uuid"

Exclude funds managed by this entity (UUID) before pagination

permitMonogrambooleanOptional
Permit monogram fallback
pageintegerOptional>=0Defaults to 0

Zero-based page index (0..N)

sizeintegerOptional>=1Defaults to 20
The size of the page to be returned
cursorstringOptional

Opaque URL-safe cursor token from X-Next-Cursor. Reuse the same filters and sort.

Response headers

X-Next-CursorstringOptional

Continuation for the next similarity page; absent on the last page

X-RateLimit-LimitintegerOptional

Requests allowed per client IP in the current rate-limit window.

X-RateLimit-RemainingintegerOptional

Requests left before the tightest applicable rate-limit bucket rejects.

X-RateLimit-ResetintegerOptional

Seconds until the exhausted rate-limit bucket admits another request; 0 when none is exhausted.

Response

OK
contentlist of objectsOptional
emptybooleanOptional
firstbooleanOptional
lastbooleanOptional
numberintegerOptional
numberOfElementsintegerOptional
pageableobjectOptional
sizeintegerOptional
sortobjectOptional
totalElementslongOptional
totalPagesintegerOptional

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
406
Not Acceptable Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error