Spren HRV API
Spren HRV API is RESTful and partially async. It communicates with JSON request and response bodies. Authorization is in the header.
- https://test.api.spren.com
- https://prod.api.spren.com
Header | Notes | Example |
X-API-KEY | Your API key for authorization | X-API-KEY: <API key> |
Content-Type | JSON, if request body present | Content-Type: application/json |
- POST /submit/sdkData
- POST /submit/deviceData
- GET /results/{guid}
- GET /populationComparison
- POST /submit/userData

readiness and ansBalance require 2 readings on 2 separate days within 10 days or value will be null This will occur for a user's first reading OR after their first reading if they have not performed a reading in the last 10 days, and when this occurs an errorDescription of "baseline not set" is returned. See GET /results/{guid} below for more details.
Response Key | Description | Type | Data Type | Return Values |
hr | Heart rate | Biomarker | number | Floating point, unrestricted range |
hrvScore | HRV score | Biomarker | number | Floating point, 0-100 |
breathingRate | Breathing/respiration rate | Biomarker | number | Floating point, unrestricted range |
readiness* | Morning readiness | Insight | number | Int, 0-10 |
ansBalance* | ANS balance | Insight | number | Int, 1-5 |
signalQuality | Signal quality | Other | number | Int, 1-3 |
*require 2 readings on 2 separate days within 10 days or value will be null