Skip to content
Tidepool API/Data API/
/
Bolus Calculator

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

Insulin Recommended

An object encoding the amount of insulin calculated as a recommended dose to "cover" the bgInput and carbInput, possibly taking into account the insulinOnBoard.

netnumber(float)[ -100 .. 100 ]

A floating point value representing units of insulin.

Floating point value rounded to the appropriate significant figures for the device's precision.

correctionnumber(float)[ -100 .. 100 ]

A floating point value representing units of insulin.

Floating point value rounded to the appropriate significant figures for the device's precision.

carbnumber(float)[ 0 .. 100 ]

A floating point value representing units of insulin.

Floating point value rounded to the appropriate significant figures for the device's precision.

{
  "net": -100,
  "correction": -100,
  "carb": 100
}

Bolus Calculator

An abstract base data type for all Tidepool diabetes data objects.

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"wizard""alert""basal""bloodKetone""bolus""cbg""cgmSettings""controllerSettings""controllerStatus""deviceEvent"
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"
bgInputBlood Value (mg/dL) (integer) or Blood Value (mmol/L) (number)(Blood Value (in mg/dL or mmol/L units))
One of:

An integer value representing a mg/dL value.

[ 0 .. 1000 ]
integer(int32)(Blood Value (mg/dL))[ 0 .. 1000 ]

An integer value representing a mg/dL value.

bgTargetBlood Glucose Target Value (mg/dL) (object) or Blood Glucose Target Value (mmol/L) (object)(Blood Glucose Target)
One of:

Blood glucose target values, in mg/dL

bolusany

The bolus event resulting from this wizard event.

carbInputinteger(int32)[ 0 .. 1000 ]

An integer encoding the PWD's carbohydrate input into the bolus calculator.

insulinCarbRationumber(double)[ 0 .. 250 ]

An integer encoding the grams of carbohydrate "covered" by one unit of insulin for the PWD.

insulinOnBoardnumber(float)[ 0 .. 250 ]

A floating point value representing units of insulin.

insulinSensitivityBlood Value (mg/dL) (integer) or Blood Value (mmol/L) (number)(Blood Value (in mg/dL or mmol/L units))
One of:

An integer value representing a mg/dL value.

[ 0 .. 1000 ]
integer(int32)(Blood Value (mg/dL))[ 0 .. 1000 ]

An integer value representing a mg/dL value.

recommendedobject(Insulin Recommended)

An object encoding the amount of insulin calculated as a recommended dose to "cover" the bgInput and carbInput, possibly taking into account the insulinOnBoard.

unitsstring
carbUnitsstring(Carbohydrate Units)
Enum"grams""exchanges"
Example: "grams"
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": "wizard",
  "uploadId": "0d92d5c1c22117a18f3620b9e24d3c06",
  "bgInput": 105,
  "bgTarget": {
    "high": 180,
    "low": 80
  },
  "bolus": null,
  "carbInput": 1000,
  "insulinCarbRatio": 250,
  "insulinOnBoard": 250,
  "insulinSensitivity": 105,
  "recommended": {
    "net": -100,
    "correction": -100,
    "carb": 100
  },
  "units": "string",
  "carbUnits": "grams"
}

CGM Settings

An abstract base data type for all Tidepool diabetes data objects.

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"cgmSettings""alert""basal""bloodKetone""bolus""cbg""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"
firmwareVersionstring[ 1 .. 100 ] characters
Example: "1.2"
hardwareVersionstring[ 1 .. 100 ] characters
Example: "2.3r45"
highAlertsobject
lowAlertsobject
manufacturersArray of strings[ 1 .. 10 ] characters
Example: ["Acme"]
modelstring[ 1 .. 100 ] characters
Example: "Turbo CGM III"
namestring[ 1 .. 100 ] characters
Example: "My CGM"
outOfRangeAlertsobject
rateOfChangeAlertobject
serialNumberstring[ 1 .. 100 ] characters
Example: "1234567890"
softwareVersionstring[ 1 .. 100 ] characters
Example: "3.4.5"
transmitterIdstring
Example: "G8X568"
unitsstring
Enum"mg/dL""mmol/L"
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": "cgmSettings",
  "uploadId": "0d92d5c1c22117a18f3620b9e24d3c06",
  "firmwareVersion": "1.2",
  "hardwareVersion": "2.3r45",
  "highAlerts": {
    "enabled": true,
    "level": 105,
    "snooze": 86400000
  },
  "lowAlerts": {
    "enabled": true,
    "level": 105,
    "snooze": 86400000
  },
  "manufacturers": [
    "Acme"
  ],
  "model": "Turbo CGM III",
  "name": "My CGM",
  "outOfRangeAlerts": {
    "enabled": true,
    "snooze": 86400000
  },
  "rateOfChangeAlert": {
    "fallRate": { … },
    "riseRate": { … }
  },
  "serialNumber": "1234567890",
  "softwareVersion": "3.4.5",
  "transmitterId": "G8X568",
  "units": "mg/dL"
}