{
  "openapi": "3.1.0",
  "info": {
    "title": "Who's Hiring? API",
    "version": "1.0.0",
    "description": "Free, keyless API to search and rank Y Combinator startups that are hiring right now against keywords or a resume. Not affiliated with Y Combinator.",
    "contact": {
      "url": "https://x.com/staskulesh"
    }
  },
  "servers": [
    {
      "url": "https://ycme.dev"
    }
  ],
  "paths": {
    "/api/v1/search": {
      "get": {
        "operationId": "searchStartups",
        "summary": "Rank hiring YC startups by keywords or a short bio",
        "parameters": [
          {
            "name": "q",
            "in": "query",
            "required": true,
            "description": "Keywords, stack, domain or short bio",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "location",
            "in": "query",
            "required": false,
            "description": "Comma-separated places or 'remote' (preference)",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "size",
            "in": "query",
            "required": false,
            "description": "1-50, 51-500, 500+",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "description": "1-50",
            "schema": {
              "type": "integer",
              "default": 10,
              "minimum": 1,
              "maximum": 50
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Ranked companies",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "source": {
                      "type": "string"
                    },
                    "total_ranked": {
                      "type": "integer"
                    },
                    "results": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/Company"
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/v1/match": {
      "post": {
        "operationId": "matchResume",
        "summary": "Rank hiring YC startups against a full resume; top 10 checked by the Jev decision model",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "resume"
                ],
                "properties": {
                  "resume": {
                    "type": "string"
                  },
                  "location": {
                    "type": "string"
                  },
                  "role": {
                    "type": "string",
                    "description": "engineering, design, product, sales, marketing or operations. Tells the AI fit check which kind of job to judge; does not filter companies."
                  },
                  "size": {
                    "type": "string"
                  },
                  "limit": {
                    "type": "integer",
                    "minimum": 1,
                    "maximum": 20,
                    "default": 10
                  },
                  "rerank": {
                    "type": "boolean",
                    "default": true
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Ranked companies",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "source": {
                      "type": "string"
                    },
                    "total_ranked": {
                      "type": "integer"
                    },
                    "results": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/Company"
                      }
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "Rate limit: 10 calls a minute per IP"
          }
        },
        "description": "Limited to 10 calls a minute per IP."
      }
    },
    "/api/v1/companies/{slug}": {
      "get": {
        "operationId": "getCompany",
        "summary": "One company by slug",
        "parameters": [
          {
            "name": "slug",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Company",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Company"
                }
              }
            }
          }
        }
      }
    },
    "/api/v1/companies": {
      "get": {
        "operationId": "listCompanies",
        "summary": "All hiring companies, paged",
        "responses": {
          "200": {
            "description": "List",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "source": {
                      "type": "string"
                    },
                    "results": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/Company"
                      }
                    },
                    "total": {
                      "type": "integer"
                    },
                    "offset": {
                      "type": "integer"
                    },
                    "next_offset": {
                      "type": [
                        "integer",
                        "null"
                      ],
                      "description": "Pass as offset for the next page; null on the last page."
                    }
                  }
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "limit",
            "in": "query",
            "schema": {
              "type": "integer",
              "minimum": 1,
              "maximum": 2000,
              "default": 2000
            }
          },
          {
            "name": "offset",
            "in": "query",
            "schema": {
              "type": "integer",
              "minimum": 0,
              "default": 0
            }
          }
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "Company": {
        "type": "object",
        "properties": {
          "rank": {
            "type": "integer"
          },
          "slug": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "one_liner": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "location": {
            "type": "string"
          },
          "team_size": {
            "type": "string"
          },
          "batch": {
            "type": "string"
          },
          "score": {
            "type": "integer"
          },
          "fit": {
            "type": "string"
          },
          "tags": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "matched_terms": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "links": {
            "type": "object",
            "properties": {
              "yc_profile": {
                "type": "string"
              },
              "apply": {
                "type": "string"
              },
              "website": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}