https://github.com/justinjd00/arc-raiders-wrapper
Unofficial Arc Raiders API Wrapper in TypeScript
https://github.com/justinjd00/arc-raiders-wrapper
api new npm package trending typrescript wrapper wrapper-api
Last synced: 5 months ago
JSON representation
Unofficial Arc Raiders API Wrapper in TypeScript
- Host: GitHub
- URL: https://github.com/justinjd00/arc-raiders-wrapper
- Owner: justinjd00
- License: mit
- Created: 2025-11-03T19:08:04.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2025-11-03T20:27:16.000Z (5 months ago)
- Last Synced: 2025-11-03T21:20:18.476Z (5 months ago)
- Topics: api, new, npm, package, trending, typrescript, wrapper, wrapper-api
- Language: TypeScript
- Homepage:
- Size: 61.5 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
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
```bash
npm install @justinjd00/arc-raiders-api
```
Or with other package managers:
```bash
# Yarn
yarn add @justinjd00/arc-raiders-api
# pnpm
pnpm add @justinjd00/arc-raiders-api
# Bun
bun add @justinjd00/arc-raiders-api
```
### Install from GitHub
```bash
npm install github:justinjd00/arc-raiders-wrapper
```
## Quick Start
```typescript
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)
```typescript
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
```typescript
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
```bash
npx arc-raiders items
npx arc-raiders weapons --rarity legendary
npx arc-raiders export json --output data.json
npx arc-raiders stats
```
### Browser Client (Bypass Cloudflare)
If the API returns 403 Forbidden due to Cloudflare bot protection, you can use the browser-based client:
```typescript
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**:
```bash
npm install playwright
npx playwright install chromium
```
**Note**: 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
- [GitHub Repository](https://github.com/justinjd00/arc-raiders-wrapper)
- [MetaForge ARC Raiders API](https://metaforge.app/arc-raiders/api)
- [ARC Raiders Official Website](https://arcraiders.com/)
---
**Note**: This is an unofficial package and is not affiliated with Embark Studios or Arc Raiders.