Document the Share API #15

timberFrame · 2015-04-03T04:10:44Z

I'd like to access the data in other places, such as a Query Table in Microsoft Excel. Could you add a file that documents the Share API?

bewest · 2016-03-03T20:02:16Z

This helps!
https://gist.github.com/StephenBlackWasAlreadyTaken/adb0525344bedade1e25

bewest · 2016-03-03T20:04:05Z

https://share1.dexcom.com/

these are the calls used by the dexcom uploader app
these are in no particular order!
User-Agent: Dexcom%20Share/3.0.2.11 CFNetwork/672.0.2 Darwin/14.0.0

General

Read Dexcoms System time clock

GET

/ShareWebServices/Services/General/SystemUtcTime

Body:

  none

Response:

  {
    "DateTime":"\/Date(1426767421178)\/",
    "OffsetMinutes":0
  }

Session Related

Login to a Publisher Account (Get a Session ID):

POST

/ShareWebServices/Services/General/LoginPublisherAccountByName

Body:

  {
    "accountName":"yourlogin",
    "applicationId":"d8665ade-9673-4e27-9ff6-92db4ce13d13",
    "password":"yourpassword"
  }

Response:

  "e3e3e6a5-coolsessionid-bro”

Authenticate Publisher Account (Get a Session ID):

POST

/ShareWebServices/Services/General/AuthenticatePublisherAccount

Body:

  {
    "accountName":"yourlogin",
    "applicationId":"d8665ade-9673-4e27-9ff6-92db4ce13d13",
    "password":"yourpassword"
  }

Response:

  "e3e3e6a5-coolsessionid-bro”

Check if the Reciever is assigned to your account

POST

/ShareWebServices/Services/Publisher/CheckMonitoredReceiverAssignmentStatus?sessionId={YourSessionId}&serialNumber={YourSerialNumber}/

Body:

  none

Response:

  `AssignedToYou` or `NotAssigned` (plaintext)

Assign the reciever to you (If you got NotAssigned or something else)

POST

/ShareWebServices/Services/Publisher/ReplacePublisherAccountMonitoredReceiver?sessionId={YourSessionId}&serialNumber={YourSerialNumber}

Body:

  none

Response:

  No Idea, Someone please tell me, if you assign one to yourself that was
  already yours you get a 500 error

Check remote monitoring session is valid

POST

/ShareWebServices/Services/Publisher/IsRemoteMonitoringSessionActive?sessionId={YourSessionId}

Body:

  none

Response:

  `true` or `false` (plaintext)

Start remote monitoring session

POST

/ShareWebServices/Services/Publisher/StartRemoteMonitoringSession?sessionId={yoursessionid}&serialNumber={YourdexcomSerialNumber}

Body:

  none

Response:

  just a status, `200`

Stop a remote monitoring session

POST

/ShareWebServices/Services/Publisher/StopRemoteMonitoringSession?sessionId={YourSessionId}

Body:

  none

Response:

  just a status, `200`

Update Publisher information (might be fun for sending them cute messages?)

POST

/ShareWebServices/Services/Publisher/UpdatePublisherAccountRuntimeInfo

Body:

  {
    "sessionId":"YourSessionId",
    "runtimeInfo":
      {
        "DeviceManufacturer":"Apple",
        "DeviceModel":"iPhone5,2",
        "DeviceOsVersion":"7.0.2",
        "AppVersion":"3.0.2.11",
        "AppName":"DexcomShare",
        "AppNumber":"SW10569",
        "DeviceOsName":"iPhone OS"
      }
  }

Response:

  just a status, `200`

Data!

Post BG Data

POST

/ShareWebServices/Services/Publisher/PostReceiverEgvRecords?sessionId={yourSessionId}

Body:

{
  "SN":"YourSerialNumber",
  "Egvs":[
      {
        "Trend":4,
        "ST":"\/Date(1426783106000)\/",
        "DT":"\/Date(1426754317000)\/",
        "Value":97
      }
    ],
  "TA":-14365
}

Response:

  just a status, `200`

ST system time, DT display time, TA is a time offset, multiply by 1000 and subtract it from the time (so subtracting a negative in this example, which is really adding)

Read BG Data

POST

/ShareWebServices/Services/Publisher/ReadPublisherLatestGlucoseValues?sessionId={YourSessionId}&minutes=1440&maxCount=1

Body:

  none

Response:

[
  {
    "DT":"\/Date(1426780716000-0700)\/",
    "ST":"\/Date(1426784306000)\/",
    "Trend":4,
    "Value":99,
    "WT":"\/Date(1426769941000)\/"
  }
]

Invite Follower Related

Check if someone is already a contact of yours

POST

/ShareWebServices/Services/Publisher/DoesContactExistByName?sessionId={YourSessionId}&contactName={NameOfNewFollower}

Body:

  none

Response:

  `true` or `false` (plaintext)

Create a contact if they dont already exist

POST

/ShareWebServices/Services/Publisher/CreateContact?sessionId={YourSessionId}&contactName={FollowerName}&emailAddress={FollowerEmail}

Body:

  none

Response:

  a contact id (needed for the invite!), `123312-af1341123-coolid`

Send the invite!!

POST

/ShareWebServices/Services/Publisher/CreateSubscriptionInvitation?sessionId={YourSessionId}&contactId={ContactId}

Body:

  {
    "AlertSettings":{
      "HighAlert":{
        "MinValue":200,
        "AlarmDelay":"PT1H",
        "AlertType":1,
        "IsEnabled":false,
        "RealarmDelay":"PT2H",
        "Sound":"High.wav",
        "MaxValue":401
      },
      "LowAlert":{
        "MinValue":39,
        "AlarmDelay":"PT30M",
        "AlertType":2,
        "IsEnabled":false,
        "RealarmDelay":"PT2H",
        "Sound":"Low.wav",
        "MaxValue":70
      },
      "FixedLowAlert":{
        "MinValue":39,
        "AlarmDelay":"PT0M",
        "AlertType":3,
        "IsEnabled":true,
        "RealarmDelay":"PT30M",
        "Sound":"UrgentLow.wav",
        "MaxValue":55
      },
      "NoDataAlert":{
        "MinValue":39,
        "AlarmDelay":"PT1H",
        "AlertType":4,
        "IsEnabled":false,
        "RealarmDelay":"PT0M",
        "Sound":"NoData.wav",
        "MaxValue":401
      }
    },
    "Permissions":1,
    "DisplayName":"{YourAccountDisplayName}"
  }

Note that permissions 1 means they can view your graph data

Response:

  a subscriber id for the person you invited! (Usefull for updating their
  subscription permissions and such) `793312-af1341123-coolid`

List all Followers

POST

/ShareWebServices/Services/Publisher/ListPublisherAccountSubscriptions?sessionId={YourSessionId}

Body:

  none

Response:

  [
    {
      "ContactId":"FollowersContactId",
      "ContactName":"FollowersName",
      "DateTimeCreated":{
        "DateTime":"\/Date(1437101121008)\/",
        "OffsetMinutes":0
      },
      "DateTimeModified":{
        "DateTime":"\/Date(1437101121008)\/",
        "OffsetMinutes":0
      },
      "DisplayName":"YourDisplayName",
      "InviteExpires":{
        "DateTime":"\/Date(1437705921008)\/",
        "OffsetMinutes":0
      },
      "IsEnabled":false,
      "IsMonitoringSessionActive":true,
      "Permissions":1,
      "State":2,
      "SubscriberId":"00000000-0000-0000-0000-000000000000",
      "SubscriptionId":"theirSubscriptionIdIsuppose?"
    }
  ]

note: maybe we can use this subscription id to send our own custom invites to
followers

Delete Follower

POST

/ShareWebServices/Services/Publisher/DeleteContact?sessionId={YourSessionId}&contactId={followersContactId}

Body:

  none

Response:

  just a status, `200`

Still undocumented but logged if you need info on it (Not adding it all here out of lazziness)

getting the image
getting the subscription display name
getting the subscription email address
reading the contact list
sending changes to the contacts Permissions
removing a contact
follower aknowledging alarms
follower reading invitation info
follower accepting invitation
follower updating runtimeInfo
folower listing all their subscriptions
read subscription alerts

CURL examples for getting values from Dexcom

curl -v \
  -H "Accept: application/json" -H "Content-Type: application/json" \
  -H "User-Agent: Dexcom Share/3.0.2.11 CFNetwork/711.2.23 Darwin/14.0.0" \
  -X POST https://share1.dexcom.com/ShareWebServices/Services/General/LoginPublisherAccountByName \
  -d '{"accountName":"YOURLOGIN","applicationId":"d8665ade-9673-4e27-9ff6-92db4ce13d13","password":"YOURPASSWORD"}'

which should recieve a response like

"8c1234deb-323c-4e9d-8362-39cfa23499ed"

which you use to get values like

curl -v \
  -H "Content-Length: 0" -H "Accept: application/json" \
  -H "User-Agent: Dexcom Share/3.0.2.11 CFNetwork/672.0.2 Darwin/14.0.0" \
  -X POST "https://share1.dexcom.com/ShareWebServices/Services/Publisher/ReadPublisherLatestGlucoseValues?sessionId=8c1234deb-323c-4e9d-8362-39cfa23499ed&minutes=1440&maxCount=1"

bewest · 2016-03-03T20:04:17Z

(for archival purposes)

timberFrame · 2016-03-03T20:55:36Z

Thanks, Ben,
I use the Dexcom Share API every day with my decision support software.

What is the status of Open APS?

-Matt

On Mar 3, 2016, at 12:04 PM, Ben West notifications@github.com wrote:

(for archival purposes)

—
Reply to this email directly or view it on GitHub #15 (comment).

mattizem · 2016-12-16T16:27:58Z

Please note.
In Europe (at least Sweden) the endpoint for the seems to be;

https://shareous1.dexcom.com

And I would like to send a very big thanks for this documentation!

303brendan · 2017-06-01T21:52:41Z

Thank you, soo very much for documenting this! This is very helpful for some automated blood sugar to Datadog work I was working on.

I now am grabbing blood sugar data from Dexcom, then posting into Datadog so I have 15 months of data stored, and nicer UI for visualization!

303brendan · 2017-06-02T21:18:36Z

@bewest or @timberFrame, do you all know what the trend values correlate to? I seem to always see a value of 4, but would be nice to know how to indicate the rate of change without having to take previous value and current value to find rate of change.

303brendan · 2017-06-06T15:36:40Z

Disregard the above post, posting my findings below for anyone else wondering about the trend value:

if trend == 0:
trendtext = ""
if trend == 1:
trendtext = "rising quickly"
if trend == 2:
trendtext = "rising"
if trend == 3:
trendtext = "rising slightly"
if trend == 4:
trendtext = "steady"
if trend == 5:
trendtext = "falling slightly"
if trend == 6:
trendtext = "falling"
if trend == 7:
trendtext = "falling quickly"
if trend == 8:
trendtext = "unable to determine a trend"
if trend == 9:
trendtext = "trend unavailable"

ejj28 · 2017-07-31T19:58:52Z

@bewest Thanks for the documentation! Is there a way to get all BG data from within two points in time?

MrJarnould · 2017-11-27T17:29:58Z

@ejj28 you can do that with the official Dexcom API.
https://developer.dexcom.com/

ejj28 · 2017-12-08T03:58:32Z

@MrJarnould Yeah, I switched over to that when it came out.

fsallstrom · 2020-06-08T19:25:49Z

Hi, this is perhaps more a question to Dexcom developers but I try here to see if anyone has had a similar issue.

I am trying to build a client to connect to the dexcom server and having problems with the response from the LoginPublisherAccountByName call. The content-type in the response header states application/JSON but the response (session ID) does not really look like a valid JSON (more like a string), consequently my client refuses to accept the response and abort with INVALID_HTTP_BODY_IN_NETWORK_RESPONSE (-400). I have tried to play around with different response content-types but with no luck.

I just wanted to check if someone have had this issue and managed to work around it somhow. Thanks!
/Fredrik

bewest mentioned this issue Mar 3, 2016

get more data from share API #25

Open

1 task

kskandispersonal mentioned this issue Mar 6, 2019

Dexcom Follow Upload NightscoutFoundation/xDrip#814

Closed

This was referenced Apr 10, 2020

Connection to Dexcom share does not work #39

Closed

No new reading in Nightscout for over 15 hours nightscout/cgm-remote-monitor#5608

Closed

liamzebedee mentioned this issue Jul 22, 2020

Spec liamzebedee/nightscout-share-server-node#1

Open

aud mentioned this issue Aug 16, 2021

Question re this Dexcom API aud/dexcomedy#7

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Document the Share API #15

Document the Share API #15

timberFrame commented Apr 3, 2015

bewest commented Mar 3, 2016

bewest commented Mar 3, 2016

bewest commented Mar 3, 2016

timberFrame commented Mar 3, 2016

mattizem commented Dec 16, 2016 •

edited

303brendan commented Jun 1, 2017

303brendan commented Jun 2, 2017

303brendan commented Jun 6, 2017

ejj28 commented Jul 31, 2017 •

edited

MrJarnould commented Nov 27, 2017

ejj28 commented Dec 8, 2017

fsallstrom commented Jun 8, 2020

Document the Share API #15

Document the Share API #15

Comments

timberFrame commented Apr 3, 2015

bewest commented Mar 3, 2016

bewest commented Mar 3, 2016

https://share1.dexcom.com/

General

Read Dexcoms System time clock

Session Related

Login to a Publisher Account (Get a Session ID):

Authenticate Publisher Account (Get a Session ID):

Check if the Reciever is assigned to your account

Assign the reciever to you (If you got NotAssigned or something else)

Check remote monitoring session is valid

Start remote monitoring session

Stop a remote monitoring session

Update Publisher information (might be fun for sending them cute messages?)

Data!

Post BG Data

Read BG Data

Invite Follower Related

Check if someone is already a contact of yours

Create a contact if they dont already exist

Send the invite!!

List all Followers

Delete Follower

Still undocumented but logged if you need info on it (Not adding it all here out of lazziness)

CURL examples for getting values from Dexcom

bewest commented Mar 3, 2016

timberFrame commented Mar 3, 2016

mattizem commented Dec 16, 2016 • edited

https://shareous1.dexcom.com

303brendan commented Jun 1, 2017

303brendan commented Jun 2, 2017

303brendan commented Jun 6, 2017

ejj28 commented Jul 31, 2017 • edited

MrJarnould commented Nov 27, 2017

ejj28 commented Dec 8, 2017

fsallstrom commented Jun 8, 2020

mattizem commented Dec 16, 2016 •

edited

ejj28 commented Jul 31, 2017 •

edited