Skip to main content

​
Base URL, API Versioning, and Endpoint Structure Of Sorsa API

Sorsa API uses URL-based versioning to keep your integrations stable. The version is embedded directly in the base URL, so every request explicitly targets a specific API version.

​
Base URL

All requests are made over HTTPS. Unencrypted HTTP is not supported and will be rejected. 
https://api.sorsa.io/v3
Every endpoint path is relative to this base URL. For example, the full URL for fetching a user profile is: 
https://api.sorsa.io/v3/info?username=elonmusk

​
Current version: v3

v3 is the current, stable, and recommended version of the Sorsa API. All new features, endpoints, and improvements are released under v3.

​
How we handle changes

Not every update requires a new version. Here is how we classify changes: Non-breaking changes (released within v3) These are applied to the current version without a version bump. Your existing integrations will continue to work without modification.
  • Adding new optional query parameters to existing endpoints
  • Adding new fields to JSON response objects
  • Adding new endpoints
  • Improving error messages or adding more detail to error responses Breaking changes (new version) If we need to remove response fields, rename existing parameters, change authentication mechanics, or alter core endpoint behavior, we will release a new version (for example, /v4/). When this happens:
  • The previous version will remain active during a clearly communicated sunset period
  • Migration guides with field mapping and structural changes will be published in advance
  • Deprecation timelines will be announced through the dashboard and documentation

​
Legacy version: v2 (deprecated)

If you are still using v2 endpoints, please note that v2 is now deprecated and scheduled for shutdown. Shutdown date: May 1, 2026 All integrations must migrate to v3 before this date to avoid service interruption. After shutdown, v2 endpoints will return 410 Gone. If you need help migrating, see the v2 to v3 Migration Guide for a complete mapping of endpoint changes, renamed fields, and updated request formats.

​
Next steps