Documentation
¶
Overview ¶
Package duckduckgo is the library behind the duckduckgo command line: the HTTP client, request shaping, and the typed data models for the DuckDuckGo Instant Answer API.
The Client here is the spine every command shares. It sets a real User-Agent, paces requests so a busy session stays polite, and retries the transient failures (429 and 5xx) that any public site throws under load.
Index ¶
Constants ¶
const BaseURL = "https://" + Host
BaseURL is the root every request is built from.
const DefaultUserAgent = "duckduckgo-cli/0.1 (tamnd87@gmail.com)"
DefaultUserAgent identifies the client to DuckDuckGo.
const Host = "api.duckduckgo.com"
Host is the site this client talks to, and the host the URI driver in domain.go claims.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Answer ¶
type Answer struct {
Heading string `kit:"id" json:"heading"`
Abstract string `json:"abstract"`
Source string `json:"source"`
URL string `json:"url"`
Type string `json:"type"`
Entity string `json:"entity"`
Topics int `json:"related_topics"`
}
Answer is the structured instant answer for a query.
type Client ¶
type Client struct {
HTTP *http.Client
UserAgent string
// Rate is the minimum gap between requests. Zero means no pacing.
Rate time.Duration
Retries int
// contains filtered or unexported fields
}
Client talks to the DuckDuckGo Instant Answer API over HTTP.
func (*Client) Get ¶
Get fetches rawURL and returns the response body. It paces and retries according to the client's settings. The caller owns nothing extra; the body is read fully and closed here.
type Domain ¶
type Domain struct{}
Domain is the duckduckgo driver. It carries no state; the per-run client is built by the factory Register hands kit.
func (Domain) Classify ¶
Classify is a no-op for duckduckgo since the API uses free-text queries, not addressable resource IDs. We still satisfy the kit.Classifier interface by treating any input as an "answer" type keyed on the trimmed query string.
func (Domain) Info ¶
func (Domain) Info() kit.DomainInfo
Info describes the scheme, the hostnames a pasted link is matched against, and the identity reused for the binary's help and version.
Source Files