Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/kjk/notion

Go client for official Notion API.
https://github.com/kjk/notion

Last synced: 3 months ago
JSON representation

Go client for official Notion API.

Host: GitHub
URL: https://github.com/kjk/notion
Owner: kjk
License: mit
Created: 2021-05-16T20:05:37.000Z (about 3 years ago)
Default Branch: master
Last Pushed: 2021-06-01T09:20:22.000Z (about 3 years ago)
Last Synced: 2023-07-11T08:46:30.533Z (12 months ago)
Language: Go
Homepage:
Size: 110 KB
Stars: 19
Watchers: 1
Forks: 3
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Lists

awesome-stars - kjk/notion - Go client for official Notion API. (Go)

README

        # notion

[![GitHub tag (latest SemVer)](https://img.shields.io/github/v/tag/kjk/notion?label=go%20module)](https://github.com/kjk/notion/tags)

[![Go Reference](https://pkg.go.dev/badge/github.com/kjk/notion.svg)](https://pkg.go.dev/github.com/kjk/notion)

[![GitHub](https://img.shields.io/github/license/kjk/notion)](LICENSE)

[![Go Report Card](https://goreportcard.com/badge/github.com/kjk/notion)](https://goreportcard.com/report/github.com/kjk/notion)

**notion** is a Go client for the

 [Notion API](https://developers.notion.com/reference).

## Features

The client supports all (non-deprecated) endpoints available in the Notion API,

as of May 15, 2021:

- [x] [Get database info](https://pkg.go.dev/github.com/kjk/notion#Client.GetDatabase), [example](https://github.com/kjk/notion/blob/master/examples/get_database_info.go)

- [x] [Query a database](https://pkg.go.dev/github.com/kjk/notion#Client.QueryDatabase), [example](https://github.com/kjk/notion/blob/master/examples/query_database.go)

- [x] [Retrieve page info](https://pkg.go.dev/github.com/kjk/notion#Client.GetPage). [example](https://github.com/kjk/notion/blob/master/examples/get_page_info.go)

- [x] [Retrieve children of a block](https://pkg.go.dev/github.com/kjk/notion#Client.GetBlockChildren), [example](https://github.com/kjk/notion/blob/master/examples/get_block_children.go)

- [x] [Create a page](https://pkg.go.dev/github.com/kjk/notion#Client.CreatePage), [example](https://github.com/kjk/notion/blob/master/examples/create_page.go)

- [x] [Update page properties](https://pkg.go.dev/github.com/kjk/notion#Client.UpdatePageProps)

- [x] [Append block children](https://pkg.go.dev/github.com/kjk/notion#Client.AppendBlockChildren)

- [x] [Get user info](https://pkg.go.dev/github.com/kjk/notion#Client.GetUser), [example](https://github.com/kjk/notion/blob/master/examples/get_user.go)

- [x] [List all users](https://pkg.go.dev/github.com/kjk/notion#Client.ListUsers), [example](https://github.com/kjk/notion/blob/master/examples/list_users.go)

- [x] [Search](https://pkg.go.dev/github.com/kjk/notion#Client.Search), [example](https://github.com/kjk/notion/blob/master/examples/search.go)

## Getting started

To obtain an API key (required for API calls), follow Notion’s [getting started guide](https://developers.notion.com/docs/getting-started).

### Code example

First, construct a new `Client`:

```go

import "github.com/kjk/notion"

(...)

client := notion.NewClient("secret-api-key")

```

Then, use the methods defined on `Client` to make requests to the API. For

example:

```go

page, err := client.GetPage(context.Background(), "18d35eb5-91f1-4dcb-85b0-c340fd965015")

if err != nil {

    // Handle error...

}

```

👉 Check out the docs on

[pkg.go.dev](https://pkg.go.dev/github.com/kjk/notion) for further

reference and examples.

## Status

The Notion API is currently in _public beta_.

⚠️ Although the API itself is versioned, this client **will** make breaking

changes in its code until `v1.0` of the module is released.

Official Notion API is still limited:

* not all block types are supported

* no way to avoid re-downloading data we already have

## Other clients

* https://github.com/kjk/notionapi : another Go client I wrote, this one uses unofficial API

* https://github.com/makenotion/notion-sdk-js : official node SDK from Notion

* https://github.com/dstotijn/go-notion : another Go client

* https://github.com/jomei/notionapi : another Go client

## License

[MIT License](LICENSE)

I based this code on https://github.com/dstotijn/go-notion (as of https://github.com/dstotijn/go-notion/commit/55aa9db5c7a72af2a57ac953ebbbdbdec3e1efa1, May 19 2021). I made API changes so it's not compatible with `go-notion`.