Skip to content

Latest commit

 

History

History
59 lines (45 loc) · 2.08 KB

README.md

File metadata and controls

59 lines (45 loc) · 2.08 KB
Raw

mapbox-sdk-js

npm version Build Status Coverage Status

A node.js and browser JavaScript client to Mapbox services.

Services

  • Geocoding
    • Forward (place names ⇢ longitude, latitude)
    • Reverse (longitude, latitude ⇢ place names)
  • Directions
    • Profiles for driving, walking, and cycling
    • GeoJSON & Polyline formatting
    • Instructions as text or HTML
  • Map Matching
    • Aligns GPS trace data to roads and paths from OpenStreetMap data
  • Surface API
    • Interpolates values along lines. Useful for elevation traces.
  • Upload API
    • Upload data to be processed and hosted by Mapbox.

Installation

$ npm install --save mapbox

Usage

Basic usage of the geocoder:

var MapboxClient = require('mapbox');
var client = new MapboxClient('YOUR_ACCESS_TOKEN');
client.geocodeForward('Chester, NJ', function(err, res) {
  // res is the geocoding result as parsed JSON
});

sub-requiring individual services

Each service is available as a sub-require if you'd only like to include only its functionality and not the entire bundle. The returned MapboxClient will have the same constructor style but only include functions necessary for that service's support.

Available sub-requires:

  • geocoder: require('mapbox/lib/services/geocoder')
  • surface: require('mapbox/lib/services/surface')
  • matching: require('mapbox/lib/services/matching')
  • directions: require('mapbox/lib/services/directions')

API