ProvidersAPI¶

class minim.api.tidal.ProvidersAPI(client: APIClient, /)[source]¶

Bases: TIDALResourceAPI

Providers API endpoints for the TIDAL API.

Important

This class is managed by TIDALAPIClient and should not be instantiated directly.

Parameters:

clientminim.api._shared.APIClient: API client instance used to make HTTP requests.

Methods

get_providers

Providers > Get Single Provider: Get TIDAL catalog information for a provider․ Providers > Get Multiple Providers: Get TIDAL catalog information for multiple providers.

get_providers(provider_ids: int | str | Collection[int | str], /) → dict[str, Any][source]¶

Providers > Get Single Provider: Get TIDAL catalog information for a provider․ Providers > Get Multiple Providers: Get TIDAL catalog information for multiple providers.

Parameters:

provider_idsint, str, or Collection[int | str]; positional-only

TIDAL IDs of the providers.

Examples: 771, "772", [771, "772"].

Returns:

providersdict[str, Any]

TIDAL metadata for the providers.

Sample responses

Single provider

{
  "data": {
    "attributes": {
      "name": <str>
    },
    "id": <str>,
    "type": "providers"
  },
  "links": {
    "self": <str>
  }
}

Multiple providers

{
  "data": [
    {
      "attributes": {
        "name": <str>
      },
      "id": <str>,
      "type": "providers"
    }
  ],
  "links": {
    "self": <str>
  }
}