WSS
wss://search.linkd.inc
/
api
/
search
/
ws
/
companies
/
yc
Messages
YC Company Search Request
type:object

Request to search for YC companies

​
Search YC Companies

This endpoint provides real-time search functionality for YC companies using WebSocket. It allows you to search through YC companies with natural language queries and receive results in real-time.

​
WebSocket Connection

Connect to the WebSocket endpoint:

wss://search.linkd.inc/api/search/ws/companies/yc

​
Request Format

Send a JSON message with the following structure:

{
  "query": "AI startups in healthcare",
  "limit": 30,
  "acceptance_threshold": 85,
  "api_key": "your_api_key_here"
}

​
Parameters

ParameterTypeRequiredDescription
querystringYesThe natural language search query
limitintegerNoMaximum number of results to return (default: 30, max: 100)
acceptance_thresholdnumberNoAcceptance score threshold (0-100) for matches (default: 85)
api_keystringYesYour API key for authentication

​
Response Format

The server will respond with a JSON message containing the search results:

{
  "results": [
    {
      "id": "company_123",
      "company_id": "yc_456",
      "company_name": "Example AI Health",
      "company_website": "https://example.com",
      "linkedin_company_description": "AI-powered healthcare solutions...",
      "linkedin_industry": "Healthcare Technology",
      "linkedin_speciality": "Artificial Intelligence, Healthcare",
      "linkedin_headcount": 50,
      "criteria": {
        "industry": "Healthcare",
        "technology": "AI"
      },
      "yc_description": "YC-backed healthcare AI startup...",
      "batch": "W23",
      "status": "Active"
    }
  ],
  "total": 1,
  "query": "AI startups in healthcare"
}

​
Response Fields

FieldTypeDescription
resultsarrayList of matching YC companies
totalintegerTotal number of results returned
querystringThe original search query
errorstringError message if the search encountered an issue

​
Company Object Fields

FieldTypeDescription
idstringUnique identifier for the company
company_idstringCompany’s internal ID
company_namestringName of the company
company_websitestringCompany’s website URL
linkedin_company_descriptionstringCompany description from LinkedIn
linkedin_industrystringIndustry classification from LinkedIn
linkedin_specialitystringCompany specialties from LinkedIn
linkedin_headcountintegerCompany size from LinkedIn
criteriaobjectCompany matching criteria
yc_descriptionstringCompany description from YC
batchstringYC batch information
statusstringCompany status

​
Error Handling

The server may respond with an error message in the following format:

{
  "error": "Invalid or expired API key"
}

Common error messages:

  • “API key is required”
  • “Invalid or expired API key”
  • “Insufficient credits for X results”
  • “Maximum limit is 100 results”
  • “Limit cannot be negative”

​
Example Usage

const ws = new WebSocket('wss://search.linkd.inc/api/search/ws/companies/yc');

ws.onopen = () => {
  ws.send(JSON.stringify({
    query: "AI startups in healthcare",
    limit: 30,
    api_key: "your_api_key_here"
  }));
};

ws.onmessage = (event) => {
  const response = JSON.parse(event.data);
  console.log('Search results:', response);
};

ws.onerror = (error) => {
  console.error('WebSocket error:', error);
};

ws.onclose = () => {
  console.log('WebSocket connection closed');
};