> For the complete documentation index, see [llms.txt](https://docs.jakarto.com/guide-jakartowns/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.jakarto.com/guide-jakartowns/en/developers/api-url.md).

# API URL

This page describes how to construct a Jakartowns URL to open the application at a specific position.

Thanks to this simple and powerful API, you're just a click away from integrating the Jakartowns digital twin into any business application. A simple click will open the application directly at a specific position by building your own URL.

### Position Customization

One of the benefits of constructing the Jakartowns URL is the ability to customize the display position in the application. To do this, you can create a custom URL that will open the application centered on the geographic coordinates you specify.

### Building the URL

To construct the custom URL, you will need the following parameters:

1. **latitude (required):** Specify the latitude value to center the display of the map application on a specific point.
2. **longitude (required):** Specify the longitude value to center the display of the map application on a specific point.
3. **tilt (optional):** Use this value to adjust the vertical tilt of the view.\
   \&#xNAN;*0 corresponds to horizontal;*\
   \&#xNAN;*3.14/2 corresponds to the zenith;*\
   \&#xNAN;*-3.14/2 corresponds to the nadir.*
4. **pan (optional):** Set this value to adjust the horizontal rotation of the view.\
   \&#xNAN;*This angle is oriented toward the North of the projection system.*\
   \&#xNAN;*0 corresponds to North*\
   \&#xNAN;*3.14/2 corresponds to West*\
   \&#xNAN;*3.14 corresponds to South*
5. **fov (optional):** Use this parameter to adjust the field of view of the application. This value ranges from 10 (very zoomed in) to 100 (default view).
6. **year (optional):** Add this value to display map data for a specific year.
7. **uid (optional):** Technical identifier of a specific image, to open that exact image rather than the one closest to `lat`/`lng`. You'll find it, for example, by copying the URL shown by the application once you're positioned there.
8. **assetsURL (optional):** Public URL (with CORS enabled) of a data file (Shapefile `.zip`, GeoJSON, etc.), automatically imported into the inventory on load.
9. **enabledTool (optional):** Directly activates a tool on load. Accepted values: `point`, `line`, `polyline`, `polygon`, `annotation`, `triangulation`, `model3D`.

By default, Jakartowns will open the closest and most recent view to the specified position and target the given latitude/longitude.

## Example of Minimal Usage

You can now combine these parameters in the URL as follows:

```javascript
https://maps.jakarto.com/?lat={latitude_value}&lng={longitude_value}
```

Replace `{latitude_value}`, `{longitude_value}` with the corresponding numeric values you want to use.

## Example of Advanced Usage

```javascript
https://maps.jakarto.com/?lat={latitude_value}&lng={longitude_value}&pan={pan_value}&tilt={tilt_value}&fov={fov_value}&year={year_value}
```

Replace `{latitude_value}`, `{longitude_value}`, `{pan_value}`, `{tilt_value}`,`{fov_value}`, and `{year_value}` with the corresponding numeric values you want to use.

The values for `pan`, `tilt`, `fov`, and `year` are optional and will default to standard values if not specified.

The `pan` orientation will be automatically calculated to target the specified latitude/longitude.

### A Unique Mapping Experience

Using the URL API gives you control over how you share the digital twin with your users. Customize display positions based on your application's needs and provide a simple yet immersive mapping experience.

### Demonstration:

2022:

{% embed url="<https://maps.jakarto.com/?lat=45.551991489&lng=-73.225664627&pan=-7.059&tilt=-0.659&fov=100&year=2022>" %}

<figure><img src="https://4125772431-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FP8V5DV7IBnVaRHIDMd6N%2Fuploads%2Fgit-blob-04095806ed91b422847942185aa9612c3545c6c9%2Fimage%20(4).png?alt=media" alt=""><figcaption></figcaption></figure>

2023:

{% embed url="<https://maps.jakarto.com/?lat=45.551991489&lng=-73.225664627&pan=-7.059&tilt=-0.659&fov=100&year=2023>" %}

<figure><img src="https://4125772431-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FP8V5DV7IBnVaRHIDMd6N%2Fuploads%2Fgit-blob-9623e99f7bb57ff4fd2fa10da3167c7492a49c53%2Fimage%20(2).png?alt=media" alt=""><figcaption></figcaption></figure>

***

For an even more integrated experience in your application, we invite you to explore the [JavaScript API](/guide-jakartowns/en/developers/api-javascript.md).