Quick Start

Getting Started: Your First Kruncher API Request

Start using the Kruncher.ai API in 5 minutes. This guide walks you through retrieving your first project.

1. Get Your API Key

Log in to kruncher.ai
Ensure your account has owner or admin permissions
Navigate to Settings → API Integration
Click Generate API Key or copy your existing key

⚠️ Note: If you don’t see the API Integration tab in Settings, your account does not have owner/admin permissions. Contact your account owner to generate an API key or grant you the necessary permissions.

2. Make Your First Call

Pick your language below and copy the code. Replace YOUR_API_KEY_HERE with your actual API key.

JavaScript

CODE

const apiKey = "YOUR_API_KEY_HERE";
 
fetch("https://api.kruncher.ai/api/integration/projects?page=0&pageSize=20", {
  headers: {
    "Authorization": `${apiKey}`
  }
})
  .then(res => res.json())
  .then(data => console.log(data))
  .catch(error => console.error("Error:", error));

Python

CODE

import requests
 
api_key = "YOUR_API_KEY_HERE"
 
response = requests.get(
    "https://api.kruncher.ai/api/integration/projects?page=0&pageSize=20",
    headers={"Authorization": f"{api_key}"}
)
 
print(response.json())

cURL

CODE

curl -X GET "https://api.kruncher.ai/api/integration/projects?page=0&pageSize=20" \
  -H "Authorization: YOUR_API_KEY_HERE"

Go

CODE

package main
 
import (
    "fmt"
    "io"
    "net/http"
)
 
func main() {
    req, _ := http.NewRequest("GET", "https://api.kruncher.ai/api/integration/projects?page=0&pageSize=20", nil)
    req.Header.Add("Authorization", "YOUR_API_KEY_HERE")
 
    resp, _ := http.DefaultClient.Do(req)
    body, _ := io.ReadAll(resp.Body)
    fmt.Println(string(body))
}

Ruby

CODE

require 'net/http'
require 'json'
 
uri = URI("https://api.kruncher.ai/api/company/list")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
 
request = Net::HTTP::Get.new(uri.path)
request["Authorization"] = "YOUR_API_KEY_HERE"
 
response = http.request(request)
puts JSON.parse(response.body)

3. See the Result

A successful call returns your projects along with pagination info. Here’s what the response looks like:

CODE

{
  "metadata": {
    "code": "1000",
    "title": "Successful",
    "description": ""
  },
  "data": [
    {
      "id": "521a93a6-091d-4943-ba13-7c1a654a14ae",
      "name": "Acme",
      "companyName": "Acme Corporation",
      "companyWebsite": "https://acme.com",
      "companyIndustry": ["Software", "SaaS"],
      "companyStage": "seriesA",
      "processing": "completed",
      "analyses": [
        {
          "id": "analysis_xyz789",
          "type": "company",
          "status": "completed",
          "createdAt": "2024-01-15T10:30:00Z"
        }
      ],
      "projectScores": [
        {
          "score": 8.5,
          "scoreText": "Strong Fit"
        }
      ]
    }
  ],
  "pagination": {
    "page": 0,
    "totalCount": 42,
    "pageSize": 20,
    "nextPage": true
  }
}

For the full list of response fields, see Find Companies.

4. Let’s see it in action!

You should see a list of your projects. Now explore:

Or check out Postman Collection to test interactively.

Need Help?

Email: info@kruncher.ai
API Docs: Full Reference