Lumirank API docs
Competitors

List competitors

GET/v1/competitors

Returns the brands that AI answers name next to yours, sorted by name. By default the list has the tracked and suggested competitors. To see the dismissed competitors, send status=dismissed.

Your own brand is not in this list. To read it, call GET /v1/brand.

Authorization

apiKey
AuthorizationBearer <token>

An API key that you create in the Lumirank dashboard, on the Settings > API keys page. Send it in the Authorization header: Bearer lr_....

In: header

Query Parameters

status?string

The statuses to include, separated by commas: tracked, suggested, dismissed. The default is tracked,suggested.

limit?integer

The number of rows on each page, from 1 to 200. The default is 50.

Formatint32
offset?integer

The number of rows to skip before this page starts. The default is 0. For the next page, add limit to offset.

Formatint32

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/competitors?status=tracked&limit=50&offset=0"

competitors

{  "data": [    {      "id": "c77d2e91-5b4a-4f3c-8d2e-7a6b5c4d3e21",      "name": "Globex",      "aliases": [        "Globex CRM",        "Globex Corp"      ],      "domain": "globex.com",      "domain_verified": true,      "status": "tracked",      "first_seen_at": "2026-07-03T04:00:00Z",      "last_seen_at": "2026-10-07T05:12:00Z"    },    {      "id": "9b1f4c2d-6e3a-4d5b-8c7f-0a1b2c3d4e5f",      "name": "Initech",      "aliases": [],      "domain": "initech.com",      "domain_verified": false,      "status": "suggested",      "first_seen_at": "2026-08-11T06:30:00Z",      "last_seen_at": "2026-10-06T07:45:00Z"    }  ],  "meta": {    "total": 2,    "limit": 50,    "offset": 0,    "has_more": false  }}

Update a prompt PATCH

Pauses, resumes, archives, or unarchives a prompt, or changes its countries, the same as the prompt actions in the dashboard. Send only the fields you want to change. An empty body changes nothing. Lumirank does not ask a paused prompt any more, but its past answers stay in reports. Lumirank does not ask an archived prompt either, and its answers are left out of lists and reports. Setting an archived prompt to `active` unarchives it and starts it again. Resuming a prompt or adding countries can go over the prompt limit of your plan. Then the request gets status `400` and nothing changes.

Get a competitor GET

Returns 1 competitor of your brand, in any status. Your own brand's id, and the id of another brand's competitor, get status `404`, the same as an id that does not exist.