Skip to content

Calculate a distance matrix between points

MatrixResult routing().matrix(, )

POST/api/v1/matrix

Calculate a distance matrix between points

ParametersExpand Collapse

RoutingMatrixParams params

MatrixRequest matrixRequest

Request body for distance matrix calculation. Computes travel durations (and optionally distances) between every origin-destination pair. Maximum 2,500 pairs (origins × destinations), each list capped at 50 coordinates.

ReturnsExpand Collapse

class MatrixResult:

Distance matrix result. The exact response shape depends on the routing backend. Contains duration (and optionally distance) data for all origin-destination pairs. Null values indicate unreachable pairs.

Calculate a distance matrix between points

package com.plazafyi.example;

import com.plazafyi.client.PlazaClient;
import com.plazafyi.client.okhttp.PlazaOkHttpClient;
import com.plazafyi.models.routing.MatrixRequest;
import com.plazafyi.models.routing.MatrixResult;
import com.plazafyi.models.routing.RoutingMatrixParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        PlazaClient client = PlazaOkHttpClient.fromEnv();

        MatrixRequest params = MatrixRequest.builder()
            .addDestination(MatrixRequest.Destination.builder()
                .lat(48.8584)
                .lng(2.2945)
                .build())
            .addOrigin(MatrixRequest.Origin.builder()
                .lat(48.8566)
                .lng(2.3522)
                .build())
            .addOrigin(MatrixRequest.Origin.builder()
                .lat(48.8606)
                .lng(2.3376)
                .build())
            .build();
        MatrixResult matrixResult = client.routing().matrix(params);
    }
}

{
  "foo": "bar"
}

Returns Examples

{
  "foo": "bar"
}