Kruncher.ai Integration Documentation

Obtaining Your API Key

View our page of Introduction for more information.

Get your analysis

Below is a basic JavaScript example that demonstrates how to use your API key to make a request to the Kruncher.ai API:

// Replace 'YOUR_API_KEY_HERE' with your actual API key
const apiKey = 'YOUR_API_KEY_HERE';
const url = 'https://api.kruncher.ai/v1/data';
 
fetch(url, {
  headers: {
    'Authorization': `Bearer ${apiKey}`,
    'Content-Type': 'application/json'
  }
})
  .then(response => response.json())
  .then(data => {
    console.log('Kruncher API Data:', data);
  })
  .catch(error => {
    console.error('Error fetching data:', error);
  });

Getting an Analysis Report

Every project in Kruncher.ai comes with an array of analyses. Each analysis contains detailed reports on company performance and insights. You might want to fetch the most recent analysis report to get up-to-date information.

Retrieving the Most Recent Analysis

1. Get Project Details: Use the relevant API endpoint to retrieve your project details. The project object includes an analyses array that holds multiple analysis objects.
2. Extract the Analysis Array: Locate the analyses array within the project data. Each analysis object typically contains properties such as analysisId, createdAt, and summary information.
3. Select the Most Recent Analysis: Sort or filter the analyses by the createdAt timestamp to identify the most recent analysis. Use the analysisId from this record for the next step.

Requesting the Full Company Report

Once you have the analysisId of the most recent report, make a GET request to retrieve the full company report:

GET https://api.kruncher.ai/api/integration/analysis/detail?analysisId=<analysisId>

Replace <analysisId> with the actual ID of the analysis you want to fetch.

Example Request in JavaScript

// Replace 'YOUR_API_KEY_HERE' with your actual API key and 'YOUR_ANALYSIS_ID' with the ID of the most recent analysis.
const apiKey = 'YOUR_API_KEY_HERE';
const analysisId = 'YOUR_ANALYSIS_ID';
const detailUrl = `https://api.kruncher.ai/api/integration/analysis/detail?analysisId=${analysisId}`;
 
fetch(detailUrl, {
  headers: {
    'Authorization': `Bearer ${apiKey}`,
    'Content-Type': 'application/json'
  }
})
  .then(response => response.json())
  .then(data => {
    console.log('Full Company Report:', data);
  })
  .catch(error => {
    console.error('Error fetching analysis report:', error);
  });

FAQ