https://github.com/th0rgall/voc-api
Unofficial API for vocabulary.com. Manage lists and get definitions.
https://github.com/th0rgall/voc-api
browser js node vocabulary
Last synced: 2 months ago
JSON representation
Unofficial API for vocabulary.com. Manage lists and get definitions.
- Host: GitHub
- URL: https://github.com/th0rgall/voc-api
- Owner: th0rgall
- License: mit
- Created: 2018-12-29T17:09:44.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2022-12-08T19:34:29.000Z (almost 3 years ago)
- Last Synced: 2025-07-09T09:50:45.276Z (3 months ago)
- Topics: browser, js, node, vocabulary
- Language: JavaScript
- Homepage:
- Size: 693 KB
- Stars: 28
- Watchers: 1
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
_**Warning: this code has not been maintained for years and has several issues.** Most of it might still work, but I recommend you only use this repository for reference._
# Vocabulary.com API
This is an unofficial Javascript API for vocabulary.com. It can be used in Firefox/Chrome web extensions or Node.js projects.
Unfortunately, the API can **not** be used in a regular web app because of CORS and other browser safety measures.
To access your user account data you need a vocabulary.com username & password.
## Getting started
To install:
```bash
npm install --save th0rgall/voc-api
```
(note: this package is not published on NPM at the moment)
Sample usage in a Node.js project:
```js
const VocAPI = require("voc-api");
const voc = new VocAPI();
// some methods extract public vocabulary.com information
voc.getDefinition("tester").then((definition) => {
console.log(definition.short);
});
// prints: "When someone is a tester, they either administer tests or they assess the safety or function of a product. You might hope for an eventual career as a bubblegum tester."
// manage user list by logging in first
voc.login("", "").then(() => {
// add the word "tester" to an existing vocabulary.com list with the name "Words to study". Include an example sentence.
voc
.addToListName(
{
word: "tester",
example: "The tester tested the untested application.",
},
"Words to study"
)
.then(() => console.log("Success!"));
});
```
For all features, check out the API reference.
## [API Reference](https://th0rgall.github.io/voc-api/VocAPI.html)
## Usage in a web extension
Make sure that your extension has host permissions for vocabulary.com, e.g. by adding `*://*.vocabulary.com/*` to your `manifest.json`.
Refer to [voc-enhancer](https://github.com/th0rgall/voc-enhancer) for a web extension example that uses this API (the API was originally built for this extension).