@stadiamaps/api
v5.0.0
Published
Stadia Maps Geospatial APIs
Downloads
4,433
Readme
Stadia Maps JavaScript SDK
This SDK helps you access the full range of geospatial APIs from Stadia Maps using JavaScript, TypeScript, etc. We've written everything in TypeScript, derived from our official API spec, so you'll get all the goodies like autocomplete, type definitions, and documentation in your favorite editor.
Getting started with npm
First, add @stadiamaps/api as a dependency of your project using your favorite package manager
like npm or yarn. Something like this:
npm install --save @stadiamaps/apiThe library exposes 3 different API classes for grouping functionality: GeocodingApi,
GeospatialApi, and RoutingApi. These correspond to the sections in our online
API Reference.
All clients have the same interface and only expose different methods. Here is an example of getting started with the geocoding API:
// Imports: you need the API(s) that you intend to use at a minimum.
import { GeocodingApi, Configuration } from "@stadiamaps/api";
// Most users can use our domain-based or localhost authentication methods (see https://docs.stadiamaps.com/authentication/).
//
// If you are writing for a backend application or can't use domain-based auth,
// then you'll need to add your API key like so:
//
// const config = new Configuration({ apiKey: "YOUR-API-KEY" });
// const api = new GeocodingApi(config);
const api = new GeocodingApi();
// Make an API call! The responses use the standard promise API.
// You can use either the callback interface...
api.reverse({ pointLat: 59.44436, pointLon: 24.75071 }).then(
function (result) {
console.log(result);
},
function (err) {
console.log(err);
},
);
// ... or the await keyword in an async context
const res = await api.search({ text: "Põhja pst 27" });Getting started with unpkg
If you like to keep your frontend simple and don't want to use JS build tooling, we have you covered! You can easily use
the SDK by linking to the module on unpkg. The library is exported via the global stadiaMapsApi, but otherwise
functions exactly like if you used npm package tooling.
Here's a quick usage example of a webpage that makes a geocoding query and displays the result.
<!doctype html>
<html>
<head>
<script
type="text/javascript"
src="https://www.unpkg.com/@stadiamaps/api@3"
></script>
<script type="text/javascript">
// In nearly all cases, you should be able to construct any of the APIs as-is (see https://docs.stadiamaps.com/authentication/).
// If you really need an API key, you can add it like so:
// const config = new stadiaMapsApi.Configuration({ apiKey: "YOUR-API-KEY" });
// const api = new stadiaMapsApi.GeocodingApi(config);
const api = new stadiaMapsApi.GeocodingApi();
window.onload = async function () {
// You can use either the async interface or the other Promise API functions like .then; the choice is yours.
const res = await api.autocomplete({ text: "Põhja pst 27" });
document.getElementById("pre").innerHTML = JSON.stringify(res, null, 2);
};
</script>
</head>
<body>
<div>
<pre id="pre">Loading...</pre>
</div>
</body>
</html>Documentation
Official documentation lives at docs.stadiamaps.com, where we have both long-form prose explanations of each endpoint and an interactive API reference.
Developing
Refer to DEVELOPING.md for details on local development.