<!--
{
  "availability" : [
    "iOS: 11.0.0 -",
    "iPadOS: 11.0.0 -",
    "macCatalyst: 13.0.0 -",
    "macOS: 13.0.0 -",
    "visionOS: 1.0.0 -",
    "watchOS: 4.0.0 -"
  ],
  "documentType" : "symbol",
  "framework" : "HealthKit",
  "identifier" : "/documentation/HealthKit/HKWorkoutRouteBuilder",
  "metadataVersion" : "0.1.0",
  "role" : "Class",
  "symbol" : {
    "kind" : "Class",
    "modules" : [
      "HealthKit"
    ],
    "preciseIdentifier" : "c:objc(cs)HKWorkoutRouteBuilder"
  },
  "title" : "HKWorkoutRouteBuilder"
}
-->

# HKWorkoutRouteBuilder

A builder object that incrementally constructs a workout route.

```
class HKWorkoutRouteBuilder
```

## Overview

To create a workout route, use [`seriesBuilder(for:)`](/documentation/HealthKit/HKWorkoutBuilder/seriesBuilder(for:)) to instantiate a [`HKWorkoutRouteBuilder`](/documentation/HealthKit/HKWorkoutRouteBuilder), and provide it with location data throughout the workout. After the workout ends, call the builder’s [`finishRoute(with:metadata:completion:)`](/documentation/HealthKit/HKWorkoutRouteBuilder/finishRoute(with:metadata:completion:)) method to construct the route. Instantiating a [`HKWorkoutRouteBuilder`](/documentation/HealthKit/HKWorkoutRouteBuilder) directly is discouraged. For detailed instructions, see <doc://com.apple.healthkit/documentation/HealthKit/creating-a-workout-route>.

## Topics

### Creating the builder

[`-  seriesBuilderForType:`](/documentation/HealthKit/HKWorkoutBuilder/seriesBuilder(for:))

Returns the series builder for the specified type, creating a new builder, if necessary.

[`-  initWithHealthStore:device:`](/documentation/HealthKit/HKWorkoutRouteBuilder/init(healthStore:device:))

Creates and returns a new workout route builder.

### Building the route

[`-  finishRouteWithWorkout:metadata:completion:`](/documentation/HealthKit/HKWorkoutRouteBuilder/finishRoute(with:metadata:completion:))

Creates, saves, and associates the route with the provided workout.

[`-  insertRouteData:completion:`](/documentation/HealthKit/HKWorkoutRouteBuilder/insertRouteData(_:completion:))

Adds route data to the builder.

[`-  addMetadata:completion:`](/documentation/HealthKit/HKWorkoutRouteBuilder/addMetadata(_:completion:))

Adds metadata to the builder.

## Relationships

### Conforms To

[`NSObjectProtocol`](/documentation/ObjectiveC/NSObjectProtocol)

[`Equatable`](/documentation/Swift/Equatable)

[`Hashable`](/documentation/Swift/Hashable)

[`CVarArg`](/documentation/Swift/CVarArg)

[`CustomDebugStringConvertible`](/documentation/Swift/CustomDebugStringConvertible)

[`SendableMetatype`](/documentation/Swift/SendableMetatype)

[`Sendable`](/documentation/Swift/Sendable)

[`CustomStringConvertible`](/documentation/Swift/CustomStringConvertible)

### Inherits From

[`HKSeriesBuilder`](/documentation/HealthKit/HKSeriesBuilder)

---

Copyright &copy; 2026 Apple Inc. All rights reserved. | [Terms of Use](https://www.apple.com/legal/internet-services/terms/site.html) | [Privacy Policy](https://www.apple.com/privacy/privacy-policy)