Fitbit API Data Extraction Project Summary

1. Project Overview

This project facilitates the extraction of various health metrics from Fitbit devices:

• ECG Table: Extracts electrocardiogram data
• Daily Summary Table: Retrieves sleep, respiratory rate, and body temperature data
• Minutes Table: Collects minute-by-minute step count, heart rate, SpO2, and heart rate variability data

2. Functionality

• Utilizes OAuth 2.0 for secure API authentication
• Retrieves data from Fitbit's servers via API calls
• Processes and exports data into structured CSV files

3. Data Type Distinctions

• ECG and Minutes data: Provide high-frequency, detailed information
• Daily Summary: Offers aggregated daily metrics

4. Application Credentials

Users have two options for API access:

a. Utilize provided credentials:

• Client ID: 23PHMD
• Client Secret: 0ce3a7d7167a733fd9a3b5c23a3438f6
• Redirect URL: http://127.0.0.1:8080/

b. Create a personal Fitbit developer application:

1. Visit https://dev.fitbit.com/
2. Select "Manage" and click 'Register An App'
3. Register or log in and create a new application
4. Select "Personal" for OAuth 2.0 Application Type
5. Set Callback URL to http://127.0.0.1:8080/
6. Select "Save"

Note: You can put in anything for Application Name, Description, Application Website URL, Organization, Organization Website URL, Terms of Service URL, Privacy Policy URL as long as it doesn't include the word 'fitbit'.

5. Execution Instructions

1. Install Python and required libraries (requests, pandas)
2. Insert appropriate Client ID and Client Secret into the scripts (if you're using our own developer app otherwise just start execution of script)
3. Execute required script via command line: python script_name.py
4. Input the desired date for data extraction
5. For initial authorization, use the following URL:

   https://www.fitbit.com/oauth2/authorize?response_type=code&client_id=CLIENT_ID_HERE&redirect_uri=http%3A%2F%2F127.0.0.1%3A8080%2F&scope=oxygen_saturation%20electrocardiogram%20sleep%20respiratory_rate%20activity%20heartrate%20temperature%20settings

6. Replace CLIENT_ID_HERE with 23PHMD if using provided credentials, or your personal Client ID if using a self-created application
7. Input the resulting authorization code when prompted

6. Authorization Code

• A temporary code Fitbit provides to allow the app to access your data
• Appears as a long string of letters and numbers, typically ending with a "#"
• Found in the URL after approving access
• Example: After approval, you'll be redirected to a URL like:

  http://127.0.0.1:8080/?code=1234abcd5678efgh9012ijkl3456mnop#_=_

• The authorization code here is: 1234abcd5678efgh9012ijkl3456mnop
• When entering this into the script:
  1. Copy the authorization code
  2. Do not include anything that comes after "#" (including #)
  3. Paste it into the script when prompted

7. Output

• The scripts generate CSV files containing the extracted Fitbit data
• Output files are saved in the same directory as the executed script

8. Best Practices

• Maintain the fitbit_tokens.json file in the script directory
• Re-authorize if authentication errors occur