xivselch/api

xivselch/api is a free, open-source REST API that lets you access live Final Fantasy XIV player and community data — no account required.

Disclaimer: This project is not affiliated with, sponsored, or endorsed by Square Enix.

Key Features

• Real-time access to Lodestone character and Free Company data
• Comprehensive multi-language support (English, Japanese, French, German)
• Persistent data endpoints powered by a robust database layer
• Secure authentication and session management
• OpenAPI 3.1 documentation with integrated Scalar UI
• Advanced abuse prevention and fair usage controls

Quick Start

Prerequisites:

• Node.js 18+
• Vercel CLI

Install dependencies:

npm install

Start the dev server:

vc dev

The API and docs will be at http://localhost:3000.

Scripts

• npm run lint — Lint code
• npm run format — Format code
• npm run drizzle:generate — Generate DB migrations
• npm run drizzle:migrate — Run DB migrations

License

MIT — see LICENSE.md