{"id":16974745,"url":"https://github.com/nulldev/qwant-api","last_synced_at":"2025-03-22T14:31:35.414Z","repository":{"id":50251593,"uuid":"113448283","full_name":"NullDev/qwant-api","owner":"NullDev","description":":crystal_ball: Unofficial API wrapper for qwant","archived":false,"fork":false,"pushed_at":"2022-06-13T12:48:28.000Z","size":81,"stargazers_count":36,"open_issues_count":8,"forks_count":4,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-03-19T21:27:40.707Z","etag":null,"topics":["api","api-client","api-wrapper","hacktoberfest","hacktoberfest2022","javascript","js","nodejs","nulldev","qwant","rest","rest-api","restful","restful-api","wrapper"],"latest_commit_sha":null,"homepage":"https://qwant.com","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/NullDev.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-12-07T12:28:43.000Z","updated_at":"2025-03-19T01:04:14.000Z","dependencies_parsed_at":"2022-08-23T07:10:08.807Z","dependency_job_id":null,"html_url":"https://github.com/NullDev/qwant-api","commit_stats":null,"previous_names":["nldev/qwant-api"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NullDev%2Fqwant-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NullDev%2Fqwant-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NullDev%2Fqwant-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NullDev%2Fqwant-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/NullDev","download_url":"https://codeload.github.com/NullDev/qwant-api/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244972067,"owners_count":20540917,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","api-client","api-wrapper","hacktoberfest","hacktoberfest2022","javascript","js","nodejs","nulldev","qwant","rest","rest-api","restful","restful-api","wrapper"],"created_at":"2024-10-14T01:07:53.016Z","updated_at":"2025-03-22T14:31:35.098Z","avatar_url":"https://github.com/NullDev.png","language":"JavaScript","readme":"# Qwant API\n\n\u003cp align=\"center\"\u003e\n\u003cimg height=\"150\" width=\"auto\" src=\"https://i.imgur.com/5krITxE.png\" /\u003e\u003cbr\u003e\nUnofficial API wrapper for qwant\n\u003c/p\u003e\n\n## :information_source: About\n\n[Qwant](http://qwant.com) provides an unofficial, free and limit-less search API. This library aims to provide a fully featured wrapper for it.\n\nThe unofficial documentation of Qwant's API can be found in the [DOCUMENTATION.md](https://github.com/NullDev/qwant-api/blob/master/DOCUMENTATION.md) file \n\n## :postbox: NPM\n\n[![](https://nodei.co/npm/qwant-api.svg?downloads=true\u0026downloadRank=true\u0026stars=true)](https://www.npmjs.com/package/qwant-api)\n\n\u003chr\u003e\n\n## :wrench: Installation\n\n```Assembly\nnpm i qwant-api\n```\n\n\u003chr\u003e\n\n## :white_check_mark: Features\n\nQwant Feature support\n  \n| web | images | news | social | videos | music |\n| :---: | :---: | :---: | :---: | :---: | :---: |\n| :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |\n\n- Error handling \n- Multiple Languages\n\n\u003chr\u003e\n\n## :bulb: Usage\n\n### Search:\n\n\n```javascript\nqwant.search(\u003ccategory\u003e, { \u003coptions\u003e }, \u003ccallback\u003e{ /*...*/ });\n```\n\nReturns search results\n\n**Categories:**\n\n- web\n- images\n- news\n- social\n- videos\n- music\n\n**Options:**\n\n| Option | Required | Type | Default | Explanation |\n|--------|----------|------|---------|-------------|\n| `query` | **Yes** | string | none | The term(s) to search |\n| `count` | No | integer | 1 | The amount of results |\n| `offset` | No | integer | 0 | The index of the first result |\n| `language ` | No | string | english | The language for the search |\n\n**Example:**\n\n```Javascript\nvar qwant = require(\"qwant-api\");\n\nqwant.search(\"web\", { query: \"test\", count: 10, offset: 1, language: \"german\" }, function(err, data){\n    if (err) return console.log(err);\n    console.log(data);\n});\n```\n\n### Languages:\n\n```javascript\nqwant.getLanguages(\u003coptions\u003e);\n```\n\nReturns a list of supported languages\n\n**Options:**\n\n| Option | Required | Type | Default | Explanation |\n|--------|----------|------|---------|-------------|\n| list codes | No | boolean | false  | List languages and language codes |\n\n**Example:**\n\n```Javascript\nvar qwant = require(\"qwant-api\");\n\nvar languages = qwant.getLanguages();\n\nconsole.log(languages);\n// =\u003e ['english', 'german', 'french', 'welsh', 'scottish', ... ]\n\nvar languagesAndCodes = qwant.getLanguages(true);\n\nconsole.log(languagesAndCodes);\n// =\u003e { english: 'en_en', german: 'de_de', french: 'fr_fr', ... }\n\n```\n\n\u003chr\u003e\n\n## :nut_and_bolt: Dependencies\n\n- [request](https://www.npmjs.com/package/request)\n\n\u003chr\u003e\n\n## :clipboard: TODO:\n\nEverything.\n\n\u003chr\u003e\n\n## :copyright: Copyright \u0026 Disclaimer\n\n`Copyright (c) NullDev`\n\nThis is **NOT** an official API Wraper for [Qwant](http://qwant.com).\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnulldev%2Fqwant-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnulldev%2Fqwant-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnulldev%2Fqwant-api/lists"}