# POST /v1/matrix

> Index: https://kartpunkt.se/llms.txt

operationId: `buildMatrix`. An origins × destinations matrix.
Tag: `routing`.

Metres and free-flow seconds along the network from every origin to every destination, as grids with a status per cell; with avoid or prefer each cell is the path POST /v1/distances answers for it. Use it for a table of travel times between many places; for each path's facts or line, use POST /v1/distances. It costs at most a calculation per two cells, rounded up; Metering has the formula.

## Request

`POST https://api.kartpunkt.se/v1/matrix` with `Authorization: Bearer $KARTPUNKT_API_KEY` and `Content-Type: application/json`, from your backend (never browser code: the key would leak, and CORS is not enabled).

Example body:

```json
{
  "origins": [
    {
      "lat": 63.72059,
      "lon": 19.342166
    },
    {
      "lat": 63.720434,
      "lon": 19.348226
    },
    {
      "lat": 63.675987,
      "lon": 19.335126
    }
  ],
  "destinations": [
    {
      "lat": 63.724508,
      "lon": 19.339523
    },
    {
      "lat": 63.718529,
      "lon": 19.418702
    },
    {
      "lat": 63.725224,
      "lon": 19.282034
    }
  ],
  "profile": "car_fastest"
}
```

JSON body:

- `origins` (array of [StreetPoint](https://api.kartpunkt.se/docs/shapes/StreetPoint.md), 1..100 items, required): The points to measure from: the matrix's rows.
- `destinations` (array of [StreetPoint](https://api.kartpunkt.se/docs/shapes/StreetPoint.md), 1..100 items, required): The points to measure to: the matrix's columns.
- `profile` ([Profile](https://api.kartpunkt.se/docs/shapes/Profile.md), required)
- `vehicle` ([Vehicle](https://api.kartpunkt.se/docs/shapes/Vehicle.md), optional)
- `avoid` ([Avoid](https://api.kartpunkt.se/docs/shapes/Avoid.md), optional)
- `prefer` (array of [Preference](https://api.kartpunkt.se/docs/shapes/Preference.md), 0..6 items, optional): Facts to prefer to keep off, on any profile, each once. Left out or [], the profile's own weighing.
- `network` ([NetworkSelector](https://api.kartpunkt.se/docs/shapes/NetworkSelector.md), optional)

## Response 200

Example:

```json
{
  "distances_m": [
    [
      560,
      3790,
      null
    ],
    [
      860,
      3490,
      null
    ],
    [
      null,
      null,
      null
    ]
  ],
  "durations_s": [
    [
      50,
      169,
      null
    ],
    [
      77,
      142,
      null
    ],
    [
      null,
      null,
      null
    ]
  ],
  "statuses": [
    [
      "ok",
      "ok",
      "no_path"
    ],
    [
      "ok",
      "ok",
      "no_path"
    ],
    [
      "no_road_near",
      "no_road_near",
      "no_road_near"
    ]
  ],
  "provenance": {
    "synthetic": true,
    "network": {
      "id": "snap_01k7exampleexampleexample0",
      "dataset": "nvdb",
      "source_date": "2026-10-13",
      "built_at": "2026-10-13T07:00:00.000Z",
      "graph": "snap_01k7exampleexampleexample0",
      "profile": "car_fastest",
      "experimental": false
    },
    "sources": [
      {
        "id": "nvdb",
        "name": "Trafikverket, NVDB",
        "licence": "CC0-1.0",
        "attribution": "Vägdata från NVDB, Trafikverket, CC0 1.0",
        "url": "https://creativecommons.org/publicdomain/zero/1.0/",
        "updated": "2026-10-13"
      }
    ]
  }
}
```

- `distances_m` (array of array of number | null): [origin][destination]: metres along the network, null where no path joins them.
- `durations_s` (array of array of number | null): [origin][destination]: seconds at free flow, null where no path joins them.
- `statuses` (array of array of "ok" | "no_path" | "ferry_required" | "no_road_near" | "avoided_road_required"): [origin][destination]: each cell's status, as a path's.
- `provenance` ([Provenance](https://api.kartpunkt.se/docs/shapes/Provenance.md))

## Errors

Every error is `{ error, message, param?, doc_url }`; `message` says what to do next. All codes: [https://api.kartpunkt.se/errors](https://api.kartpunkt.se/errors). What to do on each, with retries: [https://api.kartpunkt.se/docs/recipes/errors-and-retries.md](https://api.kartpunkt.se/docs/recipes/errors-and-retries.md).

- [`invalid_request`](https://api.kartpunkt.se/errors/invalid_request) (400): The request does not match the API schema. Fix the fields named in this message; see /openapi.json.
- [`unauthorized`](https://api.kartpunkt.se/errors/unauthorized) (401): Missing or unknown API key. Send it as 'Authorization: Bearer <key>' (or 'x-api-key'), read from the KARTPUNKT_API_KEY environment variable. The user creates a kp_test_ key on their Kartpunkt account page (https://kartpunkt.se/konto) and puts it in KARTPUNKT_API_KEY themselves; never ask them to paste a key into chat.
- [`live_access_required`](https://api.kartpunkt.se/errors/live_access_required) (403): This account is not approved for live data: kp_live_ keys are for customers under contract. Use a kp_test_ key. To ask for live access, the account holder writes to hej@kartpunkt.se, or orders a plan at https://kartpunkt.se/konto#plan.
- [`use_not_permitted`](https://api.kartpunkt.se/errors/use_not_permitted) (403): This operation would use a data source in a way its licence or approval does not allow (see GET /v1/sources). It cannot be answered for this key.
- [`network_unavailable`](https://api.kartpunkt.se/errors/network_unavailable) (404): No network snapshot matches that id or as_of. List the snapshots with GET /v1/networks and send one of their ids, or leave network out for the active one.
- [`network_not_active`](https://api.kartpunkt.se/errors/network_not_active) (409): That network snapshot is not the one served now, and answers on another snapshot are computed as jobs. Send the same input to POST /v1/jobs with this operation, then read GET /v1/jobs/{id}.
- [`profile_unavailable`](https://api.kartpunkt.se/errors/profile_unavailable) (409): This profile cannot be answered on the network snapshot asked for: it was built without the data the profile needs (see GET /v1/profiles and the snapshot's manifest at GET /v1/networks/{id}). Use another profile or a newer snapshot.
- [`network_pruned`](https://api.kartpunkt.se/errors/network_pruned) (410): That network snapshot was pruned: its tables and graph are deleted, so nothing can be answered on it again, as a job or otherwise. Leave network out to answer on the active network, and store that answer's provenance.network.id; GET /v1/networks lists the snapshots that are not pruned.
- [`too_large`](https://api.kartpunkt.se/errors/too_large) (413): Too much for one synchronous call. Send the same input to POST /v1/jobs with this operation and read the result from GET /v1/jobs/{id}, or split it.
- [`quota_exceeded`](https://api.kartpunkt.se/errors/quota_exceeded) (429): Request limit or plan quota reached (per minute, per day, or the account plan's monthly quota). Wait the number of seconds in the Retry-After header, then retry; without Retry-After, no wait helps: tell the account holder what this message says.
- [`internal_error`](https://api.kartpunkt.se/errors/internal_error) (500): Something failed on our side. Retry after a few seconds; if it keeps failing, contact hej@kartpunkt.se.
- [`live_data_unavailable`](https://api.kartpunkt.se/errors/live_data_unavailable) (503): Live data is not available yet: it opens when Kartpunkt's import of Lantmäteriet's address register completes. Use a kp_test_ key until then.
- [`routing_unavailable`](https://api.kartpunkt.se/errors/routing_unavailable) (503): Road distances and routes are not available yet: Kartpunkt's road graph from Trafikverket's NVDB has not been built. Try again later.

## Limits

| Limit | Synchronous | As a job (`POST /v1/jobs`, `operation: "matrix"`) |
| --- | --- | --- |
| Cells (origins × destinations) | 625 | 10000 |
| Cells with an `avoid` entry in `mode: "barrier"` | 20 | 10000 |
| Origins with `vehicle`, `prefer` or `avoid` (a search per origin) | 8 | within the cells (a job runs in chunks) |
| Ways of the network `avoid` keeps off | 20000 | 20000 |
| `origins` (items) | 100 | 100 |
| `destinations` (items) | 100 | 100 |
| `prefer` (items) | 6 | 6 |
| Request body | 1 MB | 8 MB |

Above a synchronous limit the call is refused (413 `too_large`, or 400 `invalid_request` naming the field); send the same input as a job.

## Metering

Calculations: max(1, min(ceil(origins × destinations / 2), the longer list × 10)), so 100 × 100 is 1000.