EnterpriseAPI¶

class minim.api.musixmatch.EnterpriseAPI(client: APIClient, /)[source]¶

Bases: MusixmatchResourceAPI

Enterprise API endpoints for the Musixmatch Lyrics API.

Important

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

Parameters:

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

Methods

`get_catalog_feeds`	Enterprise > tracks.dump.get: Get Musixmatch resource information for the latest catalog feeds.
`get_languages`	Enterprise > languages.get: Get languages supported by Musixmatch.
`get_track_catalog_record`	Enterprise > track.dump.get: Get the Musixmatch catalog record for a track.
`get_track_lyrics_analysis`	Enterprise > track.lyricslens.get: Get the Lyric Lens analysis of a track's lyrics.
`screen_track_lyrics`	Enterprise > track.lyrics.fingerprint.post: Screen text against the Musixmatch catalog to identify tracks with matching lyrics.
`set_work_validity`	Enterprise > work.validity.post: Set the validity end date for a musical work on Musixmatch.
`submit_work`	Enterprise > work.post: Submit details for a musical work to Musixmatch.

get_catalog_feeds() → dict[str, Any][source]¶

Enterprise > tracks.dump.get: Get Musixmatch resource information for the latest catalog feeds.

Subscription

Required

Musixmatch Enterprise plan: Access extended music metadata, advanced search, translations, song structure, and lyric analysis. Learn more.

Returns:

catalog_feedsdict[str, Any]

Musixmatch metadata for the catalog feeds.

Sample reponse

{
  "message": {
    "body": [
      {
        "created": <str>,
        "download_url": <str>,
        "full": <bool>,
        "id": <int>
      }
    ],
    "header": {
      "execute_time": <float>,
      "status_code": <int>
    }
  }
}

get_languages(*, include_romanization: bool | None = None) → dict[str, Any][source]¶

Enterprise > languages.get: Get languages supported by Musixmatch.

Subscription

Required

Musixmatch Enterprise plan: Access extended music metadata, advanced search, translations, song structure, and lyric analysis. Learn more.

Parameters:

include_romanizationbool; keyword-only; optional

Whether to include romanization information for romanized languages.

API default: False.

Returns:

languagesdict[str, Any]

Languages supported by Musixmatch.

Sample response

{
  "message": {
    "body": {
      "language_list": [
        {
          "language": {
            "has_romanization": <int>,
            "iso_code_romanization": <str>,
            "language_iso_code_1": <str>,
            "language_iso_code_3": <str>,
            "language_name": <str>
          }
        }
      ]
    },
    "header": {
      "available": <int>,
      "execute_time": <float>,
      "status_code": <int>
    }
  }
}

get_track_catalog_record(isrc: str) → dict[str, Any][source]¶

Enterprise > track.dump.get: Get the Musixmatch catalog record for a track.

Subscription

Required

Musixmatch Enterprise plan: Access extended music metadata, advanced search, translations, song structure, and lyric analysis. Learn more.

Parameters:

isrcstr

ISRC of the track.

Example: "USUM70905526".

Returns:

trackdict[str, Any]

Musixmatch catalog record for the track.

Sample reponse

{
  "message": {
    "body": [
      {
        "artist": <str>,
        "commontrack_id": <int>,
        "instrumental": <bool>,
        "isrcs": <list[str]>,
        "language_iso_code_1": <str>,
        "last_updated": <str>,
        "lyrics": <str>,
        "lyrics_id": <int>,
        "lyrics_tracking_url": <str>,
        "restrictions": {
          "allow": <list[str]>,
          "blocked": <list[str]>
        },
        "snippet": <str>,
        "subtitles": [
          {
            "body": <str>,
            "id": <int>,
            "length": <int>,
            "tracking_url": <str>,
          }
        ],
        "title": <str>,
        "writers": [
          {
            "id": <int>,
            "name": <str>
          }
        ]
      }
    ],
    "header": {
      "execute_time": <float>,
      "status_code": <int>
    }
  }
}

Enterprise > track.lyricslens.get: Get the Lyric Lens analysis of a track’s lyrics.

Subscription

Required

Musixmatch Enterprise plan: Access extended music metadata, advanced search, translations, song structure, and lyric analysis. Learn more.

See also

Musixmatch Lyrics API documentation – Lyric Lens introduction and metadata overview.

Parameters:

track_idint or str; keyword-only; optional

Musixmatch ID of the track.

Examples: 84584600, "359206419".

common_track_idint or str; keyword-only; optional

Musixmatch common ID of the track.

Examples: 5920049, "40728258".

isrcstr; keyword-only; optional

ISRC of the track.

Example: "USUM70905526".

Returns:

analysisdict[str, Any]

Lyric Lens analysis of the track’s lyrics.

Sample response

{
  "message": {
    "body": {
      "lens": {
        "entities": {
          "entity_list": [
            {
              "categories": <list[str]>,
              "entity_name": <str>,
              "matches": [
                {
                  "end_char": <int>,
                  "matched_text": <str>,
                  "start_char": <int>
                }
              ],
              "model_metadata": {
                "description": <str>,
                "type": <str>
              },
              "occurrencies": <int>,
              "wikidata": {
                "description": <str>,
                "id": <str>,
                "rank": <int>,
                "thumbnail": <str>,
                "types": <list[str]>
              },
              "wikipedia": [
                {
                  "language": <str>,
                  "url": <str>
                }
              ]
            }
          ]
        },
        "language_detection": {
          "languages": [
            {
              "is_romanized": <bool>,
              "language_iso_code_1": <str>,
              "language_iso_code_3": <str>,
              "language_name": <str>,
              "percentage": <int>
            }
          ]
        },
        "meaning": {
          "description": <str>,
          "explanation": <str>
        },
        "moderation": {
          "categories": [
            {
              "category": <str>,
              "is_present": <bool>,
              "score": <float>
            }
          ],
          "description": <str>,
          "needs_moderation": <bool>
        },
        "moods": {
          "description": <str>,
          "main_moods": <list[str]>
        },
        "rating": {
          "audience":<str>,
          "description": <str>,
          "descriptor": <str>,
        },
        "religion": {
          "description": <str>,
          "has_references": <bool>
        },
        "themes": {
          "description": <str>,
          "main_themes": [
            {
              "quotes": <list[str]>,
              "theme": <str>
            }
          ]
        }
      }
    },
    "header": {
      "execute_time": <float>,
      "status_code": <int>
    }
  }
}

screen_track_lyrics(text: str, /, *, max_candidates: int | None = None, limit: int | None = None) → dict[str, Any][source]¶

Enterprise > track.lyrics.fingerprint.post: Screen text against the Musixmatch catalog to identify tracks with matching lyrics.

Subscription

Required

Musixmatch Enterprise plan: Access extended music metadata, advanced search, translations, song structure, and lyric analysis. Learn more.

Parameters:

textstr; positional-only

Text to screen for potential lyrical content.

max_candidatesint; keyword-only; optional

Maximum number of track candidates.

Valid range: 1 to 20.

limitint; keyword-only; optional

Maximum number of tracks to return.

Valid range: 1 to max_candidates.

Returns:

tracksdict[str, Any]

Musixmatch metadata for the identified tracks.

Sample response

{
  "message": {
    "body": {
      "track_list": [
        {
          "similarity": <float>,
          "track": {
            "album_coverart_100x100": <str>,
            "album_coverart_350x350": <str>,
            "album_coverart_500x500": <str>,
            "album_coverart_800x800": <str>,
            "album_id": <int>,
            "album_name": <str>,
            "artist_id": <int>,
            "artist_name": <str>,
            "commontrack_id": <int>,
            "commontrack_isrcs": <list[list[str]]>,
            "explicit": <int>,
            "has_lyrics": <int>,
            "has_richsync": <int>,
            "has_subtitles": <int>,
            "instrumental": <int>,
            "num_favourite": <int>,
            "primary_genres": {
              "music_genre_list": [
                {
                  "music_genre": {
                    "music_genre_id": <int>,
                    "music_genre_name": <str>,
                    "music_genre_name_extended": <str>,
                    "music_genre_parent_id": <int>,
                    "music_genre_vanity": <str>
                  }
                }
              ]
            },
            "restricted": <int>,
            "track_edit_url": <str>,
            "track_id": <int>,
            "track_isrc": <str>,
            "track_length": <int>,
            "track_name": <str>,
            "track_rating": <int>,
            "track_share_url": <str>,
            "track_spotify_id": <str>,
            "updated_time": <str>
          }
        }
      ]
    },
    "header": {
      "execute_time": <float>,
      "status_code": <int>
    }
  }
}

set_work_validity(work_identifier: str, /, valid_until: str | datetime) → None[source]¶

Enterprise > work.validity.post: Set the validity end date for a musical work on Musixmatch.

Subscription

Required

Musixmatch Enterprise plan: Access extended music metadata, advanced search, translations, song structure, and lyric analysis. Learn more.

Parameters:

work_identifierstr; positional-only

Unique identifier of the musical work.

Valid length: 1 to 40.

Example: “00001100196005”.

valid_untilstr or datetime.datetime

Validity end date, in YYYY-MM-DD format.

Returns:

statusdict[str, Any]

Whether the work’s validity was updated successfully.

Sample response

{
  "message": {
    "body": <str>,
    "header": {
      "execute_time": <float>,
      "status_code": <int>
    }
  }
}

submit_work(work_data: dict[str, Any], /) → dict[str, Any][source]¶

Enterprise > work.post: Submit details for a musical work to Musixmatch.

Subscription

Required

Musixmatch Enterprise plan: Access extended music metadata, advanced search, translations, song structure, and lyric analysis. Learn more.

Parameters:

work_datadict[str, Any]; positional-only: Details for a musical work.

See also

Musixmatch Lyrics API documentation – Data schema.

Returns:

workdict[str, Any]

Musixmatch catalog record for the newly submitted musical work.

Sample response

{
  "message": {
    "body": {
      "alternate_titles": [
        {
          "title": <str>
        }
      ],
      "collections": {
        <str>: {
          "territories": [
            {
              "code": <str>,
              "countries": <list[str]>,
              "mech_share": <int>,
              "perf_share": <int>,
              "publisher": None,
              "sync_share": <int>
            }
          ],
          "validity_begin": <str>,
          "validity_end": None
        }
      },
      "identifier": <str>,
      "is_disabled": <int>,
      "isrc": <list[str]>,
      "iswc": <str>,
      "last_trasmission": <str>,
      "owners": {
        "publisher": [
          {
            "controlled": <str>,
            "id": <int>,
            "identifier": <str>,
            "ipi": <str>,
            "mech_ownership_share": <int>,
            "mech_society": None,
            "name": <str>,
            "perf_ownership_share": <int>,
            "perf_society": None,
            "role": None,
            "sync_ownership_share": <int>,
            "sync_society": None,
            "type": "publisher",
            "validity_begin": <str>
          }
        ],
        "writer": [
          {
            "controlled": <str>,
            "id": <int>,
            "identifier": <str>,
            "ipi": <str>,
            "mech_ownership_share": <int>,
            "mech_society": None,
            "name": <str>,
            "perf_ownership_share": <int>,
            "perf_society": None,
            "role": None,
            "sync_ownership_share": <int>,
            "sync_society": None,
            "type": "writer",
            "validity_begin": <str>
          }
        ]
      },
      "ownership": [],
      "performers": [],
      "publisher_short_name": <str>,
      "source": {
        "affiliation": None,
        "control": <bool>,
        "created": <str>,
        "credits_priority": <str>,
        "description": <str>,
        "id": <int>,
        "last_updated": <str>,
        "report": <str>,
        "sender_id": <str>,
        "sender_name": <str>,
        "short_name": <str>,
        "type_of_right": <str>,
        "validity_begin": <str>,
        "validity_end": None
      },
      "submissions": [
        {
          "creation_date": <str>,
          "disabled": <str>,
          "filename": <str>,
          "id": <int>,
          "source": <int>,
          "transmission_date": <str>
        }
      ],
      "tablespace": <str>,
      "title": <str>,
      "type_of_right": <str>,
      "validity_begin": None,
      "validity_end": <str>,
      "wgid": <str>,
      "work_id": <int>
    },
    "header": {
      "execute_time": <float>,
      "status_code": <int>
    }
  }
}