{"openapi":"3.1.0","info":{"title":"Apizie: music","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://zieapi.vercel.app"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/music:deezer/search":{"get":{"operationId":"music_deezer_search","summary":"Search","description":"Search tracks, albums, artists or playlists.","tags":["music"],"parameters":[{"name":"q","in":"query","required":true,"schema":{"type":"string"},"example":"daft punk"},{"name":"type","in":"query","required":false,"schema":{"type":"string","enum":["track","album","artist","playlist"],"default":"track"}},{"name":"limit","in":"query","required":false,"description":"Items per page","schema":{"type":"integer","default":25,"minimum":1,"maximum":100,"description":"Items per page"}},{"name":"page","in":"query","required":false,"description":"1-based page number","schema":{"type":"integer","default":1,"minimum":1,"maximum":100,"description":"1-based page number"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":3600,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/music:deezer/track/{id}":{"get":{"operationId":"music_deezer_track","summary":"Track","description":"One track by Deezer id.","tags":["music"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"example":"3135556"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":3600,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/music:deezer/album/{id}":{"get":{"operationId":"music_deezer_album","summary":"Album","description":"An album with its tracks.","tags":["music"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"example":"302127"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":3600,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/music:deezer/artist/{id}":{"get":{"operationId":"music_deezer_artist","summary":"Artist","description":"Artist profile with top tracks and albums.","tags":["music"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"example":"27"},{"name":"topLimit","in":"query","required":false,"description":"Items per page","schema":{"type":"integer","default":10,"minimum":1,"maximum":100,"description":"Items per page"}},{"name":"albumLimit","in":"query","required":false,"description":"Items per page","schema":{"type":"integer","default":25,"minimum":1,"maximum":100,"description":"Items per page"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":3600,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/music:apple-music/search":{"get":{"operationId":"music_apple_music_search","summary":"Search","description":"Search tracks, albums or artists.","tags":["music"],"parameters":[{"name":"q","in":"query","required":true,"schema":{"type":"string"},"example":"taylor swift"},{"name":"type","in":"query","required":false,"schema":{"type":"string","enum":["track","album","artist"],"default":"track"}},{"name":"limit","in":"query","required":false,"description":"Items per page","schema":{"type":"integer","default":20,"minimum":1,"maximum":200,"description":"Items per page"}},{"name":"page","in":"query","required":false,"description":"1-based page number","schema":{"type":"integer","default":1,"minimum":1,"maximum":50,"description":"1-based page number"}},{"name":"country","in":"query","required":false,"description":"Two-letter storefront country code","schema":{"type":"string","default":"us","description":"Two-letter storefront country code"},"example":"us"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":3600,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/music:apple-music/track/{id}":{"get":{"operationId":"music_apple_music_track","summary":"Track","description":"One track by iTunes track id.","tags":["music"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"example":"1440857781"},{"name":"country","in":"query","required":false,"description":"Two-letter storefront country code","schema":{"type":"string","default":"us","description":"Two-letter storefront country code"},"example":"us"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":3600,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/music:apple-music/album/{id}":{"get":{"operationId":"music_apple_music_album","summary":"Album","description":"An album with its track list.","tags":["music"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"example":"1440857777"},{"name":"country","in":"query","required":false,"description":"Two-letter storefront country code","schema":{"type":"string","default":"us","description":"Two-letter storefront country code"},"example":"us"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":3600,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/music:apple-music/artist/{id}":{"get":{"operationId":"music_apple_music_artist","summary":"Artist","description":"An artist with their albums.","tags":["music"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"example":"5468295"},{"name":"limit","in":"query","required":false,"description":"Items per page","schema":{"type":"integer","default":25,"minimum":1,"maximum":200,"description":"Items per page"}},{"name":"country","in":"query","required":false,"description":"Two-letter storefront country code","schema":{"type":"string","default":"us","description":"Two-letter storefront country code"},"example":"us"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":3600,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/music:itunes/search":{"get":{"operationId":"music_itunes_search","summary":"Search","description":"Search music in the iTunes Store.","tags":["music"],"parameters":[{"name":"query","in":"query","required":true,"schema":{"type":"string"},"example":"daft punk"},{"name":"entity","in":"query","required":false,"schema":{"type":"string","enum":["song","album","musicArtist"],"default":"song"}},{"name":"limit","in":"query","required":false,"description":"Items per page","schema":{"type":"integer","default":20,"minimum":1,"maximum":200,"description":"Items per page"}},{"name":"country","in":"query","required":false,"description":"Two-letter storefront country code","schema":{"type":"string","default":"us","description":"Two-letter storefront country code"},"example":"us"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":3600,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/music:musicbrainz/search":{"get":{"operationId":"music_musicbrainz_search","summary":"Search","description":"Lucene-style search across recordings, artists or releases.","tags":["music"],"parameters":[{"name":"query","in":"query","required":true,"schema":{"type":"string"},"example":"bohemian rhapsody"},{"name":"entity","in":"query","required":false,"schema":{"type":"string","enum":["recording","artist","release"],"default":"recording"}},{"name":"limit","in":"query","required":false,"description":"Items per page","schema":{"type":"integer","default":25,"minimum":1,"maximum":100,"description":"Items per page"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","default":0,"minimum":0}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":3600,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/music:musicbrainz/lookup":{"get":{"operationId":"music_musicbrainz_lookup","summary":"Lookup","description":"Fetch one recording, artist or release by MBID.","tags":["music"],"parameters":[{"name":"mbid","in":"query","required":true,"schema":{"type":"string"},"example":"b10bbbfc-cf9e-42e0-be17-e2c3e1d2600d"},{"name":"entity","in":"query","required":false,"schema":{"type":"string","enum":["recording","artist","release"],"default":"artist"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":86400,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/music:radio-browser/search":{"get":{"operationId":"music_radio_browser_search","summary":"Search stations","description":"By name, country or tag.","tags":["music"],"parameters":[{"name":"name","in":"query","required":false,"schema":{"type":"string"},"example":"jazz"},{"name":"countryCode","in":"query","required":false,"schema":{"type":"string"},"example":"FR"},{"name":"tag","in":"query","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"description":"Number of results","schema":{"type":"integer","default":20,"minimum":1,"maximum":500,"description":"Number of results"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":3600,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/music:radio-browser/top":{"get":{"operationId":"music_radio_browser_top","summary":"Most played","description":"Top stations by clicks.","tags":["music"],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of results","schema":{"type":"integer","default":20,"minimum":1,"maximum":500,"description":"Number of results"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":3600,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/music:cover-art-archive/release":{"get":{"operationId":"music_cover_art_archive_release","summary":"Release art","description":"Front, back and other images for a release MBID.","tags":["music"],"parameters":[{"name":"mbid","in":"query","required":true,"schema":{"type":"string"},"example":"76df3287-6cda-33eb-8e9a-044b5e15ffdd"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":604800,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}