API Endpoints
POST
/api/analyze
Analyze website for comprehensive market intelligence and competitive insights
Request Body
{
"url": "https://example.com",
"depth": "detailed"
}
Responses
200
Analysis completed successfully
{
"success": true,
"data": {
"url": "https://example.com",
"marketPosition": "Strong",
"competitorCount": 12,
"marketShare": "15.2%",
"insights": [
"Strong SEO performance",
"Active social media presence",
"Competitive pricing strategy"
]
}
}
400
Invalid request parameters
{
"success": false,
"error": "Invalid URL format"
}
GET
/api/market/overview
Get comprehensive market overview and trends data
Parameters
industry
(string)
Filter by industry sector
region
(string)
Geographic region filter
Responses
200
Market overview data retrieved successfully
{
"success": true,
"data": {
"marketSize": "$2.4B",
"growthRate": "12.5%",
"topPlayers": [
{
"name": "Company A",
"marketShare": "25%"
},
{
"name": "Company B",
"marketShare": "18%"
}
],
"trends": [
"AI adoption increasing",
"Mobile-first strategies",
"Sustainability focus"
]
}
}
GET
/api/competitors
Get detailed competitor analysis and benchmarking data
Parameters
domain
(string)
REQUIRED
Target domain for competitor analysis
limit
(number)
Maximum number of competitors to return (default: 10)
Responses
200
Competitor analysis completed
{
"success": true,
"data": {
"competitors": [
{
"domain": "competitor1.com",
"similarity": 0.85,
"marketPosition": "Direct Competitor",
"strengths": [
"SEO",
"Content Marketing"
],
"weaknesses": [
"Social Media",
"Mobile UX"
]
}
],
"insights": [
"Market is highly competitive",
"Content quality is key differentiator"
]
}
}
GET
/health
System health check and status monitoring
Responses
200
System is healthy
{
"status": "healthy",
"timestamp": "2024-01-01T00:00:00Z",
"services": {
"database": "connected",
"ai": "operational",
"cache": "active"
}
}
Authentication
All API requests require authentication using a Bearer token in the Authorization header.
Authorization: Bearer [YOUR_API_KEY]
Contact our support team to obtain your API key.
Rate Limits
API requests are limited to 1,000 requests per hour per API key.
Rate limit headers are included in all responses:
X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 999
X-RateLimit-Reset: 1640995200