@justinjd00/arc-raiders-api
v1.1.1
Published
Type-safe TypeScript wrapper for the MetaForge ARC Raiders API. Access items, quests, ARCs, maps, and traders with full TypeScript support.
Maintainers
Readme
Arc Raiders API Client
Type-safe TypeScript wrapper for the MetaForge ARC Raiders API. Fully typed, easy to use, and optimized for Arc Raiders game data.
Installation
npm install @justinjd00/arc-raiders-apiOr with other package managers:
# Yarn
yarn add @justinjd00/arc-raiders-api
# pnpm
pnpm add @justinjd00/arc-raiders-api
# Bun
bun add @justinjd00/arc-raiders-apiInstall from GitHub
npm install github:justinjd00/arc-raiders-wrapperQuick Start
import { createArcRaidersClient } from '@justinjd00/arc-raiders-api';
const client = createArcRaidersClient({
baseURL: 'https://metaforge.app/api/arc-raiders',
timeout: 10000,
});
const items = await client.getItems({ rarity: 'epic' });
console.log(items.data);Features
- Fully type-safe with TypeScript
- Access to items, weapons, armor, quests, ARCs, maps, and traders
- Filtering and pagination support
- Robust error handling
- Simple and intuitive API
- In-memory caching (configurable TTL)
- React Hooks for easy integration
- CLI tool for command-line usage
- Data export (JSON, CSV)
- Analytics and statistics helpers
Basic Usage
Get All Data (Auto-Pagination)
import { createArcRaidersClient } from '@justinjd00/arc-raiders-api';
const client = createArcRaidersClient();
const allItems = await client.getAllItems();
const allWeapons = await client.getAllWeapons({ rarity: 'legendary' });
const allQuests = await client.getAllQuests({ difficulty: 'hard' });
const allARCs = await client.getAllARCs();Get Paginated Data
const weapons = await client.getWeapons({ rarity: 'legendary', page: 1, pageSize: 50 });
const quests = await client.getQuests({ difficulty: 'hard', page: 1, pageSize: 20 });
const maps = await client.getMaps();
const traders = await client.getTraders();CLI Tool
npx arc-raiders items
npx arc-raiders weapons --rarity legendary
npx arc-raiders export json --output data.json
npx arc-raiders statsBrowser Client (Bypass Cloudflare)
If the API returns 403 Forbidden due to Cloudflare bot protection, you can use the browser-based client:
import { createBrowserClient } from '@justinjd00/arc-raiders-api';
const client = createBrowserClient({
headless: true,
browser: 'chromium',
});
await client.init();
const items = await client.getItems({ page: 1, pageSize: 10 });
console.log(items.data);
await client.close();Installation:
npm install playwright
npx playwright install chromiumNote: The browser client uses Playwright to launch a real browser, which can bypass Cloudflare protection. It's slower than the regular client but more reliable when bot protection is active.
Links
Note: This is an unofficial package and is not affiliated with Embark Studios or Arc Raiders.
