Skip to content
Tidepool API/Data API/
/
Basal Automated

Data API (1.0)

The Tidepool API is an HTTP REST API used by Tidepool clients use to communicate with the Tidepool Platform.

For more information, see the Getting Started section.

Download OpenAPI description
data.v1.json
data.v1.yaml
Overview
URL

https://support.tidepool.org/

Tidepool API Support

support@tidepool.org

License

BSD-2-Clause

Terms of Service

Languages
Servers
Mock server

https://tidepool.redocly.app/_mock/reference/data.v1/

integration

https://external.integration.tidepool.org/

production

https://api.tidepool.org/

dev1

https://dev1.dev.tidepool.org/

qa1

https://qa1.development.tidepool.org/

qa2

https://qa2.development.tidepool.org/

Internal

APIs intended for internal use by Tidepool.

Operations

Data

Manages diabetes data in user's Tidepool account.

Operations

Basal Suppressed Scheduled

typestring
Value"basal"
deliveryTypestring
Value"scheduled"
ratenumber(double)(Insulin Delivery Rate)[ 0 .. 100 ]

A floating point number >= 0 representing the amount of insulin delivered in units per hour.

insulinFormulationInsulin Formulation (object)(Insulin Formulation)
One of:
scheduleNamestring(Insulin Delivery Schedule Name)[ 1 .. 1000 ] characters

The name of the basal schedule.

annotationsArray of Annotation (object) or Blood Glucose Out of Range (object)(Annotation Array)[ 0 .. 100 ] itemsunique

An array of annotations.

{
  "type": "basal",
  "deliveryType": "scheduled",
  "rate": 100,
  "insulinFormulation": {
    "compounds": [ … ],
    "name": "string"
  },
  "scheduleName": "string",
  "annotations": [
    { … }
  ]
}

Basal Automated

An automated basal delivery event.

annotationsArray of Annotation (object) or Blood Glucose Out of Range (object)(Annotation Array)[ 0 .. 100 ] itemsunique

An array of annotations.

archivedTimestring(date-time)(Date/Time)read-only

RFC 3339 / ISO 8601 timestamp with timezone information

Example: "2017-02-06T02:37:46Z"
archivedDatasetIdstring(Data Set ID)[ 17 .. 37 ] characters^(upid_[0-9a-f]{12}|upid_[0-9a-f]{32}|[0-9a-f...
Example: "ce8cc5f7595575945f91fc6710db6fef"
associationsArray of Association (blob) (object) or Association (datum) (object) or Association (image) (object) or Association (url) (object)(Association Array)

An array of associations for the resource.

clockDriftOffsetinteger(int64)(Clock Drift Offset)[ -86400000 .. 86400000 ]

Clock drift offset, expressed as milliseconds.

Example: 0
conversionOffsetinteger(int64)(Conversion Offset)

Conversion offset, expressed as milliseconds.

Example: 0
createdTimestring(date-time)(Date/Time)

RFC 3339 / ISO 8601 timestamp with timezone information

Example: "2017-02-06T02:37:46Z"
createdUserIdstring(Tidepool User ID)^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...read-only

String representation of a Tidepool User ID. Old style IDs are 10-digit strings consisting of only hexadeximcal digits. New style IDs are 36-digit UUID v4

deduplicatorobject(Deduplicator Descriptor)
deletedTimestring(date-time)(Date/Time)

RFC 3339 / ISO 8601 timestamp with timezone information

Example: "2017-02-06T02:37:46Z"
deletedUserIdstring(Tidepool User ID)^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...read-only

String representation of a Tidepool User ID. Old style IDs are 10-digit strings consisting of only hexadeximcal digits. New style IDs are 36-digit UUID v4

deviceIdstring(Device ID)non-empty

Globally unique to device and repeatable with each upload, e.g. device make and model with serial number

Example: "MMT-1711:12345678"
deviceTimestring(Date/Time without Timezone)^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$

RFC 3339 / ISO 8601 timestamp without timezone information

Example: "2017-02-06T02:37:46"
historyArray of objects(Event History [Proposed])

Revision history of the event

idstring(Data Set ID)[ 17 .. 37 ] characters^(upid_[0-9a-f]{12}|upid_[0-9a-f]{32}|[0-9a-f...required
Example: "ce8cc5f7595575945f91fc6710db6fef"
locationobject(Location)

Location information associated with the resource. One or both of name and gps must be specified.

modifiedTimestring(date-time)(Date/Time)

RFC 3339 / ISO 8601 timestamp with timezone information

Example: "2017-02-06T02:37:46Z"
modifiedUserIdstring(Tidepool User ID)^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...read-only

String representation of a Tidepool User ID. Old style IDs are 10-digit strings consisting of only hexadeximcal digits. New style IDs are 36-digit UUID v4

notesArray of strings(Note Array)[ 1 .. 100 ] items

An array of 1 to 100 notes.

originobject(Origin)

External origin information for the source of the resource.

payloadobject(Payload)

Grab bag field for data that isn't yet part of the data model. The maximum size is 4K bytes.

sourcestring
Value"carelink"
tagsArray of strings(Tag Array)

An array of tags.

timestring(date-time)(Date/Time)required

RFC 3339 / ISO 8601 timestamp with timezone information

Example: "2017-02-06T02:37:46Z"
timezonestring(Time Zone)

A string timezone name from the IANA timezone database

Example: "Europe/London"
timezoneOffsetinteger(int32)(Time Zone offset)[ -10080 .. 10080 ]

Time zone offset, expressed as positive or negative number of minutes from UTC.

Example: -420
typestring(Tidepool Data Type)required

Data type

Enum"basal""alert""bloodKetone""bolus""cbg""cgmSettings""controllerSettings""controllerStatus""deviceEvent""deviceStatus"
Example: "upload"
uploadIdstring(Upload ID)[ 17 .. 32 ] characters^([0-9a-f]{32}|upid_[0-9a-f]{12})$

An upload identifier; this field should be the uploadId of the corresponding upload record

Example: "0d92d5c1c22117a18f3620b9e24d3c06"
deliveryTypestring(Delivery Type)required

This defines the basal delivery type, used to differentiate between automated, scheduled, suspended and temporary basal types.

Enum"automated""scheduled""suspend""temp"
durationinteger(int64)(Insulin Delivery Duration)[ 0 .. 604800000 ]required

An integer value representing a duration of time in milliseconds.

expectedDurationinteger(int64)(Expected Insulin Delivery Duration)[ 0 .. 604800000 ]

An integer value representing an original programmed duration of time in milliseconds, copied from the duration field on ingestion when a following event has resulted in truncation of the original programmed duration.

expectedDuration cannot be less than the value of duration

insulinFormulationInsulin Formulation (object)(Insulin Formulation)
One of:
ratenumber(double)(Insulin Delivery Rate)[ 0 .. 100 ]required

A floating point number >= 0 representing the amount of insulin delivered in units per hour.

scheduleNamestring(Insulin Delivery Schedule Name)[ 1 .. 1000 ] characters

The name of the basal schedule.

suppressedobject(Basal Suppressed Scheduled)
guidstringDeprecated

A string ID. Added to each event during data processing in the Tidepool Uploader or upon ingestion by the platform data ingestion service.

{
  "annotations": [
    { … }
  ],
  "archivedTime": "2017-02-06T02:37:46Z",
  "archivedDatasetId": "ce8cc5f7595575945f91fc6710db6fef",
  "associations": [
    { … }
  ],
  "clockDriftOffset": 0,
  "conversionOffset": 0,
  "createdTime": "2017-02-06T02:37:46Z",
  "createdUserId": "string",
  "deduplicator": {
    "hash": "string",
    "version": "2.36.1",
    "name": "org.tidepool.uploader"
  },
  "deletedTime": "2017-02-06T02:37:46Z",
  "deletedUserId": "string",
  "deviceId": "MMT-1711:12345678",
  "deviceTime": "2017-02-06T02:37:46",
  "guid": "string",
  "history": [
    { … }
  ],
  "id": "ce8cc5f7595575945f91fc6710db6fef",
  "location": {
    "name": "string",
    "gps": { … }
  },
  "modifiedTime": "2017-02-06T02:37:46Z",
  "modifiedUserId": "string",
  "notes": [
    "string"
  ],
  "origin": {
    "id": "string",
    "name": "string",
    "payload": {},
    "time": "2017-02-06T02:37:46Z",
    "type": "device",
    "version": "string"
  },
  "payload": {},
  "source": "carelink",
  "tags": [
    "string"
  ],
  "time": "2017-02-06T02:37:46Z",
  "timezone": "Europe/London",
  "timezoneOffset": -420,
  "type": "basal",
  "uploadId": "0d92d5c1c22117a18f3620b9e24d3c06",
  "deliveryType": "automated",
  "duration": 604800000,
  "expectedDuration": 604800000,
  "insulinFormulation": {
    "compounds": [ … ],
    "name": "string"
  },
  "rate": 100,
  "scheduleName": "string",
  "suppressed": {
    "type": "basal",
    "deliveryType": "scheduled",
    "rate": 100,
    "insulinFormulation": { … },
    "scheduleName": "string",
    "annotations": [ … ]
  }
}

Basal Scheduled

A scheduled basal delivery event.

annotationsArray of Annotation (object) or Blood Glucose Out of Range (object)(Annotation Array)[ 0 .. 100 ] itemsunique

An array of annotations.

archivedTimestring(date-time)(Date/Time)read-only

RFC 3339 / ISO 8601 timestamp with timezone information

Example: "2017-02-06T02:37:46Z"
archivedDatasetIdstring(Data Set ID)[ 17 .. 37 ] characters^(upid_[0-9a-f]{12}|upid_[0-9a-f]{32}|[0-9a-f...
Example: "ce8cc5f7595575945f91fc6710db6fef"
associationsArray of Association (blob) (object) or Association (datum) (object) or Association (image) (object) or Association (url) (object)(Association Array)

An array of associations for the resource.

clockDriftOffsetinteger(int64)(Clock Drift Offset)[ -86400000 .. 86400000 ]

Clock drift offset, expressed as milliseconds.

Example: 0
conversionOffsetinteger(int64)(Conversion Offset)

Conversion offset, expressed as milliseconds.

Example: 0
createdTimestring(date-time)(Date/Time)

RFC 3339 / ISO 8601 timestamp with timezone information

Example: "2017-02-06T02:37:46Z"
createdUserIdstring(Tidepool User ID)^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...read-only

String representation of a Tidepool User ID. Old style IDs are 10-digit strings consisting of only hexadeximcal digits. New style IDs are 36-digit UUID v4

deduplicatorobject(Deduplicator Descriptor)
deletedTimestring(date-time)(Date/Time)

RFC 3339 / ISO 8601 timestamp with timezone information

Example: "2017-02-06T02:37:46Z"
deletedUserIdstring(Tidepool User ID)^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...read-only

String representation of a Tidepool User ID. Old style IDs are 10-digit strings consisting of only hexadeximcal digits. New style IDs are 36-digit UUID v4

deviceIdstring(Device ID)non-empty

Globally unique to device and repeatable with each upload, e.g. device make and model with serial number

Example: "MMT-1711:12345678"
deviceTimestring(Date/Time without Timezone)^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$

RFC 3339 / ISO 8601 timestamp without timezone information

Example: "2017-02-06T02:37:46"
historyArray of objects(Event History [Proposed])

Revision history of the event

idstring(Data Set ID)[ 17 .. 37 ] characters^(upid_[0-9a-f]{12}|upid_[0-9a-f]{32}|[0-9a-f...required
Example: "ce8cc5f7595575945f91fc6710db6fef"
locationobject(Location)

Location information associated with the resource. One or both of name and gps must be specified.

modifiedTimestring(date-time)(Date/Time)

RFC 3339 / ISO 8601 timestamp with timezone information

Example: "2017-02-06T02:37:46Z"
modifiedUserIdstring(Tidepool User ID)^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...read-only

String representation of a Tidepool User ID. Old style IDs are 10-digit strings consisting of only hexadeximcal digits. New style IDs are 36-digit UUID v4

notesArray of strings(Note Array)[ 1 .. 100 ] items

An array of 1 to 100 notes.

originobject(Origin)

External origin information for the source of the resource.

payloadobject(Payload)

Grab bag field for data that isn't yet part of the data model. The maximum size is 4K bytes.

sourcestring
Value"carelink"
tagsArray of strings(Tag Array)

An array of tags.

timestring(date-time)(Date/Time)required

RFC 3339 / ISO 8601 timestamp with timezone information

Example: "2017-02-06T02:37:46Z"
timezonestring(Time Zone)

A string timezone name from the IANA timezone database

Example: "Europe/London"
timezoneOffsetinteger(int32)(Time Zone offset)[ -10080 .. 10080 ]

Time zone offset, expressed as positive or negative number of minutes from UTC.

Example: -420
typestring(Tidepool Data Type)required

Data type

Enum"basal""alert""bloodKetone""bolus""cbg""cgmSettings""controllerSettings""controllerStatus""deviceEvent""deviceStatus"
Example: "upload"
uploadIdstring(Upload ID)[ 17 .. 32 ] characters^([0-9a-f]{32}|upid_[0-9a-f]{12})$

An upload identifier; this field should be the uploadId of the corresponding upload record

Example: "0d92d5c1c22117a18f3620b9e24d3c06"
deliveryTypestring(Delivery Type)

This defines the basal delivery type, used to differentiate between automated, scheduled, suspended and temporary basal types.

Enum"scheduled""automated""suspend""temp"
durationinteger(int64)(Insulin Delivery Duration)[ 0 .. 604800000 ]

An integer value representing a duration of time in milliseconds.

expectedDurationinteger(int64)(Expected Insulin Delivery Duration)[ 0 .. 604800000 ]

An integer value representing an original programmed duration of time in milliseconds, copied from the duration field on ingestion when a following event has resulted in truncation of the original programmed duration.

expectedDuration cannot be less than the value of duration

insulinFormulationInsulin Formulation (object)(Insulin Formulation)
One of:
ratenumber(double)(Insulin Delivery Rate)[ 0 .. 100 ]

A floating point number >= 0 representing the amount of insulin delivered in units per hour.

scheduleNamestring(Insulin Delivery Schedule Name)[ 1 .. 1000 ] characters

The name of the basal schedule.

guidstringDeprecated

A string ID. Added to each event during data processing in the Tidepool Uploader or upon ingestion by the platform data ingestion service.

{
  "annotations": [
    { … }
  ],
  "archivedTime": "2017-02-06T02:37:46Z",
  "archivedDatasetId": "ce8cc5f7595575945f91fc6710db6fef",
  "associations": [
    { … }
  ],
  "clockDriftOffset": 0,
  "conversionOffset": 0,
  "createdTime": "2017-02-06T02:37:46Z",
  "createdUserId": "string",
  "deduplicator": {
    "hash": "string",
    "version": "2.36.1",
    "name": "org.tidepool.uploader"
  },
  "deletedTime": "2017-02-06T02:37:46Z",
  "deletedUserId": "string",
  "deviceId": "MMT-1711:12345678",
  "deviceTime": "2017-02-06T02:37:46",
  "guid": "string",
  "history": [
    { … }
  ],
  "id": "ce8cc5f7595575945f91fc6710db6fef",
  "location": {
    "name": "string",
    "gps": { … }
  },
  "modifiedTime": "2017-02-06T02:37:46Z",
  "modifiedUserId": "string",
  "notes": [
    "string"
  ],
  "origin": {
    "id": "string",
    "name": "string",
    "payload": {},
    "time": "2017-02-06T02:37:46Z",
    "type": "device",
    "version": "string"
  },
  "payload": {},
  "source": "carelink",
  "tags": [
    "string"
  ],
  "time": "2017-02-06T02:37:46Z",
  "timezone": "Europe/London",
  "timezoneOffset": -420,
  "type": "basal",
  "uploadId": "0d92d5c1c22117a18f3620b9e24d3c06",
  "deliveryType": "scheduled",
  "duration": 604800000,
  "expectedDuration": 604800000,
  "insulinFormulation": {
    "compounds": [ … ],
    "name": "string"
  },
  "rate": 100,
  "scheduleName": "string"
}