API product catalog

Enterprise Governance, Security & Access

MyStocks Partner API

Team roles, maker-checker approvals, SSO, SCIM, access reviews, security evidence, support, and SLA reporting.

Integration guides Get a sandbox key

Explore endpoints

37 of 37

GET

/sla

SLA status

Full endpoint documentation

Sandbox availablelistSla

Returns real-time service health, active incidents, upcoming maintenance windows, and your SLA tier commitments. | Tier | Uptime SLO | Rate Limit | |------|-----------|------------| | Standard (starter) | 99.5% | 100 req/min | | Professional (growth) | 99.9% | 500 req/min | | Enterprise | 99.95% | 2,000 req/min |

Parameters

This endpoint has no path or query parameters.

Headers

AuthorizationstringRequired

Bearer sk_sandbox_<your_key> for sandbox requests.

Response fields

overallStatusoperational | partial_outage | major_outage

Platform-wide health summary.

checkedAtstring

servicesobject[]

Per-service health breakdown.

services[].idstring

Example: "trading-api"

services[].namestring

Example: "Trading API"

services[].descriptionstring

services[].statusoperational | degraded | outage

services[].uptime30dnumber | null

services[].uptime90dnumber | null

services[].currentMonthUptimenumber | null

activeIncidentsobject[]

activeIncidents[].idstring

activeIncidents[].titlestring

activeIncidents[].severityP0 | P1 | P2 | P3

activeIncidents[].statusstring

activeIncidents[].affectedServicesstring[]

activeIncidents[].startedAtstring | null

activeIncidents[].resolvedAtstring | null

pastIncidentsobject[]

Incidents resolved in the last 30 days.

maintenanceobject[]

Upcoming scheduled maintenance windows.

maintenance[].idstring

maintenance[].titlestring

maintenance[].scheduledStartstring | null

maintenance[].scheduledEndstring | null

maintenance[].statusstring

partnerobject

Your SLA tier and committed SLO targets.

partner.slaTierstring

Example: "Standard"

partner.sloobject

partner.executionSloobject

Response codes

200Service health, incidents, and partner SLA commitments.

Sandbox playground

Read-only sandbox request

Sandbox API keyYour key stays in this page’s memory.

https://mystocks.africa/api/sandbox/v1/partner/sla

Open in API Tester API Reference

Response schema

{
  "type": "object",
  "properties": {
    "overallStatus": {
      "type": "string",
      "enum": [
        "operational",
        "partial_outage",
        "major_outage"
      ],
      "description": "Platform-wide health summary."
    },
    "checkedAt": {
      "type": "string",
      "format": "date-time"
    },
    "services": {
      "type": "array",
      "description": "Per-service health breakdown.",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "example": "trading-api"
          },
          "name": {
            "type": "string",
            "example": "Trading API"
          },
          "description": {
            "type": "string"
          },
          "status": {
            "type": "string",
            "enum": [
              "operational",
              "degraded",
              "outage"
            ]
          },
          "uptime30d": {
            "type": [
              "number",
              "null"
            ]
          },
          "uptime90d": {
            "type": [
              "number",
              "null"
            ]
          },
          "currentMonthUptime": {
            "type": [
              "number",
              "null"
            ]
          }
        }
      }
    },
    "activeIncidents": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "title": {
            "type": "string"
          },
          "severity": {
            "type": "string",
            "enum": [
              "P0",
              "P1",
              "P2",
              "P3"
            ]
          },
          "status": {
            "type": "string"
          },
          "affectedServices": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "startedAt": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time"
          },
          "resolvedAt": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time"
          }
        }
      }
    },
    "pastIncidents": {
      "type": "array",
      "description": "Incidents resolved in the last 30 days.",
      "items": {
        "type": "object"
      }
    },
    "maintenance": {
      "type": "array",
      "description": "Upcoming scheduled maintenance windows.",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "title": {
            "type": "string"
          },
          "scheduledStart": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time"
          },
          "scheduledEnd": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time"
          },
          "status": {
            "type": "string"
          }
        }
      }
    },
    "partner": {
      "type": "object",
      "description": "Your SLA tier and committed SLO targets.",
      "properties": {
        "slaTier": {
          "type": "string",
          "example": "Standard"
        },
        "slo": {
          "type": "object",
          "properties": {
            "uptimeSlo": {
              "type": "number",
              "example": 99.5
            },
            "responseP0": {
              "type": "string",
              "example": "4h"
            },
            "responseP1": {
              "type": "string",
              "example": "8h"
            },
            "responseP2": {
              "type": "string",
              "example": "24h"
            },
            "responseP3": {
              "type": "string",
              "example": "72h"
            },
            "credits": {
              "type": "number",
              "description": "SLA credit percentage on breach."
            }
          }
        },
        "executionSlo": {
          "type": "object",
          "properties": {
            "marketOrderExecution": {
              "type": "object",
              "properties": {
                "minMinutes": {
                  "type": "integer",
                  "example": 1
                },
                "maxMinutes": {
                  "type": "integer",
                  "example": 5
                },
                "appliesTo": {
                  "type": "string"
                },
                "excludes": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                },
                "monitoringCronId": {
                  "type": "string",
                  "example": "execution-sla-monitor"
                }
              }
            }
          }
        }
      }
    }
  }
}

curl -X GET 'https://mystocks.africa/api/sandbox/v1/partner/sla' \
  -H "Authorization: Bearer $MYSTOCKS_SANDBOX_API_KEY"

Was this page useful?

Your signal helps us tighten partner onboarding docs.

Send note

Last updated on

GET /usage

GET /approvals