Skip to content
Partner API Docs

SLA & Health

Real-time platform health, active incidents, scheduled maintenance, and your partner SLA tier via GET /sla. Drive in-app status banners and alert users when market data or order execution is degraded. Incident severity P0–P3 explained.

Real-time platform health status, active incidents, scheduled maintenance windows, and your partner SLA tier. Use it to drive status banners in your app or alert users when market data or order execution is degraded.

Service health

GET /sla

Returns overall platform health, any active incidents with severity and affected services, upcoming maintenance windows, and your SLA tier entitlements. Incidents are also broadcast via the incident.declared and incident.resolved webhooks.

curl "https://mystocks.africa/api/v1/partner/sla" \
  -H "Authorization: Bearer pk_live_<key>"
{
  "status": "OPERATIONAL",
  "tier": "starter",
  "incidents": [],
  "maintenance": [{ "id": "mnt_abc123", "title": "NGX data feed upgrade", "scheduledStart": "2026-06-15T02:00:00Z", "scheduledEnd": "2026-06-15T04:00:00Z", "affectedServices": ["market-data"], "status": "SCHEDULED" }],
  "services": [
    { "name": "Market Data", "status": "OPERATIONAL" },
    { "name": "Order Execution", "status": "OPERATIONAL" },
    { "name": "Webhooks", "status": "OPERATIONAL" },
    { "name": "Sub-Accounts", "status": "OPERATIONAL" }
  ],
  "checkedAt": "2026-06-09T10:00:00Z"
}

Incident severity levels

LevelNameImpact
P0CriticalFull platform outage — all trading and market data unavailable.
P1MajorCore service degraded — order execution or market data impaired.
P2MinorPartial degradation — some exchanges or endpoints affected.
P3InformationalMaintenance or cosmetic issue with no user impact.

On this page