Developer
Score API
Programmatic access to Business Skoor data. Retrieve scores, history, and recommendations via REST endpoints. The API returns the raw Business Health Score (0–1,000); divide by 10 for the displayed Business Skoor (0–100).
Authentication
All Score API requests require an API key passed in the X-API-Key header. Generate API keys in your dashboard under Settings. Keys are scoped to your account and can be rotated at any time. Use test-mode keys (sk_test_) during development and live keys (sk_live_) in production.
Endpoints
GET /v1/business-health/score — Returns the current raw score (0-1,000), all three pillar scores, the tier, and top reason codes. Response includes score, pillars, tier, and reasons fields.
GET /v1/business-health/history — Returns daily score snapshots. Accepts from and to date parameters (ISO 8601). Returns up to 365 data points. Each point includes the raw score, pillar scores, and the delta from the previous day.
GET /v1/business-health/recommendations — Returns the top 5 score improvement recommendations sorted by estimated point impact. Each recommendation includes the target pillar, action description, estimated points, and estimated time to impact.
POST /v1/business-health/compute — Triggers an on-demand score recomputation. Useful after a significant event (large payment batch, new processing connection). Returns the updated score. Limited to 10 calls per day to prevent abuse.
Rate limits
Free accounts: 100 API calls per day. SKOOR Plus accounts: 10,000 API calls per day. Rate limits reset at midnight UTC. When you exceed the limit, the API returns HTTP 429 with a Retry-After header indicating seconds until reset. For higher limits, contact the SKOOR team for an enterprise plan.
Example request
# Get current Business Skoor (raw 0-1,000 scale)
curl -H "X-API-Key: sk_live_YOUR_KEY" \
https://api.skoor.ai/v1/business-health/score
# Response
{
"score": 742, // Business Skoor 74
"tier": "very_good",
"pillars": { "agent": 320, "merchant": 225, "credit": 197 },
"reasons": [ ...top factors ]
}