DuckDuckScrape

npm install duck-duck-scrape - yarn add duck-duck-scrape

Search from DuckDuckGo and utilize its spice APIs for things such as stocks, weather, currency conversion and more!

Available Features

Search
- Regular search
- Image search
- Video search
- News search
Stocks (via Xignite)
Time for Location API (via timeanddate.com)
Currency Conversion (via XE)
Forecast (via Dark Sky)
Dictionary
- Definition
- Audio
- Pronunciation
- Hyphenation

Quickstart

JavaScript

const DDG = require('duck-duck-scrape');
const searchResults = await DDG.search('node.js', {
  safeSearch: DDG.SafeSearchType.STRICT
});

// DDG.stocks('aapl')
// DDG.currency('usd', 'eur', 1)
// DDG.dictionaryDefinition('happy')

console.log(searchResults);
/**

{
  noResults: false,
  vqd: '3-314...',
  results: [
    {
      title: 'Node.js® is a JavaScript runtime built on Chrome&#x27;s V8 JavaScript...',
      ...
      url: 'https://nodejs.org/',
      bang: {
        prefix: 'node',
        title: 'node.js docs',
        domain: 'nodejs.org'
      }
    },
    ...
  ]
}

*/

TypeScript

import { search, SafeSearchType } from 'duck-duck-scrape';
// import * as DDG from 'duck-duck-scrape';

const searchResults = await search('node.js', {
  safeSearch: SafeSearchType.STRICT
});

Index

Enumerations

Interfaces

Type aliases

Search Functions

Spice Functions

Other Functions

getVQD

Type aliases

AutocompleteResult

AutocompleteResult: AutocompleteTerm | AutocompleteBang

DictionaryDefinitionPartOfSpeech

DictionaryHyphenationType

DictionaryHyphenationType: "stress" | "secondary stress"

DictionaryPronunciationType

DictionaryPronunciationType: "ahd-5" | "arpabet" | "gcide-diacritical" | "IPA"

ForecastAlertSeverity

ForecastAlertSeverity: "advisory"

ForecastIcon

ForecastPrecipType

ForecastPrecipType: "rain" | "snow"

Search Functions

autocomplete

autocomplete(query: string, region?: string, needleOptions?: NeedleOptions): Promise<AutocompleteResult[]>

- Defined in search/search.ts:329
Get auto-complete terms from a query.

Parameters
- query: string
  
  The query to search
- Optional region: string
  
  The region to search as
- Optional needleOptions: NeedleOptions
  
  The options of the HTTP request
Returns Promise<AutocompleteResult[]>

Autocomplete terms

search

search(query: string, options?: SearchOptions, needleOptions?: NeedleOptions): Promise<SearchResults>

- Defined in search/search.ts:118
Search something.

Parameters
- query: string
  
  The query to search with
- Optional options: SearchOptions
  
  The options of the search
- Optional needleOptions: NeedleOptions
  
  The options of the HTTP request
Returns Promise<SearchResults>

Search results

searchImages

searchImages(query: string, options?: ImageSearchOptions, needleOptions?: NeedleOptions): Promise<ImageSearchResults>

- Defined in search/images.ts:148
Search images.

Parameters
- query: string
  
  The query to search with
- Optional options: ImageSearchOptions
  
  The options of the search
- Optional needleOptions: NeedleOptions
  
  The options of the HTTP request
Returns Promise<ImageSearchResults>

Search results

searchNews

searchNews(query: string, options?: NewsSearchOptions, needleOptions?: NeedleOptions): Promise<NewsSearchResults>

- Defined in search/news.ts:68
Search news articles.

Parameters
- query: string
  
  The query to search with
- Optional options: NewsSearchOptions
  
  The options of the search
- Optional needleOptions: NeedleOptions
  
  The options of the HTTP request
Returns Promise<NewsSearchResults>

Search results

searchVideos

searchVideos(query: string, options?: VideoSearchOptions, needleOptions?: NeedleOptions): Promise<VideoSearchResults>

- Defined in search/videos.ts:105
Search videos.

Parameters
- query: string
  
  The query to search with
- Optional options: VideoSearchOptions
  
  The options of the search
- Optional needleOptions: NeedleOptions
  
  The options of the HTTP request
Returns Promise<VideoSearchResults>

Search results

Spice Functions

currency

currency(from: string, to: string, amount?: number, needleOptions?: NeedleOptions): Promise<CurrencyResult>

- Defined in spices/currency.ts:62
Get the currency conversion between two currencies. Data provided by XE.

see

https://www.xe.com/

Parameters
- from: string
  
  The currency to convert from
- to: string
  
  The currency to convert to
- amount: number = 1
  
  The amount of currency to convert
- Optional needleOptions: NeedleOptions
  
  The options for the HTTP request
Returns Promise<CurrencyResult>

The currency result

dictionaryAudio

dictionaryAudio(word: string, needleOptions?: NeedleOptions): Promise<DictionaryAudioResult[]>

- Defined in spices/dictionary/audio.ts:36
Get audio of the word being said. Data provided by Wordnik.

see

https://www.wordnik.com/

Parameters
- word: string
  
  The word to define
- Optional needleOptions: NeedleOptions
  
  The options for the HTTP request
Returns Promise<DictionaryAudioResult[]>

The dictionary audio result

dictionaryDefinition

dictionaryDefinition(word: string, needleOptions?: NeedleOptions): Promise<DictionaryDefinitionResult[]>

- Defined in spices/dictionary/definition.ts:85
Get definitions of a word. Data provided by Wordnik.

see

https://www.wordnik.com/

Parameters
- word: string
  
  The word to define
- Optional needleOptions: NeedleOptions
  
  The options for the HTTP request
Returns Promise<DictionaryDefinitionResult[]>

The dictionary definition result

dictionaryHyphenation

dictionaryHyphenation(word: string, needleOptions?: NeedleOptions): Promise<DictionaryHyphenationResult[]>

- Defined in spices/dictionary/hyphenation.ts:26
Get word syllables. Data provided by Wordnik.

see

https://www.wordnik.com/

Parameters
- word: string
  
  The word to define
- Optional needleOptions: NeedleOptions
  
  The options for the HTTP request
Returns Promise<DictionaryHyphenationResult[]>

The dictionary hyphenation result

dictionaryPronunciation

dictionaryPronunciation(word: string, needleOptions?: NeedleOptions): Promise<DictionaryPronunciationResult[]>

- Defined in spices/dictionary/pronunciation.ts:29
Get text pronunciations of a word. Data provided by Wordnik.

see

https://www.wordnik.com/

Parameters
- word: string
  
  The word to define
- Optional needleOptions: NeedleOptions
  
  The options for the HTTP request
Returns Promise<DictionaryPronunciationResult[]>

The dictionary pronunciation result

dns

dns(domain: string, recordType?: DNSRecordType, needleOptions?: NeedleOptions): Promise<DNSResult>

- Defined in spices/dns.ts:79
Get DNS records of a domain. Data provided by ViewDNS.info.

see

https://viewdns.info/

since

v2.1.0

Parameters
- domain: string
- recordType: DNSRecordType = ...
  
  The type of DNS record to retrieve
- Optional needleOptions: NeedleOptions
  
  The options for the HTTP request
Returns Promise<DNSResult>

The dns result

emojipedia

emojipedia(emoji: string, needleOptions?: NeedleOptions): Promise<EmojipediaResult>

- Defined in spices/emojipedia.ts:51
Get information on an emoji. Data provided by Emojipedia.

see

https://emojipedia.org/

since

v2.2.0

Parameters
- emoji: string
  
  The emoji to use
- Optional needleOptions: NeedleOptions
  
  The options for the HTTP request
Returns Promise<EmojipediaResult>

The emojipedia result

expandUrl

expandUrl(url: string, needleOptions?: NeedleOptions): Promise<ExpandUrlResult>

- Defined in spices/expandUrl.ts:27
Expand a shortened link. Data provided by Unshorten.me.

see

https://unshorten.me/

since

v2.2.0

Parameters
- url: string
  
  The URL to unshorten
- Optional needleOptions: NeedleOptions
  
  The options for the HTTP request
Returns Promise<ExpandUrlResult>

The expandUrl result

forecast

forecast(query: string, locale?: string, needleOptions?: NeedleOptions): Promise<ForecastResult | null>

- Defined in spices/forecast.ts:143
Get the forecast of a location. Returns null if there are no results. Data provided by Dark Sky and other sources.

see

https://darksky.net/

Parameters
- query: string
  
  The query to search with
- locale: string = 'en'
  
  The locale to give the summaries in
- Optional needleOptions: NeedleOptions
  
  The options for the HTTP request
Returns Promise<ForecastResult | null>

The forecast result

statista

statista(query: string, needleOptions?: NeedleOptions): Promise<StatistaResult>

- Defined in spices/statista.ts:57
Search statistics. Data provided by Statista.

see

https://www.statista.com/

since

v2.2.0

Parameters
- query: string
  
  The query to search with
- Optional needleOptions: NeedleOptions
  
  The options for the HTTP request
Returns Promise<StatistaResult>

The statista result

stocks

stocks(symbol: string, needleOptions?: NeedleOptions): Promise<StocksResult>

- Defined in spices/stocks.ts:115
Get the stocks of a symbol. Data provided by Xignite.

see

https://www.xignite.com/

Parameters
- symbol: string
  
  What symbol to get stats from
- Optional needleOptions: NeedleOptions
  
  The options for the HTTP request
Returns Promise<StocksResult>

The stocks result

thesaurus

thesaurus(word: string, needleOptions?: NeedleOptions): Promise<ThesaurusResult | null>

- Defined in spices/thesaurus.ts:30
Get synonyms and antonyms of a word. Data provided by Big Huge Thesaurus.

see

https://words.bighugelabs.com/

since

v2.2.0

Parameters
- word: string
  
  The word to define
- Optional needleOptions: NeedleOptions
  
  The options for the HTTP request
Returns Promise<ThesaurusResult | null>

The thesaurus result

time

time(query: string, needleOptions?: NeedleOptions): Promise<TimeResult>

- Defined in spices/time.ts:111
Search the time of locations with a query. Data provided by TimeAndDate.com.

see

https://www.timeanddate.com/

Parameters
- query: string
  
  The query to search with
- Optional needleOptions: NeedleOptions
  
  The options of the HTTP request
Returns Promise<TimeResult>

The time result

Other Functions

getVQD

getVQD(query: string, ia?: string, options?: NeedleOptions): Promise<string>

- Defined in util.ts:43
Get the VQD of a search query.

Parameters
- query: string
  
  The query to search
- ia: string = 'web'
  
  The type(?) of search
- Optional options: NeedleOptions
  
  The options of the HTTP request
Returns Promise<string>

The VQD

Generated using TypeDoc

Available Features

Quickstart

JavaScript

TypeScript

Index

Enumerations

Interfaces

Type aliases

Search Functions

Spice Functions

Other Functions

Type aliases

AutocompleteResult

DictionaryDefinitionPartOfSpeech

DictionaryHyphenationType

DictionaryPronunciationType

ForecastAlertSeverity

ForecastIcon

ForecastPrecipType

Search Functions

autocomplete

Parameters

query: string

Optional region: string

Optional needleOptions: NeedleOptions

Returns Promise<AutocompleteResult[]>

search

Parameters

query: string

Optional options: SearchOptions

Optional needleOptions: NeedleOptions

Returns Promise<SearchResults>

searchImages

Parameters

query: string

Optional options: ImageSearchOptions

Optional needleOptions: NeedleOptions

Returns Promise<ImageSearchResults>

searchNews

Parameters

query: string

Optional options: NewsSearchOptions

Optional needleOptions: NeedleOptions

Returns Promise<NewsSearchResults>

searchVideos

Parameters

query: string

Optional options: VideoSearchOptions

Optional needleOptions: NeedleOptions

Returns Promise<VideoSearchResults>

Spice Functions

currency

Parameters

from: string

to: string

amount: number = 1

Optional needleOptions: NeedleOptions

Returns Promise<CurrencyResult>

dictionaryAudio

Parameters

word: string

Optional needleOptions: NeedleOptions

Returns Promise<DictionaryAudioResult[]>

dictionaryDefinition

Parameters

word: string

Optional needleOptions: NeedleOptions

Returns Promise<DictionaryDefinitionResult[]>

dictionaryHyphenation

Parameters

word: string

Optional needleOptions: NeedleOptions

Returns Promise<DictionaryHyphenationResult[]>

dictionaryPronunciation

Parameters

word: string

Optional needleOptions: NeedleOptions

Returns Promise<DictionaryPronunciationResult[]>

dns

Parameters