itunes-web-api
Advanced tools
Comparing version 1.0.7 to 1.0.8
{ | ||
"name": "itunes-web-api", | ||
"version": "1.0.7", | ||
"version": "1.0.8", | ||
"description": "iTunes WEB API Scrapper. Get iTunes track/trackvideo/artist/album/movie/app/book/voicebook/podcast infos with their names.", | ||
"main": "index.js", | ||
"main": "dist", | ||
"keywords": [ | ||
@@ -15,5 +15,8 @@ "itunes", | ||
"scripts": { | ||
"test": "echo \"Error: no test specified\" && exit 1" | ||
"format": "prettier --write .", | ||
"start": "node dist/index.js", | ||
"dev": "nodemon index.ts", | ||
"build": "tsc" | ||
}, | ||
"author": "shynox, sroxynartz, theark", | ||
"author": "shynox", | ||
"license": "MIT", | ||
@@ -26,3 +29,6 @@ "repository": { | ||
"node-fetch": "^2.6.1" | ||
}, | ||
"devDependencies": { | ||
"@types/node-fetch": "^2.5.12" | ||
} | ||
} |
167
README.md
@@ -1,4 +0,2 @@ | ||
## WELCOME TO ITUNES WEB API! | ||
## WARNING!! (IF U ARE USING VER 1.0.5 or LOWER PLEASE UPDATE YOUR MODULE) | ||
### NOTE: OPTIONS ARE OPTIONAL - NOT NECESSARY | ||
## WELCOME TO ITUNES WEB API! | ||
@@ -9,118 +7,83 @@ NOTE: | ||
### EXAMPLE FOR USAGE | ||
````js | ||
//##### USAGE FOR TRACK INFO #####\\ | ||
const itunes = require('itunes-web-api'); | ||
let data = await itunes.track(songName, {limit: Number, lang: 'lang-code', country: 'country-code'}) | ||
console.log(data)//track infos in resulst array | ||
## Usage | ||
ES5 Syntax | ||
//##### USAGE FOR TRACK-VIDEO INFO #####\\ | ||
const itunes = require('itunes-web-api'); | ||
let data = await itunes.trackVideo(songName, {limit: Number, lang: 'lang-code', country: 'country-code'}) | ||
console.log(data) //album infos in resulst array | ||
```js | ||
const { getSong } = require("itunes-web-api"); | ||
song("Lil Nas X, Jack Harlow - INDUSTRY BABY ", { | ||
limit: 1, | ||
language: "en", | ||
country: "US", | ||
}).then((result) => console.log(result.result)); // -> { song object } | ||
``` | ||
//##### USAGE FOR ARTIST INFO #####\\ | ||
const itunes = require('itunes-web-api'); | ||
let data = await itunes.artist(artistName, {limit: Number, lang: 'lang-code', country: 'country-code'}) | ||
console.log(data) //album infos in resulst array | ||
ES6 Syntax | ||
```js | ||
import { getSong } from "itunes-web-api"; | ||
//##### USAGE FOR ALBUM INFO #####\\ | ||
const itunes = require('itunes-web-api'); | ||
let data = await itunes.album(albumName, {limit: Number, lang: 'lang-code', country: 'country-code'}) | ||
console.log(data) //album infos in resulst array | ||
const main = async () => { | ||
await getSong("Lil Nas X, Jack Harlow - INDUSTRY BABY ", { | ||
limit: 1, | ||
language: "en", | ||
country: "US", | ||
}); | ||
console.log(result.result); // -> { song object } | ||
}; | ||
//##### USAGE FOR APP INFO #####\\ | ||
const itunes = require('itunes-web-api'); | ||
let data = await itunes.app(songName, {limit: Number, lang: 'lang-code', country: 'country-code'}) | ||
console.log(data)//app infos in resulst array | ||
main(); | ||
``` | ||
##### Example Output | ||
//##### USAGE FOR MOVIE INFO #####\\ | ||
const itunes = require('itunes-web-api'); | ||
let data = await itunes.movie(movieName, {limit: Number, lang: 'lang-code', country: 'country-code'}) | ||
console.log(data)//movie infos in resulst array | ||
//##### USAGE FOR BOOK INFO #####\\ | ||
const itunes = require('itunes-web-api'); | ||
let data = await itunes.book(bookName, {limit: Number, lang: 'lang-code', country: 'country-code'}) | ||
console.log(data)//book infos in resulst array | ||
//##### USAGE FOR VOICE-BOOK INFO #####\\ | ||
const itunes = require('itunes-web-api'); | ||
let data = await itunes.voicebook(voicebookName, {limit: Number, lang: 'lang-code', country: 'country-code'}) | ||
console.log(data)//voice-book infos in resulst array | ||
//##### USAGE FOR PODCAST INFO #####\\ | ||
const itunes = require('itunes-web-api'); | ||
let data = await itunes.voicebook(voicebookName, {limit: Number, lang: 'lang-code', country: 'country-code'}) | ||
console.log(data)//podcast infos in resulst array | ||
//##### USAGE FOR ALL INFO #####\\ | ||
const itunes = require('itunes-web-api'); | ||
let data = await itunes.searchAll(searchString, entity, attribute, {limit: Number, lang: 'lang-code', country: 'country-code'}) | ||
//entity examples === movie, album, allArtist, podcast, musicVideo, mix, audiobook, tvSeason, allTrack | ||
//attribute examples === actorTerm, languageTerm, allArtistTerm, tvEpisodeTerm, shortFilmTerm, directorTerm, releaseYearTerm, titleTerm, featureFilmTerm, ratingIndex, keywordsTerm, descriptionTerm, authorTerm, genreIndex, mixTerm, allTrackTerm, artistTerm, composerTerm, tvSeasonTerm, producerTerm, ratingTerm, songTerm, movieArtistTerm, showTerm, movieTerm, albumTerm | ||
console.log(data)//string infos in resulst array | ||
```` | ||
##### EXAMPLE OUTPUT FOR TRACK | ||
```js | ||
const itunes = require('itunes-web-api'); | ||
let data = await itunes.track(songName, {limit: Number, lang: 'lang-code', country: 'country-code'}) | ||
console.log(data) | ||
/* data OUTPUT | ||
```json | ||
{ | ||
resultCount: 1, | ||
results: [ | ||
"resultCount": 1, | ||
"results": [ | ||
{ | ||
wrapperType: 'track', | ||
kind: 'song', | ||
artistId: 1400730578, | ||
collectionId: 1468166325, | ||
trackId: 1468166457, | ||
artistName: 'Lil Nas X & Cardi B', | ||
collectionName: '7 - EP', | ||
trackName: 'Rodeo', | ||
collectionCensoredName: '7 - EP', | ||
trackCensoredName: 'Rodeo', | ||
collectionArtistName: 'Lil Nas X', | ||
artistViewUrl: 'https://music.apple.com/us/artist/lil-nas-x/1400730578?uo=4', | ||
collectionViewUrl: 'https://music.apple.com/us/album/rodeo/1468166325?i=1468166457&uo=4', | ||
trackViewUrl: 'https://music.apple.com/us/album/rodeo/1468166325?i=1468166457&uo=4', | ||
previewUrl: 'https://audio-ssl.itunes.apple.com/itunes-assets/AudioPreview123/v4/9e/33/d3/9e33d321-54f9-07cc-e3ad-4070f2b91007/mzaf_7571049535424902725.plus.aac.p.m4a', | ||
artworkUrl30: 'https://is2-ssl.mzstatic.com/image/thumb/Music113/v4/0d/f9/28/0df92898-90d1-6e15-3b04-9a860feabd0d/source/30x30bb.jpg', | ||
artworkUrl60: 'https://is2-ssl.mzstatic.com/image/thumb/Music113/v4/0d/f9/28/0df92898-90d1-6e15-3b04-9a860feabd0d/source/60x60bb.jpg', | ||
artworkUrl100: 'https://is2-ssl.mzstatic.com/image/thumb/Music113/v4/0d/f9/28/0df92898-90d1-6e15-3b04-9a860feabd0d/source/100x100bb.jpg', | ||
collectionPrice: 6.99, | ||
trackPrice: 1.29, | ||
releaseDate: '2019-06-21T07:00:00Z', | ||
collectionExplicitness: 'explicit', | ||
trackExplicitness: 'explicit', | ||
discCount: 1, | ||
discNumber: 1, | ||
trackCount: 8, | ||
trackNumber: 5, | ||
country: 'USA', | ||
currency: 'USD', | ||
primaryGenreName: 'Alternative', | ||
contentAdvisoryRating: 'Explicit', | ||
isStreamable: true | ||
"wrapperType": "track", | ||
"kind": "song", | ||
"artistId": 1400730578, | ||
"collectionId": 1468166325, | ||
"trackId": 1468166457, | ||
"artistName": "Lil Nas X & Cardi B", | ||
"collectionName": "7 - EP", | ||
"trackName": "Rodeo", | ||
"collectionCensoredName": "7 - EP", | ||
"trackCensoredName": "Rodeo", | ||
"collectionArtistName": "Lil Nas X", | ||
"artistViewUrl": "https://music.apple.com/us/artist/lil-nas-x/1400730578?uo=4", | ||
"collectionViewUrl": "https://music.apple.com/us/album/rodeo/1468166325?i=1468166457&uo=4", | ||
"trackViewUrl": "https://music.apple.com/us/album/rodeo/1468166325?i=1468166457&uo=4", | ||
"previewUrl": "https://audio-ssl.itunes.apple.com/itunes-assets/AudioPreview123/v4/9e/33/d3/9e33d321-54f9-07cc-e3ad-4070f2b91007/mzaf_7571049535424902725.plus.aac.p.m4a", | ||
"artworkUrl30": "https://is2-ssl.mzstatic.com/image/thumb/Music113/v4/0d/f9/28/0df92898-90d1-6e15-3b04-9a860feabd0d/source/30x30bb.jpg", | ||
"artworkUrl60": "https://is2-ssl.mzstatic.com/image/thumb/Music113/v4/0d/f9/28/0df92898-90d1-6e15-3b04-9a860feabd0d/source/60x60bb.jpg", | ||
"artworkUrl100": "https://is2-ssl.mzstatic.com/image/thumb/Music113/v4/0d/f9/28/0df92898-90d1-6e15-3b04-9a860feabd0d/source/100x100bb.jpg", | ||
"collectionPrice": 6.99, | ||
"trackPrice": 1.29, | ||
"releaseDate": "2019-06-21T07:00:00Z", | ||
"collectionExplicitness": "explicit", | ||
"trackExplicitness": "explicit", | ||
"discCount": 1, | ||
"discNumber": 1, | ||
"trackCount": 8, | ||
"trackNumber": 5, | ||
"country": "USA", | ||
"currency": "USD", | ||
"primaryGenreName": "Alternative", | ||
"contentAdvisoryRating": "Explicit", | ||
"isStreamable": true | ||
} | ||
] | ||
}*/ | ||
} | ||
*/ | ||
``` | ||
## WARNING!! | ||
## WARNING! | ||
If you are confronted with any problems, you can come to our discord support server below. | ||
[Support Server](https://discord.gg/4agCuVt) | ||
[Support Server](https://discord.gg/4agCuVt) |
Major refactor
Supply chain riskPackage has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.
Found 1 instance in 1 package
Network access
Supply chain riskThis module accesses the network.
Found 1 instance in 1 package
No tests
QualityPackage does not have any tests. This is a strong signal of a poorly maintained or low quality package.
Found 1 instance in 1 package
45710
12
452
1
1
1
89