Python API to interact with Dexcom Share API
Project description
A simple Python API to interact with Dexcom Share service. Used to get real-time Dexcom CGM sensor data.
Quick-start
- Download the Dexcom G7 / G6 / G5 / G4 mobile app and enable the Share service.
The Dexcom Share service requires setup of at least one follower to enable the share service, but pydexcom
will use your (or the dependent's) credentials, not the follower's or manager's.
- Install the
pydexcom
package.
pip install pydexcom
- Profit.
>>> from pydexcom import Dexcom
>>> dexcom = Dexcom(username="username", password="password") # `region="ous"` if outside of US, `region="jp"` if Japan
>>> dexcom = Dexcom(username="+11234567890", password="password") # phone number
>>> dexcom = Dexcom(username="user@email.com", password="password") # email address
>>> dexcom = Dexcom(account_id="12345678-90ab-cdef-1234-567890abcdef", password="password") # account ID (advanced)
>>> glucose_reading = dexcom.get_current_glucose_reading()
>>> print(glucose_reading)
85
>>> glucose_reading.value
85
>>> glucose_reading.mmol_l
4.7
>>> glucose_reading.trend
4
>>> glucose_reading.trend_direction
'Flat'
>>> glucose_reading.trend_description
'steady'
>>> glucose_reading.trend_arrow
'→'
>>> print(bg.datetime)
2023-08-07 20:40:58
>>> glucose_reading.json
{'WT': 'Date(1691455258000)', 'ST': 'Date(1691455258000)', 'DT': 'Date(1691455258000-0400)', 'Value': 85, 'Trend': 'Flat'}
Documentation
https://gagebenne.github.io/pydexcom/pydexcom.html
Frequently Asked Questions
Why is my password not working?
The Dexcom Share API understandably reports limited information during account validation. If anything is incorrect, the API simply reports back invalid password ( pydexcom.errors.AccountErrorEnum
). However, there could be many reasons you are getting this error:
1. Ensure your credentials are valid.
Validate your Dexcom account credentials by logging on to the Dexcom Account Management website for your region:
For users in the United States: uam1.dexcom.com. For users outside of the United States: uam2.dexcom.com. For users in the Asia-Pacific: uam.dexcom.jp.
2. Use the correct Dexcom Share API endpoint.
For users in the United States: use the default, or set region="us"
when initializing Dexcom
.
For users outside of the United States: be sure to set region="ous"
when initializing Dexcom
.
For users in Japan: be sure to set region="jp"
when initializing Dexcom
.
3. Ensure your username is correctly formatted.
Format phone numbers with a +
, your country code, then your phone number. For example, a US phone number of (123)-456-7890
would be supplied as a username="+11234567890"
.
4. Use your Dexcom Share credentials, not the follower's credentials.
Use the same credentials used to login to the Dexcom mobile application publishing the glucose readings.
5. Ensure you have at least one follower on Dexcom Share.
The Dexcom Share service requires setup of at least one follower to enable the service, as does this package.
6. Try using your account ID.
You can find your account ID by logging in to Dexcom Account Management website for your region. After logging in, note the UUID in the URL -- this is your account ID.
Format account IDs (UUIDs) with hyphens. For example, an account ID of 1234567890abcdef1234567890abcdef
found in the URL after logging in would be supplied as account_id="12345678-90ab-cdef-1234-567890abcdef"
.
7. Report it!
The Dexcom Share API sometimes changes. If you believe there is an issue with pydexcom
, feel free to create an issue if one has not been created yet already.
Why not use the official Dexcom Developer API?
The official Dexcom API is a great tool to view trends, statistics, and day-by-day data, but is not suitable for real time fetching of glucose readings as it is a retrospective API.
Can I use the Dexcom Stelo with this package?
No, the Dexcom Stelo isn't compatible with the Dexcom Share service, so this package can't retrieve its readings.
How can I let you know of suggestions or issues?
By all means submit a pull request if you have a feature you would like to see in the next release. Alternatively, you may create an issue if you have a suggestion or bug you'd like to report.
Where is this package being used?
Primarily this package is used in the Home Assistant Dexcom integration, but it's fantastic to see community projects involving pydexcom
:
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file pydexcom-0.4.1.tar.gz
.
File metadata
- Download URL: pydexcom-0.4.1.tar.gz
- Upload date:
- Size: 19.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.1.1 CPython/3.12.7
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0e308ce4b5370a4e8bbb6a62b6ae881eef11de808d2dae0e163945758d6528b5 |
|
MD5 | f3d5fd062105f11b3d8e153cf7ce182d |
|
BLAKE2b-256 | 1f139098360c3af3453404f6b4dc5ef5b238aaf0466ba89bc3eee1f6d4f02eba |
Provenance
File details
Details for the file pydexcom-0.4.1-py3-none-any.whl
.
File metadata
- Download URL: pydexcom-0.4.1-py3-none-any.whl
- Upload date:
- Size: 9.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.1.1 CPython/3.12.7
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | b72d2c185f6cc81de3e7f4ee6af0c0eba234adaf0a9d931e143a521be35c937d |
|
MD5 | 0a27d4a4733947209fa9042142fc4164 |
|
BLAKE2b-256 | df4f404385bed8f8059c5c7469b27cfcecb48c5e4ff2dcdc6ad367661d02ddaa |