---
title: "Gets a single map's zones"
method: GET
path: "/v1/maps/{mapID}/zones"
tags: ["Maps"]
---

# Gets a single map's zones

`GET /v1/maps/{mapID}/zones`

## Request

- Base URL: `https://api.momentum-mod.org` (the document declares no server; this is the origin it was published from)
- URL: `https://api.momentum-mod.org/v1/maps/{mapID}/zones`
- Auth: HTTP bearer

## Path parameters

- `mapID` number, required

## Response `200`

The map's zones

- MapZonesDto
  - `dataTimestamp` number, required
  - `formatVersion` number, required
  - `maxVelocity` number, required: The sv_maxvelocity value set on the map
  - `tracks` MapTracksDto, required
    - `main` MainTrackDto, required
      - `zones` TrackZonesDto
        - `segments` SegmentDto[]
          - `limitStartGroundSpeed` boolean, required: If enabled, prevents the player from bhopping in start zones, even with the timer running.
          - `checkpointsRequired` boolean, required: Whether the checkpoints must be hit
          - `checkpointsOrdered` boolean, required: Whether the checkpoints have a logical order.
          - `checkpoints` ZoneDto[]: A collection of checkpoint zones
            - `filtername` string, required: `targetname` of a filter entity on the map.
            - `regions` RegionDto[]: A collection of regions. In most cases just a single region, but the format is structured this way so multiple are possible.
              - …
          - `cancel` ZoneDto[]
            - `filtername` string, required: `targetname` of a filter entity on the map.
            - `regions` RegionDto[]: A collection of regions. In most cases just a single region, but the format is structured this way so multiple are possible.
              - …
          - `name` string, required: An optional name for the track
        - `end` ZoneDto
          - `filtername` string, required: `targetname` of a filter entity on the map.
          - `regions` RegionDto[]: A collection of regions. In most cases just a single region, but the format is structured this way so multiple are possible.
            - `points` string[], required: A collection of 2-tuples of floats representing points in the XY plane, describing the shape of the zone from a top-down view.
            - `bottom` number, required: The Z coordinate of all the points in the "points" collection, forming the bottom of the region.
            - `height` number, required: The height of the zone, effectively Z coordinate of the points in the "points" collection at the top of the region.
            - `teleDestPos` object, required: A 3-tuple of floats representing the location in the XYZ plane the player is placed at when teleported into the region.Should *generally correspond to an `info_teleport_destination.`Required if the region is part of a volume used by a start or major checkpoint zone, otherwise optional.
            - `teleDestYaw` number, required: The yaw angle in degrees the player faces when teleported into the region.Required if the region is part of a volume used by a start or major checkpoint zone, otherwise optional.
            - `teleDestTargetname` string, required: The name of the teleport destination entity that the player is teleported to when teleported into the region.
            - `safeHeight` number, required: The "safe height" is the greatest height from the base of the region that the player is allowed to enter "primed" state from - see the docs for a detailed explanation.If not included, the game uses a default value of -1, which indicates that the entire region is also the safe region.
      - `stagesEndAtStageStarts` boolean, required: Whether the stage end zones are generated using the next stage start zones
      - `bhopEnabled` boolean: Overrides the game mode's settings to allow bhopping on this track
    - `bonuses` BonusTrackDto[]: A collection of bonus tracks
      - `zones` TrackZonesDto
        - `segments` SegmentDto[]
          - `limitStartGroundSpeed` boolean, required: If enabled, prevents the player from bhopping in start zones, even with the timer running.
          - `checkpointsRequired` boolean, required: Whether the checkpoints must be hit
          - `checkpointsOrdered` boolean, required: Whether the checkpoints have a logical order.
          - `checkpoints` ZoneDto[]: A collection of checkpoint zones
            - `filtername` string, required: `targetname` of a filter entity on the map.
            - `regions` RegionDto[]: A collection of regions. In most cases just a single region, but the format is structured this way so multiple are possible.
              - …
          - `cancel` ZoneDto[]
            - `filtername` string, required: `targetname` of a filter entity on the map.
            - `regions` RegionDto[]: A collection of regions. In most cases just a single region, but the format is structured this way so multiple are possible.
              - …
          - `name` string, required: An optional name for the track
        - `end` ZoneDto
          - `filtername` string, required: `targetname` of a filter entity on the map.
          - `regions` RegionDto[]: A collection of regions. In most cases just a single region, but the format is structured this way so multiple are possible.
            - `points` string[], required: A collection of 2-tuples of floats representing points in the XY plane, describing the shape of the zone from a top-down view.
            - `bottom` number, required: The Z coordinate of all the points in the "points" collection, forming the bottom of the region.
            - `height` number, required: The height of the zone, effectively Z coordinate of the points in the "points" collection at the top of the region.
            - `teleDestPos` object, required: A 3-tuple of floats representing the location in the XYZ plane the player is placed at when teleported into the region.Should *generally correspond to an `info_teleport_destination.`Required if the region is part of a volume used by a start or major checkpoint zone, otherwise optional.
            - `teleDestYaw` number, required: The yaw angle in degrees the player faces when teleported into the region.Required if the region is part of a volume used by a start or major checkpoint zone, otherwise optional.
            - `teleDestTargetname` string, required: The name of the teleport destination entity that the player is teleported to when teleported into the region.
            - `safeHeight` number, required: The "safe height" is the greatest height from the base of the region that the player is allowed to enter "primed" state from - see the docs for a detailed explanation.If not included, the game uses a default value of -1, which indicates that the entire region is also the safe region.
      - `defragModifiers` number, required: Defrag gameplay modifications
      - `bhopEnabled` boolean: Overrides the game mode's settings to allow bhopping on this track
  - `globalRegions` GlobalRegionsDto
    - `allowBhop` RegionDto[]: A collection of allow bhop regions
      - `points` string[], required: A collection of 2-tuples of floats representing points in the XY plane, describing the shape of the zone from a top-down view.
      - `bottom` number, required: The Z coordinate of all the points in the "points" collection, forming the bottom of the region.
      - `height` number, required: The height of the zone, effectively Z coordinate of the points in the "points" collection at the top of the region.
      - `teleDestPos` object, required: A 3-tuple of floats representing the location in the XYZ plane the player is placed at when teleported into the region.Should *generally correspond to an `info_teleport_destination.`Required if the region is part of a volume used by a start or major checkpoint zone, otherwise optional.
      - `teleDestYaw` number, required: The yaw angle in degrees the player faces when teleported into the region.Required if the region is part of a volume used by a start or major checkpoint zone, otherwise optional.
      - `teleDestTargetname` string, required: The name of the teleport destination entity that the player is teleported to when teleported into the region.
      - `safeHeight` number, required: The "safe height" is the greatest height from the base of the region that the player is allowed to enter "primed" state from - see the docs for a detailed explanation.If not included, the game uses a default value of -1, which indicates that the entire region is also the safe region.
    - `overbounce` RegionDto[]: A collection of overbounce regions
      - `points` string[], required: A collection of 2-tuples of floats representing points in the XY plane, describing the shape of the zone from a top-down view.
      - `bottom` number, required: The Z coordinate of all the points in the "points" collection, forming the bottom of the region.
      - `height` number, required: The height of the zone, effectively Z coordinate of the points in the "points" collection at the top of the region.
      - `teleDestPos` object, required: A 3-tuple of floats representing the location in the XYZ plane the player is placed at when teleported into the region.Should *generally correspond to an `info_teleport_destination.`Required if the region is part of a volume used by a start or major checkpoint zone, otherwise optional.
      - `teleDestYaw` number, required: The yaw angle in degrees the player faces when teleported into the region.Required if the region is part of a volume used by a start or major checkpoint zone, otherwise optional.
      - `teleDestTargetname` string, required: The name of the teleport destination entity that the player is teleported to when teleported into the region.
      - `safeHeight` number, required: The "safe height" is the greatest height from the base of the region that the player is allowed to enter "primed" state from - see the docs for a detailed explanation.If not included, the game uses a default value of -1, which indicates that the entire region is also the safe region.
    - `cancel` RegionDto[]: A collection of timer cancel regions
      - `points` string[], required: A collection of 2-tuples of floats representing points in the XY plane, describing the shape of the zone from a top-down view.
      - `bottom` number, required: The Z coordinate of all the points in the "points" collection, forming the bottom of the region.
      - `height` number, required: The height of the zone, effectively Z coordinate of the points in the "points" collection at the top of the region.
      - `teleDestPos` object, required: A 3-tuple of floats representing the location in the XYZ plane the player is placed at when teleported into the region.Should *generally correspond to an `info_teleport_destination.`Required if the region is part of a volume used by a start or major checkpoint zone, otherwise optional.
      - `teleDestYaw` number, required: The yaw angle in degrees the player faces when teleported into the region.Required if the region is part of a volume used by a start or major checkpoint zone, otherwise optional.
      - `teleDestTargetname` string, required: The name of the teleport destination entity that the player is teleported to when teleported into the region.
      - `safeHeight` number, required: The "safe height" is the greatest height from the base of the region that the player is allowed to enter "primed" state from - see the docs for a detailed explanation.If not included, the game uses a default value of -1, which indicates that the entire region is also the safe region.

## Other responses

- `404`: Map not found

---

[API](https://skmtc.dev/momentum-mod/apis/momentum-mod-api.md) - [All operations](https://skmtc.dev/momentum-mod/apis/momentum-mod-api/llms.txt) - [OpenAPI document](https://skmtc.dev/momentum-mod/apis/momentum-mod-api/revisions/0a88cfbbcc65?raw)
