Fare Zone

Return distance between two fare zones

POST

https://api.entur.io/distance

/fare-zones/distances/zones

Calculates the shortest-path distance between two fare zones, where 'distance' is the number of fare zone borders crossed. All shortest paths of equal length are returned. Nested zones are transparently mapped to their parent overlapping zone before the path is calculated.

Return distance between two fare zones › Headers

ET-Client-Name

string · style: simple

Entur Client Header. It is required that all consumers identify themselves by using this header. Entur will deploy strict rate-limiting policies on API-consumers who do not identify with a header and reserves the right to block unidentified consumers. The structure of ET-Client-Name should be: <company>-<application>.

X-Correlation-Id

string · style: simple

Correlation id

Return distance between two fare zones › Request Body

FareZoneDistanceRequest

from

string

to

string

organisationId

integer | null · int64

time

string | null · date-time

via

array | null

Use 'via' to force the path through one or more intermediate zones.

preOwned

array | null · unique

Use 'preOwned' to exclude zones the traveller already owns — these zones are not counted toward the distance.

Return distance between two fare zones › Responses

FareZoneDistanceResponse

fromZoneId

string

toZoneId

string

organisationId

integer · int64

distance

integer · int32

Zones[]

array | null

This field only gets populated if the direct path from-to is shorter than the via path

POST/fare-zones/distances/zones

curl https://api.entur.io/distance/fare-zones/distances/zones \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'ET-Client-Name: <api-key>' \
  --data '{
  "from": "ENT:FareZone:1",
  "to": "ENT:FareZone:2",
  "organisationId": 1,
  "time": "2026-08-26T10:53:07.737812629Z",
  "via": [
    "ENT:FareZone:1"
  ],
  "preOwned": [
    "ENT:FareZone:2"
  ]
}'

Example Request Body

{
  "from": "ENT:FareZone:1",
  "to": "ENT:FareZone:2",
  "organisationId": 1,
  "time": "2026-08-26T10:53:07.737812629Z",
  "via": [
    "ENT:FareZone:1"
  ],
  "preOwned": [
    "ENT:FareZone:2"
  ]
}

json

Example Responses

{
  "fromZoneId": "ENT:FareZone:1",
  "toZoneId": "ENT:FareZone:4",
  "organisationId": 1,
  "distance": 10,
  "zones": [
    {
      "requiredZones": [
        "ENT:FareZone:1",
        "ENT:FareZone:2",
        "ENT:FareZone:4"
      ],
      "path": [
        "ENT:FareZone:1",
        "ENT:FareZone:2",
        "ENT:FareZone:4"
      ]
    }
  ],
  "directPath": [
    {
      "requiredZones": [
        "ENT:FareZone:1",
        "ENT:FareZone:4"
      ],
      "path": [
        "ENT:FareZone:1",
        "ENT:FareZone:4"
      ]
    }
  ]
}

json

application/json

Return zone distance between two stop places

POST

https://api.entur.io/distance

/fare-zones/distances/stops

Resolves stop places to coordinates, then determines which overlapping fare zones each stop belongs to. Because a stop place can belong to multiple overlapping fare zones, all zone combinations are evaluated and one result per combination is returned. The request does support mixing zones into the stop places. If only doing zones the recommended url is /fare-zones/distances/zones as it is faster

Return zone distance between two stop places › Headers

ET-Client-Name

string · style: simple

X-Correlation-Id

string · style: simple

Correlation id

Return zone distance between two stop places › Request Body

ZonalStopPlaceDistanceRequest

stopPlaces

string[] · minItems: 1 · required

Ordered list of stop place IDs (first is origin, last is destination, any in between are via-points) the path must pass through. If needed the list can also contain Zones

organisationId

integer | null · int64

codespaces

string | null · minLength: 3 · maxLength: 3

time

string | null · date-time

preOwned

array | null · unique

Return zone distance between two stop places › Responses

FareZoneDistanceResponse[]

FareZoneDistanceResponse

fromZoneId

string

toZoneId

string

organisationId

integer · int64

distance

integer · int32

Zones[]

array | null

This field only gets populated if the direct path from-to is shorter than the via path

POST/fare-zones/distances/stops

curl https://api.entur.io/distance/fare-zones/distances/stops \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'ET-Client-Name: <api-key>' \
  --data '{
  "stopPlaces": [
    "NSR:StopPlace:337",
    "NSR:StopPlace:11"
  ],
  "organisationId": 1,
  "codespaces": "ENT",
  "time": "2026-08-26T10:53:07.820698178Z",
  "preOwned": [
    "ENT:FareZone:1"
  ]
}'

Example Request Body

{
  "stopPlaces": [
    "NSR:StopPlace:337",
    "NSR:StopPlace:11"
  ],
  "organisationId": 1,
  "codespaces": "ENT",
  "time": "2026-08-26T10:53:07.820698178Z",
  "preOwned": [
    "ENT:FareZone:1"
  ]
}

json

Example Responses

[
  {
    "fromZoneId": "ENT:FareZone:1",
    "toZoneId": "ENT:FareZone:4",
    "organisationId": 1,
    "distance": 10,
    "zones": [
      {
        "requiredZones": [
          "ENT:FareZone:1",
          "ENT:FareZone:2",
          "ENT:FareZone:4"
        ],
        "path": [
          "ENT:FareZone:1",
          "ENT:FareZone:2",
          "ENT:FareZone:4"
        ]
      }
    ],
    "directPath": [
      {
        "requiredZones": [
          "ENT:FareZone:1",
          "ENT:FareZone:4"
        ],
        "path": [
          "ENT:FareZone:1",
          "ENT:FareZone:4"
        ]
      }
    ]
  }
]

json

application/json

Return distance from polyline

POST

https://api.entur.io/distance

/fare-zones/distances/polyline

Finds all zones that a polyline passes through

Return distance from polyline › query Parameters

organisationId

integer[] · required · style: form · explode: true

List of organisations that one might request zones through

time

string · date-time · style: form · explode: true

The time at which the distance is active. This defaults to now

excludePolylineCoordinates

boolean · style: form · explode: true

Removes the polyline coordinates from the response

Return distance from polyline › Headers

ET-Client-Name

string · style: simple

X-Correlation-Id

string · style: simple

Correlation id

Return distance from polyline › Request Body

string

Example: cxk~Fhy~uO

Return distance from polyline › Responses

CoordinateDistanceResponse

from

string[]

to

string[]

array | null

allZonesCrossed

string[]

OrgBasedDistances[]

POST/fare-zones/distances/polyline

curl 'https://api.entur.io/distance/fare-zones/distances/polyline?organisationId=<value>' \
  --request POST \
  --header 'Content-Type: text/plain' \
  --header 'ET-Client-Name: <api-key>' \
  --data 'cxk~Fhy~uO'

Example Request Body

cxk~Fhy~uO

text

Example Responses

{
  "from": [
    "ENT:FareZone:337"
  ],
  "to": [
    "ENT:FareZone:94"
  ],
  "polylineCoordinates": [
    {
      "latitude": 1,
      "longitude": 1
    }
  ],
  "allZonesCrossed": [
    "RUT:FareZone:1"
  ],
  "orgBasedDistances": [
    {
      "from": "ENT:FareZone:337",
      "to": "ENT:FareZone:337",
      "organisation": 1,
      "zonesCrossed": [
        "ENT:FareZone:337"
      ],
      "shortestDistance": 1,
      "shortestPath": []
    }
  ]
}

json

application/json

Distance Netex

Did you find what you were looking for?

Fare Zone

Return distance between two fare zones

Return distance between two fare zones › Headers

Return distance between two fare zones › Request Body

Return distance between two fare zones › Responses

Return zone distance between two stop places

Return zone distance between two stop places › Headers

Return zone distance between two stop places › Request Body

Return zone distance between two stop places › Responses

Return distance from polyline

Return distance from polyline › query Parameters

Return distance from polyline › Headers

Return distance from polyline › Request Body

Return distance from polyline › Responses

Build with Entur

Contribute

Terms & Policies