https://github.com/coddingtonbear/obsidian-local-rest-api
Unlock your automation needs by interacting with your notes in Obsidian over a secure REST API.
https://github.com/coddingtonbear/obsidian-local-rest-api
Last synced: about 1 month ago
JSON representation
Unlock your automation needs by interacting with your notes in Obsidian over a secure REST API.
- Host: GitHub
- URL: https://github.com/coddingtonbear/obsidian-local-rest-api
- Owner: coddingtonbear
- License: mit
- Created: 2022-01-25T04:20:29.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-03-16T18:16:01.000Z (3 months ago)
- Last Synced: 2025-03-16T19:35:36.688Z (3 months ago)
- Language: TypeScript
- Homepage:
- Size: 1.42 MB
- Stars: 791
- Watchers: 9
- Forks: 67
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - coddingtonbear/obsidian-local-rest-api - Unlock your automation needs by interacting with your notes in Obsidian over a secure REST API. (TypeScript)
README
# Local REST API for Obsidian
See our interactive docs: https://coddingtonbear.github.io/obsidian-local-rest-api/
Have you ever needed to automate interacting with your notes? This plugin gives Obsidian a REST API you can interact with your notes from other tools so you can automate what you need to automate.
This plugin provides a secure HTTPS interface gated behind api key authentication that allows you to:
- Read, create, update or delete existing notes. There's even a `PATCH` HTTP method for inserting content into a particular section of a note.
- List notes stored in your vault.
- Create and fetch periodic notes.
- Execute commands and list what commands are available.
This is particularly useful if you need to interact with Obsidian from a browser extension like [Obsidian Web](https://chrome.google.com/webstore/detail/obsidian-web/edoacekkjanmingkbkgjndndibhkegad).
## Credits
This was inspired by [Vinzent03](https://github.com/Vinzent03)'s [advanced-uri plugin](https://github.com/Vinzent03/obsidian-advanced-uri) with hopes of expanding the automation options beyond the limitations of custom URL schemes.