API Documentation for your own tools and code

Read your businesses, keywords, scans, reviews and listings and start scans, with the REST API or the MCP server. Both give the same data and use the same API key.

Just want to use Claude, ChatGPT or Cursor? Follow the step-by-step guide to connect your AI assistant.

Your API key

Both the REST API and the MCP server use an API key, sent as a Bearer token in the Authorization header:

Header

Authorization: Bearer YOUR_API_KEY

Create a key in your dashboard under Settings > API Keys. Open API Keys. A key can always read your data (the read permission). Tick "Can start scans" when you create it to also let it start scans, which use credits (the scan permission). Keep keys secret and delete any you no longer use.

Building something other people connect their own account to? Use OAuth instead of keys.

Check that it works

Call GET /api/v1/me with the key. It answers with your account and what the key can do.

curl

curl https://citednearby.com/api/v1/me \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Accept: application/json"

JSON

{ "data": { "id": 123, "name": "Jane Smith", "email": "[email protected]", "api_key": { "name": "My script", "abilities": [ "read", "scan" ], "expires_at": null } } }

Next, see what you can read and start: REST endpoints or the MCP server.