Skip to main content

Python API to interact with Dexcom Share API

Project description

PyPI Python versions Pre-commit Tests Docs

A simple Python API to interact with Dexcom Share service. Used to get real-time Dexcom CGM sensor data.

Quick-start

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

  1. Install the pydexcom package.

pip install pydexcom

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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pydexcom-0.5.1.tar.gz (22.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pydexcom-0.5.1-py3-none-any.whl (11.0 kB view details)

Uploaded Python 3

File details

Details for the file pydexcom-0.5.1.tar.gz.

File metadata

  • Download URL: pydexcom-0.5.1.tar.gz
  • Upload date:
  • Size: 22.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for pydexcom-0.5.1.tar.gz
Algorithm Hash digest
SHA256 1789408929547d8cb48a53369cc0f1b25f0377e5770e9eb2f4e7c249d8325d2e
MD5 b85cb7884c0c46cd7a15bdc06b700e7a
BLAKE2b-256 7510f1682348db56733d8bd85c5582dd6ad37c4612cb4d36c9b24e5c109e3e3a

See more details on using hashes here.

Provenance

The following attestation bundles were made for pydexcom-0.5.1.tar.gz:

Publisher: publish.yaml on gagebenne/pydexcom

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pydexcom-0.5.1-py3-none-any.whl.

File metadata

  • Download URL: pydexcom-0.5.1-py3-none-any.whl
  • Upload date:
  • Size: 11.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for pydexcom-0.5.1-py3-none-any.whl
Algorithm Hash digest
SHA256 cf009d9360c8c3c64c73c07d55a9e30831f2094fd9a243535cde78f8cfa549cb
MD5 7c7590b46015f46a3fe9f372039b81c0
BLAKE2b-256 28ba38ccac326421383ab3cec4c2f61005fc123093c99f2460ed8c98f023ab1a

See more details on using hashes here.

Provenance

The following attestation bundles were made for pydexcom-0.5.1-py3-none-any.whl:

Publisher: publish.yaml on gagebenne/pydexcom

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page