Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/raminhuk/worker-api-notion
A serverless wrapper for the private Notion API. It provides fast and easy access to your Notion content. Ideal to make Notion your CMS.
https://github.com/raminhuk/worker-api-notion
cloudflare-workers notion notion-api notion-database worker workers
Last synced: 8 days ago
JSON representation
A serverless wrapper for the private Notion API. It provides fast and easy access to your Notion content. Ideal to make Notion your CMS.
- Host: GitHub
- URL: https://github.com/raminhuk/worker-api-notion
- Owner: raminhuk
- Created: 2024-10-29T00:32:13.000Z (8 days ago)
- Default Branch: master
- Last Pushed: 2024-10-29T01:01:33.000Z (8 days ago)
- Last Synced: 2024-10-29T01:31:00.940Z (8 days ago)
- Topics: cloudflare-workers, notion, notion-api, notion-database, worker, workers
- Language: TypeScript
- Homepage: https://worker-notion.fabioraminhuk.workers.dev
- Size: 0 Bytes
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
A **serverless wrapper** for the private Notion API. It provides fast and easy access to your Notion content.
Ideal to make Notion your CMS.
We provide a hosted version of this project on [`https://worker-notion.fabioraminhuk.workers.dev`](https://worker-notion.fabioraminhuk.workers.dev/). You can also [host it yourself](https://workers.cloudflare.com/). Cloudflare offers a generous free plan with up to 100,000 request per day.
_Use with caution. This is based on the private Notion API. We can not gurantee it will stay stable._
## Features
🍭 **Easy to use** – Receive Notion data with a single GET request
🗄 **Table Access** – Get structured data from tables & databases
✨ **Blazing Fast** – Built-in [SWR](https://www.google.com/search?q=stale+while+revalidate) caching for instant results
🛫 **CORS Friendly** – Access your data where you need it
## Use Cases
- Use it as data-source for blogs and documentation. Create a table with pages and additional metadata. Query the `/table` endpoints everytime you want to render a list of all pages.
- Get data of specific pages, which can be rendered with [`react-notion`](https://github.com/splitbee/react-notion)
## Endpoints
### Load page data
`/v1/page/`
Example ([Source Notion Page](https://www.notion.so/react-notion-example-2e22de6b770e4166be301490f6ffd420))
[`https://worker-notion.fabioraminhuk.workers.dev/v1/page/2e22de6b770e4166be301490f6ffd420`](https://worker-notion.fabioraminhuk.workers.dev/v1/page/2e22de6b770e4166be301490f6ffd420)
Returns all block data for a given page.
For example, you can render this data with [`react-notion`](https://github.com/splitbee/react-notion).
### Load data from table
`/v1/table/`
Example ([Source Notion Page](https://www.notion.so/splitbee/20720198ca7a4e1b92af0a007d3b45a4?v=4206debfc84541d7b4503ebc838fdf1e))
[`https://worker-notion.fabioraminhuk.workers.dev/v1/table/20720198ca7a4e1b92af0a007d3b45a4`](https://worker-notion.fabioraminhuk.workers.dev/v1/table/20720198ca7a4e1b92af0a007d3b45a4)
## Authentication for private pages
All public pages can be accessed without authorization. If you want to fetch private pages there are two options.
- The recommended way is to host your own worker with the `NOTION_TOKEN` environment variable set. You can find more information in the [Cloudflare Workers documentation](https://developers.cloudflare.com/workers/reference/apis/environment-variables/).
- Alternatively you can set the `Authorization: Bearer ` header to authorize your requests.
### Receiving the token
To obtain your token, login to Notion and open your DevTools and find your cookies. There should be a cookie called `token_v2`, which is used for the authorization.
## Credits
- [Timo Lins](https://twitter.com/timolins) – Idea, Documentation
- [Tobias Lins](https://twitter.com/linstobias) – Code
- [Travis Fischer](https://twitter.com/transitive_bs) – Code
- [Fabio Raminhuk](https://x.com/fabio_rmk) - Code