# obsidianmd/obsidian-api

Type definitions for the latest Obsidian API.

Repository: https://github.com/obsidianmd/obsidian-api
Canonical: https://ross.abutalabs.com/products/obsidian-api
Homepage: https://docs.obsidian.md
License: MIT
License Family: permissive
Last push: 2026-07-14T14:31:59+00:00

## Health v2 (maintenance only)
Score: 74/100 (v2, computed 2026-09-02T17:46:02.011165+00:00)
- activity 92, release rhythm 35, longevity 100
- inputs: {"age_days": 2137, "days_push": 50, "days_rel": null, "gap_med": null, "n_releases_24m": 0}
- flags: no_releases
- formula: round(0.45*activity + 0.35*rhythm + 0.20*longevity); archived -> min(score, 10)

## Adoption (not part of the score)
Stars 2315, forks 271 (observed 2026-08-28T04:06:36.794990+00:00)

## What it is
TypeScript type definitions for the Obsidian plugin API, maintained by the Obsidian team. It enables developers to build Obsidian plugins with type-safe access to the vault, workspace, metadata cache, and UI extension points.

## Use cases
- develop an obsidian plugin in typescript
- get autocomplete for the obsidian api
- access and modify files in an obsidian vault programmatically
- add custom views, commands, and settings tabs to obsidian
- register event handlers in an obsidian plugin
- build a plugin that reads markdown metadata like links and tags

## When to choose
- you are writing an Obsidian plugin in TypeScript or JavaScript
- you want up-to-date, official type definitions for the Obsidian API
- you need typed access to vault, workspace, and metadata cache interfaces

## When to avoid
- you want to script Obsidian from outside the app rather than build a plugin
- you are building an editor unrelated to Obsidian
- you need a runtime library - this package only ships type definitions

## Facets
- artifact type: library
- maturity: active
- function: sdk, type-system, plugin-system, developer-tools
- domain: developer-tools, text-editors, documentation
- platform: cross-platform
- tags: obsidian, type-definitions, plugin-development, note-taking, markdown, plugins, electron, nodejs, typescript

## Member repositories
- obsidianmd/obsidian-api (main) score 74

## Provenance
- Observed fields: from GitHub, fetched 2026-08-28T04:06:36.794990+00:00.
- Health v2: computed from the inputs above; adoption is never an input.
- Inferred fields (summary, facets, guidance): AI-extracted, prompt v1, taxonomy v1, on 2026-08-30T02:39:26.034202+00:00, confidence not recorded.
  - readme: https://github.com/obsidianmd/obsidian-api (fetched 2026-08-28T04:06:36.794990+00:00, sha 04090db7fd88)
  - homepage: https://docs.obsidian.md (fetched 2026-08-29T10:19:49.764255+00:00, sha 5ff248b4e448)
- Data as of 2026-08-30T08:39:29.467469+00:00.