Skip to main content

Oura api client.

Project description


Easiest way is to get it from PyPI:

pip install oura

Getting started

Both personal access tokens and oauth flows are supported by the API (and by this library). For personal use, the simplest way to start is by getting yourself a PAT and supplying it to a client:

client = OuraClient(personal_access_token="MY_TOKEN")

If you are using oauth, there are a few more steps. First, register an application Then you can use this sample script to authorize access to your own data or some test account data. It will follow the auth code flow and print out the token response. Make sure to add localhost:3030 to the redirect uris for your app (the port can be changed in the script).

./ <client-id> <client-secret>

Some sample code is located in the samples directory, maybe it will be useful for you. Maybe it will change your life for the better. Maybe it will cause you to rethink using this project at all. Let me know the outcome if you feel like it.

Business time

If you are writing a real application, use the following pattern. Basically, the work is done by the underlying oauthlib to use the refresh token whenever the access token has expired, and you supply the refresh callback to save the new tokens for next time. This seems to have worked fine for me, but I don't actually use this library that much

from oura import OuraClient, OuraOAuth2Client

auth_client = OuraOAuth2Client(client_id='my_application', client_secret='random-string')
url = auth_client.authorize_endpoint(scope='defaults to all scopes', 'https://localhost/myendpoint')
# user clicks url, auth happens, then redirect to given url

Now we handle the redirect by exchanging an auth code for a token

# save this somewhere, see below
token_dict = auth_client.fetch_access_token(code='auth_code_from_query_string')

Now that's out of the way, you can call the api:

# supply all the params for auto refresh
oura = OuraClient(<client_id>, <client_secret> <access_token>, <refresh_token>, <refresh_callback>)

# or just these for make calls until token expires
oura = OuraClient(<client_id>, <access_token>)

# make authenticated API calls
oura.sleep_summary(start='2018-12-05', end='2018-12-10')

The refresh_callback is a fuction that takes a token dict and saves it somewhere. It will look like:

{'token_type': 'bearer', 'refresh_token': <refresh>, 'access_token': <token>, 'expires_in': 86400, 'expires_at': 1546485086.3277025}

Working with pandas

You can also make requests and have the data converted to pandas dataframes by using the pandas client. Some customization is available but subject to future improvement.

client = OuraClientDataFrame(...)
bedtime = client.bedtime_df(start, end, convert=True)

In [3]: client.bedtime_df()
              bedtime_window                   status
  2020-03-17  {'start': -3600, 'end': 0} IDEAL_BEDTIME_AVAILABLE
  2020-03-18  {'start': None, 'end': None} LOW_SLEEP_SCORES

Live your life.

Project details

Download files

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

Files for oura, version 1.1.4
Filename, size File type Python version Upload date Hashes
Filename, size oura-1.1.4-py2.py3-none-any.whl (11.1 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size oura-1.1.4.tar.gz (11.4 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page