Response Types
This is an alphabetic listing of all response types.
Some fields returns a Proxy
, this is a class similar to a dict, but using dotted access. This makes LyricResult.meta.spotify
possible.
BanInfo
class BanInfo:
id: str
name: str
discriminator: str
moderator_id: str
reason: str
proof: str
is_ban_active: bool
can_be_appealed: bool
timestamp: str
appeal_reason: Optional[str]
appeal_date: Optional[str]
requested_by: str
exists: bool
raw: dict
BanSimple
class BanSimple:
id: str
reason: str
proof: str
moderator_id: str
active: bool
raw: dict
Currency
class Currency:
value: float
pretty: str
raw: dict
Image
class Image:
url: str
snowflake: str
nsfw: bool
tag: str
raw: dict
IPInfo
class IPInfo:
city: str
continent_code: str
continent_name: str
country_code: str
country_name: str
dma_code: str
latitude: float
longitude: float
postal_code: str
region: str
timezone: str
apis: Proxy
raw: dict
Location
class Location:
address: str
lat: float
lon: float
bounding_box: List[str]
type: List[str]
map: Optional[str]
raw: dict
LyricResult
class LyricResult:
artist: str
artist_id: int
album: str
album_ids: List[str]
album_year: List[str]
name: str
lyrics: str
search_str: str
album_art: str
popularity: int
singalong: List[dict]
meta: Proxy
id: str
search_score: float
url: str
raw: dict
PaginatorListing
class PaginatorListing:
count: int
page_count: int
per_page: int
page: int
on_page: int
next_page: Optional[int]
previous_page: Optional[int]
data: List[BanInfo]
raw: dict
Recommendation
class Recommendation:
name: str
youtube_id: str
youtube_link: str
youtube_title: str
youtube_thumbnail: str
spotify_id: str
spotify_name: str
spotify_link: str
spotify_album_name: str
spotify_album_art: str
spotify_album_link: str
spotify_artists: Dict[str, str]
raw: dict
RedditImage
class RedditImage:
author: str
title: str
image_url: str
source: str
subreddit: str
upvotes: int
downvotes: int
comments: int
created_at: int
nsfw: bool
awards: int
raw: dict
Tag
class Tag:
name: str
nsfw: bool
raw: dict
TagCollection
class TagCollection:
raw_models: List[dict]
models: List[Tag]
sfw_tags: List[str]
nsfw_tags: List[str]
raw: dict
WikiHowImage
class WikiHowImage:
url: str
title: str
nsfw: bool
article_url: str
raw: dict
Last updated
Was this helpful?