API Reference

Integrate Prominara into your applications with our REST API. Access scanning, tracking, and analytics programmatically.

Base URL

https://api.prominara.com/v1

Authentication

All API requests require authentication using an API key. Include your API key in the request header:

Authorization: Bearer prm_live_your_api_key_here

You can generate API keys in your account settings. Keep your API keys secure and never expose them in client-side code.

Endpoints

POST/api/v1/scans

Create a new scan for a URL

GET/api/v1/scans/:id

Retrieve scan results by ID

GET/api/v1/sites

List all tracked sites

GET/api/v1/sites/:id/history

Get historical scores for a site

GET/api/v1/citations

List citation mentions

GET/api/v1/citations/share-of-voice

Get share of voice metrics

Example: Create a Scan

Submit a URL for AI visibility analysis:

curl -X POST https://api.prominara.com/v1/scans \
  -H "Authorization: Bearer prm_live_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{"url": "https://example.com/page"}'

Response:

{
  "id": "scan_abc123",
  "url": "https://example.com/page",
  "status": "processing",
  "created_at": "2025-01-07T12:00:00Z"
}

Example: Get Scan Results

Retrieve the results of a completed scan:

curl https://api.prominara.com/v1/scans/scan_abc123 \
  -H "Authorization: Bearer prm_live_your_api_key"

Response:

{
  "id": "scan_abc123",
  "url": "https://example.com/page",
  "status": "completed",
  "score": {
    "overall": 72,
    "content_structure": 78,
    "entity_topic": 65,
    "authority_signals": 70,
    "technical_readiness": 75
  },
  "recommendations": [
    {
      "category": "content_structure",
      "priority": "high",
      "title": "Add more structured headings",
      "description": "..."
    }
  ],
  "created_at": "2025-01-07T12:00:00Z",
  "completed_at": "2025-01-07T12:00:15Z"
}

Rate Limits

API rate limits vary by plan:

Plan	Requests/min	Scans/day
Free	10	5
Starter	60	100
Pro	120	500
Agency	300	2000

SDKs & Libraries

Official client libraries coming soon:

Node.js

Coming soon

Python

Coming soon

PHP

Coming soon

Need help with the API?

Our team is ready to help you integrate Prominara into your workflow.

Contact Developer Support