getDistance
Retrieve walking or running distance data from your Fitbit device for specified dates or time periods to track fitness progress.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "getDistance"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| date | No | Date in YYYY-MM-DD format. If not specified, will use today. | |
| period | No | Period for data: 1d, 7d, 30d, 1w, 1m |
Implementation Reference
- src/server.ts:612-653 (handler)Handler function that fetches distance activity data from Fitbit API for a given date and optional period, returns JSON-formatted response or error.
async ({ date, period }) => { try { const formattedDate = formatDate(date); let endpoint = ""; if (period) { endpoint = `/user/-/activities/distance/date/${formattedDate}/${period}.json`; } else { endpoint = `/user/-/activities/distance/date/${formattedDate}/1d.json`; } const data = await makeApiRequest(endpoint); return { content: [ { type: "text", text: JSON.stringify( { date: formattedDate, distance: data["activities-distance"] || [], intraday: data["activities-distance-intraday"] || {}, }, null, 2 ), }, ], }; } catch (error) { return { content: [ { type: "text", text: `Error: ${ error instanceof Error ? error.message : String(error) }`, }, ], isError: true, }; } } - src/server.ts:602-611 (schema)Zod input schema defining optional 'date' and 'period' parameters for the getDistance tool.
{ date: z .string() .optional() .describe("Date in YYYY-MM-DD format. If not specified, will use today."), period: z .string() .optional() .describe("Period for data: 1d, 7d, 30d, 1w, 1m"), }, - src/server.ts:600-654 (registration)Registration of the 'getDistance' tool using server.tool(), including schema and inline handler function.
server.tool( "getDistance", { date: z .string() .optional() .describe("Date in YYYY-MM-DD format. If not specified, will use today."), period: z .string() .optional() .describe("Period for data: 1d, 7d, 30d, 1w, 1m"), }, async ({ date, period }) => { try { const formattedDate = formatDate(date); let endpoint = ""; if (period) { endpoint = `/user/-/activities/distance/date/${formattedDate}/${period}.json`; } else { endpoint = `/user/-/activities/distance/date/${formattedDate}/1d.json`; } const data = await makeApiRequest(endpoint); return { content: [ { type: "text", text: JSON.stringify( { date: formattedDate, distance: data["activities-distance"] || [], intraday: data["activities-distance-intraday"] || {}, }, null, 2 ), }, ], }; } catch (error) { return { content: [ { type: "text", text: `Error: ${ error instanceof Error ? error.message : String(error) }`, }, ], isError: true, }; } } ); - src/server.ts:44-64 (helper)Shared helper function to make authenticated HTTP requests to the Fitbit API endpoints.
async function makeApiRequest(endpoint: string): Promise<any> { try { const url = `${baseUrl}${endpoint}`; const response = await fetch(url, { headers: { Authorization: `Bearer ${accessToken}`, Accept: "application/json", }, }); if (!response.ok) { throw new Error( `Fitbit API error: ${response.status} ${response.statusText}` ); } return await response.json(); } catch (error) { console.error(`Error making request to ${endpoint}:`, error); throw error; } - src/server.ts:68-72 (helper)Shared helper function to format input date or default to today's date in YYYY-MM-DD format.
function formatDate(date?: string): string { if (date) return date; const today = new Date(); return today.toISOString().split("T")[0]; // YYYY-MM-DD }