Skip to content
This repository was archived by the owner on Jan 5, 2026. It is now read-only.

miichom/nodecollect

Repository files navigation

nodecollect

NPM Version

About

A NodeJS wrapper that easily interacts with the FFXIV Collect & Lalachievements APIs.

  • Supports TypeScript
  • Supports both CommonJS and ESM

Installation

Prerequisites Node.js (18.0.0 or newer).

npm install nodecollect
yarn add nodecollect
pnpm add nodecollect
bun add nodecollect

Example usage

Getting a character via Lodestone

import { Lodestone } from 'nodecollect';

const lodestone = new Lodestone();

// using an id
await lodestone.getCharacter(12345678);

// or using searching parameters
await lodestone.getCharacter({
  q: 'Tataru Taru',
  worldname: 'Raiden'
});

Getting a collection entry from XIVCollect

import { XIVCollect } from 'nodecollect';

const xivcollect = new XIVCollect();

await xivcollect.getItemFrom('achievements', 1);

Contributing

Before creating an issue, please ensure that it hasn't been reported or suggested previously.

Attribution

Final Fantasy XIV and all related assets, including data accessed through the APIs used in this package, are the intellectual property of © SQUARE ENIX CO., LTD. All rights reserved. This project is not affiliated with or endorsed by Square Enix.

Additionally, this package is not affiliated with FFXIVCollect or Lalachievements in any way. Please send the love their way for the amazing things they do. ❤️

The data provided by FFXIVCollect API was made possible by open source software, generous crowd funding in support of an ad-free internet, and countless volunteer contributions.

About

A NodeJS wrapper that easily interacts with the FFXIV Collection APIs.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 2

  •  
  •