go-notion/README.md

go-notion

go-notion is a client for the Notion API, written in Go.

Features

The client supports all (non-deprecated) endpoints available in the Notion API, as of December 22, 2021:

Databases

• Query a database
• Create a database
• Update database
• Retrieve a database

Pages

• Retrieve a page
• Create a page
• Update page
• Retrieve a page property

Blocks

• Retrieve a block
• Update block
• Retrieve block children
• Append block children
• Delete block

Users

• Retrieve a user
• List all users
• Retrieve your token's bot user

Search

• Search

Installation

$ go get github.com/dstotijn/go-notion

Getting started

To obtain an API key, follow Notion’s getting started guide.

Code example

First, construct a new Client:

import "github.com/dstotijn/go-notion"

(...)

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

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

page, err := client.FindPageByID(context.Background(), "18d35eb5-91f1-4dcb-85b0-c340fd965015")
if err != nil {
    // Handle error...
}

👉 Check out the docs on pkg.go.dev 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.

To do

• Write tests
• Provide examples

License

MIT License

© 2021 David Stotijn