@chirag127/habitica

Zero-dependency Habitica API v3 client.

Install

npm i @chirag127/habitica

Usage

import { createClient } from '@chirag127/habitica';

const client = createClient('USER_ID', 'API_TOKEN');

// User stats + profile
const user = await client.getUser();

// Tasks — type: habits | dailys | todos | rewards
const habits = await client.getTasks('habits');
const todos = await client.getTasks('todos');

Auth

Get credentials from Habitica → Settings → API.

• userId → User ID
• apiToken → API Token
• clientId (optional) → x-client header, defaults to 'habitica-client'

API

createClient(userId, apiToken, clientId?)

Returns a client with:

| Method | Description | |---|---| | getUser() | GET /api/v3/user — returns data (stats, profile, preferences) | | getTasks(type?) | GET /api/v3/tasks/user?type={type} — returns array. type: habits (default), dailys, todos, rewards |

15s timeout. Throws on non-2xx responses.

License

MIT