notion

TypeScript packages for Notion's unofficial API, data types, and related utilities.

Features

• 🚀 Simple - It's all TypeScript. Easy peasy.
• ⚡ Fast - Concurrent network IO for fetching all resources on a page.
• 💯 Tests - Comes with a comprehensive test suite covering 98% of Notion functionality.
• 📓 Docs - Auto-generated docs for all packages.
• 🔥 Solid - Used in production by Notion X (coming soon), Notion VIP, and Notion2Site.

Usage

import { NotionAPI } from 'notion-client'

const api = new NotionAPI()

// fetch a notion page's content, including all async blocks, collection queries, and signed urls
const page = await api.getPage('067dd719-a912-471e-a9a3-ac10710e7fdf')

// fetch the data for a specific collection instance
const collectionId = '2d8aec23-8281-4a94-9090-caaf823dd21a'
const collectionViewId = 'ab639a5a-853e-45e1-9ef7-133b486c0acf'
const colectionData = await api.getCollectionData(
  collectionId,
  collectionViewId
)

You can optionally pass an authToken to NotionAPI if you need to access private notion resources.

Packages

无标题

• The Notion API is not expected to be used from client-side browsers due to CORS restrictions. notion-client is compatible with Node.js, Deno, and Cloudflare Workers.

Supported Blocks

The majority of Notion blocks and collection views are fully supported.

无标题

Please let us know if you find any issues or missing blocks.