Get started

Get started

TypeScript SDK

Typed packages for the Mountaya platform. Read itineraries, render them on a map, and edit them, in a browser or on a server.

The SDK ships on npm under the @mountaya scope, from one repository released together.

One family talks to the platform. It builds every request, holds your credential, and hands back typed data. The other family draws that data on a map and fetches nothing for you. Feed it from your cache, your store, or a payload you rendered on a server.

Install sets up the packages, the stylesheet, and the provider the React components read. Every page after it assumes you did that once.

What you can build

One credential, three hosts

The client resolves each surface to its own host, so one instance serves all three.

SurfaceDefault base URL
Map Studio APIhttps://api.mountaya.com
Data APIhttps://data.mountaya.com
Tile APIhttps://tiles.mountaya.com

Point any of them at a local stack or at your own gateway with the baseUrls option.

A publishable key (pk_…) is safe to ship to a browser. A secret key (sk_…) mints session tokens and belongs on a server you control. @mountaya/client/browser does not export the secret-key credential, and its constructor throws in a page or a React Native application. Read authentication for the key, scope, and session model these packages implement.

Next steps