interface Segment {
    allowNoDirection: boolean;
    alternateStreetIds: number[];
    elevationLevel: null | number;
    flagAttributes: SegmentFlagAttributes;
    fromLanesInfo: null | SegmentLanesInfo;
    fromNodeId: null | number;
    fromNodeLanesCount: number;
    fwdSpeedLimit: null | number;
    geometry: LineString;
    hasClosures: boolean;
    hasHouseNumbers: boolean;
    hasRestrictions: boolean;
    hasSeparator: boolean;
    id: number;
    isAtoB: boolean;
    isBtoA: boolean;
    isFwdSpeedLimitVerified: boolean;
    isRevSpeedLimitVerified: boolean;
    isTwoWay: boolean;
    junctionId: null | number;
    length: number;
    lockRank: UserRank;
    modificationData: ModificationMetadata;
    primaryStreetId: null | number;
    revSpeedLimit: null | number;
    roadType: RoadTypeId;
    routingRoadType: null | 1 | 2 | 3 | 6 | 7;
    toLanesInfo: null | SegmentLanesInfo;
    toNodeId: null | number;
    toNodeLanesCount: number;
}

Properties

allowNoDirection: boolean

true if the segment can have no direction When true, it indicates that the segment does not have a formally defined traffic direction (one-way or two-way) and vehicles can travel in any direction on such segment. This is often used for areas like parking lots, private roads.

alternateStreetIds: number[]

A list of the segment's alternate streets

elevationLevel: null | number

The elevation level of the segment.

flagAttributes: SegmentFlagAttributes

The flag attributes of the segment.

fromLanesInfo: null | SegmentLanesInfo

The lanes info for the segment in the forward direction. laneWidth is returned in m or ft depending on the active units system.

fromNodeId: null | number

The id of a segment's from node, or null if segment from node is not set.

fromNodeLanesCount: number
fwdSpeedLimit: null | number

Speed limit of the segment in the forward direction, or null if there's no limit.

geometry: LineString

The GeoJSON LineString representation of the segment's geometry.

hasClosures: boolean

Whether a segment has closures.

hasHouseNumbers: boolean
hasRestrictions: boolean
hasSeparator: boolean

true if the segment has a separator.

id: number
isAtoB: boolean

true if the segment's direction is one way, from node A to B

isBtoA: boolean

true if the segment's direction is one way, from node B to A

isFwdSpeedLimitVerified: boolean

true if the segment's speed limit in the forward direction was verified by an editor, false if it was added automatically.

The attribute is deprecated and will be removed soon. The value is always true

isRevSpeedLimitVerified: boolean

true if the segment's speed limit in the reverse direction was verified by an editor, false if it was added automatically.

The attribute is deprecated and will be removed soon. The value is always true

isTwoWay: boolean

true if the segment's direction is two-way, from node A to B and from node B to A

junctionId: null | number

The junction id the segment is a part of. null if the segment is not a part of a junction.

length: number

The length of the segment in meters.

lockRank: UserRank

The lock rank of the segment.

modificationData: ModificationMetadata
primaryStreetId: null | number

The id of a segment's primary street, or null if not set.

revSpeedLimit: null | number

Speed limit of the segment in the reverse direction, or null if there's no limit.

roadType: RoadTypeId
routingRoadType: null | 1 | 2 | 3 | 6 | 7

Routing road type of the segment, or null if there's no routing road type.

toLanesInfo: null | SegmentLanesInfo

The lanes info for the segment in the forward direction. laneWidth is returned in m or ft depending on the active units system.

toNodeId: null | number

The id of a segment's to node, or null if segment to node is not set.

toNodeLanesCount: number