API Versioning
The MyStocks Partner API is versioned via the URL path, current stable v1. What counts as a backwards-compatible change vs. a breaking change, plus the 90-day deprecation policy and its response headers.
The Partner API is versioned via the URL path. The current stable version is v1. The sandbox mirrors
the same versioning scheme.
| Environment | Base URL |
|---|---|
| Production | https://mystocks.africa/api/v1/partner |
| Sandbox | https://mystocks.africa/api/sandbox/v1 |
Backwards-compatible changes (no version bump)
These changes will not break your existing integration. We make them freely within v1:
- Adding new optional fields to request bodies.
- Adding new fields to response objects.
- Adding new endpoints or HTTP methods.
- Adding new webhook event types.
- Adding new query parameters (all optional).
- Adding new error codes for new scenarios.
Breaking changes (require a bump to v2)
- Renaming or removing existing fields from request/response bodies.
- Changing the type of an existing field (e.g. number → string).
- Removing or renaming endpoints or HTTP methods.
- Changing the authentication scheme.
- Changing error-code semantics for existing scenarios.
Deprecation policy
Deprecated endpoints and fields receive a minimum 90-day sunset notice. You will be notified via:
email to your registered partner address; a Deprecation response header on every affected call; a
Sunset response header with the removal date; and a changelog entry marked Deprecated.
Check for the Deprecation: true header in your HTTP client to detect deprecated usage before the
sunset date.