Socket
Socket
Sign inDemoInstall

google-books-search

Package Overview
Dependencies
2
Maintainers
1
Versions
6
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    google-books-search

A lightweight node wrapper for the Google Books API.


Version published
Weekly downloads
29
increased by52.63%
Maintainers
1
Install size
1.37 MB
Created
Weekly downloads
 

Readme

Source

Build Status npm npm

A simple Node.js client for the Google Books API.

Install

npm install --save google-books-search

Basic Usage

.search(query, options, callback)

Search for books matching the specified query.

var books = require('google-books-search');

books.search('Professional JavaScript for Web Developers', function(error, results) {
    if ( ! error ) {
        console.log(results);
    } else {
        console.log(error);
    }
});

Returns an array of JSON objects. For example;

[
    {
        "id": "9KJJYFIss_wC",
        "title": "Professional Javascript For Web Developers 2Nd Ed",
        "subtitle": "...",
        "authors":[
            "Nicholas C. Zakas"
        ],
        "publisher": "John Wiley & Sons",
        "publishedDate": "2009-02-09",
        "description": "...",
        "industryIdentifiers": [
            {
                "type": "ISSN",
                "identifier": "..."
            }
        ],
        "pageCount": 840,
        "printType": "BOOK",
        "averageRating": "4",
        "thumbnail": "http://bks5.books.google.com.au/books?id=...",
        "images": {
            "small": "http://...",
            "medium": "http://...",
            "large": "http://...",
            "extraLarge": "http://...",
        },
        "language": "en",
        "link": "http://books.google.com.au/books?id=..."
    },

    ...

]

For a description of each value; see the Google Books API documentaion for volumes.

.lookup(volumeId, options, callback)

Lookup books by Volume ID.

books.lookup('9KJJYFIss_wC', function(error, result) {
    ...
});

The options argument accepts an object with a key field (your API key).

Advanced Searches

The search method optionally accepts an options object as the second argument. See below for an overview of the available options.

var books = require('google-books-search');

var options = {
    key: "YOUR API KEY",
    field: 'title',
    offset: 0,
    limit: 10,
    type: 'books',
    order: 'relevance',
    lang: 'en'
};

books.search("Professional JavaScript for Web Developers", options, function(error, results, apiResponse) {
    if ( ! error ) {
        console.log(results);
    } else {
        console.log(error);
    }
});

Options

OptionDescription
keyYour Google API key (Optional)
fieldSearch in a specified field (title, author, publisher, subject or isbn) (Optional)
offsetThe position in the collection at which to start the list of results (Default: 0)
limitThe maximum number of results to return (Max 40) (Defult: 10)
typeRestrict results to books or magazines (Default: all)
orderOrder results by relevance or newest (Default: relevance)
langRestrict results to a specified language (two-letter ISO-639-1 code) (Default: en)

For more info please see the Google Books API documentation

Keywords

FAQs

Last updated on 13 Jan 2017

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc