API Documentation

GetData vs BizSearch: Which should I use?

Practical rule: start with getdata; use bizsearch mainly for compatibility.

OpenAPI-Like Spec

openapi: 3.0.3
info:
  title: Kernel Account Sourcing API
  version: 1.0.0
servers:
  - url: https://kernel-account-sourcing.onrender.com
paths:
  /healthz:
    get:
      summary: Health probe
      responses:
        '200':
          description: Service is healthy
  /api/relevant-accounts:
    post:
      summary: Search relevant company accounts with filters
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                api: {type: string, enum: [getdata, bizsearch], default: getdata}
                businessKeywords:
                  oneOf:
                    - {type: string, description: "CSV keywords"}
                    - {type: array, items: {type: string}}
                categoryKeywords:
                  oneOf:
                    - {type: string, description: "CSV category keywords"}
                    - {type: array, items: {type: string}}
                countryCodes:
                  oneOf:
                    - {type: string, description: "CSV country codes (US,CA,GB)"}
                    - {type: array, items: {type: string}}
                cityNames: {type: string, description: "CSV city names"}
                provinceNames: {type: string, description: "CSV province/state names"}
                postCodes: {type: string, description: "CSV postal codes"}
                where: {type: string}
                who: {type: string}
                hasWebsite: {type: boolean}
                hasPhone: {type: boolean}
                hasEmail: {type: boolean}
                hasLinkedIn: {type: boolean}
                hasDigitalMarketing: {type: boolean}
                employeesTotalFrom: {type: integer, minimum: 0}
                employeesTotalTo: {type: integer, minimum: 0}
                yearStartedFrom: {type: integer, minimum: 1800, maximum: 2100}
                yearStartedTo: {type: integer, minimum: 1800, maximum: 2100}
                linkedInFollowersFrom: {type: integer, minimum: 0}
                linkedInFollowersTo: {type: integer, minimum: 0}
                language: {type: string, description: "Optional ISO 639-1 alpha-2 language code (or CSV list; first code is used for labels)"}
                pageSize: {type: integer, default: 25, minimum: 1, maximum: 200}
                maxPages: {type: integer, default: 8, minimum: 1, maximum: 50}
                maxDisplay: {type: integer, default: 250, minimum: 1, maximum: 5000}
                strictSchema: {type: boolean, default: true}
                tryAnyLocationMatch: {type: boolean, default: false}
                trackScores: {type: boolean, default: true}
                searchOverrides: {type: object, description: "Optional SearchInput overrides"}
      responses:
        '200':
          description: Relevant account search response

Common Search Options

Override Field Names

Override keys are validated against SearchInput fields. Both PascalCase and lowerCamelCase are accepted.

API Endpoints (OpenAPI-Style Reference)

All Documented Model Fields

Includes every field parsed from the API model docs.