Skip to main content

Goal

In this tutorial, you will answer one practical question with the public API:
Who is working on housing in Kansas City, and what sources back the results?
You do not need an account for this tutorial.

1. Check that Atlas is reachable

The health endpoint is outside the /api base path. The data endpoints below use:

2. Search from the place

Start with the place because the question is local.
Place-first search is usually better than broad keyword search when your user already knows the city, county, or region they care about.

3. Pick one result and inspect its sources

Copy one entity id from the search response, then ask for its sources.
Before you reuse the result, check:
  • Does the source actually say what you plan to repeat?
  • Is the source recent enough for your use?
  • Is the record backed by more than one independent source?
  • Is the actor type right for your workflow?
This is the most important habit in Atlas API usage: carry evidence forward with the record.

4. Add place context

Coverage endpoints help you decide whether your result set is broad enough.
Use coverage as context, not a final verdict. Thin coverage may mean Atlas has not found enough public sources yet, or it may reveal a real local gap.

5. Decide whether you need authentication

You can browse public directory data without credentials. You need credentials when your workflow does one of these:
  • Starts or syncs discovery runs.
  • Writes, updates, or imports records.
  • Uses workspace briefs, lists, watches, private review, or usage proof.
  • Needs higher API limits.
For server-side integrations, create an API key. For AI assistants, connect the MCP server and let the client handle OAuth.

6. Keep the generated reference nearby

This tutorial shows the model and the workflow. Use the generated reference for exact parameters and response shapes.

API reference

Search exact endpoints, parameters, and schemas.

Authentication

Choose API keys or OAuth for protected workflows.

Find source-backed actors

Learn the safe search and evidence pattern.

Connect an AI assistant

Use the same data through Claude, Copilot, Gemini, or Codex.