---
title: "Public ranking state"
method: GET
path: "/api/ranking"
tags: ["Telemetry"]
---

# Public ranking state

`GET /api/ranking`

## Request

- Base URL: `http://localhost:3013`
- URL: `http://localhost:3013/api/ranking`
- Auth: HTTP bearer

Whether this install can join the public agent-swarm.dev ranking (telemetry on, organization name and website set), whether it is opted in, and its stored listing. Only a config admin can read it.

## Response `200`

Ranking state

- object
  - `eligible` boolean, required
  - `missing` string[], required
  - `telemetryOn` boolean, required
  - `enabled` boolean, required
  - `name` string, nullable, required
  - `domain` string, nullable, required
  - `listing` object, nullable, required
    - `v` 1, required
    - `name` string, required
    - `domain` string, required
    - `category` 'engineering' | 'product' | 'marketing' | 'support' | 'operations' | 'other', required
    - `subcategory` string, nullable, required
    - `description` string, nullable, required
    - `sourceCodeUrl` string, nullable, required
    - `updatedAt` string, required
  - `listingMatchesDomain` boolean, required
  - `verifyUrl` string, nullable, required

## Other responses

- `401`: Unauthorized
- `403`: Only a config admin can read the ranking state

## Changes

- **2026-10-19** `915daaf44761`: 3 breaking
  - removed the required property `fileJson` from the response with the `200` status
  - removed the required property `listing/claim` from the response with the `200` status
  - removed the required property `prUrl` from the response with the `200` status
- **2026-10-19** `9cbdf0c80fac`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/desplega-ai/apis/agent-swarm-api/changes/api/ranking/get.md)

---

[API](https://skmtc.dev/desplega-ai/apis/agent-swarm-api.md) - [All operations](https://skmtc.dev/desplega-ai/apis/agent-swarm-api/llms.txt) - [OpenAPI document](https://skmtc.dev/desplega-ai/apis/agent-swarm-api/revisions/7e4c7198192a?raw)