Skip to content
Tidepool API/Data API/
/
Client Software

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

Metadata

property name*anyadditional property
{}

Client Software

The client software that provided diabetes data.

namestring(Reverse Domain Name)^[a-zA-Z0-9](|[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])(...required

Name in the reverse domain name notation.

Example: "org.tidepool.uploader"
versionstring(Semantic Version Number)>= 5 characters^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-...required

Semantic Version Number 2.0.0. Regex from their site.

Example: "2.36.1"
platformstring(Client Software Platform)

The software platform on which the client software was run.

Example: "macOS 10.15.4"
privateobject(Metadata)
{
  "name": "org.tidepool.uploader",
  "version": "2.36.1",
  "platform": "macOS 10.15.4",
  "private": {}
}

Clock Drift Offset

Clock drift offset, expressed as milliseconds.

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

Clock drift offset, expressed as milliseconds.

0