Build with AI

Use the Woosmap documentation with LLMs and coding agents: a Markdown version of every page, a routing index, the OpenAPI spec, and a rules file for your agent.

Writing Woosmap code with Claude Code, Cursor or Copilot? Start here.

Resource URL
Rules for your agent /llms-rules.txt
Routing index /llms.txt
Full page list /llms-full.txt
OpenAPI 3.1 spec /assets/woosmap-openapi3.json

Set up your agent

Add this line to CLAUDE.md, .cursorrules, AGENTS.md, or whatever file your tool reads:

        Before writing any Woosmap API call, read and follow
https://developers.woosmap.com/llms-rules.txt

Use the URL rather than a copy. When a convention changes, the file changes with it.

The rules cover base URLs, which API key to use where, rate limits, and how to build a reference URL.

Any page in Markdown

Append .md to a page URL for clean Markdown, with no HTML or navigation.

An endpoint reference gives you the whole contract in one request: method, base URL, rate limit, auth schemes, every parameter with its type and default, the response schema, errors, and examples in shell, JavaScript and Python.

        /api-reference/localities-api/get-localities-autocomplete.md

A code sample gives you the working project: TypeScript, compiled JavaScript, CSS, HTML, and how to run it locally.

        /js-samples/render-shapes-data.md

The Map JS reference gives you every class, method and option in one file.

        /products/map-api/reference/1.4.md

Product and guide pages work the same way.

        /products/localities/overview.md

Which index to load

Load /llms.txt. It maps a question to the page that answers it and lists every endpoint with its base URL. It fits in a context window.

/llms-full.txt lists every page. Use it to find something, not in every conversation.

Generating a client or validating requests? Use the OpenAPI spec directly.

Which product for which job

I want to Use
Geocode an address, city or postal code Localities API
Search my own stores or assets Stores API
Store geometries and query them spatially Datasets API
Travel time, distance, routes or tolls Distance API
Public-transport routing and schedules Transit API
Locate a device from its IP Geolocation API
Show an interactive map on the web Map JS API
Put a map image in an email or PDF Static Map API
Add a store locator without building one Store Locator Widget
Track entry and exit from zones on mobile Geofencing (Zones API + Mobile SDK)
Map the inside of a venue Indoor API
Convert a three-word address What3Words API
Move an app off Google Maps Migration guides
Let an assistant call Woosmap at runtime MCP Server

Which pages to trust

Endpoint references under /api-reference/ are authoritative. They come from the OpenAPI spec, so parameter names, types, defaults and rate limits match what the API accepts.

Product pages and samples are narrative. They show one call and leave out most parameters. Read them to understand a product, not to build a request.

Reference URLs are verb-prefixed and path-flattened:

        GET /localities/autocomplete
  -> /api-reference/localities-api/get-localities-autocomplete.md

Take these URLs from the routing index instead of assembling them.

Let an agent call the API

To have an agent do the location work rather than write code for it, use the Woosmap MCP Server. It exposes geocoding, search, routing and distance as tools.

Something wrong?

The Markdown pages are generated, so a broken one is a bug we can fix. Post the page URL on the Woosmap Community forum.

Was this helpful?