get_annotation: Retrieve metadata for an annotation

View source: R/annotations.R

get_annotationR Documentation

Retrieve metadata for an annotation

Description

The Genius API lets you return data for a specific annotation, given an annotation ID. get_annotation returns this data in full.

Usage

get_annotation(annotation_id, access_token = genius_token())

Arguments

annotation_id

ID of the annotation

access_token

Genius' client access token, defaults to genius_token

Details

A Genius annotation is a piece of content about a part of a document. The document may be a song (hosted on Genius) or a web page (hosted anywhere). The part of a document that an annotation is attached to is called a referent.

Value

a genius_annotation object that contains the extracted content from the request, the original JSON response object and the request path.

See Also

Other annotation: get_referent()

Examples

## Not run: 
get_annotation(annotation_id = 16511101)

## End(Not run)

geniusr documentation built on Sept. 4, 2022, 1:07 a.m.