Search for Library Resources
Search the library by using a query.
URL
GET https://api.music.apple.com/v1/me/library/searchQuery Parameters
| Name | Type | Description |
|---|---|---|
term Required | string | The text for the search, with a plus sign ( |
types Required | [string] | The list of the types of resources to include in the results. The possible values are |
limit Optional | integer | The number of objects or number of objects in the specified relationship returned. |
offset Optional | string | The next page or group of objects to fetch. |
l Optional | string | The localization to use, specified by a language tag. The possible values are in the |
Response Codes
| Status | Reason | Type | Description |
|---|---|---|---|
| 200 | OK Content-Type: application/json | LibrarySearchResponse | The request was successful. |
| 401 | Unauthorized Content-Type: application/json | UnauthorizedResponse | A response indicating an incorrect |
| 403 | Forbidden Content-Type: application/json | ForbiddenResponse | A response indicating invalid or insufficient authentication. |
| 500 | Internal Server Error Content-Type: application/json | ErrorsResponse | A response indicating an error occurred on the server. |
Discussion
If successful, the HTTP status code is 200 (OK) and the results contains a map of search results. If unsuccessful, the HTTP status code indicates the error and the details are in the errors array. For more information, see Handling Requests and Responses.
This endpoint requires a music user token. For more information, see User Authentication for MusicKit.