A Hypothes.is API client for browser and server-side
$ npm install --save hypothesis-api-clientconst HypothesisClient = require('hypothesis-api-client');
let hypothesisClient = new HypothesisClient(TOKEN);
hypothesisClient.searchAnnotations({url: 'https://hypothes.is'}, (err, annotations) => {
console.log(annotations)
})The client currently supports the following methods. JSDoc can be found here.
- createNewAnnotation(annotation, callback)
- createNewAnnotations(annotationsArray, callback)
- fetchAnnotation(id, callback)
- updateAnnotation(id, annotation, callback)
- deleteAnnotation(id, callback)
- deleteAnnotations(annotationsArray, callback)
- searchAnnotations(data, callback): Search up to 10K bulk annotations in parallel (faster). Maybe it will be deprecated.
- searchBunchAnnotations(data, offset, callback): Search a bunch (up to 200) of annotations giving an offset (up to 9.8K)
- searchAnnotationsSequential: Search over 10K bulk annotations sequentially (slower).
- getListOfGroups(data, callback)
- removeAMemberFromAGroup(groupId, user, callback)
- createHypothesisGroup(data, callback)
- getUserProfile(callback)
MIT © Haritz Medina