{"id":29213652,"url":"https://github.com/NotionDocs/NotionAPI","last_synced_at":"2025-07-02T23:05:19.541Z","repository":{"id":47997541,"uuid":"338516550","full_name":"NotionDocs/NotionAPI","owner":"NotionDocs","description":"The unofficial Javascript API for Notion content. Written in Typescript, GraphQL friendly.","archived":false,"fork":false,"pushed_at":"2022-06-06T18:54:37.000Z","size":327,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-04-21T01:06:13.288Z","etag":null,"topics":["api","cms","graphql","notion","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/NotionDocs.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-02-13T06:59:00.000Z","updated_at":"2024-03-05T06:35:57.000Z","dependencies_parsed_at":"2022-08-12T16:11:14.326Z","dependency_job_id":null,"html_url":"https://github.com/NotionDocs/NotionAPI","commit_stats":null,"previous_names":["notionapi/notionapi"],"tags_count":20,"template":false,"template_full_name":null,"purl":"pkg:github/NotionDocs/NotionAPI","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NotionDocs%2FNotionAPI","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NotionDocs%2FNotionAPI/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NotionDocs%2FNotionAPI/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NotionDocs%2FNotionAPI/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/NotionDocs","download_url":"https://codeload.github.com/NotionDocs/NotionAPI/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NotionDocs%2FNotionAPI/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263229072,"owners_count":23434000,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","cms","graphql","notion","typescript"],"created_at":"2025-07-02T23:01:47.809Z","updated_at":"2025-07-02T23:05:19.512Z","avatar_url":"https://github.com/NotionDocs.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cbr /\u003e\n\n\u003cdiv align=\"center\"\u003e\n\n\u003cimg src=\"https://avatars2.githubusercontent.com/u/67568167\" width=\"100\"/\u003e  \n\n\u003ch1\u003eNotionAPI\u003c/h1\u003e\n\u003cp\u003eThe unofficial Javascript API for Notion content. Written in Typescript, GraphQL friendly.\u003c/p\u003e\n\n[![Build](https://github.com/NotionDocs/NotionAPI/actions/workflows/build.yml/badge.svg)](https://github.com/NotionDocs/NotionAPI/actions/workflows/build.yml)\n[![release](https://badgen.net/github/release/NotionDocs/NotionAPI)](https://github.com/NotionDocs/NotionAPI/releases)\n[![last commit](https://badgen.net/github/last-commit/NotionDocs/NotionAPI/main)](https://github.com/NotionDocs/NotionAPI/commits/main) \u003c!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section --\u003e\n[![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg)](#contributors-)\n\u003c!-- ALL-CONTRIBUTORS-BADGE:END --\u003e\n\n![Code Quality Score](https://www.code-inspector.com/project/21908/score/svg)\n![Code Grade](https://www.code-inspector.com/project/21908/status/svg)\n\n\u003c/div\u003e\n\n---\n\n## Overview\n\nNotionAPI comes with 3 packages: [`@notiondocs/api-client`](https://github.com/NotionDocs/NotionAPI/packages/696039), [`@notiondocs/api-core`](https://github.com/NotionDocs/NotionAPI/packages/696041), and [`@notiondocs/api-transform`](https://github.com/NotionDocs/NotionAPI/packages/696040). Each package serves a different purpose:\n\n- [`@notiondocs/api-client`](https://github.com/NotionDocs/NotionAPI/packages/696039) is used for making queries to the Notion backend. It is a required dependency for the `core` package.\n- [`@notiondocs/api-core`](https://github.com/NotionDocs/NotionAPI/packages/696041) provides a layer of abstraction on top of the `client` package that makes manipulating data from the Notion backend a breeze.\n- [`@notiondocs/api-transform`](https://github.com/NotionDocs/NotionAPI/packages/696040) allows you to transform Notion page content by providing specific transformation rules.\n\n## Features\n\nNotion API supports all read operations on pages and collections. Write operations are coming soon!\n\n### Notion backend\n\n| Feature | Availability | Notes |\n|---------|--------------|-------|\n| Query Notion backend | ✅ | see [`client` package](https://github.com/NotionDocs/NotionAPI/tree/main/packages/client) |\n| Query private pages | ✅ | see [`client` package](https://github.com/NotionDocs/NotionAPI/tree/main/packages/client) |\n| Get user information | 😕 | not directly supported, but possible with [`client` package](https://github.com/NotionDocs/NotionAPI/tree/main/packages/client) |\n\n### Notion page\n\n| Feature | Availability | Notes |\n|---------|--------------|-------|\n| Read page properties | ✅ | see [`core` package](https://github.com/NotionDocs/NotionAPI/tree/main/packages/core) |\n| Read page metadata | ✅ | see [`core` package](https://github.com/NotionDocs/NotionAPI/tree/main/packages/core) |\n| Read full page content | ✅ | see [`core` package](https://github.com/NotionDocs/NotionAPI/tree/main/packages/core) |\n| Transform content block map | ✅ | see [`transform` package](https://github.com/NotionDocs/NotionAPI/tree/main/packages/transform) |\n| Update page | ❌ | Feature coming soon! 👀 |\n\n### Notion table/collection\n\n| Feature | Availability | Notes |\n|---------|--------------|-------|\n| Fetch collection schema | ✅ | see [`core` package](https://github.com/NotionDocs/NotionAPI/tree/main/packages/core) |\n| Fetch collection from collection page | ✅ | see [`core` package](https://github.com/NotionDocs/NotionAPI/tree/main/packages/core) |\n| Fetch collection from collection ID | ✅ | see [`core` package](https://github.com/NotionDocs/NotionAPI/tree/main/packages/core) |\n| Filter collection based on view | ✅ | see [`core` package](https://github.com/NotionDocs/NotionAPI/tree/main/packages/core) |\n| Create new page in collection    | ❌ |                                                                         |\n| Delete page in collection        | ❌ |                                                                         |\n\n## Documentation\n\nDocumentation is coming soon, once the entire NotionDocs suite is finished. **That being said**, NotionAPI is written entirely in Typescript and is (WIP) fully documented in code.\n\n## Contributors ✨\n\nThanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --\u003e\n\u003c!-- prettier-ignore-start --\u003e\n\u003c!-- markdownlint-disable --\u003e\n\u003ctable\u003e\n  \u003ctr\u003e\n    \u003ctd align=\"center\"\u003e\u003ca href=\"https://colegaw.in\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/8595795?v=4?s=100\" width=\"100px;\" alt=\"\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eCole Gawin\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/NotionDocs/NotionAPI/commits?author=chroline\" title=\"Code\"\u003e💻\u003c/a\u003e \u003ca href=\"#content-chroline\" title=\"Content\"\u003e🖋\u003c/a\u003e \u003ca href=\"#design-chroline\" title=\"Design\"\u003e🎨\u003c/a\u003e \u003ca href=\"#ideas-chroline\" title=\"Ideas, Planning, \u0026 Feedback\"\u003e🤔\u003c/a\u003e \u003ca href=\"#infra-chroline\" title=\"Infrastructure (Hosting, Build-Tools, etc)\"\u003e🚇\u003c/a\u003e \u003ca href=\"#maintenance-chroline\" title=\"Maintenance\"\u003e🚧\u003c/a\u003e \u003ca href=\"#projectManagement-chroline\" title=\"Project Management\"\u003e📆\u003c/a\u003e\u003c/td\u003e\n  \u003c/tr\u003e\n\u003c/table\u003e\n\n\u003c!-- markdownlint-restore --\u003e\n\u003c!-- prettier-ignore-end --\u003e\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:END --\u003e\n\nThis project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FNotionDocs%2FNotionAPI","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FNotionDocs%2FNotionAPI","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FNotionDocs%2FNotionAPI/lists"}