Solve a clustering problem

POST

/cluster

The Cluster endpoint is used with a POST request towards
https://graphhopper.com/api/1/cluster?key=<your_key>. The solution will be provided in the JSON response.
Please note that for problems that take longer than 10 seconds a bad request error is returned.
In this case please use the asynchronous Batch Cluster Endpoint instead.

请求参数

Authorization

API Key

在 query 添加参数

key

示例：

key: ********************

Body 参数application/json必填

示例

{
    "configuration": {
        "response_type": "json",
        "routing": {
            "profile": "car",
            "cost_per_second": 1,
            "cost_per_meter": 0
        },
        "clustering": {
            "num_clusters": 10,
            "max_quantity": 50,
            "min_quantity": 30
        }
    },
    "clusters": [
        {
            "name": "GraphHopper GmbH",
            "center": {
                "lon": 11.53941,
                "lat": 48.118434,
                "street_hint": "Lindenschmitstraße 52"
            },
            "min_quantity": 10,
            "max_quantity": 10
        }
    ],
    "customers": [
        {
            "id": "GraphHopper GmbH",
            "address": {
                "lon": 11.53941,
                "lat": 48.118434,
                "street_hint": "Lindenschmitstraße 52"
            },
            "quantity": 10
        }
    ]
}

请求示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location '/cluster?key=%3Capi-key%3E' \
--header 'Content-Type: application/json' \
--data '{
    "configuration": {
        "response_type": "json",
        "routing": {
            "profile": "car",
            "cost_per_second": 1,
            "cost_per_meter": 0
        },
        "clustering": {
            "num_clusters": 10,
            "max_quantity": 50,
            "min_quantity": 30
        }
    },
    "clusters": [
        {
            "name": "GraphHopper GmbH",
            "center": {
                "lon": 11.53941,
                "lat": 48.118434,
                "street_hint": "Lindenschmitstraße 52"
            },
            "min_quantity": 10,
            "max_quantity": 10
        }
    ],
    "customers": [
        {
            "id": "GraphHopper GmbH",
            "address": {
                "lon": 11.53941,
                "lat": 48.118434,
                "street_hint": "Lindenschmitstraße 52"
            },
            "quantity": 10
        }
    ]
}'

返回响应

🟢200成功

application/json

A response containing the solution

Headers

Bodyapplication/json

示例

{
    "copyrights": [
        "GraphHopper",
        "OpenStreetMap contributors"
    ],
    "status": "waiting_in_queue",
    "waiting_time_in_queue": 0,
    "processing_time": 4900,
    "clusters": [
        {
            "quantity": 40,
            "ids": [
                "GraphHopper GmbH"
            ]
        }
    ]
}

🟠400请求有误

🔴500服务器错误

修改于 2025-11-25 06:18:54

Retrieve solution of a route optimization job

Submit a clustering job