Skip to main content
GET
/
v2
/
timeseries
/
sleep
/
{sleep_id}
/
stream
curl --request GET \
    --url {{BASE_URL}}/v2/summary/sleep/{sleep_id}/stream \
    --header 'Accept: application/json' \
    --header 'x-vital-api-key: <API_KEY>'

{
  "heartrate": [
    {
      "id": 0,
      "timestamp": "2026-05-01T17:50:10.708022+00:00",
      "unit": "bpm",
      "value": 78
    },
    {
      "id": 1,
      "timestamp": "2026-05-01T17:50:40.708042+00:00",
      "unit": "bpm",
      "value": 130
    },
    {
      "id": 2,
      "timestamp": "2026-05-01T17:51:10.708060+00:00",
      "unit": "bpm",
      "value": 181
    },
    {
      "id": 3,
      "timestamp": "2026-05-01T17:51:40.708076+00:00",
      "unit": "bpm",
      "value": 89
    },
    {
      "id": 4,
      "timestamp": "2026-05-01T17:52:10.708098+00:00",
      "unit": "bpm",
      "value": 155
    }
  ],
  "hrv": [
    {
      "id": 0,
      "timestamp": "2026-05-01T17:50:10.707825+00:00",
      "unit": "rmssd",
      "value": 8
    },
    {
      "id": 1,
      "timestamp": "2026-05-01T17:50:40.707913+00:00",
      "unit": "rmssd",
      "value": 91
    },
    {
      "id": 2,
      "timestamp": "2026-05-01T17:51:10.707953+00:00",
      "unit": "rmssd",
      "value": 97
    },
    {
      "id": 3,
      "timestamp": "2026-05-01T17:51:40.707980+00:00",
      "unit": "rmssd",
      "value": 10
    },
    {
      "id": 4,
      "timestamp": "2026-05-01T17:52:10.708001+00:00",
      "unit": "rmssd",
      "value": 19
    }
  ],
  "hypnogram": [
    {
      "id": 0,
      "timestamp": "2026-05-01T17:50:10.708117+00:00",
      "unit": "stage",
      "value": 1
    },
    {
      "id": 1,
      "timestamp": "2026-05-01T17:50:40.708135+00:00",
      "unit": "stage",
      "value": 0
    },
    {
      "id": 2,
      "timestamp": "2026-05-01T17:51:10.708153+00:00",
      "unit": "stage",
      "value": -1
    },
    {
      "id": 3,
      "timestamp": "2026-05-01T17:51:40.708169+00:00",
      "unit": "stage",
      "value": 1
    },
    {
      "id": 4,
      "timestamp": "2026-05-01T17:52:10.708184+00:00",
      "unit": "stage",
      "value": -1
    }
  ],
  "respiratory_rate": [
    {
      "id": 0,
      "timestamp": "2026-05-01T17:50:10.708200+00:00",
      "unit": "bpm",
      "value": 11
    },
    {
      "id": 1,
      "timestamp": "2026-05-01T17:50:40.708216+00:00",
      "unit": "bpm",
      "value": 17
    },
    {
      "id": 2,
      "timestamp": "2026-05-01T17:51:10.708232+00:00",
      "unit": "bpm",
      "value": 23
    },
    {
      "id": 3,
      "timestamp": "2026-05-01T17:51:40.708247+00:00",
      "unit": "bpm",
      "value": 27
    },
    {
      "id": 4,
      "timestamp": "2026-05-01T17:52:10.708262+00:00",
      "unit": "bpm",
      "value": 29
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.junction.com/llms.txt

Use this file to discover all available pages before exploring further.

curl --request GET \
    --url {{BASE_URL}}/v2/summary/sleep/{sleep_id}/stream \
    --header 'Accept: application/json' \
    --header 'x-vital-api-key: <API_KEY>'

Authorizations

​
x-vital-api-key
string
header
required

Vital Team API Key

Path Parameters

​
sleep_id
string
required

The Vital Sleep ID

Response

Successful Response

​
hrv
ClientFacingHRVTimeseries · object[] | null
​
heartrate
ClientFacingHeartRateTimeseries · object[] | null
​
hypnogram
ClientFacingHypnogramTimeseries · object[] | null
​
respiratory_rate
ClientFacingRespiratoryRateTimeseries · object[] | null