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.0.tar.gz (32.2 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.0-py3-none-any.whl (41.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: soundcharts-0.2.0.tar.gz
  • Upload date:
  • Size: 32.2 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.0.tar.gz
Algorithm Hash digest
SHA256 8784d152d6602e6d93e3e54b50f667d8295b048b10dd993da65af4fe0463e825
MD5 1bd5bcaae53e8c7144a45c5590bbf086
BLAKE2b-256 25d9edf58f1431477c8ca4574e64bc0c0f6dbec6960474ea17b194565668fb3a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: soundcharts-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 41.7 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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 de933e3f18a64786bcbd2abfb627a12a07e89815d9b2ef1a649a6703cf395d06
MD5 5e995dd442d43aee6fed2f4edc538fbb
BLAKE2b-256 833d2fa56b238c469c28a538fff90aa6ee0a31646dd1b7ee2f3ef6b808d27868

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