Skip to main content

A Python package for interacting with the Soundcharts API.

Project description

Soundcharts Module

A Python package for interacting with the Soundcharts API.

API Documentation

Full documentation of the API is available here: Soundcharts API Documentation

You will need a Soundcharts API subscription to use this package.

Features

  • Easily pull data from Soundcharts' API.
  • Every endpoint from the documentation is available as a Python function.
    • For example, the "get audience" endpoint in the "playlist" category is accessible via playlist.get_audience().
  • Automatically loops through endpoints to get around API limitations, such as the limit of 100 items per request.
  • Configurable error handling.

Installation

pip install soundcharts

Usage

from soundcharts.client import SoundchartsClient

sc = SoundchartsClient(app_id="your_app_id", api_key="your_api_key")

# Example with Billie Eilish's UUID
billie_metadata = sc.artist.get_artist_metadata("11e81bcc-9c1c-ce38-b96b-a0369fe50396")
print(billie_metadata)

Error handling

You can set the severity of the console logs, file logs, and exceptions:

from soundcharts.client import SoundchartsClient
import logging

sc = SoundchartsClient( app_id="your_app_id",
                        api_key="your_api_key",
                        console_log_level=logging.INFO,
                        file_log_level=logging.WARNING,
                        exception_log_level=logging.ERROR)

Setting the level of the console or file log to logging.DEBUG will log each request send to the API.

Parallel processing

You can specify the number of requests to run in parallel. It's especially useful when looping through a lot of calls, like in this case fetching 3 months of Billie Eilish's radio airplay (about 3,000 calls):

from soundcharts.client import SoundchartsClient
import logging

sc = SoundchartsClient( app_id="your_app_id",
                        api_key="your_api_key",
                        parallel_requests=10)

billie = "11e81bcc-9c1c-ce38-b96b-a0369fe50396"

response = sc.artist.get_radio_spins(
    billie, start_date="2025-01-01", end_date="2025-03-31", limit=None
)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

soundcharts-0.2.3.tar.gz (32.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

soundcharts-0.2.3-py3-none-any.whl (41.9 kB view details)

Uploaded Python 3

File details

Details for the file soundcharts-0.2.3.tar.gz.

File metadata

  • Download URL: soundcharts-0.2.3.tar.gz
  • Upload date:
  • Size: 32.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.9

File hashes

Hashes for soundcharts-0.2.3.tar.gz
Algorithm Hash digest
SHA256 701af551a59ca8ba80ad1d8a3e92803c74b63397a4efed6bbe3415b6bfc09a6d
MD5 80a0af479d5fb6682b7b7085c101d7ca
BLAKE2b-256 8c66b0327a6af1d07b3d9c39810c2cf4297f8dc8dd1ea11de6c96eb9cc4aa249

See more details on using hashes here.

File details

Details for the file soundcharts-0.2.3-py3-none-any.whl.

File metadata

  • Download URL: soundcharts-0.2.3-py3-none-any.whl
  • Upload date:
  • Size: 41.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.9

File hashes

Hashes for soundcharts-0.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 6495aa49a19fd7a323df2924b927db29ec512b75b3af39b828316290f6a85b64
MD5 8636f6b10d9ccb07f3a186639e34d719
BLAKE2b-256 dae09eb69eddaeddf77c1352263f2442b91eb44b973a8ef1070da41b010d6c01

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page