156 lines
3.9 KiB
Markdown
156 lines
3.9 KiB
Markdown
# Node Bing API
|
|
Node.js lib for the Azure Bing Web Search API
|
|
|
|
## Changelog v3
|
|
Thanks to the contribution of [@franciscofsales](https://github.com/franciscofsales), version 3 supports the
|
|
new API (Cognitive Services). This version is not compatible with the
|
|
Azure version, so if you are still using an Azure access key, please
|
|
stay with v2.
|
|
|
|
## Changelog v2
|
|
In order to follow JavaScript best practices and allow the library to
|
|
be promisified, the callback function is now the last parameter.
|
|
|
|
## Installation
|
|
````
|
|
npm install node-bing-api
|
|
````
|
|
|
|
## Usage
|
|
|
|
Require the library and initialize it with your account key:
|
|
|
|
```js
|
|
var Bing = require('node-bing-api')({ accKey: "your-account-key" });
|
|
```
|
|
|
|
#### Web Search (same as Composite):
|
|
|
|
```js
|
|
Bing.web("Pizza", {
|
|
top: 10, // Number of results (max 50)
|
|
skip: 3 // Skip first 3 results
|
|
}, function(error, res, body){
|
|
|
|
// body has more useful information besides web pages
|
|
// (image search, related search, news, videos)
|
|
// but for this example we are just
|
|
// printing the first two web page results
|
|
console.log(body.webPages.value[0]);
|
|
console.log(body.webPages.value[1]);
|
|
});
|
|
```
|
|
|
|
#### Composite Search (same as Web):
|
|
```js
|
|
Bing.composite("xbox", {
|
|
top: 10, // Number of results (max 15 for news, max 50 if other)
|
|
skip: 3 // Skip first 3 results
|
|
}, function(error, res, body){
|
|
console.log(body.news);
|
|
});
|
|
```
|
|
|
|
#### News Search:
|
|
```js
|
|
Bing.news("xbox", {
|
|
top: 10, // Number of results (max 15)
|
|
skip: 3 // Skip first 3 results
|
|
}, function(error, res, body){
|
|
console.log(body);
|
|
});
|
|
```
|
|
|
|
#### Video Search:
|
|
```js
|
|
Bing.video("monkey vs frog", {
|
|
top: 10, // Number of results (max 50)
|
|
skip: 3 // Skip first 3 result
|
|
}, function(error, res, body){
|
|
console.log(body);
|
|
});
|
|
```
|
|
|
|
#### Images Search:
|
|
```js
|
|
Bing.images("Ninja Turtles", {
|
|
top: 15, // Number of results (max 50)
|
|
skip: 3 // Skip first 3 result
|
|
}, function(error, res, body){
|
|
console.log(body);
|
|
});
|
|
```
|
|
|
|
#### Related Search (same as Web):
|
|
```js
|
|
Bing.relatedSearch('berlin', {market: 'en-US'}, function (err, res, body) {
|
|
var suggestions = body.relatedSearches.value.map(function(r){ return r.displayText; });
|
|
console.log(suggestions.join('\n'));
|
|
});
|
|
```
|
|
|
|
#### Spelling Suggestions:
|
|
```js
|
|
Bing.spelling('awsome spell', function (err, res, body) {
|
|
console.log(body.flaggedTokens.suggestions[0].suggestion); //awesome spell
|
|
});
|
|
```
|
|
|
|
Requires specific Account key
|
|
|
|
Available Options:
|
|
* mode:\<Proof | Spell\>
|
|
* preContextText:\<*String*\>
|
|
* postContextText:\<*String*\>
|
|
|
|
#### Specify Market
|
|
Getting spanish results:
|
|
```js
|
|
Bing.images("Ninja Turtles"
|
|
, {top: 5, market: 'es-ES'}
|
|
, function(error, res, body){
|
|
|
|
console.log(body);
|
|
});
|
|
```
|
|
|
|
Full list of supported markets:
|
|
es-AR,en-AU,de-AT,nl-BE,fr-BE,pt-BR,en-CA,fr-CA,es-CL,da-DK,fi-FI,fr-FR,
|
|
de-DE,zh-HK,en-IN,en-ID,en-IE,it-IT,ja-JP,ko-KR,en-MY,es-MX,nl-NL,en-NZ,
|
|
no-NO,zh-CN,pl-PL,pt-PT,en-PH,ru-RU,ar-SA,en-ZA,es-ES,sv-SE,fr-CH,de-CH,
|
|
zh-TW,tr-TR,en-GB,en-US,es-US
|
|
|
|
|
|
#### Adult Filter
|
|
```js
|
|
Bing.images('Kim Kardashian'
|
|
, {market: 'en-US', adult: 'Strict'}
|
|
, function(error, res, body){
|
|
|
|
console.log(body.value);
|
|
});
|
|
```
|
|
Accepted values: "Off", "Moderate", "Strict".
|
|
|
|
*Moderate level should not include results with sexually explicit images
|
|
or videos, but may include sexually explicit text.*
|
|
|
|
#### Web Only API Subscriptions
|
|
To use this library with a web only subscription, you can require and initialize it with an alternate root url:
|
|
```js
|
|
var Bing = require('node-bing-api')
|
|
({
|
|
accKey: "your-account-key",
|
|
rootUri: "https://api.datamarket.azure.com/Bing/SearchWeb/v1/"
|
|
});
|
|
```
|
|
|
|
## Running Tests
|
|
In order to run the tests, the integration tests require to create a `secrets.js` file
|
|
from the provided `secrets.js.example` example, and fill it in with a valid access key.
|
|
|
|
Then just `mocha`.
|
|
|
|
|
|
## License
|
|
MIT
|