ArtworksAPI¶

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

Bases: TIDALResourceAPI

Artworks 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_artwork_owners`	Artworks > Get Artwork's Owners: Get TIDAL profile information for owners of an artwork resource.
`get_artworks`	Artworks > Get Single Artwork: Get TIDAL catalog information for an artwork․ Artworks > Get Multiple Artworks: Get TIDAL catalog information for multiple artworks.

get_artwork_owners(artwork_id: str, /, *, include_metadata: bool = False, cursor: str | None = None) → dict[str, Any][source]¶

Artworks > Get Artwork’s Owners: Get TIDAL profile information for owners of an artwork resource.

User authentication

Optional

User authentication: Access information for a resource’s owners.

Parameters:

artwork_idstr; positional-only

TIDAL ID of the artwork.

Example: "2xpmpI1s9DzeAPMlmNh9kM".

include_metadatabool; keyword-only; default: False

Whether to include metadata for the owners.

cursorstr; keyword-only; optional

Cursor for fetching the next page of results.

Example: "3nI1Esi".

Returns:

ownersdict[str, Any]

Page of TIDAL profile information for the artwork resource’s owners.

Sample response

{
  "data": [],
  "included": [],
  "links": {
    "self": <str>
  }
}

get_artworks(artwork_ids: str | Collection[str], /, country_code: str | None = None, *, expand: str | Collection[str] | None = None) → dict[str, Any][source]¶

Artworks > Get Single Artwork: Get TIDAL catalog information for an artwork․ Artworks > Get Multiple Artworks: Get TIDAL catalog information for multiple artworks.

User authentication

Optional

User authentication: Access information for a resource’s owners.

Parameters:

artwork_idsstr or Collection[str]; positional-only

TIDAL IDs of the artworks.

Examples: "2xpmpI1s9DzeAPMlmNh9kM", ["2xpmpI1s9DzeAPMlmNh9kM", "iWOu0yW0IPH0H5O42lAP"].

country_codestr; keyword-only; optional

ISO 3166-1 alpha-2 country code.

Example: "US".

expandstr or Collection[str]; keyword-only; optional

Related resources to include metadata for in the response.

Valid value: "owners".

Examples: "owners", ["owners"].

Returns:

artworksdict[str, Any]

TIDAL metadata for the artworks.

Sample responses

Single artwork

{
  "data": {
    "attributes": {
      "files": [
        {
          "href": <str>,
          "meta": {
            "height": <int>,
            "width": <int>
          }
        }
      ],
      "mediaType": "IMAGE"
    },
    "id": <str>,
    "relationships": {
      "owners": {
        "data": [],
        "links": {
          "self": <str>
        }
      }
    },
    "type": "artworks"
  },
  "included": [],
  "links": {
    "self": <str>
  }
}

Multiple artworks

{
  "data": [
    {
      "attributes": {
        "files": [
          {
            "href": <str>,
            "meta": {
              "height": <int>,
              "width": <int>
            }
          }
        ],
        "mediaType": "IMAGE"
      },
      "id": <str>,
      "relationships": {
        "owners": {
          "data": [],
          "links": {
            "self": <str>
          }
        }
      },
      "type": "artworks"
    }
  ],
  "included": [],
  "links": {
    "self": <str>
  }
}