API Reference

Routing

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Calculate a distance matrix between points

routing().matrix(RoutingMatrixParamsparams, RequestOptionsrequestOptions = RequestOptions.none()) : MatrixResult

POST/api/v1/matrix

Calculate a distance matrix between points

ParametersExpand Collapse

params: RoutingMatrixParams

matrixRequest: MatrixRequest

ReturnsExpand Collapse

class MatrixResult:

distances: List<List<Double>>

Distance matrix (meters), origins x destinations

durations: List<List<Double>>

Duration matrix (seconds), origins x destinations

Calculate a distance matrix between points

Kotlin

HTTP

TypeScript

Python

Java

Kotlin

Go

Ruby

CLI Tool

PHP

C#

package com.plazafyi.example

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

fun main() {
    val client: PlazaClient = PlazaOkHttpClient.fromEnv()

    val params: MatrixRequest = MatrixRequest.builder()
        .destinations(GeoJsonGeometry.builder()
            .coordinatesOfDoubles(listOf(0.0))
            .type(GeoJsonGeometry.Type.POINT)
            .build())
        .origins(GeoJsonGeometry.builder()
            .coordinatesOfDoubles(listOf(0.0))
            .type(GeoJsonGeometry.Type.POINT)
            .build())
        .build()
    val matrixResult: MatrixResult = client.routing().matrix(params)
}

200 example

{
  "distances": [
    [
      0
    ]
  ],
  "durations": [
    [
      0
    ]
  ]
}

Returns Examples

200 example

{
  "distances": [
    [
      0
    ]
  ],
  "durations": [
    [
      0
    ]
  ]
}