Skip to content
Tidepool API/Data API/
/
Insulin Formulation

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 Simple

actingTypestringrequired
Enum"intermediate""long""rapid""short"
brandstring[ 1 .. 100 ] characters
concentrationobject(Insulin Concentration)
{
  "actingType": "intermediate",
  "brand": "string",
  "concentration": {
    "value": 10000,
    "units": "Units/mL"
  }
}

Insulin Formulation

One of:
compoundsArray of objects(Insulin Compound Array)[ 1 .. 100 ] items
namestring[ 1 .. 100 ] characters
{
  "simple": {
    "actingType": "intermediate",
    "brand": "string",
    "concentration": { … }
  },
  "name": "string"
}

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": [
    { … }
  ]
}