Data

class soundchartspy.data.AudienceData(date, likeCount, followerCount, followingCount, postCount, viewCount)[source]

Represents audience data for an artist or song.

Parameters:
  • date (datetime)

  • likeCount (int | None)

  • followerCount (int | None)

  • followingCount (int | None)

  • postCount (int | None)

  • viewCount (int | None)

date

The date of the audience data.

Type:

datetime.datetime

likeCount

The number of likes.

Type:

int

followerCount

The number of followers.

Type:

int

followingCount

The number of accounts followed.

Type:

int

postCount

The number of posts.

Type:

int

viewCount

The number of views.

Type:

int

class soundchartspy.data.ISRC(value, countryCode, countryName)[source]

Represents an International Standard Recording Code (ISRC) for a song.

Parameters:
  • value (str)

  • countryCode (str)

  • countryName (str)

value

The ISRC value, a unique identifier for the recording.

Type:

str

countryCode

The country code associated with the ISRC.

Type:

str

countryName

The name of the country associated with the ISRC.

Type:

str

class soundchartspy.data.Artist(uuid, slug, name, appUrl, imageUrl, countryCode=None, biography=None, isni=None, ipi=None, gender=None, type=None, birthDate=None, genres=None)[source]

Represents an artist’s information.

Parameters:
  • uuid (str)

  • slug (str)

  • name (str)

  • appUrl (str)

  • imageUrl (str)

  • countryCode (str | None)

  • biography (str | None)

  • isni (str | None)

  • ipi (str | None)

  • gender (str | None)

  • type (str | None)

  • birthDate (datetime | None)

  • genres (list[str] | None)

uuid

The unique identifier for the artist.

Type:

str

slug

A short string that identifies the artist in a URL-friendly format.

Type:

str

name

The name of the artist.

Type:

str

appUrl

The URL to the artist’s profile on the SoundCharts platform.

Type:

str

imageUrl

The URL to the artist’s image.

Type:

str

class soundchartspy.data.Genre(root, sub)[source]

Represents the genre of a song.

Parameters:
  • root (str)

  • sub (list[str])

root

The main or root genre of the song.

Type:

str

sub

A list of sub-genres associated with the song.

Type:

list[str]

class soundchartspy.data.Label(name, type)[source]

Represents a record label associated with a song.

Parameters:
  • name (str)

  • type (str)

name

The name of the label.

Type:

str

type

The type of label (e.g., major, indie).

Type:

str

class soundchartspy.data.Audio(danceability, energy, instrumentalness, key, liveness, loudness, mode, speechiness, tempo, timeSignature, valence)[source]

Represents the audio properties of a song.

Parameters:
  • danceability (float)

  • energy (float)

  • instrumentalness (float)

  • key (int)

  • liveness (float)

  • loudness (float)

  • mode (int)

  • speechiness (float)

  • tempo (float)

  • timeSignature (int)

  • valence (float)

danceability

A measure of how suitable the track is for dancing.

Type:

float

energy

A measure of intensity and activity.

Type:

float

instrumentalness

Predicts whether the track contains no vocals.

Type:

float

key

The key of the track.

Type:

int

liveness

A measure of the presence of a live audience in the track.

Type:

float

loudness

The overall loudness of the track in decibels.

Type:

float

mode

The modality (major or minor) of the track.

Type:

int

speechiness

A measure of the presence of spoken words.

Type:

float

tempo

The tempo of the track in beats per minute (BPM).

Type:

float

timeSignature

The time signature of the track.

Type:

int

valence

A measure of the musical positiveness of the track.

Type:

float

class soundchartspy.data.PlatformIdentifier(platformName, platformCode, identifier, url, default)[source]

Represents platform-specific identifiers for a song or artist.

Parameters:
  • platformName (str)

  • platformCode (str)

  • identifier (str)

  • url (str)

  • default (bool)

platformName

The name of the platform (e.g., Spotify, Apple Music).

Type:

str

platformCode

A short code representing the platform.

Type:

str

identifier

The unique identifier for the song or artist on the platform.

Type:

str

url

The URL to the song or artist on the platform.

Type:

str

default

Whether this is the default identifier.

Type:

bool

class soundchartspy.data.Song(uuid, name, isrc, creditName, artists, releaseDate, copyright, appUrl, imageUrl, duration, genres, composers, producers, labels, audio, explicit, languageCode)[source]

Represents a song with its metadata.

Parameters:
  • uuid (str)

  • name (str)

  • isrc (ISRC)

  • creditName (str)

  • artists (list[Artist])

  • releaseDate (str)

  • copyright (str)

  • appUrl (str)

  • imageUrl (str)

  • duration (int)

  • genres (list[Genre])

  • composers (list[str])

  • producers (list[str])

  • labels (list[Label])

  • audio (Audio)

  • explicit (bool)

  • languageCode (str)

uuid

The unique identifier for the song.

Type:

str

name

The name of the song.

Type:

str

isrc

The ISRC code for the song.

Type:

ISRC

creditName

The credited name for the song’s release.

Type:

str

artists

A list of artists associated with the song.

Type:

list[Artist]

releaseDate

The release date of the song in ISO format.

Type:

str

copyright

The copyright information for the song.

Type:

str

appUrl

The URL to the song on the SoundCharts platform.

Type:

str

imageUrl

The URL to the song’s cover image.

Type:

str

duration

The duration of the song in seconds.

Type:

int

genres

A list of genres associated with the song.

Type:

list[Genre]

composers

A list of composers of the song.

Type:

list[str]

producers

A list of producers of the song.

Type:

list[str]

labels

A list of labels associated with the song.

Type:

list[Label]

audio

The audio properties of the song.

Type:

Audio

explicit

Whether the song contains explicit content.

Type:

bool

languageCode

The language code of the song.

Type:

str

class soundchartspy.data.ArtistSongEntry(uuid: str, creditName: str, name: str, releaseDate: datetime.datetime)[source]
Parameters:
  • uuid (str)

  • creditName (str)

  • name (str)

  • releaseDate (datetime)

class soundchartspy.data.Album(name, creditName, releaseDate, type, uuid, default=None)[source]

Represents an album with its metadata.

Parameters:
  • name (str)

  • creditName (str)

  • releaseDate (datetime)

  • type (str)

  • uuid (str)

  • default (bool | None)

name

The name of the album.

Type:

str

creditName

The credited name for the album’s release.

Type:

str

releaseDate

The release date of the album.

Type:

datetime.datetime

default

Whether this album is the default release.

Type:

bool

type

The type of album (e.g. Album, Compil).

Type:

str

uuid

The unique identifier for the album.

Type:

str

class soundchartspy.data.Playlist(uuid, name, identifier, platform, countryCode, latestCrawlDate, latestTrackCount, latestSubscriberCount, type)[source]

Represents a playlist with its metadata.

Parameters:
  • uuid (str)

  • name (str)

  • identifier (str)

  • platform (str)

  • countryCode (str)

  • latestCrawlDate (datetime)

  • latestTrackCount (int)

  • latestSubscriberCount (int)

  • type (str)

uuid

The unique identifier for the playlist.

Type:

str

name

The name of the playlist.

Type:

str

identifier

The identifier of the playlist.

Type:

str

platform

The platform where the playlist is hosted.

Type:

str

countryCode

The country code associated with the playlist.

Type:

str

latestCrawlDate

The date of the latest crawl.

Type:

datetime.datetime

latestTrackCount

The latest track count of the playlist.

Type:

int

latestSubscriberCount

The latest subscriber count of the playlist.

Type:

int

type

The type of playlist (e.g., user, editorial).

Type:

str

class soundchartspy.data.PlaylistPosition(position, peakPosition, entryDate, positionDate, peakPositionDate)[source]

Represents the position of a song in a playlist.

Parameters:
  • position (int)

  • peakPosition (int)

  • entryDate (datetime)

  • positionDate (datetime)

  • peakPositionDate (datetime)

position

The position of the song in the playlist.

Type:

int

peakPosition

The peak position of the song in the playlist.

Type:

int

entryDate

The date the song entered the playlist.

Type:

datetime.datetime

positionDate

The date of the position.

Type:

datetime.datetime

peakPositionDate

The date of the peak position.

Type:

datetime.datetime

class soundchartspy.data.RadioStation(slug, name, cityName, countryCode, countryName, timeZone)[source]

Represents a radio station with its metadata.

Parameters:
  • slug (str)

  • name (str)

  • cityName (str)

  • countryCode (str)

  • countryName (str)

  • timeZone (str)

slug

The unique identifier for the radio station.

Type:

str

name

The name of the radio station.

Type:

str

cityName

The city where the radio station is located.

Type:

str

countryCode

The country code associated with the radio station.

Type:

str

countryName

The name of the country associated with the radio station.

Type:

str

timeZone

The time zone of the radio station.

Type:

str

class soundchartspy.data.ShortVideo(identifier, title, description, createdAt, externalUrl, latestAudience)[source]

Represents a short video with its metadata.

Parameters:
  • identifier (str)

  • title (str)

  • description (str)

  • createdAt (datetime)

  • externalUrl (str)

  • latestAudience (dict)