Before you begin
Registering an app and checking the REST API key
To use the Directions API, you must register an application (app) and get a REST API key.
1. Registering an app
[Performed on Kakao Developers]
Log in to Kakao Developers. If you do not have an account, sign up first, then proceed to the next step.
After logging in, click App → Create app at the top right of the screen.
Review the items below and fill them in to create your app.
App icon: Add an image to use as the app icon. The recommended image size is 128x128 px, and you can upload a file of up to 250 KB. Supported file formats are JPG, GIF, and PNG.
App name: Set the name of your app (service). * Required
Company name: Enter your business name. It must match the name in your business registration information. * Required
DANGER
Caution: The app (service) name can be up to 30 characters including spaces.
Category: Select the category of your service. * Required
App domain: Enter the main domain of your service.
- Fill in each item, make sure your app does not fall under any restrictions in the operation policy, and click Save to create the app. You can find the created app under App.
2. Registering service information
[Performed on Kakao Developers]
REST API calls require a REST API key, and you must register your service information on Kakao Developers before use.
Go to App → select the app to issue a key for → App → Platform key.
Select Add REST API key to add a REST API key, or select the default key that was created.
Register the required service information items.
- REST API key: View and copy the issued REST API key value.
- Key name: Set a name to identify the key. * Required
- Allowed IP address: Register the IP addresses allowed to make requests with the REST API key.
- Redirect URI: Register the redirect URI required when using Kakao Login or business authentication.
- Client Secret: Enable or disable it, and issue and manage codes. The client secret is enabled by default when a REST API key is created.
- Additional information: Check the key's activation status, creation date, and modification date.
TIP
For details, see App settings on Kakao Developers.
3. Checking the REST API key
[Performed on Kakao Developers]
- Go to App → select the app to issue a key for → App → Platform key.
- Copy the REST API key value and use it.
Directions API information
The number of locations you can set and the information provided by each API are as follows.
| API Name | Origin | Destination | Waypoints | Departure Time | Information Provided |
|---|---|---|---|---|---|
| Driving Directions | 1 | 1 | Up to 5 | Current | Detailed route guidance by section, or route summary |
| Multi-Waypoint Directions | 1 | 1 | Up to 30 | Current | Detailed route guidance by section, or route summary |
| Multi-Origin Directions | 1 or more (up to 30) | 1 | - | Current | Estimated travel time and distance |
| Multi-Destination Directions | 1 | 1 or more (up to 30) | - | Current | Estimated travel time and distance |
| Future Driving Directions | 1 | 1 | Up to 5 | Future | Detailed route guidance by section, or route summary |
The following section lists quotas and pricing for the Directions API. To request a higher quota or more locations than the maximums in the table above, submit an affiliate inquiry.
Directions API list
The features provided by the Directions API and the basic request specifications are as follows.
| Name | URL | Host | Method |
|---|---|---|---|
| Driving Directions | /v1/directions | https://apis-navi.kakaomobility.com | GET |
| Multi-Waypoint Directions | /v1/waypoints/directions | https://apis-navi.kakaomobility.com | POST |
| Multi-Origin Directions | /v1/origins/directions | https://apis-navi.kakaomobility.com | POST |
| Multi-Destination Directions | /v1/destinations/directions | https://apis-navi.kakaomobility.com | POST |
| Future Driving Directions | /v1/future/directions | https://apis-navi.kakaomobility.com | GET |