duckduckgo

README

DuckDuckGo clients for Crawlora

Official Crawlora client packages for the hosted DuckDuckGo API. Access 6 API endpoints covering web, news, image, video, and shopping search plus query suggestions from JavaScript/TypeScript, Python, Go, Ruby, Java, and PHP. These clients call Crawlora's hosted API; they do not scrape DuckDuckGo locally. Requests use your Crawlora account and CRAWLORA_API_KEY; service usage follows your account billing plan. Crawlora is independent from and not affiliated with or endorsed by DuckDuckGo or its owners.

Language packages

• JavaScript / TypeScript: @crawlora-org/duckduckgo
• Python: crawlora-duckduckgo
• Go: github.com/Crawlora-org/crawlora-duckduckgo
• Ruby: crawlora-duckduckgo
• Java: net.crawlora:crawlora-duckduckgo:0.1.1
• PHP: crawlora/duckduckgo

For installation and runnable examples, use the README for your language. See the API endpoint and parameter reference for shared operation details.

Create an account at crawlora.net, open the Crawlora console to get an API key, or read the API documentation. Keep CRAWLORA_API_KEY out of source control.

API coverage and supported endpoints

The six language clients provide access to all 6 selected public DuckDuckGo API operations. Search or browse by endpoint path and operation ID below; the complete API reference adds parameters, enums, and response details.

Method	Endpoint	API operation	Description
GET	/duckduckgo/image	duckduckgo-image	Search DuckDuckGo image results
GET	/duckduckgo/news	duckduckgo-news	Search DuckDuckGo news results
GET	/duckduckgo/search	duckduckgo-search	Search DuckDuckGo web results
GET	/duckduckgo/shopping	duckduckgo-shopping	Search DuckDuckGo shopping results
GET	/duckduckgo/suggest	duckduckgo-suggest	Suggest DuckDuckGo search queries
GET	/duckduckgo/video	duckduckgo-video	Search DuckDuckGo video results

License

MIT. See LICENSE.

Documentation

Overview

Package duckduckgo is Crawlora's DuckDuckGo API client for 6 endpoints, covering web, news, image, video, and shopping search plus query suggestions. API documentation: https://crawlora.net/docs?utm_source=pkg.go.dev&utm_medium=referral&utm_campaign=platform-clients&utm_content=duckduckgo-go-api-docs

Index

• Constants
• func OperationIDs() []string
• type Client
  • func NewClient(apiKey string) *Client
  • func (c *Client) Call(ctx context.Context, operationID string, params Params) (any, error)
  • func (c *Client) Close() error
  • func (c *Client) Image(ctx context.Context, params Params) (any, error)
  • func (c *Client) News(ctx context.Context, params Params) (any, error)
  • func (c *Client) Search(ctx context.Context, params Params) (any, error)
  • func (c *Client) Shopping(ctx context.Context, params Params) (any, error)
  • func (c *Client) Suggest(ctx context.Context, params Params) (any, error)
  • func (c *Client) Video(ctx context.Context, params Params) (any, error)
• type Params

Examples

• Client.Call

Constants

const (
	DefaultBaseURL = "https://api.crawlora.net/api/v1"
	Version        = "0.1.1"
)

const OperationCount = 6

OperationCount reports how many selected-platform operations this module exposes.

Functions

func OperationIDs

func OperationIDs() []string

OperationIDs returns the selected operation IDs in stable sorted order.

Types

type Client

type Client struct {
	APIKey     string
	BaseURL    string
	Timeout    time.Duration
	HTTPClient *http.Client
}

Client calls only the operation IDs included in this platform module.

func NewClient

func NewClient(apiKey string) *Client

NewClient creates a client using the supplied API key, or CRAWLORA_API_KEY when empty.

func (*Client) Call

func (c *Client) Call(ctx context.Context, operationID string, params Params) (any, error)

Call executes a selected platform operation by operation ID.

Example

server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
	w.Header().Set("Content-Type", "application/json")
	_, _ = w.Write([]byte(`{"ok":true}`))
}))
defer server.Close()

client := NewClient("your-crawlora-api-key")
client.BaseURL = server.URL + "/api/v1"
client.HTTPClient = server.Client()
result, err := client.Call(context.Background(), "duckduckgo-image", Params{"q": "sample"})
if err != nil {
	panic(err)
}
fmt.Println(result.(map[string]any)["ok"])

Output:
true

func (*Client) Close

func (c *Client) Close() error

Close releases idle connections held by the configured HTTP transport.

func (*Client) Image

func (c *Client) Image(ctx context.Context, params Params) (any, error)

Image calls the duckduckgo-image operation.

func (*Client) News

func (c *Client) News(ctx context.Context, params Params) (any, error)

News calls the duckduckgo-news operation.

func (*Client) Search

func (c *Client) Search(ctx context.Context, params Params) (any, error)

Search calls the duckduckgo-search operation.

func (*Client) Shopping

func (c *Client) Shopping(ctx context.Context, params Params) (any, error)

Shopping calls the duckduckgo-shopping operation.

func (*Client) Suggest

func (c *Client) Suggest(ctx context.Context, params Params) (any, error)

Suggest calls the duckduckgo-suggest operation.

func (*Client) Video

func (c *Client) Video(ctx context.Context, params Params) (any, error)

Video calls the duckduckgo-video operation.

type Params

type Params map[string]any

Params maps the exact OpenAPI parameter names expected by this platform client.