/usr/share/doc/python-fitbit/html/index.html is in python-fitbit-doc 0.3.0-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Overview — Python-Fitbit 0.3.0 documentation</title>
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '0.3.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
</head>
<body>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="overview">
<h1>Overview<a class="headerlink" href="#overview" title="Permalink to this headline">¶</a></h1>
<p>This is a complete python implementation of the Fitbit API.</p>
<p>It uses oAuth for authentication, it supports both us and si
measurements</p>
</div>
<div class="section" id="quickstart">
<h1>Quickstart<a class="headerlink" href="#quickstart" title="Permalink to this headline">¶</a></h1>
<p>If you are only retrieving data that doesn’t require authorization, then you can use the unauthorized interface:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">fitbit</span>
<span class="n">unauth_client</span> <span class="o">=</span> <span class="n">fitbit</span><span class="o">.</span><span class="n">Fitbit</span><span class="p">(</span><span class="s1">'<consumer_key>'</span><span class="p">,</span> <span class="s1">'<consumer_secret>'</span><span class="p">)</span>
<span class="c1"># certain methods do not require user keys</span>
<span class="n">unauth_client</span><span class="o">.</span><span class="n">food_units</span><span class="p">()</span>
</pre></div>
</div>
<p>Here is an example of authorizing with OAuth 2.0:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="c1"># You'll have to gather the tokens on your own, or use</span>
<span class="c1"># ./gather_keys_oauth2.py</span>
<span class="n">authd_client</span> <span class="o">=</span> <span class="n">fitbit</span><span class="o">.</span><span class="n">Fitbit</span><span class="p">(</span><span class="s1">'<consumer_key>'</span><span class="p">,</span> <span class="s1">'<consumer_secret>'</span><span class="p">,</span>
<span class="n">access_token</span><span class="o">=</span><span class="s1">'<access_token>'</span><span class="p">,</span> <span class="n">refresh_token</span><span class="o">=</span><span class="s1">'<refresh_token>'</span><span class="p">)</span>
<span class="n">authd_client</span><span class="o">.</span><span class="n">sleep</span><span class="p">()</span>
</pre></div>
</div>
</div>
<div class="section" id="fitbit-api">
<h1>Fitbit API<a class="headerlink" href="#fitbit-api" title="Permalink to this headline">¶</a></h1>
<p>Some assumptions you should note. Anywhere it says user_id=None,
it assumes the current user_id from the credentials given, and passes
a <code class="docutils literal"><span class="pre">-</span></code> through the API. Anywhere it says date=None, it should accept
either <code class="docutils literal"><span class="pre">None</span></code> or a <code class="docutils literal"><span class="pre">date</span></code> or <code class="docutils literal"><span class="pre">datetime</span></code> object
(anything with proper strftime will do), or a string formatted
as <code class="docutils literal"><span class="pre">%Y-%m-%d</span></code>.</p>
<dl class="class">
<dt id="fitbit.Fitbit">
<em class="property">class </em><code class="descclassname">fitbit.</code><code class="descname">Fitbit</code><span class="sig-paren">(</span><em>client_id</em>, <em>client_secret</em>, <em>system='en_US'</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/fitbit/api.html#Fitbit"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#fitbit.Fitbit" title="Permalink to this definition">¶</a></dt>
<dd><dl class="method">
<dt id="fitbit.Fitbit._COLLECTION_RESOURCE">
<code class="descname">_COLLECTION_RESOURCE</code><span class="sig-paren">(</span><em>resource</em>, <em>date=None</em>, <em>user_id=None</em>, <em>data=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/fitbit/api.html#Fitbit._COLLECTION_RESOURCE"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#fitbit.Fitbit._COLLECTION_RESOURCE" title="Permalink to this definition">¶</a></dt>
<dd><p>Retrieving and logging of each type of collection data.</p>
<dl class="docutils">
<dt>Arguments:</dt>
<dd>resource, defined automatically via curry
[date] defaults to today
[user_id] defaults to current logged in user
[data] optional, include for creating a record, exclude for access</dd>
</dl>
<p>This implements the following methods:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">body</span><span class="p">(</span><span class="n">date</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">user_id</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">data</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span>
<span class="n">activities</span><span class="p">(</span><span class="n">date</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">user_id</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">data</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span>
<span class="n">foods_log</span><span class="p">(</span><span class="n">date</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">user_id</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">data</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span>
<span class="n">foods_log_water</span><span class="p">(</span><span class="n">date</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">user_id</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">data</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span>
<span class="n">sleep</span><span class="p">(</span><span class="n">date</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">user_id</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">data</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span>
<span class="n">heart</span><span class="p">(</span><span class="n">date</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">user_id</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">data</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span>
<span class="n">bp</span><span class="p">(</span><span class="n">date</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">user_id</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">data</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span>
</pre></div>
</div>
<ul class="simple">
<li><a class="reference external" href="https://dev.fitbit.com/docs/">https://dev.fitbit.com/docs/</a></li>
</ul>
</dd></dl>
<dl class="method">
<dt id="fitbit.Fitbit._DELETE_COLLECTION_RESOURCE">
<code class="descname">_DELETE_COLLECTION_RESOURCE</code><span class="sig-paren">(</span><em>resource</em>, <em>log_id</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/fitbit/api.html#Fitbit._DELETE_COLLECTION_RESOURCE"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#fitbit.Fitbit._DELETE_COLLECTION_RESOURCE" title="Permalink to this definition">¶</a></dt>
<dd><p>deleting each type of collection data</p>
<dl class="docutils">
<dt>Arguments:</dt>
<dd>resource, defined automatically via curry
log_id, required, log entry to delete</dd>
</dl>
<p>This builds the following methods:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">delete_body</span><span class="p">(</span><span class="n">log_id</span><span class="p">)</span>
<span class="n">delete_activities</span><span class="p">(</span><span class="n">log_id</span><span class="p">)</span>
<span class="n">delete_foods_log</span><span class="p">(</span><span class="n">log_id</span><span class="p">)</span>
<span class="n">delete_foods_log_water</span><span class="p">(</span><span class="n">log_id</span><span class="p">)</span>
<span class="n">delete_sleep</span><span class="p">(</span><span class="n">log_id</span><span class="p">)</span>
<span class="n">delete_heart</span><span class="p">(</span><span class="n">log_id</span><span class="p">)</span>
<span class="n">delete_bp</span><span class="p">(</span><span class="n">log_id</span><span class="p">)</span>
</pre></div>
</div>
</dd></dl>
<dl class="method">
<dt id="fitbit.Fitbit._food_stats">
<code class="descname">_food_stats</code><span class="sig-paren">(</span><em>user_id=None</em>, <em>qualifier=''</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/fitbit/api.html#Fitbit._food_stats"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#fitbit.Fitbit._food_stats" title="Permalink to this definition">¶</a></dt>
<dd><p>This builds the convenience methods on initialization:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">recent_foods</span><span class="p">(</span><span class="n">user_id</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">qualifier</span><span class="o">=</span><span class="s1">''</span><span class="p">)</span>
<span class="n">favorite_foods</span><span class="p">(</span><span class="n">user_id</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">qualifier</span><span class="o">=</span><span class="s1">''</span><span class="p">)</span>
<span class="n">frequent_foods</span><span class="p">(</span><span class="n">user_id</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">qualifier</span><span class="o">=</span><span class="s1">''</span><span class="p">)</span>
</pre></div>
</div>
<ul class="simple">
<li><a class="reference external" href="https://dev.fitbit.com/docs/food-logging/#get-favorite-foods">https://dev.fitbit.com/docs/food-logging/#get-favorite-foods</a></li>
<li><a class="reference external" href="https://dev.fitbit.com/docs/food-logging/#get-frequent-foods">https://dev.fitbit.com/docs/food-logging/#get-frequent-foods</a></li>
<li><a class="reference external" href="https://dev.fitbit.com/docs/food-logging/#get-recent-foods">https://dev.fitbit.com/docs/food-logging/#get-recent-foods</a></li>
</ul>
</dd></dl>
<dl class="method">
<dt id="fitbit.Fitbit._resource_goal">
<code class="descname">_resource_goal</code><span class="sig-paren">(</span><em>resource</em>, <em>data={}</em>, <em>period=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/fitbit/api.html#Fitbit._resource_goal"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#fitbit.Fitbit._resource_goal" title="Permalink to this definition">¶</a></dt>
<dd><p>Handles GETting and POSTing resource goals of all types</p>
</dd></dl>
<dl class="method">
<dt id="fitbit.Fitbit.accept_invite">
<code class="descname">accept_invite</code><span class="sig-paren">(</span><em>other_user_id</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/fitbit/api.html#Fitbit.accept_invite"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#fitbit.Fitbit.accept_invite" title="Permalink to this definition">¶</a></dt>
<dd><p>Convenience method for respond_to_invite</p>
</dd></dl>
<dl class="method">
<dt id="fitbit.Fitbit.activities_daily_goal">
<code class="descname">activities_daily_goal</code><span class="sig-paren">(</span><em>calories_out=None</em>, <em>active_minutes=None</em>, <em>floors=None</em>, <em>distance=None</em>, <em>steps=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/fitbit/api.html#Fitbit.activities_daily_goal"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#fitbit.Fitbit.activities_daily_goal" title="Permalink to this definition">¶</a></dt>
<dd><p>Implements the following APIs for period equal to daily</p>
<p><a class="reference external" href="https://dev.fitbit.com/docs/activity/#get-activity-goals">https://dev.fitbit.com/docs/activity/#get-activity-goals</a>
<a class="reference external" href="https://dev.fitbit.com/docs/activity/#update-activity-goals">https://dev.fitbit.com/docs/activity/#update-activity-goals</a></p>
<p>Pass no arguments to get the daily activities goal. Pass any one of
the optional arguments to set that component of the daily activities
goal.</p>
<p>Arguments:
* <code class="docutils literal"><span class="pre">calories_out</span></code> – New goal value; in an integer format
* <code class="docutils literal"><span class="pre">active_minutes</span></code> – New goal value; in an integer format
* <code class="docutils literal"><span class="pre">floors</span></code> – New goal value; in an integer format
* <code class="docutils literal"><span class="pre">distance</span></code> – New goal value; in the format X.XX or integer
* <code class="docutils literal"><span class="pre">steps</span></code> – New goal value; in an integer format</p>
</dd></dl>
<dl class="method">
<dt id="fitbit.Fitbit.activities_list">
<code class="descname">activities_list</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/fitbit/api.html#Fitbit.activities_list"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#fitbit.Fitbit.activities_list" title="Permalink to this definition">¶</a></dt>
<dd><p><a class="reference external" href="https://dev.fitbit.com/docs/activity/#browse-activity-types">https://dev.fitbit.com/docs/activity/#browse-activity-types</a></p>
</dd></dl>
<dl class="method">
<dt id="fitbit.Fitbit.activities_weekly_goal">
<code class="descname">activities_weekly_goal</code><span class="sig-paren">(</span><em>distance=None</em>, <em>floors=None</em>, <em>steps=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/fitbit/api.html#Fitbit.activities_weekly_goal"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#fitbit.Fitbit.activities_weekly_goal" title="Permalink to this definition">¶</a></dt>
<dd><p>Implements the following APIs for period equal to weekly</p>
<p><a class="reference external" href="https://dev.fitbit.com/docs/activity/#get-activity-goals">https://dev.fitbit.com/docs/activity/#get-activity-goals</a>
<a class="reference external" href="https://dev.fitbit.com/docs/activity/#update-activity-goals">https://dev.fitbit.com/docs/activity/#update-activity-goals</a></p>
<p>Pass no arguments to get the weekly activities goal. Pass any one of
the optional arguments to set that component of the weekly activities
goal.</p>
<p>Arguments:
* <code class="docutils literal"><span class="pre">distance</span></code> – New goal value; in the format X.XX or integer
* <code class="docutils literal"><span class="pre">floors</span></code> – New goal value; in an integer format
* <code class="docutils literal"><span class="pre">steps</span></code> – New goal value; in an integer format</p>
</dd></dl>
<dl class="method">
<dt id="fitbit.Fitbit.activity_detail">
<code class="descname">activity_detail</code><span class="sig-paren">(</span><em>activity_id</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/fitbit/api.html#Fitbit.activity_detail"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#fitbit.Fitbit.activity_detail" title="Permalink to this definition">¶</a></dt>
<dd><p><a class="reference external" href="https://dev.fitbit.com/docs/activity/#get-activity-type">https://dev.fitbit.com/docs/activity/#get-activity-type</a></p>
</dd></dl>
<dl class="method">
<dt id="fitbit.Fitbit.activity_stats">
<code class="descname">activity_stats</code><span class="sig-paren">(</span><em>user_id=None</em>, <em>qualifier=''</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/fitbit/api.html#Fitbit.activity_stats"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#fitbit.Fitbit.activity_stats" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li><a class="reference external" href="https://dev.fitbit.com/docs/activity/#activity-types">https://dev.fitbit.com/docs/activity/#activity-types</a></li>
<li><a class="reference external" href="https://dev.fitbit.com/docs/activity/#get-favorite-activities">https://dev.fitbit.com/docs/activity/#get-favorite-activities</a></li>
<li><a class="reference external" href="https://dev.fitbit.com/docs/activity/#get-recent-activity-types">https://dev.fitbit.com/docs/activity/#get-recent-activity-types</a></li>
<li><a class="reference external" href="https://dev.fitbit.com/docs/activity/#get-frequent-activities">https://dev.fitbit.com/docs/activity/#get-frequent-activities</a></li>
</ul>
<p>This implements the following methods:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">recent_activities</span><span class="p">(</span><span class="n">user_id</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">qualifier</span><span class="o">=</span><span class="s1">''</span><span class="p">)</span>
<span class="n">favorite_activities</span><span class="p">(</span><span class="n">user_id</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">qualifier</span><span class="o">=</span><span class="s1">''</span><span class="p">)</span>
<span class="n">frequent_activities</span><span class="p">(</span><span class="n">user_id</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">qualifier</span><span class="o">=</span><span class="s1">''</span><span class="p">)</span>
</pre></div>
</div>
</dd></dl>
<dl class="method">
<dt id="fitbit.Fitbit.add_alarm">
<code class="descname">add_alarm</code><span class="sig-paren">(</span><em>device_id</em>, <em>alarm_time</em>, <em>week_days</em>, <em>recurring=False</em>, <em>enabled=True</em>, <em>label=None</em>, <em>snooze_length=None</em>, <em>snooze_count=None</em>, <em>vibe='DEFAULT'</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/fitbit/api.html#Fitbit.add_alarm"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#fitbit.Fitbit.add_alarm" title="Permalink to this definition">¶</a></dt>
<dd><p><a class="reference external" href="https://dev.fitbit.com/docs/devices/#add-alarm">https://dev.fitbit.com/docs/devices/#add-alarm</a>
alarm_time should be a timezone aware datetime object.</p>
</dd></dl>
<dl class="method">
<dt id="fitbit.Fitbit.add_favorite_activity">
<code class="descname">add_favorite_activity</code><span class="sig-paren">(</span><em>activity_id</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/fitbit/api.html#Fitbit.add_favorite_activity"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#fitbit.Fitbit.add_favorite_activity" title="Permalink to this definition">¶</a></dt>
<dd><p><a class="reference external" href="https://dev.fitbit.com/docs/activity/#add-favorite-activity">https://dev.fitbit.com/docs/activity/#add-favorite-activity</a></p>
</dd></dl>
<dl class="method">
<dt id="fitbit.Fitbit.add_favorite_food">
<code class="descname">add_favorite_food</code><span class="sig-paren">(</span><em>food_id</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/fitbit/api.html#Fitbit.add_favorite_food"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#fitbit.Fitbit.add_favorite_food" title="Permalink to this definition">¶</a></dt>
<dd><p><a class="reference external" href="https://dev.fitbit.com/docs/food-logging/#add-favorite-food">https://dev.fitbit.com/docs/food-logging/#add-favorite-food</a></p>
</dd></dl>
<dl class="method">
<dt id="fitbit.Fitbit.body_fat_goal">
<code class="descname">body_fat_goal</code><span class="sig-paren">(</span><em>fat=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/fitbit/api.html#Fitbit.body_fat_goal"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#fitbit.Fitbit.body_fat_goal" title="Permalink to this definition">¶</a></dt>
<dd><p>Implements the following APIs</p>
<ul class="simple">
<li><a class="reference external" href="https://dev.fitbit.com/docs/body/#get-body-goals">https://dev.fitbit.com/docs/body/#get-body-goals</a></li>
<li><a class="reference external" href="https://dev.fitbit.com/docs/body/#update-body-fat-goal">https://dev.fitbit.com/docs/body/#update-body-fat-goal</a></li>
</ul>
<p>Pass no arguments to get the body fat goal. Pass a <code class="docutils literal"><span class="pre">fat</span></code> argument
to update the body fat goal.</p>
<p>Arguments:
* <code class="docutils literal"><span class="pre">fat</span></code> – Target body fat in %; in the format X.XX</p>
</dd></dl>
<dl class="method">
<dt id="fitbit.Fitbit.body_weight_goal">
<code class="descname">body_weight_goal</code><span class="sig-paren">(</span><em>start_date=None</em>, <em>start_weight=None</em>, <em>weight=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/fitbit/api.html#Fitbit.body_weight_goal"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#fitbit.Fitbit.body_weight_goal" title="Permalink to this definition">¶</a></dt>
<dd><p>Implements the following APIs</p>
<ul class="simple">
<li><a class="reference external" href="https://dev.fitbit.com/docs/body/#get-body-goals">https://dev.fitbit.com/docs/body/#get-body-goals</a></li>
<li><a class="reference external" href="https://dev.fitbit.com/docs/body/#update-weight-goal">https://dev.fitbit.com/docs/body/#update-weight-goal</a></li>
</ul>
<p>Pass no arguments to get the body weight goal. Pass <code class="docutils literal"><span class="pre">start_date</span></code>,
<code class="docutils literal"><span class="pre">start_weight</span></code> and optionally <code class="docutils literal"><span class="pre">weight</span></code> to set the weight goal.
<code class="docutils literal"><span class="pre">weight</span></code> is required if it hasn’t been set yet.</p>
<p>Arguments:
* <code class="docutils literal"><span class="pre">start_date</span></code> – Weight goal start date; in the format yyyy-MM-dd
* <code class="docutils literal"><span class="pre">start_weight</span></code> – Weight goal start weight; in the format X.XX
* <code class="docutils literal"><span class="pre">weight</span></code> – Weight goal target weight; in the format X.XX</p>
</dd></dl>
<dl class="method">
<dt id="fitbit.Fitbit.create_food">
<code class="descname">create_food</code><span class="sig-paren">(</span><em>data</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/fitbit/api.html#Fitbit.create_food"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#fitbit.Fitbit.create_food" title="Permalink to this definition">¶</a></dt>
<dd><p><a class="reference external" href="https://dev.fitbit.com/docs/food-logging/#create-food">https://dev.fitbit.com/docs/food-logging/#create-food</a></p>
</dd></dl>
<dl class="method">
<dt id="fitbit.Fitbit.delete_alarm">
<code class="descname">delete_alarm</code><span class="sig-paren">(</span><em>device_id</em>, <em>alarm_id</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/fitbit/api.html#Fitbit.delete_alarm"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#fitbit.Fitbit.delete_alarm" title="Permalink to this definition">¶</a></dt>
<dd><p><a class="reference external" href="https://dev.fitbit.com/docs/devices/#delete-alarm">https://dev.fitbit.com/docs/devices/#delete-alarm</a></p>
</dd></dl>
<dl class="method">
<dt id="fitbit.Fitbit.delete_favorite_activity">
<code class="descname">delete_favorite_activity</code><span class="sig-paren">(</span><em>activity_id</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/fitbit/api.html#Fitbit.delete_favorite_activity"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#fitbit.Fitbit.delete_favorite_activity" title="Permalink to this definition">¶</a></dt>
<dd><p><a class="reference external" href="https://dev.fitbit.com/docs/activity/#delete-favorite-activity">https://dev.fitbit.com/docs/activity/#delete-favorite-activity</a></p>
</dd></dl>
<dl class="method">
<dt id="fitbit.Fitbit.delete_favorite_food">
<code class="descname">delete_favorite_food</code><span class="sig-paren">(</span><em>food_id</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/fitbit/api.html#Fitbit.delete_favorite_food"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#fitbit.Fitbit.delete_favorite_food" title="Permalink to this definition">¶</a></dt>
<dd><p><a class="reference external" href="https://dev.fitbit.com/docs/food-logging/#delete-favorite-food">https://dev.fitbit.com/docs/food-logging/#delete-favorite-food</a></p>
</dd></dl>
<dl class="method">
<dt id="fitbit.Fitbit.food_detail">
<code class="descname">food_detail</code><span class="sig-paren">(</span><em>food_id</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/fitbit/api.html#Fitbit.food_detail"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#fitbit.Fitbit.food_detail" title="Permalink to this definition">¶</a></dt>
<dd><p><a class="reference external" href="https://dev.fitbit.com/docs/food-logging/#get-food">https://dev.fitbit.com/docs/food-logging/#get-food</a></p>
</dd></dl>
<dl class="method">
<dt id="fitbit.Fitbit.food_goal">
<code class="descname">food_goal</code><span class="sig-paren">(</span><em>calories=None</em>, <em>intensity=None</em>, <em>personalized=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/fitbit/api.html#Fitbit.food_goal"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#fitbit.Fitbit.food_goal" title="Permalink to this definition">¶</a></dt>
<dd><p>Implements the following APIs</p>
<p><a class="reference external" href="https://dev.fitbit.com/docs/food-logging/#get-food-goals">https://dev.fitbit.com/docs/food-logging/#get-food-goals</a>
<a class="reference external" href="https://dev.fitbit.com/docs/food-logging/#update-food-goal">https://dev.fitbit.com/docs/food-logging/#update-food-goal</a></p>
<p>Pass no arguments to get the food goal. Pass at least <code class="docutils literal"><span class="pre">calories</span></code> or
<code class="docutils literal"><span class="pre">intensity</span></code> and optionally <code class="docutils literal"><span class="pre">personalized</span></code> to update the food goal.</p>
<p>Arguments:
* <code class="docutils literal"><span class="pre">calories</span></code> – Manual Calorie Consumption Goal; calories, integer;
* <code class="docutils literal"><span class="pre">intensity</span></code> – Food Plan intensity; (MAINTENANCE, EASIER, MEDIUM, KINDAHARD, HARDER);
* <code class="docutils literal"><span class="pre">personalized</span></code> – Food Plan type; <code class="docutils literal"><span class="pre">True</span></code> or <code class="docutils literal"><span class="pre">False</span></code></p>
</dd></dl>
<dl class="method">
<dt id="fitbit.Fitbit.food_units">
<code class="descname">food_units</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/fitbit/api.html#Fitbit.food_units"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#fitbit.Fitbit.food_units" title="Permalink to this definition">¶</a></dt>
<dd><p><a class="reference external" href="https://dev.fitbit.com/docs/food-logging/#get-food-units">https://dev.fitbit.com/docs/food-logging/#get-food-units</a></p>
</dd></dl>
<dl class="method">
<dt id="fitbit.Fitbit.get_alarms">
<code class="descname">get_alarms</code><span class="sig-paren">(</span><em>device_id</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/fitbit/api.html#Fitbit.get_alarms"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#fitbit.Fitbit.get_alarms" title="Permalink to this definition">¶</a></dt>
<dd><p><a class="reference external" href="https://dev.fitbit.com/docs/devices/#get-alarms">https://dev.fitbit.com/docs/devices/#get-alarms</a></p>
</dd></dl>
<dl class="method">
<dt id="fitbit.Fitbit.get_badges">
<code class="descname">get_badges</code><span class="sig-paren">(</span><em>user_id=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/fitbit/api.html#Fitbit.get_badges"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#fitbit.Fitbit.get_badges" title="Permalink to this definition">¶</a></dt>
<dd><p><a class="reference external" href="https://dev.fitbit.com/docs/friends/#badges">https://dev.fitbit.com/docs/friends/#badges</a></p>
</dd></dl>
<dl class="method">
<dt id="fitbit.Fitbit.get_bodyfat">
<code class="descname">get_bodyfat</code><span class="sig-paren">(</span><em>base_date=None</em>, <em>user_id=None</em>, <em>period=None</em>, <em>end_date=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/fitbit/api.html#Fitbit.get_bodyfat"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#fitbit.Fitbit.get_bodyfat" title="Permalink to this definition">¶</a></dt>
<dd><p><a class="reference external" href="https://dev.fitbit.com/docs/body/#get-body-fat-logs">https://dev.fitbit.com/docs/body/#get-body-fat-logs</a>
base_date should be a datetime.date object (defaults to today),
period can be ‘1d’, ‘7d’, ‘30d’, ‘1w’, ‘1m’, ‘3m’, ‘6m’, ‘1y’, ‘max’ or None
end_date should be a datetime.date object, or None.</p>
<p>You can specify period or end_date, or neither, but not both.</p>
</dd></dl>
<dl class="method">
<dt id="fitbit.Fitbit.get_bodyweight">
<code class="descname">get_bodyweight</code><span class="sig-paren">(</span><em>base_date=None</em>, <em>user_id=None</em>, <em>period=None</em>, <em>end_date=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/fitbit/api.html#Fitbit.get_bodyweight"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#fitbit.Fitbit.get_bodyweight" title="Permalink to this definition">¶</a></dt>
<dd><p><a class="reference external" href="https://dev.fitbit.com/docs/body/#get-weight-logs">https://dev.fitbit.com/docs/body/#get-weight-logs</a>
base_date should be a datetime.date object (defaults to today),
period can be ‘1d’, ‘7d’, ‘30d’, ‘1w’, ‘1m’, ‘3m’, ‘6m’, ‘1y’, ‘max’ or None
end_date should be a datetime.date object, or None.</p>
<p>You can specify period or end_date, or neither, but not both.</p>
</dd></dl>
<dl class="method">
<dt id="fitbit.Fitbit.get_devices">
<code class="descname">get_devices</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/fitbit/api.html#Fitbit.get_devices"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#fitbit.Fitbit.get_devices" title="Permalink to this definition">¶</a></dt>
<dd><p><a class="reference external" href="https://dev.fitbit.com/docs/devices/#get-devices">https://dev.fitbit.com/docs/devices/#get-devices</a></p>
</dd></dl>
<dl class="method">
<dt id="fitbit.Fitbit.get_friends">
<code class="descname">get_friends</code><span class="sig-paren">(</span><em>user_id=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/fitbit/api.html#Fitbit.get_friends"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#fitbit.Fitbit.get_friends" title="Permalink to this definition">¶</a></dt>
<dd><p><a class="reference external" href="https://dev.fitbit.com/docs/friends/#get-friends">https://dev.fitbit.com/docs/friends/#get-friends</a></p>
</dd></dl>
<dl class="method">
<dt id="fitbit.Fitbit.get_friends_leaderboard">
<code class="descname">get_friends_leaderboard</code><span class="sig-paren">(</span><em>period</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/fitbit/api.html#Fitbit.get_friends_leaderboard"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#fitbit.Fitbit.get_friends_leaderboard" title="Permalink to this definition">¶</a></dt>
<dd><p><a class="reference external" href="https://dev.fitbit.com/docs/friends/#get-friends-leaderboard">https://dev.fitbit.com/docs/friends/#get-friends-leaderboard</a></p>
</dd></dl>
<dl class="method">
<dt id="fitbit.Fitbit.get_meals">
<code class="descname">get_meals</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/fitbit/api.html#Fitbit.get_meals"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#fitbit.Fitbit.get_meals" title="Permalink to this definition">¶</a></dt>
<dd><p><a class="reference external" href="https://dev.fitbit.com/docs/food-logging/#get-meals">https://dev.fitbit.com/docs/food-logging/#get-meals</a></p>
</dd></dl>
<dl class="method">
<dt id="fitbit.Fitbit.get_sleep">
<code class="descname">get_sleep</code><span class="sig-paren">(</span><em>date</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/fitbit/api.html#Fitbit.get_sleep"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#fitbit.Fitbit.get_sleep" title="Permalink to this definition">¶</a></dt>
<dd><p><a class="reference external" href="https://dev.fitbit.com/docs/sleep/#get-sleep-logs">https://dev.fitbit.com/docs/sleep/#get-sleep-logs</a>
date should be a datetime.date object.</p>
</dd></dl>
<dl class="method">
<dt id="fitbit.Fitbit.intraday_time_series">
<code class="descname">intraday_time_series</code><span class="sig-paren">(</span><em>resource</em>, <em>base_date='today'</em>, <em>detail_level='1min'</em>, <em>start_time=None</em>, <em>end_time=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/fitbit/api.html#Fitbit.intraday_time_series"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#fitbit.Fitbit.intraday_time_series" title="Permalink to this definition">¶</a></dt>
<dd><p>The intraday time series extends the functionality of the regular time series, but returning data at a
more granular level for a single day, defaulting to 1 minute intervals. To access this feature, one must
fill out the Private Support form here (see <a class="reference external" href="https://dev.fitbit.com/docs/help/">https://dev.fitbit.com/docs/help/</a>).
For details on the resources available and more information on how to get access, see:</p>
<p><a class="reference external" href="https://dev.fitbit.com/docs/activity/#get-activity-intraday-time-series">https://dev.fitbit.com/docs/activity/#get-activity-intraday-time-series</a></p>
</dd></dl>
<dl class="method">
<dt id="fitbit.Fitbit.invite_friend">
<code class="descname">invite_friend</code><span class="sig-paren">(</span><em>data</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/fitbit/api.html#Fitbit.invite_friend"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#fitbit.Fitbit.invite_friend" title="Permalink to this definition">¶</a></dt>
<dd><p><a class="reference external" href="https://dev.fitbit.com/docs/friends/#invite-friend">https://dev.fitbit.com/docs/friends/#invite-friend</a></p>
</dd></dl>
<dl class="method">
<dt id="fitbit.Fitbit.invite_friend_by_email">
<code class="descname">invite_friend_by_email</code><span class="sig-paren">(</span><em>email</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/fitbit/api.html#Fitbit.invite_friend_by_email"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#fitbit.Fitbit.invite_friend_by_email" title="Permalink to this definition">¶</a></dt>
<dd><p>Convenience Method for
<a class="reference external" href="https://dev.fitbit.com/docs/friends/#invite-friend">https://dev.fitbit.com/docs/friends/#invite-friend</a></p>
</dd></dl>
<dl class="method">
<dt id="fitbit.Fitbit.invite_friend_by_userid">
<code class="descname">invite_friend_by_userid</code><span class="sig-paren">(</span><em>user_id</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/fitbit/api.html#Fitbit.invite_friend_by_userid"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#fitbit.Fitbit.invite_friend_by_userid" title="Permalink to this definition">¶</a></dt>
<dd><p>Convenience Method for
<a class="reference external" href="https://dev.fitbit.com/docs/friends/#invite-friend">https://dev.fitbit.com/docs/friends/#invite-friend</a></p>
</dd></dl>
<dl class="method">
<dt id="fitbit.Fitbit.list_subscriptions">
<code class="descname">list_subscriptions</code><span class="sig-paren">(</span><em>collection=''</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/fitbit/api.html#Fitbit.list_subscriptions"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#fitbit.Fitbit.list_subscriptions" title="Permalink to this definition">¶</a></dt>
<dd><p><a class="reference external" href="https://dev.fitbit.com/docs/subscriptions/#getting-a-list-of-subscriptions">https://dev.fitbit.com/docs/subscriptions/#getting-a-list-of-subscriptions</a></p>
</dd></dl>
<dl class="method">
<dt id="fitbit.Fitbit.log_activity">
<code class="descname">log_activity</code><span class="sig-paren">(</span><em>data</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/fitbit/api.html#Fitbit.log_activity"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#fitbit.Fitbit.log_activity" title="Permalink to this definition">¶</a></dt>
<dd><p><a class="reference external" href="https://dev.fitbit.com/docs/activity/#log-activity">https://dev.fitbit.com/docs/activity/#log-activity</a></p>
</dd></dl>
<dl class="method">
<dt id="fitbit.Fitbit.log_sleep">
<code class="descname">log_sleep</code><span class="sig-paren">(</span><em>start_time</em>, <em>duration</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/fitbit/api.html#Fitbit.log_sleep"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#fitbit.Fitbit.log_sleep" title="Permalink to this definition">¶</a></dt>
<dd><p><a class="reference external" href="https://dev.fitbit.com/docs/sleep/#log-sleep">https://dev.fitbit.com/docs/sleep/#log-sleep</a>
start time should be a datetime object. We will be using the year, month, day, hour, and minute.</p>
</dd></dl>
<dl class="method">
<dt id="fitbit.Fitbit.reject_invite">
<code class="descname">reject_invite</code><span class="sig-paren">(</span><em>other_user_id</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/fitbit/api.html#Fitbit.reject_invite"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#fitbit.Fitbit.reject_invite" title="Permalink to this definition">¶</a></dt>
<dd><p>Convenience method for respond_to_invite</p>
</dd></dl>
<dl class="method">
<dt id="fitbit.Fitbit.respond_to_invite">
<code class="descname">respond_to_invite</code><span class="sig-paren">(</span><em>other_user_id</em>, <em>accept=True</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/fitbit/api.html#Fitbit.respond_to_invite"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#fitbit.Fitbit.respond_to_invite" title="Permalink to this definition">¶</a></dt>
<dd><p><a class="reference external" href="https://dev.fitbit.com/docs/friends/#respond-to-friend-invitation">https://dev.fitbit.com/docs/friends/#respond-to-friend-invitation</a></p>
</dd></dl>
<dl class="method">
<dt id="fitbit.Fitbit.search_foods">
<code class="descname">search_foods</code><span class="sig-paren">(</span><em>query</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/fitbit/api.html#Fitbit.search_foods"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#fitbit.Fitbit.search_foods" title="Permalink to this definition">¶</a></dt>
<dd><p><a class="reference external" href="https://dev.fitbit.com/docs/food-logging/#search-foods">https://dev.fitbit.com/docs/food-logging/#search-foods</a></p>
</dd></dl>
<dl class="method">
<dt id="fitbit.Fitbit.subscription">
<code class="descname">subscription</code><span class="sig-paren">(</span><em>subscription_id</em>, <em>subscriber_id</em>, <em>collection=None</em>, <em>method='POST'</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/fitbit/api.html#Fitbit.subscription"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#fitbit.Fitbit.subscription" title="Permalink to this definition">¶</a></dt>
<dd><p><a class="reference external" href="https://dev.fitbit.com/docs/subscriptions/">https://dev.fitbit.com/docs/subscriptions/</a></p>
</dd></dl>
<dl class="method">
<dt id="fitbit.Fitbit.time_series">
<code class="descname">time_series</code><span class="sig-paren">(</span><em>resource</em>, <em>user_id=None</em>, <em>base_date='today'</em>, <em>period=None</em>, <em>end_date=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/fitbit/api.html#Fitbit.time_series"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#fitbit.Fitbit.time_series" title="Permalink to this definition">¶</a></dt>
<dd><p>The time series is a LOT of methods, (documented at urls below) so they
don’t get their own method. They all follow the same patterns, and
return similar formats.</p>
<p>Taking liberty, this assumes a base_date of today, the current user,
and a 1d period.</p>
<p><a class="reference external" href="https://dev.fitbit.com/docs/activity/#activity-time-series">https://dev.fitbit.com/docs/activity/#activity-time-series</a>
<a class="reference external" href="https://dev.fitbit.com/docs/body/#body-time-series">https://dev.fitbit.com/docs/body/#body-time-series</a>
<a class="reference external" href="https://dev.fitbit.com/docs/food-logging/#food-or-water-time-series">https://dev.fitbit.com/docs/food-logging/#food-or-water-time-series</a>
<a class="reference external" href="https://dev.fitbit.com/docs/heart-rate/#heart-rate-time-series">https://dev.fitbit.com/docs/heart-rate/#heart-rate-time-series</a>
<a class="reference external" href="https://dev.fitbit.com/docs/sleep/#sleep-time-series">https://dev.fitbit.com/docs/sleep/#sleep-time-series</a></p>
</dd></dl>
<dl class="method">
<dt id="fitbit.Fitbit.update_alarm">
<code class="descname">update_alarm</code><span class="sig-paren">(</span><em>device_id</em>, <em>alarm_id</em>, <em>alarm_time</em>, <em>week_days</em>, <em>recurring=False</em>, <em>enabled=True</em>, <em>label=None</em>, <em>snooze_length=None</em>, <em>snooze_count=None</em>, <em>vibe='DEFAULT'</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/fitbit/api.html#Fitbit.update_alarm"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#fitbit.Fitbit.update_alarm" title="Permalink to this definition">¶</a></dt>
<dd><p><a class="reference external" href="https://dev.fitbit.com/docs/devices/#update-alarm">https://dev.fitbit.com/docs/devices/#update-alarm</a>
alarm_time should be a timezone aware datetime object.</p>
</dd></dl>
<dl class="method">
<dt id="fitbit.Fitbit.user_profile_get">
<code class="descname">user_profile_get</code><span class="sig-paren">(</span><em>user_id=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/fitbit/api.html#Fitbit.user_profile_get"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#fitbit.Fitbit.user_profile_get" title="Permalink to this definition">¶</a></dt>
<dd><p>Get a user profile. You can get other user’s profile information
by passing user_id, or you can get the current user’s by not passing
a user_id</p>
<p><a class="reference external" href="https://dev.fitbit.com/docs/user/">https://dev.fitbit.com/docs/user/</a></p>
</dd></dl>
<dl class="method">
<dt id="fitbit.Fitbit.user_profile_update">
<code class="descname">user_profile_update</code><span class="sig-paren">(</span><em>data</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/fitbit/api.html#Fitbit.user_profile_update"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#fitbit.Fitbit.user_profile_update" title="Permalink to this definition">¶</a></dt>
<dd><p>Set a user profile. You can set your user profile information by
passing a dictionary of attributes that will be updated.</p>
<p><a class="reference external" href="https://dev.fitbit.com/docs/user/#update-profile">https://dev.fitbit.com/docs/user/#update-profile</a></p>
</dd></dl>
<dl class="method">
<dt id="fitbit.Fitbit.water_goal">
<code class="descname">water_goal</code><span class="sig-paren">(</span><em>target=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/fitbit/api.html#Fitbit.water_goal"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#fitbit.Fitbit.water_goal" title="Permalink to this definition">¶</a></dt>
<dd><p>Implements the following APIs</p>
<p><a class="reference external" href="https://dev.fitbit.com/docs/food-logging/#get-water-goal">https://dev.fitbit.com/docs/food-logging/#get-water-goal</a>
<a class="reference external" href="https://dev.fitbit.com/docs/food-logging/#update-water-goal">https://dev.fitbit.com/docs/food-logging/#update-water-goal</a></p>
<p>Pass no arguments to get the water goal. Pass <code class="docutils literal"><span class="pre">target</span></code> to update it.</p>
<p>Arguments:
* <code class="docutils literal"><span class="pre">target</span></code> – Target water goal in the format X.X, will be set in unit based on locale</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="indices-and-tables">
<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h1>
<ul class="simple">
<li><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></li>
<li><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></li>
<li><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></li>
</ul>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3><a href="#">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Overview</a></li>
<li><a class="reference internal" href="#quickstart">Quickstart</a></li>
<li><a class="reference internal" href="#fitbit-api">Fitbit API</a></li>
<li><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="#">Documentation overview</a><ul>
</ul></li>
</ul>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/index.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<div><input type="text" name="q" /></div>
<div><input type="submit" value="Go" /></div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
©Copyright 2012-2017 ORCAS.
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.6.7</a>
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.8</a>
|
<a href="_sources/index.rst.txt"
rel="nofollow">Page source</a>
</div>
</body>
</html>
|