Documentation / joplin-api

joplin-api

A JavaScript wrapper library for accessing the Joplin Data API, providing type-safe and intuitive interfaces.

Features

• 🚀 Support multiple runtime environments: Browser, NodeJS and Joplin plugin
• 📦 Complete TypeScript type definitions
• 🔒 Type-safe API calls
• 📚 Compliant with official API specifications

Installation

npm install joplin-api
# or
yarn add joplin-api
# or
pnpm add joplin-api

Quick Start

REST API Mode (Browser/NodeJS)

import { joplinDataApi } from 'joplin-api'

const api = joplinDataApi({
  type: 'rest',
  token: 'your-token-here',
  baseUrl: 'http://localhost:41184',
})

// Get note list
const notes = await api.note.list()
console.log(notes)

Plugin Mode (Joplin Plugin)

import { joplinDataApi } from 'joplin-api'

const api = joplinDataApi({
  type: 'plugin',
})

// API call example
const notes = await api.note.list()

Documentation

For complete API documentation, please refer to:

• Joplin Official REST API Documentation
• Project TypeScript Type Definitions

Contributing

Issues and Pull Requests are welcome!

License

MIT License

---

📝 Note: To use REST API mode, you need to enable Web Clipper service in Joplin settings and obtain an authorization token first.