VenueScope

VenueScope API

Public, read only data about FFXIV venues and featured events, the same data the VenueScope plugin shows in game. No key or sign up is needed.

Basics

Base URL: https://api.venuescope.club
Format: JSON, UTF-8. Lists come inside data.
Times: ISO 8601 in UTC, like 2026-10-04T19:00:00.000Z. Lineup slots are written in server time.
Browsers: CORS is open, so you can call it from a web page.
Freshness: Answers can be up to a minute old.

Please cache on your side and keep it to about one request per minute. The API is free and runs on a small budget.

Endpoints

Request	What it returns
GET `/v1/spotlights`	The featured venues shown right now, highest priority first.
GET `/v1/spotlights/{id}`	One featured venue.
GET `/v1/status`	A quick check that the API is up, with its version.

Venues and events published by their owners will be added to v1 soon.

Example

curl https://api.venuescope.club/v1/spotlights

{
  "data": [
    {
      "id": "nocturn",
      "name": "Nocturn",
      "tagline": "Nightclub on Lich",
      "description": "",
      "imageUrl": "https://example.com/banner.png",
      "accentColor": "#a855f7",
      "banner": { "title": "", "subtitle": "", "hideText": false },
      "place": { "world": "Lich", "district": "Mist", "ward": 12, "plot": 30 },
      "startsAt": "2026-10-04T19:00:00.000Z",
      "endsAt": "2026-10-05T00:00:00.000Z",
      "priority": 1,
      "activities": [
        { "name": "Bingo", "start": "11 PM ST", "price": "50,000 gil a card", "payout": "", "note": "" }
      ],
      "lineup": [
        { "time": "9 - 11 PM ST", "name": "Cyanna", "link": "https://www.twitch.tv/...", "logoUrl": "https://..." }
      ],
      "links": { "discord": "https://discord.gg/...", "website": "" }
    }
  ]
}

Errors

Errors use the usual HTTP status codes and always have the same shape.

{ "error": { "status": 404, "message": "No spotlight with this id." } }

Stability

Everything under /v1 keeps working as documented. New fields may appear in answers, so ignore the ones you do not know. A change that would break existing apps would come as /v2, with v1 kept alive alongside.

A machine readable description is available at /openapi.json (OpenAPI 3.1).