Accessing the Ultrahuman Partnership API

Introduction

The Partnership API gives you full access to the data generated by Ultrahuman. This documentation describes the API calls and properties of the returned objects. If you have any questions, please don’t hesitate to contact us.

Environments

Live Environment: '<https://partner.ultrahuman.com/api/v1/metrics>

Test Environment: '<https://www.staging.ultrahuman.com/api/v1/metrics>

Pre-requisites

Each Partner will be given:

1. Authorization key – to access apis.
2. Data sharing code – Any user can enter this code on UH app. This will give the Partner, access to read the user’s data through AP.

API request

These are the properties that you must include in every API call.

1. Authorization: A 40-character alpha-numeric string that gives you access to the API to be added in the Header as Authorization key.
2. email: Email of the user, data is fetched for. For e.g ([email protected])
3. date: Date for which data is required. ISO 8601 Date Format: YYYY-MM-DD (e.g., “2023-10-09”)

Anyone with this Authorization Key can use the Ultrahuman API as you. If it is compromised, please send an email, and it can be deactivated or changed.

With that in mind, the next step is to send a GET request to partner.ultrahuman.com with the appropriate values set.

curl --location --request GET '<https://partner.ultrahuman.com/api/v1/[email protected]&date=yyyy-mm-dd>' \\
--header 'Authorization: abssdsdsdsddsdss.eyJ1c2VyX2lkIjoxMTg5MDMwLCJleHAiOjE2NzE3NzMzNzl9.xU08oMCRIGyu3FcAP9wn-FajrfhsZ5luqXS_ESzkYVk'

API response

Response contains metrics for user for given date. Metrics contains

1. Sleep Data
2. Movement Data
3. Heart Rate
4. HRV
5. Temperature
6. Steps
7. Glucose
8. Metabolic Score
9. Glucose Variability (%)
10. Average Glucose (mg/dL)
11. HbA1c
12. Time in Target (%)
13. Recovery Index
14. Movement Index
15. VO2 Max

Below is the sample api response

Response.json

Test Environment