https://github.com/krmanik/ankijs-api
Anki JavaScript API to get cards informations in reviewer window
https://github.com/krmanik/ankijs-api
anki anki-addon anki-api anki-js anki21
Last synced: 6 months ago
JSON representation
Anki JavaScript API to get cards informations in reviewer window
- Host: GitHub
- URL: https://github.com/krmanik/ankijs-api
- Owner: krmanik
- License: mit
- Created: 2020-12-15T10:00:07.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2025-01-13T09:58:46.000Z (10 months ago)
- Last Synced: 2025-05-07T05:49:40.248Z (6 months ago)
- Topics: anki, anki-addon, anki-api, anki-js, anki21
- Language: Python
- Homepage:
- Size: 198 KB
- Stars: 9
- Watchers: 2
- Forks: 5
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: License
Awesome Lists containing this project
README
# AnkiJS-API
Anki JavaScript API to get cards information in reviewer window
This addon is made to work with [AnkiDroid JS API](https://github.com/ankidroid/Anki-Android/wiki/AnkiDroid-Javascript-API).
# Install from AnkiWeb
https://ankiweb.net/shared/info/1490471827
# Demo
# To get card info in reviewer for creating decks
To know more about the options view
[AnkiDroid JS API](https://github.com/ankidroid/Anki-Android/wiki/AnkiDroid-Javascript-API).
## New Count
```javascript
pycmd("AnkiJS.ankiGetNewCardCount()", (ret) => {
console.log(ret);
});
```
## Learn Count
```javascript
pycmd("AnkiJS.ankiGetLrnCardCount()", (ret) => {
console.log(ret);
});
```
## Review Count
```javascript
pycmd("AnkiJS.ankiGetRevCardCount()", (ret) => {
console.log(ret);
});
```
## Mark
```javascript
pycmd("AnkiJS.ankiGetCardMark()", (ret) => {
console.log(ret);
});
```
## Flag
```javascript
pycmd("AnkiJS.ankiGetCardFlag()", (ret) => {
console.log(ret);
});
```
## Card Id
```javascript
pycmd("AnkiJS.ankiGetCardId()", (ret) => {
console.log(ret);
});
```
## Note Id
```javascript
pycmd("AnkiJS.ankiGetCardNid()", (ret) => {
console.log(ret);
});
```
## Deck Id
```javascript
pycmd("AnkiJS.ankiGetCardDid()", (ret) => {
console.log(ret);
});
```
## Last modified time of card
```javascript
pycmd("AnkiJS.ankiGetCardMod()", (ret) => {
console.log(ret);
});
```
## Type
```javascript
pycmd("AnkiJS.ankiGetCardType()", (ret) => {
console.log(ret);
});
```
## Queue
```javascript
pycmd("AnkiJS.ankiGetCardQueue()", (ret) => {
console.log(ret);
});
```
## Left
```javascript
pycmd("AnkiJS.ankiGetCardLeft()", (ret) => {
console.log(ret);
});
```
## Due
```javascript
pycmd("AnkiJS.ankiGetCardDue()", (ret) => {
console.log(ret);
});
```
## Interval
```javascript
pycmd("AnkiJS.ankiGetCardInterval()", (ret) => {
console.log(ret);
});
```
## Factor
```javascript
pycmd("AnkiJS.ankiGetCardFactor()", (ret) => {
console.log(ret);
});
```
## Reps
```javascript
pycmd("AnkiJS.ankiGetCardReps()", (ret) => {
console.log(ret);
});
```
## Lapses
```javascript
pycmd("AnkiJS.ankiGetCardLapses()", (ret) => {
console.log(ret);
});
```
## Original Due
```javascript
pycmd("AnkiJS.ankiGetCardODue()", (ret) => {
console.log(ret);
});
```
## Deck ID of home deck if filtered
```javascript
pycmd("AnkiJS.ankiGetCardODid()", (ret) => {
console.log(ret);
});
```
## Next Time 1
```javascript
pycmd("AnkiJS.ankiGetNextTime1()", (ret) => {
console.log(ret);
});
```
## Next Time 2
```javascript
pycmd("AnkiJS.ankiGetNextTime2()", (ret) => {
console.log(ret);
});
```
## Next Time 3
```javascript
pycmd("AnkiJS.ankiGetNextTime3()", (ret) => {
console.log(ret);
});
```
## Next Time 4
```javascript
pycmd("AnkiJS.ankiGetNextTime4()", (ret) => {
console.log(ret);
});
```
## Search in browser
When quotes are needed in the search, e.g. "deck:My Deck" due to spaces in a deck name, they'll need to be escaped as the argument itself must be wrapped with single or double quotes.
```javascript
pycmd("AnkiJS.ankiSearchCard('\"deck:My Deck\" MyField:*foo*')");
```