Skip to content

AreaOps Documentation

AreaOps docs

AreaOps documentation is organised in four parts: how to build on the API, the files written for AI agents, how the ZIP scoring data works, and how operators use the product day to day. If you are wiring up an agent or writing code against AreaOps, start at the developer portal.

Build on AreaOps

Everything needed to call AreaOps from code or from an AI agent: authentication, the MCP tool catalogue, rate-limit conventions, and worked examples.

  • Developer portal

    Quickstart, API-key authentication, MCP server setup, the CLI, endpoint reference, rate limits, and error codes.

  • OpenAPI 3.1 contract

    The machine-readable API description. Unique operationIds, typed parameters and response schemas — ready for LLM function calling.

  • MCP discovery document

    Public, unauthenticated description of the Model Context Protocol server and its 17 tools.

  • AreaOps for AI agents

    What an agent can do with AreaOps, what stays behind human review, and where the data boundary sits.

Agent instructions

Files written for machines rather than people. Point a crawler, an answer engine, or an agent's context loader at these.

  • llms.txt

    What AreaOps is, when an agent should reach for it, how to call it, and the citation-safe boundary on public data.

  • llms-full.txt

    Every public page inlined as one markdown document, for context loading in a single fetch.

  • agent-instructions.md

    The when-to-use guidance on its own, as plain markdown.

  • Sitemap index

    Every indexable URL on the site, split into per-type child sitemaps.

How the data works

The scoring model is documented in full — every source, every signal, every per-vertical weight. Nothing about a score is a black box.

Using the product

Strategy guides for the operators and agencies who run the territories AreaOps manages.

Can't find what you need?

Documentation gaps are bugs. Tell us what you were looking for and we will either point you at it or write it.

Contact AreaOps