Welcome to the NytBooksSdk SDK documentation. This guide will help you get started with integrating and using the NytBooksSdk SDK in your project.
- API version:
3.0.0
- SDK version:
1.0.0
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
This SDK is compatible with the following versions: TypeScript >= 4.8.4
To get started with the SDK, we recommend installing using npm
:
npm install nyt-books
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 |
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:
This SDK is licensed under the MIT License.
See the LICENSE file for more details.