marginalia

Documentation

Overview

Package marginalia implements the Marginalia search API.

You need an API key to use this. See the Marginalia API docs for more information: https://www.marginalia.nu/marginalia-search/api/

Index

• type Client
  • func New(apiKey string, httpCli *http.Client) *Client
  • func (c *Client) Search(ctx context.Context, req *Request) (*Response, error)
• type Detail
• type Request
• type Response
• type Result

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

func New

func New(apiKey string, httpCli *http.Client) *Client

func (*Client) Search

func (c *Client) Search(ctx context.Context, req *Request) (*Response, error)

type Detail

type Detail struct {
	Keyword          string   `json:"keyword"`
	Count            int      `json:"count"`
	FlagsUnstableAPI []string `json:"flagsUnstableAPI"`
}

type Request

type Request struct {
	Query string
	Count *int
	Index *int
}

type Response

type Response struct {
	License string   `json:"license"`
	Query   string   `json:"query"`
	Results []Result `json:"results"`
}

type Result

type Result struct {
	URL         string     `json:"url"`
	Title       string     `json:"title"`
	Description string     `json:"description"`
	Quality     float64    `json:"quality"`
	Details     [][]Detail `json:"details"`
}