Developer API Reference

Integrate global app store scraping, ASO scorecards, sentiments, and valuation models into your systems.

Introduction

The IntelMyApp AI API is a robust, RESTful service allowing developers and platforms to audit mobile applications programmatically. You can submit Google Play Store packages or Apple App Store URLs, trigger multi-regional background scrapes, estimate financial metrics, generate SWOT tables, calculate valuations, run unit economic models, and compile reports directly to PDF.

BASE API URL https://intelmyapp.com/api/v1

All requests and responses use JSON formatting. Status codes indicate the success or failure of operations. Rates are limited by user subscription tier (Starter, Pro, or Agency).

Authentication

Most endpoints require Sanctum Bearer Token Authentication. You can easily generate and revoke personal access keys directly on your dashboard's API Key Management page.

To authenticate your API requests, pass your token inside the HTTP request headers:

HTTP Request Headers 
Authorization: Bearer YOUR_API_TOKEN
Accept: application/json
Content-Type: application/json
Security Reminder: Never expose your API keys in frontend Javascript clients or repository public repositories. Keep them securely stored in your server configuration environment variables.

API Endpoints Reference

Register Account

POST /register

Create a new user account programmatically. Once registered, the user can log in to obtain authorization credentials.

Request Body (JSON)
Parameter Type Required Description
name string Yes The user's full name.
email string Yes Unique email address for the account.
password string Yes Must be at least 8 characters.
password_confirmation string Yes Must match the password parameter exactly.
Request Example
cURL 
curl -X POST "https://intelmyapp.com/api/v1/register" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Jane Doe",
    "email": "jane@example.com",
    "password": "password123",
    "password_confirmation": "password123"
  }'
JSON Response
200 OK 
{
  "success": true,
  "message": "Registration successful.",
  "error": "",
  "data": {
    "token": "1|abc123xyz...",
    "user": {
      "name": "Jane Doe",
      "email": "jane@example.com",
      "updated_at": "2026-06-20T12:00:00.000000Z",
      "created_at": "2026-06-20T12:00:00.000000Z",
      "id": 5
    }
  }
}

User Login

POST /login

Authenticate a user's login credentials to retrieve a dynamic API token.

Request Body (JSON)
Parameter Type Required Description
email string Yes Registered account email.
password string Yes Account password.
Request Example
cURL 
curl -X POST "https://intelmyapp.com/api/v1/login" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "jane@example.com",
    "password": "password123"
  }'
JSON Response
200 OK 
{
  "success": true,
  "message": "Login successful.",
  "error": "",
  "data": {
    "token": "2|key789qwe...",
    "user": {
      "id": 5,
      "name": "Jane Doe",
      "email": "jane@example.com",
      "created_at": "2026-06-20T12:00:00.000000Z"
    }
  }
}

Get Profile Details

GET /profile

Retrieve basic profile metadata and active subscription credentials for the logged-in user.

Request Example
cURL 
curl -X GET "https://intelmyapp.com/api/v1/profile" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Accept: application/json"
JSON Response
200 OK 
{
  "success": true,
  "message": "Profile details retrieved.",
  "error": "",
  "data": {
    "id": 5,
    "name": "Jane Doe",
    "email": "jane@example.com",
    "role": "user",
    "created_at": "2026-06-20T12:00:00.000000Z"
  }
}

Submit App Scan

POST /scans

Submits a store link for scanning. IntelMyApp initiates a background scrape, SWOT extraction, ASO grade checklist creation, and financial models. Scans consume 1 credit.

Request Body (JSON)
Parameter Type Required Description
url string Yes A valid App Store URL (iOS) or Google Play Store URL (Android).
Request Example
cURL 
curl -X POST "https://intelmyapp.com/api/v1/scans" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
    "url": "https://play.google.com/store/apps/details?id=com.whatsapp"
  }'
JSON Response
202 Accepted 
{
  "success": true,
  "message": "Scan submitted successfully and is processing in the background.",
  "error": "",
  "data": {
    "scan_id": 42,
    "status": "pending"
  }
}

List Scan History

GET /scans

Fetch the entire list of app scans ran by your account. Perfect for rendering custom lists or syncing scan histories.

Request Example
cURL 
curl -X GET "https://intelmyapp.com/api/v1/scans" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Accept: application/json"
JSON Response
200 OK 
{
  "success": true,
  "message": "Scan history retrieved successfully.",
  "error": "",
  "data": [
    {
      "id": 42,
      "user_id": 5,
      "submitted_url": "https://play.google.com/store/apps/details?id=com.whatsapp",
      "app_name": "WhatsApp Messenger",
      "developer": "WhatsApp LLC",
      "platform": "android",
      "status": "completed",
      "aso_score": "A",
      "valuation_low": 42000000.0,
      "valuation_high": 63000000.0,
      "created_at": "2026-06-20T12:05:00.000000Z"
    }
  ]
}

Retrieve Scan Report

GET /scans/{id}

Fetch complete app metrics, valuations, ASO checklists, reviews sentiment counts, and SWOT insights for a given scan ID.

URL Parameters
Parameter Type Required Description
id integer Yes The unique numerical identifier of the scan.
Request Example
cURL 
curl -X GET "https://intelmyapp.com/api/v1/scans/42" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Accept: application/json"
JSON Response
200 OK 
{
  "success": true,
  "message": "Scan report details retrieved.",
  "error": "",
  "data": {
    "id": 42,
    "submitted_url": "https://play.google.com/store/apps/details?id=com.whatsapp",
    "status": "completed",
    "app_name": "WhatsApp Messenger",
    "developer": "WhatsApp LLC",
    "category": "Communication",
    "platform": "android",
    "icon_url": "https://play-lh.googleusercontent.com/bYtPu1b...",
    "rating": 4.5,
    "review_count": 1782500,
    "installs": "5,000,000,000+",
    "revenue_estimation": {
      "downloads": 5000000000,
      "monetization_type": "Hybrid",
      "mau": 1000000000,
      "dau": 250000000,
      "total_revenue": 1250000.0,
      "estimated_monthly_profit": 875000.0,
      "profit_margin": 70
    },
    "valuation": {
      "valuation_low": 42000000.0,
      "valuation_high": 63000000.0,
      "suggested_buy_price": 39900000.0,
      "suggested_sell_price": 66150000.0
    },
    "aso_score": "A",
    "aso_checklist": [
      {
        "factor": "App Title & Branding",
        "status": "pass",
        "details": "Branding is distinctive and leverages massive key category keywords."
      }
    ],
    "sentiment_breakdown": {
      "positive_percentage": 88,
      "negative_percentage": 12,
      "insights": [
        {
          "type": "praise",
          "category": "Reliability",
          "percentage": 50,
          "details": "Users praise call stability and instant message deliveries."
        }
      ]
    },
    "strengths": [
      "Unrivaled market penetration globally",
      "High user retention and DAU engagement loops"
    ],
    "weaknesses": [
      "High server operational costs",
      "Limited direct monetization avenues"
    ],
    "opportunities": [
      "Expand value-added banking or business payments integrations",
      "Cross-sell premium chat themes"
    ],
    "threats": [
      "Strict data compliance policies in key regions",
      "Rapidly evolving communication competitors"
    ]
  }
}

Download PDF Report

GET /scans/{id}/download-pdf

Generates a public or private PDF download url for the completed valuation report prospectus.

Request Example
cURL 
curl -X GET "https://intelmyapp.com/api/v1/scans/42/download-pdf" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Accept: application/json"
JSON Response
200 OK 
{
  "success": true,
  "message": "PDF report compiled successfully.",
  "error": "",
  "data": {
    "pdf_url": "http://localhost/aitool/public/storage/reports/report_42.pdf",
    "file_path": "storage/reports/report_42.pdf"
  }
}

API Usage Snippets

Choose your programming language to copy full integration handlers to query the scanning engine.

import requests

url = "https://intelmyapp.com/api/v1/scans"
headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json",
    "Accept": "application/json"
}
payload = {
    "url": "https://play.google.com/store/apps/details?id=com.whatsapp"
}

response = requests.post(url, json=payload, headers=headers)
data = response.json()
print(data)
const axios = require('axios');

const url = "https://intelmyapp.com/api/v1/scans";
const headers = {
  'Authorization': 'Bearer YOUR_API_TOKEN',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
};
const payload = {
  url: 'https://play.google.com/store/apps/details?id=com.whatsapp'
};

axios.post(url, payload, { headers })
  .then(response => {
    console.log(response.data);
  })
  .catch(error => {
    console.error('API Error:', error.response ? error.response.data : error.message);
  });
<?php

$url = "https://intelmyapp.com/api/v1/scans";
$token = "YOUR_API_TOKEN";

$ch = curl_init($url);
$payload = json_encode(["url" => "https://play.google.com/store/apps/details?id=com.whatsapp"]);

curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $payload);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "Authorization: Bearer " . $token,
    "Content-Type: application/json",
    "Accept: application/json"
]);

$response = curl_exec($ch);
if (curl_errno($ch)) {
    echo 'Error: ' . curl_error($ch);
} else {
    $data = json_decode($response, true);
    print_r($data);
}
curl_close($ch);