/v1/apple-music/search
Search
Search Apple Music
| Credit cost | Default: 1 credit How charges are determinedCost is decided per call, not per endpoint: the same operation can cost different amounts depending on what it returns. A call that fails costs 0 credits. A result served from cache costs 0 credits. `default` is the cost when no rule matches. Rules are evaluated in order and the first whose conditions all hold wins. A `when` condition is one of: `param` (the request parameter is true), `outcome` (the classifier's outcome), `empty` / `nonEmpty` (a response field is empty and absent, or a non-empty array or string), `flag` (a response field is exactly true). A cost of `{ perStartedMinute: n, of: [fields] }` is n x max(1, ceil(seconds / 60)), so even a short result bills at least one minute. |
|---|---|
| Cache support | Not specified in the published contract. |
| Pagination | No explicit pagination metadata in the published contract. Consult the parameters and response fields below. |
Parameters
| Name | Location / required | Schema |
|---|---|---|
querySearch query | query / required |
|
typeResult type to return. Use all, song, album, artist, playlist, station, music_video, or radio_episode. | query / optional |
|
Request examples
Replace placeholder values and supply your own API key. For operations with a request body, populate the body using the schema above.
cURL
curl --request GET 'https://api.fetchproof.com/v1/apple-music/search?query=YOUR_QUERY' \
--header 'x-api-key: YOUR_API_KEY'JavaScript
const response = await fetch("https://api.fetchproof.com/v1/apple-music/search?query=YOUR_QUERY", {
method: 'GET',
headers: { 'x-api-key': process.env.FETCHPROOF_API_KEY }
});
console.log(await response.text());Python
import os
import requests
response = requests.get("https://api.fetchproof.com/v1/apple-music/search?query=YOUR_QUERY",
headers={"x-api-key": os.environ["FETCHPROOF_API_KEY"]})
print(response.text)Responses
200Success. Envelope: success / credits_remaining / credits_charged.
application/json
object
successrequired
boolean
credits_remainingrequired
integer
credits_chargedrequired
integer
dataoptional
object
queryrequired
string
typerequired
string
resultsrequired
array
Array items
object
idrequired
string
kindrequired
string
titlerequired
string
artist_namerequired
string
urlrequired
string
duration_msrequired
integer
queryoptional
string
typeoptional
string
sectionsoptional
array
Array items
object
idrequired
string
titlerequired
string
itemsrequired
array
Array items
object
idrequired
string
kindrequired
string
titlerequired
string
subtitlerequired
string
albumrequired
null
urlrequired
string
artworkrequired
object
urlrequired
string
widthrequired
integer
heightrequired
integer
bgColorrequired
string
textColor1required
string
textColor2required
string
textColor3required
string
textColor4required
string
duration_msrequired
null
track_numberrequired
null
disc_numberrequired
null
artist_namerequired
string
explicitrequired
boolean
preview_urlrequired
null
track_countrequired
integer