api-server/assets/index.html
Frank Villaro-Dixon a5b97b67a8 add source code
Signed-off-by: Frank Villaro-Dixon <frank@villaro-dixon.eu>
2024-10-09 23:32:13 +02:00

107 lines
3.5 KiB
HTML

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Free Elevation API Service</title>
<style>
body {
font-family: Arial, sans-serif;
margin: 0;
padding: 0;
background: #f4f4f4;
color: #454545;
}
header {
background: #007BFF;
color: #ffffff;
padding: 10px 20px;
text-align: center;
}
section {
padding: 20px;
margin: 0 10px;
background: #ffffff;
border-radius: 8px;
box-shadow: 0 2px 5px rgba(0, 0, 0, 0.1);
}
footer {
text-align: center;
padding: 10px 0;
background: #007BFF;
color: white;
/*position: fixed;*/
bottom: 0;
width: 100%;
}
code {
background: #eee;
padding: 2px 5px;
border-radius: 3px;
}
a {
color: #07a;
}
</style>
</head>
<body>
<header>
<h1>Free Elevation API Service</h1>
<p>Get the elevation of every point on Earth.</p>
</header>
<section>
<h2>About This Service</h2>
<p>This API provides you with access to elevation data across Earth's globe, absolutely free of charge.</p>
</section>
<section>
<h2>API Usage</h2>
<p>To use the API, make a GET request to this endpoint with the required parameters. Here is an example request:
</p>
<code>https://www.elevation-api.eu/v1/elevation/:lat/:lon[?json]</code>
<h3>Parameters:</h3>
<ul>
<li><strong>lat</strong> - Latitude of the location, WGS-84</li>
<li><strong>lon</strong> - Longitude of the location, WGS-84</li>
<li><strong>?json</strong> - Append this to have the result retuned as JSON</li>
</ul>
<h3>Response:</h3>
<p>The API will return the elevation in meters. For example:</p>
<code>42</code>
<p>If the point is not into the DEM dataset, the response code will be 501 (or <code>Null</code> in JSON mode)
</p>
<h3>Try it out:</h3>
<a href="http://www.elevation-api.eu/v1/elevation/46.24566/6.17081">Get the elevation of the Lake Leman</a>
</section>
<section>
<h2>JSON API endpoint (multi coordinates)</h2>
You can also request many coordinates at once by using the following endpoint:
<code>https://www.elevation-api.eu/v1/elevation?pts=[[lat1,lon1],[lat2,lon2],[lat3,lon3]]</code>
<h4>Example</h4>
<code><a href="https://www.elevation-api.eu/v1/elevation?pts=[[46.24566,6.17081],[46.85499,6.78134]]">
https://www.elevation-api.eu/v1/elevation?pts=[[46.24566,6.17081],[46.85499,6.78134]]
</a></code>
</section>
<section>
<h2>Misc</h2>
<h3>Data source</h3>
<p>The digital elevation data comes from ESA's Copernicus program.</p>
<h3>Rate limits</h3>
<p>Don't be an idiot. Less than 10/s is okay</p>
<h3>Source code</h3>
<p><a href="https://forge.k3s.fr/elevation-api-eu/api-server">https://forge.k3s.fr/elevation-api-eu/api-server</a></p>
<h3>Contact</h3>
<p>For more information, you can reach me at f@vi-di.fr. Patches welcome!</p>
</section>
<footer>
<p>© 2024 Frank Villaro-Dixon. No rights reserved</p>
</footer>
</body>
</html>