Getting started with wrld.js

If you don’t have an account yet, you will need to sign up for a Digital Twin account and confirm your email address
Create an API Key in the developer portal
Take note of the created key, you will need it soon

2. Get wrld.js

Install using a package manager…

yarn: yarn add wrld.js
NPM: npm install wrld.js

… or reference from a CDN

Add the following lines to the <head> section of your HTML file:

<script src="https://unpkg.com/wrld.js@1.x.x"></script>
<link href="https://cdnjs.cloudflare.com/ajax/libs/leaflet/1.0.1/leaflet.css" rel="stylesheet" />

3. Add the map to your page

The last step is to insert your API key and you’re good to go!

You can do this whenever you create a new map: Wrld.map("map", "your_api_key_here").

Here is a complete live example (drag the map!):

<script src="https://unpkg.com/wrld.js@1.x.x"></script>
<link href="https://cdnjs.cloudflare.com/ajax/libs/leaflet/1.0.1/leaflet.css" rel="stylesheet" />
<div id="map" style="height: 250px"></div>
<script>Wrld.map("map", "your_api_key_here");</script>

Console errors?

Seeing Eegeo:: Bad API Key - Sign up at https://accounts.wrld3d.com/users/sign_in?service=https%3A%2F%2Faccounts.wrld3d.com%2F%23apikeys to get a wrld.js API Key? You probably forgot to insert your API key when creating your map!