{"id":20801095,"url":"https://github.com/kartoffelchipss/splatoon3api","last_synced_at":"2025-05-07T00:10:51.798Z","repository":{"id":65431457,"uuid":"544516195","full_name":"KartoffelChipss/splatoon3api","owner":"KartoffelChipss","description":"Splatoon3api is a simple library to get the current and next Splatoon 3 Maps (rotations), Salmonruns and Splatnet gear","archived":false,"fork":false,"pushed_at":"2025-01-13T13:31:07.000Z","size":1024,"stargazers_count":16,"open_issues_count":0,"forks_count":2,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-27T18:24:49.030Z","etag":null,"topics":["nintendo","rotation","schedule","splatoon","splatoon3"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/splatoon3api","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/KartoffelChipss.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-10-02T17:16:34.000Z","updated_at":"2025-04-09T10:22:46.000Z","dependencies_parsed_at":"2024-01-16T11:27:31.131Z","dependency_job_id":"6987de5d-e4b4-4999-afd7-a2a5dc209bb3","html_url":"https://github.com/KartoffelChipss/splatoon3api","commit_stats":{"total_commits":23,"total_committers":2,"mean_commits":11.5,"dds":"0.17391304347826086","last_synced_commit":"2a2ac7f93a6cdc9be7e820fbc08edab784d8b60a"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KartoffelChipss%2Fsplatoon3api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KartoffelChipss%2Fsplatoon3api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KartoffelChipss%2Fsplatoon3api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KartoffelChipss%2Fsplatoon3api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/KartoffelChipss","download_url":"https://codeload.github.com/KartoffelChipss/splatoon3api/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252788529,"owners_count":21804284,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["nintendo","rotation","schedule","splatoon","splatoon3"],"created_at":"2024-11-17T18:16:31.908Z","updated_at":"2025-05-07T00:10:51.780Z","avatar_url":"https://github.com/KartoffelChipss.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Splatoon3api\n\nSplatoon3api is a simple library to get the current and next Splatoon 3 Maps (rotations), Salmonruns, Challenges, Splatfests and Splatnet gear. This package uses the data from [splatoon3.ink](https://splatoon3.ink/). Splatoon3api is available in 14 different languages ([List of available languages](#languages))\n\n[![npm](https://img.shields.io/npm/dm/splatoon3api?label=Downloads)](https://www.npmjs.com/package/splatoon3api) [![npm](https://img.shields.io/npm/v/splatoon3api?label=Version)](https://www.npmjs.com/package/splatoon3api) [![discord](https://dcbadge.vercel.app/api/server/Cc76tYwXvy?style=flat\u0026theme=default-inverted)](https://discord.com/invite/Cc76tYwXvy)\n\nIf you have trouble with this package, feel free to ask me in my [Discord](https://discord.com/invite/Cc76tYwXvy).\n\n## Table of contents\n\n - [Installation](#installation)\n - [Usage](#usage)\n    - [Languages](#languages)\n    - [Options](#options)\n    - [Stages](#stages)\n        - [All Stages](#all-stages)\n      \t- [Current stages](#current-stages)\n      \t- [Next stages](#next-stages)\n    - [Other](#other)\n        - [Salmonrun](#salmonrun-schedules)\n        - [Challenges](#challenges)\n        - [Splatnet gear](#splatnet-gear)\n    - [Splatfests](#splatfests)\n      - [Currently running Splatfests](#currently-running-splatfest)\n      - [Upcoming Splatfests](#scheduled-splatfests)\n      - [Past Splatfests](#past-splatfests)\n- [Change Log](#change-log)\n\n### Installation\n\nSimply execute the following command in your commandline:\n\n```\nnpm install splatoon3api\n```\n\n### Usage\n\nImport the package like this:\n\n```js\nimport splatoon3api from \"splatoon3api\";\nconst Splatoon3 = new splatoon3api.Client(\"en-US\");\n```\n\nor this:\n\n```js\nconst splatoon3api = require(\"splatoon3api\");\nconst Splatoon3 = new splatoon3api.Client(\"en-US\");\n```\n\n### Languages\nYou can exchange `en-US` for any other language in the list below:\n- `en-US` - English (US)\n- `en-GB` - English (GB)\n- `de-DE` - Deutsch\n- `nl-NL` - Nederlands\n- `fr-FR` - Français (FR)\n- `fr-CA` - Français (CA)\n- `es-ES` - Español (ES)\n- `es-MX` - Español (MX)\n- `it-IT` - Italiano\n- `ru-RU` - Русский\n- `ja-JP` - 日本語\n- `ko-KR` - 한국어\n- `zh-CN` - 中文(简体)\n- `zh-TW` - 中文(台灣)\n\n### Options\n\nYou can change the options to tune splatoon3api to your liking:\n\n```js\nconst Splatoon3 = new splatoon3api.Client(\"en-GB\");\nSplatoon3.options.userAgent = \"MyApp/1.0 (contact@example.com)\";\nSplatoon3.options.cache = {\n   enabled: true,\n   ttl: 60,\n}\n```\n\nOnce you have done this, you can use all the following functions as you like.\n\n## Stages\n\n### All Stages\n\nTo get 11 upcoming and the current stages for Turf War, Ranked, XBattle, and Splatfest, you can use the `getStages()` function:\n\n```js\nSplatoon3.getStages(res =\u003e {\n    console.log(res);\n});\n```\n\n### Current Stages\n\nTo get the current Turf War and Ranked maps, you can use the `getCurrentStages()` function:\n\n```js\nSplatoon3.getCurrentStages(res =\u003e {\n    console.log(res);\n});\n```\n\n### Next Stages\n\nTo get the next Turf War and Ranked maps, you can use the `getNextStages()` function:\n\n```js\nSplatoon3.getNextStages(res =\u003e {\n    console.log(res);\n});\n```\n\n## Other\n\n### Salmonrun Schedules\n\nTo get the current and next Salmonruns, you can use the `getSalmonRun()` function:\n\n```js\nSplatoon3.getSalmonRun(res =\u003e {\n    console.log(res);\n});\n```\n\n### Challenges\n\nTo get the current Challenges, you can use the `getChallenges()` function:\n\n```js\nSplatoon3.getChallenges(res =\u003e {\n    console.log(res);\n});\n```\n\n### Splatnet Gear\n\nTo get the currently available Splatnet gear, you can use the `getSplatnetGear()` function:\n\n```js\nSplatoon3.getSplatnetGear(res =\u003e {\n    console.log(res);\n});\n```\n\n## Splatfests\n\n#### Splatfests are divided into those four regions:\n- **US:** The Americas, Australia, New Zealand\n- **EU:** Europe\n- **JP:** Japan\n- **AP:** Hong Kong, South Korea (Asia/Pacific)\n\n### Currently running Splatfest\n\nTo get the currenttly running Splatfest, you can use the `getRunningSplatfests()` function:\n\n```js\nSplatoon3.getRunningSplatfests(res =\u003e {\n    console.log(res);\n});\n```\n\nPlease note that the hexcolors may differ a little from the real colors. If you want the most accurate colors, you should use RGBA.\n\n### Scheduled Splatfests\n\nTo get scheduled Splatfest, that are coming in the future, you can use the `getUpcomingSplatfests()` function:\n\n```js\nSplatoon3.getUpcomingSplatfests(res =\u003e {\n    console.log(res);\n});\n```\n\n### Past Splatfests\n\nTo get all past Splatfests, you can use the `getPastSplatfests()` function:\n\n```js\nSplatoon3.getPastSplatfests(res =\u003e {\n    console.log(res);\n});\n```\n\n## Change Log\n\nYou can find the Changelog in [CHANGELOG.md](./CHANGELOG.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkartoffelchipss%2Fsplatoon3api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkartoffelchipss%2Fsplatoon3api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkartoffelchipss%2Fsplatoon3api/lists"}