Base URL

All RealtimeX API endpoints are accessed through a common Base URL. Every endpoint documented in this reference should be appended to the appropriate environment's base URL.

terminal

{baseUrl}/api/{apiVersion}

Parameter	Description	Example
baseUrl	Server origin for the target environment	https://realtimex.softwareco.com
apiVersion	API version prefix. Changing this re-points every request in the collection.	v1

Endpoint Structure

Each API endpoint consists of the Base URL followed by the endpoint path.

Example:

If the Base URL is:

https://api.your-domain.com/api/v1

and the endpoint is:

/user/login/client

the complete request URL becomes:

https://api.your-domain.com/api/v1/user/login/client

Environment Reference

Environment	Base URL
Development	Used during local development and testing.
Staging	Used for pre-production validation and QA testing.
Production	Used for live applications and production traffic.

The base URL is determined by the target environment. Use the table above for the correct prefix.