---
title: "A published comparison"
method: GET
path: "/compare/{key}.json"
tags: ["Catalog"]
---

# A published comparison

`GET /compare/{key}.json`

## Request

- Base URL: `https://listme.name/api/v1`
- URL: `https://listme.name/api/v1/compare/{key}.json`
- Auth: none required

The data behind a /compare/{a}-vs-{b} page (slugs in alphabetical order).

## Path parameters

- `key` string, required

## Response `200`

A published comparison

- Comparison
  - `products` Product[], required
    - `slug` string, required
    - `name` string, required
    - `kind` string, required
    - `website` string, uri, required
    - `page` string, uri, required
    - `tagline` string
    - `summary` string
    - `developer` string
    - `author` string
    - `platforms` string[]
    - `formats` string[]
    - `pricing` string
    - `price_note` string
    - `free_to_use` boolean
    - `open_source` boolean
    - `license` string
    - `source` string, uri
    - `strengths` string[]
    - `limits` string[]
    - `checked` string, date: Date the facts were last checked against the vendor.
    - `connected_to_publisher` boolean
    - `cover` string, uri
  - `differences` string[], required
  - `shared_rankings` object[], required
  - `ranks_higher_in_closest_shared_list` string
  - `page` string, uri

## Other responses

- `400`: The request was invalid or the item does not exist.
- `404`: The request was invalid or the item does not exist.

---

[API](https://skmtc.dev/listme/apis/listme-name-api.md) · [All operations](https://skmtc.dev/listme/apis/listme-name-api/llms.txt) · [OpenAPI document](https://skmtc.dev/listme/apis/listme-name-api/revisions/c7260c20d722?raw)