Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Xetera/kindle-api
📕 Access Kindle's private API in Node.js without a headless browser
https://github.com/Xetera/kindle-api
Last synced: 22 days ago
JSON representation
📕 Access Kindle's private API in Node.js without a headless browser
- Host: GitHub
- URL: https://github.com/Xetera/kindle-api
- Owner: Xetera
- License: mit
- Created: 2023-01-13T03:32:56.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-02-24T16:53:11.000Z (10 months ago)
- Last Synced: 2024-11-16T01:11:34.901Z (about 1 month ago)
- Language: TypeScript
- Homepage:
- Size: 334 KB
- Stars: 133
- Watchers: 5
- Forks: 12
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- starred - Xetera/kindle-api - 📕 Access Kindle's private API in Node.js without a headless browser (TypeScript)
README
# Kindle-Api
A zero dependency, blazing fast library for Amazon Kindle's private API built without headless browsers.
## Installation
```
pnpm add kindle-api
```
## Setup
Ok I kinda lied about the zero dependency part. The library does actually depend on an external [tls-client-api](https://github.com/bogdanfinn/tls-client-api) to proxy requests due to amazon's recent changes to their TLS fingerprinting in July 2023. You'll need to run the server locally to be able to use this library. It's quite easy to set up and have one running in a few minutes and will save you tons of headache if you wanna do other kinds of scraping in the future
### Cookies
Amazon's login system is quite strict and the SMS 2FA makes automating logins difficult. Instead of trying to automate that with puppeteer and slow things down, we use 4 cookies that stay valid for an entire year.
- `ubid-main`
- `at-main`
- `x-main`
- `session-id`
You can grab these values directly by going on inspect element after loading [read.amazon.com](https://read.amazon.com) and copying the entire thing or just the select ones 
### Device Token
We also need a deviceToken for your kindle. You can grab this from the same network window as before on the `getDeviceToken` request that looks like:
https://read.amazon.com/service/web/register/getDeviceToken?serialNumber=(your-device-token)&deviceType=(your-device-token)
Both of those numbers should be the same.
### Usage
Upon creating the `Kindle` object, you'll load the first batch of books.
```js
import { Kindle } from "kindle-api";
const kindle = await Kindle.fromConfig({
cookies: "ubid-main=xxx.xxxx ...",
deviceToken: "(your-device-token)",
tlsServer: {
url: "https://your-tls-server-api.com",
apiKey: "(your-api-key)",
},
});
console.log(kindle.defaultBooks);
/*
[
KindleBook {
title: 'Project Hail Mary: A Novel',
authors: [ { firstName: 'Andy', lastName: 'Weir' } ]
imageUrl: 'https://m.media-amazon.com/images/I/51YS2zsN+iL._SY400_.jpg',
asin: 'B08FHBV4ZX',
originType: 'PURCHASE',
productUrl: 'https://m.media-amazon.com/images/I/51YS2zsN+iL._SY400_.jpg',
mangaOrComicAsin: false,
webReaderUrl: 'https://read.amazon.com/?asin=B08FHBV4ZX'
},
KindleBook {
title: 'Engineering Management for the Rest of Us',
authors: [ { firstName: 'Sarah', lastName: 'Drasner' } ],
imageUrl: 'https://m.media-amazon.com/images/I/61xVsTw0gIL._SY400_.jpg',
asin: 'B0BGYVDX35',
originType: 'PURCHASE',
productUrl: 'https://m.media-amazon.com/images/I/61xVsTw0gIL._SY400_.jpg',
mangaOrComicAsin: false,
webReaderUrl: 'https://read.amazon.com/?asin=B0BGYVDX35'
}
]
*/
```
## Book Details
Here's an example of how you could implement a script that keeps track of your book progress
```ts
import { setTimeout } from "node:timers/promises";
// assuming we saved our previous run
const previous = await getPreviousData();
// you can use `await kindle.books()` if you want to re-fetch your book list
for (const book of kindle.defaultBooks) {
const details = await book.details();
const readSinceLastTime =
details.progress.syncDate > previous.get(details.asin).lastSync;
if (readSinceLastTime) {
// make another request to fetch full book details
// including reading progress
const fullDetails = await book.fullDetails(details);
console.log(fullDetails.percentageRead); // 45
}
// add a delay after each book lookup to not spam and get banned
await setTimeout(5000);
}
```
## Missing features
- [ ] Pagination
- [ ] Reading book content? Can't think of a usecase for this one
- [ ] Basically anything that isn't just getting book info