Skip to content
Ranqo
Docs
DashboardGet started
GuidesMethodologyIntegrationsAPI
Video tutorials

Get started

  • Introduction
  • Quickstart
  • Authentication

Using the API

  • Rate limits
  • Errors
  • Pagination
  • Dates and time zones
  • Versioning

Account

  • Get the account

Brands

  • List brands
  • Get a brand

Visibility

  • Get visibility

Competitors

  • List competitors

Runs

  • List runs
  • Get a run

Prompts

  • List prompts
  • Get a prompt
  • List a prompt's answers

Site Access

  • Get site access

Page audits

  • List page audits
  • Get a page audit

Recommendations

  • List recommendations
  • Get a recommendation

Outreach

  • List outreach targets

4 sections

Get started

Ranqo API

View as MarkdownOpen this page as .md
ChatGPTOpen in ChatGPTAsk about this pageClaudeOpen in ClaudeAsk about this page

Read your Ranqo data from your own tools with an API key. Brands, visibility, competitors, prompts, answers, audits and recommendations.

The Ranqo API gives your own tools read access to what the dashboard shows: your brands, their visibility and competitors, the prompts you track and the answers AI gave them, Site Access, page audits, Action Center recommendations and Outreach targets. Use it to feed a BI dashboard, a client report or an agent.

It is read-only JSON over HTTPS at https://api.ranqo.ai/v1. Every request carries an API key in its Authorization header. The whole API is described in an OpenAPI document you can load into an API client or a code generator.

Who can use it#

API access is included on Pro and above, and a plan in its trial has the same access. Each key's rate limit depends on the plan:

API access by plan
PlanRequests per minuteActive keys
StarterNot includedNot included
Pro605
Agency Growth12010
Agency Scale30025

Business is a custom plan with limits set together with you. Book a demo to shape one. Keys are created and revoked by the account owner, in the API keys section of Settings; teammates cannot create them.

The same numbers as the dashboard#

The reports are computed by the code behind the Visibility page, over the same window and filters, and rounded the way the page prints them. For the same period, filters and time zone, a figure the API returns matches the page. Two differences to know:

  • The dashboard counts days in your browser's time zone. The API counts them in tz, and in UTC when you leave it out, so send your zone to get the page's figures. See Dates and time zones.
  • The Competitors page reads a 365-day or custom period as 7, 30 or 90 days. The API reads the window you ask for, so over those periods its competitor figures can differ from that page.

Where a field differs in any other way, its reference page says so.

Start here#

Quickstart

Create a key and make your first requests.

Authentication

How keys work, where to send them and how to keep them safe.

Errors

Every error the API returns, and what to do about it.

Dates and time zones

How report windows are set and how a window with no run is read.

What you can read#

Brands

The brands a key can read, with their latest run's scores.

Visibility

Visibility, share of voice, position and sentiment over a window.

Competitors

The brands AI names alongside yours, ranked.

Prompts and answers

The questions you track and what AI answered.

Recommendations

Action Center work and what it measurably changed.

Site Access

Whether AI crawlers and search engines can fetch your site.
Previous page: PrivacyNext page: Quickstart
On this page
Ranqo
Docs
Dashboardranqo.aiPrivacyTerms
Be the Source AI Cites.
Ranqo
Docs
GuidesMethodologyIntegrationsAPI

Get started

  • Introduction
  • Quickstart
  • Authentication

Using the API

  • Rate limits
  • Errors
  • Pagination
  • Dates and time zones
  • Versioning

Account

  • Get the account

Brands

  • List brands
  • Get a brand

Visibility

  • Get visibility

Competitors

  • List competitors

Runs

  • List runs
  • Get a run

Prompts

  • List prompts
  • Get a prompt
  • List a prompt's answers

Site Access

  • Get site access

Page audits

  • List page audits
  • Get a page audit

Recommendations

  • List recommendations
  • Get a recommendation

Outreach

  • List outreach targets
Get started