Get started

Getting started

Make your first Atlas requests — search a place, route to it, draw the map and overlay imagery.
Every example uses the hosted API at https://atlas-api-dusky.vercel.app. Read-only routes work without a token while auth is optional; send one anyway so your usage is attributed (see Authentication).
Terminal
export ATLAS_API=https://atlas-api-dusky.vercel.app export ATLAS_TOKEN=<your user token>
  • 1

    Check the API is up

    Terminal
    curl "$ATLAS_API/healthz"
  • 2

    Find a place

    Terminal
    curl "$ATLAS_API/search?q=coffee&near=40.7484,-73.9857&limit=5" \ -H "Authorization: Bearer $ATLAS_TOKEN"
    Results carry a GERS id you can pass to GET /places/{gersId} for full detail.
  • 3

    Route to it

    Terminal
    curl "$ATLAS_API/route?from=40.7484,-73.9857&to=40.7536,-73.9837&mode=walk" \ -H "Authorization: Bearer $ATLAS_TOKEN"
    You get a GeoJSON LineString, the distance and duration, and turn-by-turn steps.
  • 4

    Draw the map

    Point any MVT renderer, such as MapLibre GL, at the vector tiles:
    Text
    https://atlas-api-dusky.vercel.app/tiles/vector/{z}/{x}/{y}.mvt
    Rendered PNG basemap tiles are at /tiles/raster/{z}/{x}/{y}.png and shaded relief at /tiles/terrain/{z}/{x}/{y}.png.
  • 5

    Overlay imagery

    Ingested remote-sensing datasets are served at /raster/{dataset}/{z}/{x}/{y}.png, with rescale, colormap_name and algorithm as query parameters. For scripted analysis, see Running Earth Engine scripts.
Previous
Overview
Next
Coverage and data