Get similar company summaries by id

GET

https://api.aventure.vc/v1/entities/:entityId/similar/summary

GET

/v1/entities/:entityId/similar/summary

curl -G https://api.aventure.vc/v1/entities/04e2bf9c-a100-72ad-83ff-ba69c647b30b/similar/summary \
     -H "Authorization: Bearer <token>" \
     -d relationshipType=competitor \
     -d typeRecord=Company

{
  "content": [
    {
      "core": {
        "id": "string",
        "image": {
          "isMonogram": true,
          "logo": "string",
          "logoSquare": "string"
        },
        "nameAlias": [
          {
            "name": "Bun",
            "displayable": true,
            "type": "alternativeDba"
          }
        ],
        "nameBrand": "string",
        "slug": "aventure-vc",
        "defaultCurrency": "string",
        "foundedYear": 1,
        "lastModifiedAt": "2024-01-15T09:30:00Z",
        "nameLegal": "string",
        "operatingStatus": "string",
        "publicId": "eV1StGXR8Z5a",
        "publicUrl": "string",
        "sitemap": {
          "hasAnalysis": true,
          "hasEmployees": true,
          "hasFundraising": true,
          "hasNews": true,
          "productServiceSlug": [
            "string"
          ],
          "hasAcquisitions": false
        },
        "typeRecord": "Company",
        "updatedAt": "2024-01-15T09:30:00Z"
      },
      "similarity": {
        "origin": "curated",
        "rank": 1,
        "compositeScore": 1.1,
        "cosineScore": 1.1,
        "curatedAsOf": "2023-01-15",
        "curatedRelationshipType": "string",
        "curatedSource": "string",
        "derivedFromEntityId": "string",
        "matchedSectionWeight": 1.1,
        "sharedSectionCount": 1
      },
      "urlLink": [
        {
          "url": "https://example.com",
          "urlType": "website",
          "crawlCdnProvider": "cloudflare",
          "crawlRenderMode": "static",
          "createdAt": "2024-01-15T09:30:00Z",
          "id": 1,
          "isCurrent": true,
          "isPrimary": true,
          "owner": {
            "entityId": "string",
            "personId": "string"
          },
          "sourceId": "string",
          "status": "string",
          "statusChecked": "2024-01-15T09:30:00Z",
          "updatedAt": "2024-01-15T09:30:00Z"
        }
      ]
    }
  ],
  "empty": true,
  "first": true,
  "last": true,
  "number": 1,
  "numberOfElements": 1,
  "pageable": {
    "offset": 1,
    "pageNumber": 1,
    "pageSize": 1,
    "paged": true,
    "sort": {
      "empty": true,
      "sorted": true,
      "unsorted": true
    },
    "unpaged": true
  },
  "size": 1,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "totalElements": 1,
  "totalPages": 1
}

Returns the same similar entities, order, and totals as GET /v1/entities/{entityId:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}}/similar with lean rows: entity core, current URL links, and similarity provenance. Use it for rails and cards that do not render list enrichment. 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

User bearer token: an aVenture API key, an OAuth access token, or a signed-in session 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.

permitMonogrambooleanOptional

Permit monogram fallback

pageintegerOptional>=0Defaults to 0

Zero-based page index (0..N)

sizeintegerOptional>=1Defaults to 10

The size of the page to be returned

Response headers

X-RateLimit-Limitinteger

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

X-RateLimit-Remaininginteger

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

X-RateLimit-Resetinteger

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

Response

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