Activity Endpoint
polar_flow.endpoints.activity.ActivityEndpoint
Activity endpoint for daily activity data.
Provides access to daily activity summaries, steps, and activity zones. Data is available for the last 28 days.
__init__(client)
Initialize activity endpoint.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
client
|
PolarFlow
|
PolarFlow client instance |
required |
get(date)
async
Get activity summary for a specific date.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
date
|
str
|
Date in YYYY-MM-DD format |
required |
Returns:
| Type | Description |
|---|---|
Activity
|
Activity summary with samples |
Raises:
| Type | Description |
|---|---|
NotFoundError
|
If no activity data exists for the date |
ValidationError
|
If date format is invalid |
list(from_date=None, to_date=None)
async
List activity summaries.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
from_date
|
str | None
|
Start date in YYYY-MM-DD format (optional) |
None
|
to_date
|
str | None
|
End date in YYYY-MM-DD format (optional) |
None
|
Returns:
| Type | Description |
|---|---|
list[Activity]
|
List of activity summaries (max 28 days) |
Note
API returns data for last 28 days if no date range specified. Date range cannot exceed 28 days.