nyt-books
v1.0.0
Published
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
Downloads
4
Readme
NytBooksSdk TypeScript 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: TypeScript >= 4.8.4
Installation
To get started with the SDK, we recommend installing using npm
:
npm install nyt-books
Services
The SDK provides various services to interact with the API.
| 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.
| Name | Description | | :------------------------------------------------------------------------------------------------------------------------- | :---------- | | GetListsFormatOkResponse | | | GetListsDateListJsonOkResponse | | | OverviewResponse | | | GetListsNamesFormatOkResponse | | | GetListsBestSellersHistoryJsonOkResponse | | | GetReviewsFormatOkResponse | | | GetListsFormatOkResponseResults | | | ResultsIsbns1 | | | BookDetails | | | ResultsReviews1 | | | GetListsDateListJsonOkResponseResults | | | ResultsBooks | | | BooksIsbns | | | BooksBuyLinks1 | | | Result | | | Lists | | | ListsBooks | | | BooksBuyLinks2 | | | GetListsNamesFormatOkResponseResults | | | Updated | | | GetListsBestSellersHistoryJsonOkResponseResults | | | ResultsIsbns2 | | | RanksHistory | | | ResultsReviews2 | | | GetReviewsFormatOkResponseResults | |
License
This SDK is licensed under the MIT License.
See the LICENSE file for more details.