Skip to content

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
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

Data Source ID

string(Data Source ID)= 32 characters^[0-9a-f]{32}$
"c0ce05326529c6b35b0f4a568a344026"

Data Source State

State of the data source.

string(Data Source State)

State of the data source.

Enum"connected""disconnected""error"
"connected"

Data Source

Data source for diabetes data.

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

RFC 3339 / ISO 8601 timestamp with timezone information

Example: "2017-02-06T02:37:46Z"
dataSetIdsArray of strings(Data Set ID Array)non-emptyuniquerequired

An array of data set IDs. The IDs in the array must be unique.

Example: ["ce8cc5f7595575945f91fc6710db6fef"]
earliestDataTimestring(date-time)(Date/Time)required

RFC 3339 / ISO 8601 timestamp with timezone information

Example: "2017-02-06T02:37:46Z"
idstring(Data Source ID)= 32 characters^[0-9a-f]{32}$required
Example: "c0ce05326529c6b35b0f4a568a344026"
lastImportTimestring(date-time)(Date/Time)required

RFC 3339 / ISO 8601 timestamp with timezone information

Example: "2017-02-06T02:37:46Z"
latestDataTimestring(date-time)(Date/Time)required

RFC 3339 / ISO 8601 timestamp with timezone information

Example: "2017-02-06T02:37:46Z"
modifiedTimestring(date-time)(Date/Time)

RFC 3339 / ISO 8601 timestamp with timezone information

Example: "2017-02-06T02:37:46Z"
providerNamestring(Provider Name)[ 1 .. 100 ] charactersrequired
Example: "dexcom"
providerSessionIdstring(Provider Session ID)^[0-9a-z]{32}$required
providerTypestring(Provider Type)required
Value"oauth"
Example: "oauth"
revisioninteger(int32)
statestring(Data Source State)required

State of the data source.

Enum"connected""disconnected""error"
Example: "connected"
userIdstring(Tidepool User ID)^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...read-onlyrequired

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

{ "createdTime": "2017-02-06T02:37:46Z", "dataSetIds": [ "ce8cc5f7595575945f91fc6710db6fef" ], "earliestDataTime": "2017-02-06T02:37:46Z", "id": "c0ce05326529c6b35b0f4a568a344026", "lastImportTime": "2017-02-06T02:37:46Z", "latestDataTime": "2017-02-06T02:37:46Z", "modifiedTime": "2017-02-06T02:37:46Z", "providerName": "dexcom", "providerSessionId": "string", "providerType": "oauth", "revision": 0, "state": "connected", "userId": "string" }