{"_id":"@akashagrahari/dota-liquipedia-api-client","_rev":"8-a11b237c3745c8dbaba7426e152f2de0","name":"@akashagrahari/dota-liquipedia-api-client","dist-tags":{"latest":"1.0.7"},"versions":{"1.0.0":{"name":"@akashagrahari/dota-liquipedia-api-client","version":"1.0.0","description":"An API client to read data from Liquipedia for the video game Dota","main":"./dist/index.js","typings":"./dist/index.d.ts","scripts":{"test":"jest","build":"tsc"},"repository":{"type":"git","url":"git+https://github.com/Flusaka/dota-liquipedia-api-client.git"},"keywords":[],"author":{"name":"Neil Armitage"},"license":"MIT","bugs":{"url":"https://github.com/Flusaka/dota-liquipedia-api-client/issues"},"homepage":"https://github.com/Flusaka/dota-liquipedia-api-client#readme","devDependencies":{"@types/jest":"^27.4.0","@types/node":"^17.0.10","@typescript-eslint/eslint-plugin":"^5.10.0","@typescript-eslint/parser":"^5.10.0","eslint":"^8.7.0","jest":"^27.4.7","jest-mock-extended":"^2.0.4","ts-jest":"^27.1.3","typescript":"^4.5.5"},"dependencies":{"axios":"^0.25.0","node-html-parser":"^5.2.0"},"_id":"@akashagrahari/dota-liquipedia-api-client@1.0.0","gitHead":"5621832e06dceac7f09682834bacc1a0883889ac","_nodeVersion":"21.6.2","_npmVersion":"10.2.4","dist":{"integrity":"sha512-rCjYOemf9v2xZCvLIMZRd4GZySQLSE8F1/tGOHY38Sn2N58mVP3m1KNSzbsxv05l24VLKcrpvLztbCVRqfy4+A==","shasum":"cae6e1c36e004580bfd704ebab14f0da79e18183","tarball":"https://registry.npmjs.org/@akashagrahari/dota-liquipedia-api-client/-/dota-liquipedia-api-client-1.0.0.tgz","fileCount":3,"unpackedSize":5238,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCGeoRQlMU6BRrvKaw1HG4ajOyX6yHe8Y50ASYOMf7W9gIhALvPJ40sTXjOFsreZy1Y33qc9YDyK/PhAhgs8q0sk6Eu"}]},"_npmUser":{"name":"akashagrahari","email":"akash.agrahari@gmail.com"},"directories":{},"maintainers":[{"name":"akashagrahari","email":"akash.agrahari@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/dota-liquipedia-api-client_1.0.0_1709775635760_0.03642908367097908"},"_hasShrinkwrap":false},"1.0.1":{"name":"@akashagrahari/dota-liquipedia-api-client","version":"1.0.1","description":"An API client to read data from Liquipedia for the video game Dota","main":"./src/index.js","typings":"./src/index.d.ts","scripts":{"test":"jest","build":"tsc"},"repository":{"type":"git","url":"git+https://github.com/akashagrahari/dota-liquipedia-api-client.git"},"keywords":[],"author":{"name":"Akash Agrahari"},"license":"MIT","bugs":{"url":"https://github.com/akashagrahari/dota-liquipedia-api-client/issues"},"homepage":"https://github.com/akashagrahari/dota-liquipedia-api-client#readme","devDependencies":{"@types/jest":"^27.4.0","@types/node":"^17.0.10","@typescript-eslint/eslint-plugin":"^5.10.0","@typescript-eslint/parser":"^5.10.0","eslint":"^8.7.0","jest":"^27.4.7","jest-mock-extended":"^2.0.4","ts-jest":"^27.1.3","typescript":"^4.5.5"},"dependencies":{"axios":"^0.25.0","node-html-parser":"^5.2.0"},"_id":"@akashagrahari/dota-liquipedia-api-client@1.0.1","gitHead":"5621832e06dceac7f09682834bacc1a0883889ac","_nodeVersion":"21.6.2","_npmVersion":"10.2.4","dist":{"integrity":"sha512-vTKBgzeCfE0iH+HLZU3BZROb0Ef6tI7kOniImH/IVo0oreHbiyy+8toeqOZNdthCHSRcNvf0ymONmzPk9RmTbw==","shasum":"55bc7dd074f93dd0b922a7e773d7fa4b1a9e2fde","tarball":"https://registry.npmjs.org/@akashagrahari/dota-liquipedia-api-client/-/dota-liquipedia-api-client-1.0.1.tgz","fileCount":3,"unpackedSize":5255,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIH2bKLOM5o+7hE3y+02igKtRCSa018HmVfEeJVK/4HIgAiA1da4G3IIg3fypKQGb/sSTJjdT/a4sg62TwAKV85TyQg=="}]},"_npmUser":{"name":"akashagrahari","email":"akash.agrahari@gmail.com"},"directories":{},"maintainers":[{"name":"akashagrahari","email":"akash.agrahari@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/dota-liquipedia-api-client_1.0.1_1709816896886_0.30510557439662644"},"_hasShrinkwrap":false},"1.0.2":{"name":"@akashagrahari/dota-liquipedia-api-client","version":"1.0.2","description":"An API client to read data from Liquipedia for the video game Dota","main":"./dist/index.js","typings":"./dist/index.d.ts","scripts":{"test":"jest","build":"tsc"},"repository":{"type":"git","url":"git+https://github.com/akashagrahari/dota-liquipedia-api-client.git"},"keywords":[],"author":{"name":"Akash Agrahari"},"license":"MIT","bugs":{"url":"https://github.com/akashagrahari/dota-liquipedia-api-client/issues"},"homepage":"https://github.com/akashagrahari/dota-liquipedia-api-client#readme","devDependencies":{"@types/jest":"^27.4.0","@types/node":"^17.0.10","@typescript-eslint/eslint-plugin":"^5.10.0","@typescript-eslint/parser":"^5.10.0","eslint":"^8.7.0","jest":"^27.4.7","jest-mock-extended":"^2.0.4","ts-jest":"^27.1.3","typescript":"^4.5.5"},"dependencies":{"axios":"^0.25.0","node-html-parser":"^5.2.0"},"_id":"@akashagrahari/dota-liquipedia-api-client@1.0.2","gitHead":"e0e2d50b439ada5edcd714bad17344991bef4100","_nodeVersion":"21.6.2","_npmVersion":"10.2.4","dist":{"integrity":"sha512-onxIFpZVmBYRpGcUklBTjz3hwvROCM4fUZC8n4MHw2MhtdKEjVD63s2t+CPbRBSMFoJk2eJa8bc1SZqwm2omyQ==","shasum":"ba792ba903ee1204c945f666c71507ab94dab9f6","tarball":"https://registry.npmjs.org/@akashagrahari/dota-liquipedia-api-client/-/dota-liquipedia-api-client-1.0.2.tgz","fileCount":21,"unpackedSize":25789,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCTAo4ouv2n5Y2GOxGtMqno7FIqnsLUUG3pammks6S2MwIhAIqJ9BVeKNSIXhEf2n03SM15muW5ovHCj7liMekhl8aQ"}]},"_npmUser":{"name":"akashagrahari","email":"akash.agrahari@gmail.com"},"directories":{},"maintainers":[{"name":"akashagrahari","email":"akash.agrahari@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/dota-liquipedia-api-client_1.0.2_1709844761501_0.26699176535547386"},"_hasShrinkwrap":false},"1.0.4":{"name":"@akashagrahari/dota-liquipedia-api-client","version":"1.0.4","description":"An API client to read data from Liquipedia for the video game Dota","main":"./dist/index.js","typings":"./dist/index.d.ts","scripts":{"test":"jest","build":"tsc"},"repository":{"type":"git","url":"git+https://github.com/akashagrahari/dota-liquipedia-api-client.git"},"keywords":[],"author":{"name":"Akash Agrahari"},"license":"MIT","bugs":{"url":"https://github.com/akashagrahari/dota-liquipedia-api-client/issues"},"homepage":"https://github.com/akashagrahari/dota-liquipedia-api-client#readme","devDependencies":{"@types/jest":"^27.4.0","@types/node":"^17.0.10","@typescript-eslint/eslint-plugin":"^5.10.0","@typescript-eslint/parser":"^5.10.0","eslint":"^8.7.0","jest":"^27.4.7","jest-mock-extended":"^2.0.4","ts-jest":"^27.1.3","typescript":"^4.5.5"},"dependencies":{"axios":"^0.25.0","node-html-parser":"^5.2.0"},"_id":"@akashagrahari/dota-liquipedia-api-client@1.0.4","gitHead":"e0e2d50b439ada5edcd714bad17344991bef4100","_nodeVersion":"21.6.2","_npmVersion":"10.2.4","dist":{"integrity":"sha512-lJXLd6XcUJQRNhq4zqW0fsE2WS8gW9V9skxjYLMEzD1fNUSjc0WgSAeZ/xQnDE4FS0EoM1Da/KFvNeh+Xu2New==","shasum":"2977332aae1b79391001a4f3c08f6301d108594d","tarball":"https://registry.npmjs.org/@akashagrahari/dota-liquipedia-api-client/-/dota-liquipedia-api-client-1.0.4.tgz","fileCount":21,"unpackedSize":26097,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDiAMwonCVfNAU8QNV7oNKKLRfC9N0cUfTdrt8p9NXUGQIhAP8JuwQYNkfS/HR548ftEMhzUinOPPtGLyJXFNnd9tUz"}]},"_npmUser":{"name":"akashagrahari","email":"akash.agrahari@gmail.com"},"directories":{},"maintainers":[{"name":"akashagrahari","email":"akash.agrahari@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/dota-liquipedia-api-client_1.0.4_1709861482669_0.03137595830777529"},"_hasShrinkwrap":false},"1.0.5":{"name":"@akashagrahari/dota-liquipedia-api-client","version":"1.0.5","description":"An API client to read data from Liquipedia for the video game Dota","main":"./dist/index.js","typings":"./dist/index.d.ts","scripts":{"test":"jest","build":"tsc"},"repository":{"type":"git","url":"git+https://github.com/akashagrahari/dota-liquipedia-api-client.git"},"keywords":[],"author":{"name":"Akash Agrahari"},"license":"MIT","bugs":{"url":"https://github.com/akashagrahari/dota-liquipedia-api-client/issues"},"homepage":"https://github.com/akashagrahari/dota-liquipedia-api-client#readme","devDependencies":{"@types/jest":"^27.4.0","@types/node":"^17.0.10","@typescript-eslint/eslint-plugin":"^5.10.0","@typescript-eslint/parser":"^5.10.0","eslint":"^8.7.0","jest":"^27.4.7","jest-mock-extended":"^2.0.4","ts-jest":"^27.1.3","typescript":"^4.5.5"},"dependencies":{"axios":"^0.25.0","node-html-parser":"^5.2.0"},"_id":"@akashagrahari/dota-liquipedia-api-client@1.0.5","gitHead":"e0e2d50b439ada5edcd714bad17344991bef4100","_nodeVersion":"21.6.2","_npmVersion":"10.2.4","dist":{"integrity":"sha512-7ymW2r7dpvQoPhMZCISlh3gpuezArVpvua8pX3/LJxsvbocxdq50rSEkdeioAXrKb3KDeTueTYRiSXIoTCTkkA==","shasum":"fbf64d852908d0b3052632d9141e93b83a44c947","tarball":"https://registry.npmjs.org/@akashagrahari/dota-liquipedia-api-client/-/dota-liquipedia-api-client-1.0.5.tgz","fileCount":21,"unpackedSize":26013,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDsT83r6PTTxaXEIqegNQii4x9flU9+b7LZORhmssXMiwIgVIfqFBqzV07vfUqrs4uAjZjGPllZyzwRRp3jK/X16N8="}]},"_npmUser":{"name":"akashagrahari","email":"akash.agrahari@gmail.com"},"directories":{},"maintainers":[{"name":"akashagrahari","email":"akash.agrahari@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/dota-liquipedia-api-client_1.0.5_1709861793701_0.6017170232184437"},"_hasShrinkwrap":false},"1.0.6":{"name":"@akashagrahari/dota-liquipedia-api-client","version":"1.0.6","description":"An API client to read data from Liquipedia for the video game Dota","main":"./dist/index.js","typings":"./dist/index.d.ts","scripts":{"test":"jest","build":"tsc"},"repository":{"type":"git","url":"git+https://github.com/akashagrahari/dota-liquipedia-api-client.git"},"keywords":[],"author":{"name":"Akash Agrahari"},"license":"MIT","bugs":{"url":"https://github.com/akashagrahari/dota-liquipedia-api-client/issues"},"homepage":"https://github.com/akashagrahari/dota-liquipedia-api-client#readme","devDependencies":{"@types/jest":"^27.4.0","@types/node":"^17.0.10","@typescript-eslint/eslint-plugin":"^5.10.0","@typescript-eslint/parser":"^5.10.0","eslint":"^8.7.0","jest":"^27.4.7","jest-mock-extended":"^2.0.4","ts-jest":"^27.1.3","typescript":"^4.5.5"},"dependencies":{"axios":"^0.25.0","node-html-parser":"^5.2.0"},"_id":"@akashagrahari/dota-liquipedia-api-client@1.0.6","gitHead":"e0e2d50b439ada5edcd714bad17344991bef4100","_nodeVersion":"21.6.2","_npmVersion":"10.2.4","dist":{"integrity":"sha512-lPXLYsJIUsoMiyH0SXXb/2XxLTzC+O2Mj5jdGFP8HT9mZ7QYN4DVhz/Go3j3Bbdo0hjQ2Bh1EM9Et3VPvgi15Q==","shasum":"9f0bae8e607061d55e4aa9f1a2e996900b820032","tarball":"https://registry.npmjs.org/@akashagrahari/dota-liquipedia-api-client/-/dota-liquipedia-api-client-1.0.6.tgz","fileCount":21,"unpackedSize":25984,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQD22xEgqwDPDQd+NB1j6N0VyJFkG3B/QZkMZkGvHlrgPgIhALFhN8emj4IFa444d6/cL/5Lxe+4LYSt23X731z5/Ytb"}]},"_npmUser":{"name":"akashagrahari","email":"akash.agrahari@gmail.com"},"directories":{},"maintainers":[{"name":"akashagrahari","email":"akash.agrahari@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/dota-liquipedia-api-client_1.0.6_1709864534687_0.8755332953242376"},"_hasShrinkwrap":false},"1.0.7":{"name":"@akashagrahari/dota-liquipedia-api-client","version":"1.0.7","description":"An API client to read data from Liquipedia for the video game Dota","main":"./dist/index.js","typings":"./dist/index.d.ts","scripts":{"test":"jest","build":"tsc"},"repository":{"type":"git","url":"git+https://github.com/akashagrahari/dota-liquipedia-api-client.git"},"keywords":[],"author":{"name":"Akash Agrahari"},"license":"MIT","bugs":{"url":"https://github.com/akashagrahari/dota-liquipedia-api-client/issues"},"homepage":"https://github.com/akashagrahari/dota-liquipedia-api-client#readme","devDependencies":{"@types/jest":"^27.4.0","@types/node":"^17.0.10","@typescript-eslint/eslint-plugin":"^5.10.0","@typescript-eslint/parser":"^5.10.0","eslint":"^8.7.0","jest":"^27.4.7","jest-mock-extended":"^2.0.4","ts-jest":"^27.1.3","typescript":"^4.5.5"},"dependencies":{"axios":"^0.25.0","node-html-parser":"^5.2.0"},"_id":"@akashagrahari/dota-liquipedia-api-client@1.0.7","gitHead":"e0e2d50b439ada5edcd714bad17344991bef4100","_nodeVersion":"21.6.2","_npmVersion":"10.2.4","dist":{"integrity":"sha512-YnbXjTwSdgKx2XpjWgO3nD7+VLJMfcH6tGluXwQ3NXyszBq+oAc3iy70uWttupQYhvT1f3VvLxabCbv5kxylWw==","shasum":"3743c1743b40aff957c4dbbfbe6a2542be879f0b","tarball":"https://registry.npmjs.org/@akashagrahari/dota-liquipedia-api-client/-/dota-liquipedia-api-client-1.0.7.tgz","fileCount":21,"unpackedSize":26040,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDLXhry+XD75O3H1GJPI18VJeIMGWKdrfHf3bn/Dx9FAwIgBkQTiXX5WulcfQF5t74EMSuBdTd2K+GY0PGiLwBAW+8="}]},"_npmUser":{"name":"akashagrahari","email":"akash.agrahari@gmail.com"},"directories":{},"maintainers":[{"name":"akashagrahari","email":"akash.agrahari@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/dota-liquipedia-api-client_1.0.7_1709866697944_0.7887304394897603"},"_hasShrinkwrap":false}},"time":{"created":"2024-03-07T01:40:35.653Z","1.0.0":"2024-03-07T01:40:35.939Z","modified":"2024-03-08T02:58:18.775Z","1.0.1":"2024-03-07T13:08:17.044Z","1.0.2":"2024-03-07T20:52:41.670Z","1.0.3":"2024-03-07T20:58:17.560Z","1.0.4":"2024-03-08T01:31:22.833Z","1.0.5":"2024-03-08T01:36:33.893Z","1.0.6":"2024-03-08T02:22:14.885Z","1.0.7":"2024-03-08T02:58:18.092Z"},"maintainers":[{"name":"akashagrahari","email":"akash.agrahari@gmail.com"}],"description":"An API client to read data from Liquipedia for the video game Dota","homepage":"https://github.com/akashagrahari/dota-liquipedia-api-client#readme","keywords":[],"repository":{"type":"git","url":"git+https://github.com/akashagrahari/dota-liquipedia-api-client.git"},"author":{"name":"Akash Agrahari"},"bugs":{"url":"https://github.com/akashagrahari/dota-liquipedia-api-client/issues"},"license":"MIT","readme":"# Dota 2 Liquipedia API Client\n\nAn API client to read data from the [Liquipedia Wiki for the video game Dota 2](https://liquipedia.net/dota2/). Currently it can retrieve teams and matches (upcoming, live or all).\n\n## Installation\n\nInstall the Dota 2 Liquipedia API Client via npm or your package manager of choice\n```bash\nnpm i --save dota-liquipedia-api-client\n```\n\n## How To Use\n\nImport the main client file and class, create an instance and initialise it with your User Agent name\n\n```typescript\nimport DotaLiquipediaClient from 'dota-liquipedia-api-client';\n\nconst client = new DotaLiquipediaClient('MyUserAgent');\n```\nYou can then use this to make any of the calls required for your purposes.\n\nAll API functions return a Promise, and therefore can be used through either the traditional Promise mechanism, or with the await syntax.\n\n### Teams\n\nThe data structure(s) for teams look like the following:\n\n```typescript\ntype ITeamMember = {\n    nickname: string;\n    fullName: string;\n    joinDate: Date;\n    position: string;\n}\n\ntype ITeam = {\n    name: string;\n    roster: ITeamMember[];\n    region: string;\n    captain?: string;\n}\n```\n\nYou can retrieve any team by name how the page would be named on the Liquipedia Wiki, without underscores (i.e. \"Team Liquid\", \"OG\")\n\n```typescript\nclient.getTeamByName(\"Team Liquid\").then(team => {\n    console.log(team);\n}).catch(error => {\n    console.log(error);\n});\n```\n\n### Matches\n\nThe data structure(s) for matches look like the following:\n\n```typescript\ntype IMatchTeam = {\n    name: string;\n    shortName?: string;\n    currentScore?: number;\n}\n\nenum MatchStatus {\n    Upcoming,\n    Live,\n    Completed\n}\n\ntype IMatch = {\n    homeTeam: IMatchTeam;\n    awayTeam: IMatchTeam;\n    bestOf: number;\n    status: MatchStatus;\n    startTime?: Date;\n    twitchStream?: string;\n    tournamentName?: string;\n}\n```\n\nAll matches (live & upcoming) can be retrieved using the following function.\n\n```typescript\nclient.getMatches().then(matches => {\n    console.log(matches);\n}).catch(error => {\n    console.log(error);\n});\n```\n\nOnly upcoming matches can be retrieved using the following function.\n\n```typescript\nclient.getUpcomingMatches().then(matches => {\n    console.log(matches);\n}).catch(error => {\n    console.log(error);\n});\n```\n\nOnly live matches can be retrieved using the following function.\n\n```typescript\nclient.getLiveMatches().then(matches => {\n    console.log(matches);\n}).catch(error => {\n    console.log(error);\n});\n```\n\n## Usage Notes\n\nPlease note that this uses the Dota 2 Liquipedia Wiki and you should use it in accordance with their API terms of use which you can find from [here](https://liquipedia.net/api-terms-of-use).\n\nThis library uses the \"parse\" actions for all calls, so you should be aware not to use these requests more than once per 30 seconds. Remember to cache results from the API calls to avoid recurring calls to the Liquipedia API.\n\nPlease remember to also attribute the data & content you're using to Liquipedia under the CC-BY-SA 3.0 license as described [here](https://liquipedia.net/commons/Liquipedia:Copyrights).","readmeFilename":"README.md"}