# Woosmap Developers

> Woosmap is a Platform for Developers to enable Location Intelligence in their Website and App. Get access to tutorials or explore our API References.

Every page here has a clean Markdown twin: append `.md` to any page URL.
This file is a ROUTING index. Exhaustive page list: https://developers.woosmap.com/llms-full.txt

## How to choose a page

- Exact request shape — parameter names, types, required flags, defaults,
  response schema: use `/api-reference/...`. Those pages are generated from
  the OpenAPI spec and are AUTHORITATIVE. Prefer them over guides and samples,
  which show one usage and omit most parameters.
- Whole-schema machine consumption: /assets/woosmap-openapi3.json (OpenAPI 3.1).
- What a product does, coverage, limits, concepts: `/products/<product>/...`.
- Runnable end-to-end code: `/js-samples/...`.
- Client-side SDKs (Map JS API, mobile, widgets) expose no REST endpoints;
  their API surface lives under `/products/<product>/reference/...`.

Reference URLs are verb-prefixed and path-flattened: `GET /localities/autocomplete`
is at `/api-reference/localities-api/get-localities-autocomplete.md`. Take reference
URLs from this file rather than assembling them, and never invent a parameter that
is absent from the reference page.

## Machine-readable schema

- OpenAPI 3.1 spec, all REST endpoints: https://developers.woosmap.com/assets/woosmap-openapi3.json
- API reference hub: https://developers.woosmap.com/api-reference.md
- Authentication, API keys and referrer restrictions: https://developers.woosmap.com/api-reference/authentication.md

## REST APIs

### Localities API

Address, city and postal-code autocomplete, geocoding and place details worldwide.
Base URL: `https://api.woosmap.com/localities`

Endpoint reference — authoritative for parameters and responses:
- `GET /localities/autocomplete` — Autocomplete: https://developers.woosmap.com/api-reference/localities-api/get-localities-autocomplete.md
- `GET /localities/details` — Details: https://developers.woosmap.com/api-reference/localities-api/get-localities-details.md
- `GET /localities/geocode` — Geocode: https://developers.woosmap.com/api-reference/localities-api/get-localities-geocode.md
- `GET /localities/nearby` — Nearby: https://developers.woosmap.com/api-reference/localities-api/get-localities-nearby.md
- Product docs (22 pages), start at: https://developers.woosmap.com/products/localities/overview.md
- Runnable samples (11), e.g. https://developers.woosmap.com/js-samples/localities-api-autocomplete-advanced.md — full list in llms-full.txt

### Stores API

Search your own asset/store network, and create/update/delete those assets.
Base URL: `https://api.woosmap.com/stores`

Endpoint reference — authoritative for parameters and responses:
- `DELETE /stores` — Delete the Assets: https://developers.woosmap.com/api-reference/data-api/delete-stores.md
- `POST /stores` — Create your Assets: https://developers.woosmap.com/api-reference/data-api/post-stores.md
- `PUT /stores` — Update the Assets: https://developers.woosmap.com/api-reference/data-api/put-stores.md
- `GET /stores/autocomplete` — Autocomplete for assets: https://developers.woosmap.com/api-reference/search-api/get-stores-autocomplete.md
- `POST /stores/replace` — Replace all assets: https://developers.woosmap.com/api-reference/data-api/post-stores-replace.md
- `GET /stores/search` — Search for assets: https://developers.woosmap.com/api-reference/search-api/get-stores-search.md
- `GET /stores/search/bounds` — Bounds for assets: https://developers.woosmap.com/api-reference/search-api/get-stores-search-bounds.md
- `GET /stores/{storeId}` — Get Asset from ID: https://developers.woosmap.com/api-reference/data-api/get-stores-storeid.md
- Product docs (10 pages), start at: https://developers.woosmap.com/products/stores-api/overview.md
- Runnable samples (7), e.g. https://developers.woosmap.com/js-samples/stores-list-sync-map.md — full list in llms-full.txt

### Distance API

Travel distances, durations, routes and toll costs; sync and async matrix modes.
Base URL: `https://api.woosmap.com/distance`

Endpoint reference — authoritative for parameters and responses:
- `GET /distance/distancematrix/json/` — Calculate Matrix: https://developers.woosmap.com/api-reference/distance-api/get-distance-distancematrix-json.md
- `POST /distance/distancematrix/json/` — Calculate Matrix: https://developers.woosmap.com/api-reference/distance-api/post-distance-distancematrix-json.md
- `GET /distance/isochrone/json/` — Calculate Isochrone: https://developers.woosmap.com/api-reference/distance-api/get-distance-isochrone-json.md
- `POST /distance/isochrone/json/` — Calculate Isochrone: https://developers.woosmap.com/api-reference/distance-api/post-distance-isochrone-json.md
- `POST /distance/matrix/async/` — Start Matrix Calculation: https://developers.woosmap.com/api-reference/distance-async-api/post-distance-matrix-async.md
- `GET /distance/matrix/async/{matrix_id}` — Get Matrix Calculation Result: https://developers.woosmap.com/api-reference/distance-async-api/get-distance-matrix-async-matrix_id.md
- `GET /distance/matrix/async/{matrix_id}/status` — Check Matrix Calculation Status: https://developers.woosmap.com/api-reference/distance-async-api/get-distance-matrix-async-matrix_id-status.md
- `GET /distance/route/json/` — Find Routes: https://developers.woosmap.com/api-reference/distance-api/get-distance-route-json.md
- `GET /distance/tolls/json/` — Find Tolls: https://developers.woosmap.com/api-reference/distance-api/get-distance-tolls-json.md
- Product docs (14 pages), start at: https://developers.woosmap.com/products/distance-api/overview.md
- Runnable samples (3), e.g. https://developers.woosmap.com/js-samples/distance-isochrone.md — full list in llms-full.txt

### Geolocation API

Resolve a device position from IP or network signals.
Base URL: `https://api.woosmap.com/geolocation`

Endpoint reference — authoritative for parameters and responses:
- `GET /geolocation/position` — Geolocation from an IP address: https://developers.woosmap.com/api-reference/geolocation-api/get-geolocation-position.md
- `GET /geolocation/stores` — Assets nearby a Geolocation: https://developers.woosmap.com/api-reference/geolocation-api/get-geolocation-stores.md
- `GET /geolocation/timezone` — Timezone: https://developers.woosmap.com/api-reference/geolocation-api/get-geolocation-timezone.md
- Product docs (4 pages), start at: https://developers.woosmap.com/products/geolocation-api/location.md

### Datasets API

Bulk-import and manage large custom datasets.
Base URL: `https://api.woosmap.com/datasets`

Endpoint reference — authoritative for parameters and responses:
- `GET /datasets/` — List Datasets: https://developers.woosmap.com/api-reference/datasets-api/get-datasets.md
- `POST /datasets/` — Create Dataset: https://developers.woosmap.com/api-reference/datasets-api/post-datasets.md
- `POST /datasets/hooks/reimport/{reimport_key}` — Reimport Dataset Webhook: https://developers.woosmap.com/api-reference/datasets-api/post-datasets-hooks-reimport-reimport_key.md
- `DELETE /datasets/{dataset_id}` — Delete Dataset: https://developers.woosmap.com/api-reference/datasets-api/delete-datasets-dataset_id.md
- `GET /datasets/{dataset_id}` — Get Dataset: https://developers.woosmap.com/api-reference/datasets-api/get-datasets-dataset_id.md
- `PUT /datasets/{dataset_id}` — Update Dataset: https://developers.woosmap.com/api-reference/datasets-api/put-datasets-dataset_id.md
- `POST /datasets/{dataset_id}/features/contains/` — Contains Features: https://developers.woosmap.com/api-reference/datasets-api/post-datasets-dataset_id-features-contains.md
- `POST /datasets/{dataset_id}/features/intersects/` — Intersect Features: https://developers.woosmap.com/api-reference/datasets-api/post-datasets-dataset_id-features-intersects.md
- `POST /datasets/{dataset_id}/features/nearby/` — Nearby Features: https://developers.woosmap.com/api-reference/datasets-api/post-datasets-dataset_id-features-nearby.md
- `POST /datasets/{dataset_id}/features/search/` — Search Features: https://developers.woosmap.com/api-reference/datasets-api/post-datasets-dataset_id-features-search.md
- `POST /datasets/{dataset_id}/features/within/` — Within Features: https://developers.woosmap.com/api-reference/datasets-api/post-datasets-dataset_id-features-within.md
- `GET /datasets/{dataset_id}/features/{feature_id}` — Get Feature: https://developers.woosmap.com/api-reference/datasets-api/get-datasets-dataset_id-features-feature_id.md
- `POST /datasets/{dataset_id}/import` — Trigger Import: https://developers.woosmap.com/api-reference/datasets-api/post-datasets-dataset_id-import.md
- `GET /datasets/{dataset_id}/status` — Get Dataset Status: https://developers.woosmap.com/api-reference/datasets-api/get-datasets-dataset_id-status.md
- Product docs (2 pages), start at: https://developers.woosmap.com/products/datasets-api/get-started.md

### Indoor API

Indoor venues, levels, POIs and indoor routing.
Base URL: `https://api.woosmap.com/indoor`

Endpoint reference — authoritative for parameters and responses:
- `GET /indoor/directions/{venue_id}` — Directions: https://developers.woosmap.com/api-reference/indoor-api/get-indoor-directions-venue_id.md
- `GET /indoor/distancematrix/{venue_id}` — Distance Matrix: https://developers.woosmap.com/api-reference/indoor-api/get-indoor-distancematrix-venue_id.md
- `GET /indoor/style` — Get Indoor Style: https://developers.woosmap.com/api-reference/indoor-api/get-indoor-style.md
- `GET /indoor/venues` — Get Venues By Key: https://developers.woosmap.com/api-reference/indoor-api/get-indoor-venues.md
- `GET /indoor/venues/{venue_id}` — Get Venue By Key: https://developers.woosmap.com/api-reference/indoor-api/get-indoor-venues-venue_id.md
- `GET /indoor/venues/{venue_id}/features/{feature_id}` — Get Feature By Key: https://developers.woosmap.com/api-reference/indoor-api/get-indoor-venues-venue_id-features-feature_id.md
- `GET /indoor/venues/{venue_id}/pois/autocomplete` — Autocomplete Venue Pois By Key: https://developers.woosmap.com/api-reference/indoor-api/get-indoor-venues-venue_id-pois-autocomplete.md
- `GET /indoor/venues/{venue_id}/pois/search` — Search Venue Pois By Key: https://developers.woosmap.com/api-reference/indoor-api/get-indoor-venues-venue_id-pois-search.md
- `GET /indoor/venues/{venue_id}/tiles/{z}/{x}/{y}.pbf` — Tiles By Key: https://developers.woosmap.com/api-reference/indoor-api/get-indoor-venues-venue_id-tiles-z-x-y.md
- Product docs (16 pages), start at: https://developers.woosmap.com/products/indoor-api/overview.md
- Runnable samples (6), e.g. https://developers.woosmap.com/js-samples/indoor-directions-service.md — full list in llms-full.txt

### Static Map API

Server-rendered map images with markers, paths and polygons.
Base URL: `https://api.woosmap.com/maps`

Endpoint reference — authoritative for parameters and responses:
- `GET /maps/static` — Get Static Map: https://developers.woosmap.com/api-reference/static-map-api/get-maps-static.md
- Product docs (3 pages), start at: https://developers.woosmap.com/products/map-static-api/get-started.md

### Transit API

Public-transport routing and schedules.
Base URL: `https://api.woosmap.com/transit`

Endpoint reference — authoritative for parameters and responses:
- `GET /transit/route` — Transit Route: https://developers.woosmap.com/api-reference/transit-api/get-transit-route.md
- Product docs (1 pages), start at: https://developers.woosmap.com/products/transit-api/route-endpoint.md

### What3Words API

Convert between three-word addresses and coordinates.
Base URL: `https://api.woosmap.com/what3words`

Endpoint reference — authoritative for parameters and responses:
- `GET /what3words/autosuggest` — Autosuggest: https://developers.woosmap.com/api-reference/what3words-api/get-what3words-autosuggest.md
- `GET /what3words/convert-to-3wa` — Convert To What 3 Words: https://developers.woosmap.com/api-reference/what3words-api/get-what3words-convert-to-3wa.md
- `GET /what3words/convert-to-address` — Convert To Address: https://developers.woosmap.com/api-reference/what3words-api/get-what3words-convert-to-address.md
- Product docs (3 pages), start at: https://developers.woosmap.com/products/w3w-api/overview.md
- Runnable samples (1), e.g. https://developers.woosmap.com/js-samples/w3w-autocomplete.md — full list in llms-full.txt

### Geofencing (Zones API + Mobile SDK)

Define geofence zones server-side and track entry/exit from mobile SDKs.
Base URL: `https://api.woosmap.com/zones`

Endpoint reference — authoritative for parameters and responses:
- `DELETE /zones` — Delete the Zones: https://developers.woosmap.com/api-reference/zones-api/delete-zones.md
- `GET /zones` — List your Zones: https://developers.woosmap.com/api-reference/zones-api/get-zones.md
- `POST /zones` — Create your Zones: https://developers.woosmap.com/api-reference/zones-api/post-zones.md
- `PUT /zones` — Update the Zones: https://developers.woosmap.com/api-reference/zones-api/put-zones.md
- `DELETE /zones/{zone_id}` — Delete Zone from ID: https://developers.woosmap.com/api-reference/zones-api/delete-zones-zone_id.md
- `GET /zones/{zone_id}` — Get Zone from ID: https://developers.woosmap.com/api-reference/zones-api/get-zones-zone_id.md
- Product docs (42 pages), start at: https://developers.woosmap.com/products/geofencing-sdk/get-started.md

## Client-side SDKs and libraries

### Map JS API

Interactive web maps, layers, markers and client-side services.

- Product docs (23 pages), start at: https://developers.woosmap.com/products/map-api/get-started.md
- Runnable samples (12), e.g. https://developers.woosmap.com/js-samples/map-clustering-geojson.md — full list in llms-full.txt

### Woosmap JS API (legacy)

Previous-generation JS SDK. Prefer Map JS API for new work.

### Mobile SDKs (Android / iOS / Flutter / React Native)

Native location, geofencing and store-locator components.

- Product docs (20 pages), start at: https://developers.woosmap.com/products/mobile/flutter/get-started.md

### MultiSearch library

Unified autocomplete across Localities, Stores and third-party sources.

- Product docs (9 pages), start at: https://developers.woosmap.com/products/multisearch-lib/get-started.md

### Widgets

Drop-in Store Locator and address-input widgets.

- Product docs (5 pages), start at: https://developers.woosmap.com/products/widgets/store-locator-widget/advanced-usages.md

### MCP Server

Model Context Protocol server exposing Woosmap APIs as agent tools.

- Product docs (2 pages), start at: https://developers.woosmap.com/products/mcp-server/overview.md

### Migration guides

Moving from Google Maps or from legacy Woosmap SDKs.

- Product docs (1 pages), start at: https://developers.woosmap.com/products/migration-guides/migration-from-google-maps.md

## Support and everything else

- Support pages, migration guides and the full page list: https://developers.woosmap.com/llms-full.txt