NullDev / qwant-api

:crystal_ball: Unofficial API wrapper for qwant
https://qwant.com
Apache License 2.0
32 stars 4 forks source link
api api-client api-wrapper hacktoberfest hacktoberfest2022 javascript js nodejs nulldev qwant rest rest-api restful restful-api wrapper

Qwant API


Unofficial API wrapper for qwant

:information_source: About

Qwant provides an unofficial, free and limit-less search API. This library aims to provide a fully featured wrapper for it.

The unofficial documentation of Qwant's API can be found in the DOCUMENTATION.md file

:postbox: NPM


:wrench: Installation

npm i qwant-api

:white_check_mark: Features

Qwant Feature support

web images news social videos music
:heavy_check_mark: :heavy_check_mark: :heavy_check_mark: :heavy_check_mark: :heavy_check_mark: :heavy_check_mark:

:bulb: Usage

Search:

qwant.search(<category>, { <options> }, <callback>{ /*...*/ });

Returns search results

Categories:

Options:

Option Required Type Default Explanation
query Yes string none The term(s) to search
count No integer 1 The amount of results
offset No integer 0 The index of the first result
language No string english The language for the search

Example:

var qwant = require("qwant-api");

qwant.search("web", { query: "test", count: 10, offset: 1, language: "german" }, function(err, data){
    if (err) return console.log(err);
    console.log(data);
});

Languages:

qwant.getLanguages(<options>);

Returns a list of supported languages

Options:

Option Required Type Default Explanation
list codes No boolean false List languages and language codes

Example:

var qwant = require("qwant-api");

var languages = qwant.getLanguages();

console.log(languages);
// => ['english', 'german', 'french', 'welsh', 'scottish', ... ]

var languagesAndCodes = qwant.getLanguages(true);

console.log(languagesAndCodes);
// => { english: 'en_en', german: 'de_de', french: 'fr_fr', ... }

:nut_and_bolt: Dependencies


:clipboard: TODO:

Everything.


:copyright: Copyright & Disclaimer

Copyright (c) NullDev

This is NOT an official API Wraper for Qwant.