API reference

The Onym API is a REST API for your AI visibility data. It uses predictable URLs, returns JSON, and uses standard HTTP status codes and Bearer authentication.

https://getonym.com/api/v1

Every endpoint returns the same numbers as the dashboard for the same filters, with the sample size and 95% range behind each rate. The API is read-only apart from adding prompts.

curl https://getonym.com/api/v1/domains \
  -H "Authorization: Bearer YOUR_API_KEY"

import requests

r = requests.get("https://getonym.com/api/v1/domains", headers={"Authorization": "Bearer YOUR_API_KEY"})
print(r.json())

const r = await fetch("https://getonym.com/api/v1/domains", {
  headers: { Authorization: "Bearer YOUR_API_KEY" },
});
console.log(await r.json());

#Conventions

• Domains are addressed by host (acme.example) or ID.
• Rates are numbers from 0 to 1, always with k, n, low and high. See Rates and changes.
• Filters are the same on every analytics endpoint. See Filters.
• Dates are UTC. run_date is YYYY-MM-DD; timestamps are ISO 8601.
• Errors use one object with a stable code. See Errors.

#Endpoints

#Also available

• OpenAPI spec for code generators and API clients.
• Webhooks to get results pushed after each run.
• The MCP server for AI assistants.