Skip to main content

The Books API provides information about book reviews and The New York Times Best Sellers lists.

Project description

NytBooksSdk Python SDK 1.0.0

Welcome to the NytBooksSdk SDK documentation. This guide will help you get started with integrating and using the NytBooksSdk SDK in your project.

Versions

  • API version: 3.0.0
  • SDK version: 1.0.0

About the API

The Books API provides information about book reviews and The New York Times Best Sellers lists.

Best Sellers Lists Services

List Names

The lists/names service returns a list of all the NYT Best Sellers Lists. Some lists are published weekly and others monthly. The response includes when each list was first published and last published. /lists/names.json

List Data

The lists/{date}/{name} service returns the books on the best sellers list for the specified date and list name. /lists/2019-01-20/hardcover-fiction.json Use current for {date} to get the latest list. /lists/current/hardcover-fiction.json

Book Reviews Services

The book reviews service lets you get NYT book review by author, ISBN, or title. /reviews.json?author=Michelle+Obama /reviews.json?isbn=9781524763138 /reviews.json?title=Becoming Example Calls https://api.nytimes.com/svc/books/v3/lists/current/hardcover-fiction.json?api-key=yourkey https://api.nytimes.com/svc/books/v3/reviews.json?author=Stephen+King&api-key=yourkey

Table of Contents

Setup & Configuration

Supported Language Versions

This SDK is compatible with the following versions: Python >= 3.7

Installation

To get started with the SDK, we recommend installing using pip:

pip install nyt-books

Services

The SDK provides various services to interact with the API.

Below is a list of all available services with links to their detailed documentation:
Name
ListsJsonService
ListsService
ReviewsJsonService

Models

The SDK includes several models that represent the data structures used in API requests and responses. These models help in organizing and managing the data efficiently.

Below is a list of all available models with links to their detailed documentation:
Name Description
GetListsFormatOkResponse
GetListsDateListJsonOkResponse
OverviewResponse
GetListsNamesFormatOkResponse
GetListsBestSellersHistoryJsonOkResponse
GetReviewsFormatOkResponse
GetListsFormatOkResponseResults
ResultsIsbns_1
BookDetails
ResultsReviews_1
GetListsDateListJsonOkResponseResults
ResultsBooks
BooksIsbns
BooksBuyLinks_1
Result
Lists
ListsBooks
BooksBuyLinks_2
GetListsNamesFormatOkResponseResults
Updated
GetListsBestSellersHistoryJsonOkResponseResults
ResultsIsbns_2
RanksHistory
ResultsReviews_2
GetReviewsFormatOkResponseResults

License

This SDK is licensed under the MIT License.

See the LICENSE file for more details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nyt-books-1.0.0.tar.gz (22.8 kB view hashes)

Uploaded Source

Built Distribution

nyt_books-1.0.0-py3-none-any.whl (39.9 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page