ClarityStorm Commitment API Docs

Authenticate with `X-API-Key`. Extract commitments, detect commitment changes, and consume company follow-through scores through a focused API surface.

API access is coming soon.

Explore Dataset

Authentication

Pass your key in `X-API-Key` on every request.

curl -H "X-API-Key: cs_your_key" \
  "https://www.claritystorm.com/api/v1/commitments/recent"

Rate Limits

Free: 50/day, Pro: 1,000/day, Business: 10,000/day, Enterprise: custom.

Responses include `X-RateLimit-Limit`, `X-RateLimit-Remaining`, and `X-RateLimit-Reset`.

Endpoint Reference

POST/api/v1/analyze

Analyze a press release and extract commitments.

Sample response

{
  "sourceUrl": "https://example.com/press-release",
  "companyTicker": "AAPL",
  "commitmentsFound": 2,
  "commitments": [
    {
      "text": "Launch carbon-neutral data centers by 2028.",
      "type": "sustainability",
      "targetDate": "2028-12-31",
      "confidence": 0.93
    }
  ]
}

GET/api/v1/commitments

List commitments with pagination and filters.

Sample response

{
  "items": [
    {
      "id": "com_01J8R2Y15H3A2G8B8H4F",
      "ticker": "MSFT",
      "companyName": "Microsoft",
      "summary": "Deploy AI assistants to all enterprise tiers in FY2027.",
      "status": "open",
      "announcedAt": "2026-01-19T12:22:10.000Z"
    }
  ],
  "pagination": {
    "page": 1,
    "pageSize": 25,
    "totalItems": 348,
    "totalPages": 14
  }
}

GET/api/v1/commitments/recent

Return latest commitments across tracked companies.

Sample response

{
  "items": [
    {
      "id": "com_01J8R2Y15H3A2G8B8H4F",
      "ticker": "NVDA",
      "summary": "Increase domestic chip packaging capacity by 30%.",
      "announcedAt": "2026-02-11T09:45:12.000Z"
    }
  ],
  "asOf": "2026-02-22T00:00:00.000Z"
}

GET/api/v1/commitments/{id}

Get full details for a specific commitment.

Sample response

{
  "id": "com_01J8R2Y15H3A2G8B8H4F",
  "ticker": "TSLA",
  "companyName": "Tesla",
  "summary": "Scale annual battery output to 2TWh by 2030.",
  "status": "in_progress",
  "evidence": [
    {
      "sourceType": "earnings_call",
      "url": "https://example.com/transcript",
      "capturedAt": "2026-01-29T16:00:00.000Z"
    }
  ]
}

GET/api/v1/changes

List detected commitment status changes.

Sample response

{
  "items": [
    {
      "commitmentId": "com_01J8R2Y15H3A2G8B8H4F",
      "ticker": "META",
      "previousStatus": "open",
      "newStatus": "fulfilled",
      "changedAt": "2026-02-18T07:34:00.000Z",
      "reason": "Independent verification from regulatory filing."
    }
  ]
}

GET/api/v1/companies

List tracked companies and coverage metadata.

Sample response

{
  "items": [
    {
      "ticker": "AMZN",
      "name": "Amazon",
      "sector": "Consumer Discretionary",
      "commitmentCount": 48,
      "followThroughScore": 71
    }
  ]
}

GET/api/v1/companies/{ticker}

Get one company profile and rollup metrics.

Sample response

{
  "ticker": "GOOGL",
  "name": "Alphabet",
  "commitmentCount": 63,
  "fulfilledCount": 39,
  "followThroughScore": 78,
  "lastUpdatedAt": "2026-02-21T13:10:04.000Z"
}

GET/api/v1/companies/{ticker}/commitments

List commitments for a specific company.

Sample response

{
  "ticker": "NFLX",
  "items": [
    {
      "id": "com_01J8R2Y15H3A2G8B8H4F",
      "summary": "Expand ad-supported plan availability to 12 new markets.",
      "status": "open",
      "announcedAt": "2026-02-01T11:30:00.000Z"
    }
  ]
}

GET/api/v1/export/commitments

Export commitments dataset (CSV or JSON).

Sample response

{
  "downloadUrl": "https://cdn.claritystorm.com/exports/commitments-2026-02-22.csv",
  "format": "csv",
  "expiresAt": "2026-02-22T01:00:00.000Z"
}

GET/api/v1/export/changes

Export status-change events (CSV or JSON).

Sample response

{
  "downloadUrl": "https://cdn.claritystorm.com/exports/changes-2026-02-22.csv",
  "format": "csv",
  "expiresAt": "2026-02-22T01:00:00.000Z"
}

GET/api/v1/public/summary

Public overview statistics with no API key required.

Sample response

{
  "trackedCompanies": 524,
  "totalCommitments": 6231,
  "changesDetected30d": 112,
  "lastIngestedAt": "2026-02-21T23:59:40.000Z"
}

JavaScript

const res = await fetch("/api/v1/companies", {
  headers: { "X-API-Key": process.env.CS_API_KEY! }
});
const data = await res.json();

Python

import requests
r = requests.get(
  "https://www.claritystorm.com/api/v1/changes",
  headers={"X-API-Key": "cs_your_key"}
)
print(r.json())

Try Public Summary

Unauthenticated summary endpoint:

GET /api/v1/public/summary