Authentication
The DataMaxi+ API server is hosted under https://api.datamaxiplus.com.
Some API endpoints are private and protected by an API key. Python SDK, REST API and WebSocket API share the same API Key. You can get the API key by clicking on the button on the top right corner after logging in via https://datamaxiplus.com.
👉 Please refer to the quickstart guide.
Once you receive your API key, you must pass it with every request to private endpoints.
The API keys are passed with authorization header X-DTMX-APIKEY
.
curl -H "X-DTMX-APIKEY: $YOUR_API_KEY" https://api.datamaxiplus.com/
Check API server status
The following endpoints give you information about
Ping​
/api/v1/ping
Description​
Test connectivity to the API server.
Method​
GET
Source​
Memory
Parameters​
None
Request​
GET /api/v1/ping
Response​
OK
Server Time​
/api/v1/time
Description​
Test connectivity to the API server and get the current server time.
Method​
GET
Source​
Memory
Parameters​
None
Request​
GET /api/v1/time
Response​
{
"ts": 1702817580077
}